export interface CanaryCodeInput {
    /** If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name. */
    S3Bucket?: string;
    /** The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects. */
    S3Key?: string;
    /** The Amazon S3 version ID of your script. */
    S3Version?: string;
    /** If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the sc */
    ZipFile?: string;
    /** The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, t */
    Handler?: string;
    /** BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing cus */
    BlueprintTypes?: string[];
    /** A list of dependencies that should be used for running this canary. Specify the dependencies as a key-value pair, where the key is the type of dependency and the value is the dependency reference. */
    Dependencies?: any[];
}
export interface RetryConfigInput {
    /** The maximum number of retries. The value must be less than or equal to 2. */
    MaxRetries: number;
}
export interface CanaryScheduleInput {
    /** A rate expression or a cron expression that defines how often the canary is to run. For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 mi */
    Expression: string;
    /** How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omi */
    DurationInSeconds?: number;
    /** A structure that contains the retry configuration for a canary */
    RetryConfig?: RetryConfigInput;
}
export interface CanaryRunConfigInput {
    /** How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary. If you omit this field, the frequency of the canary is us */
    TimeoutInSeconds?: number;
    /** The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64. */
    MemoryInMB?: number;
    /** Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not  */
    ActiveTracing?: boolean;
    /** Specifies the keys and values to use for any environment variables used in the canary script. Use the following format: { "key1" : "value1", "key2" : "value2", ...} Keys must start with a letter and b */
    EnvironmentVariables?: Record<string, string>;
    /** Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 b */
    EphemeralStorage?: number;
}
export interface VpcConfigInput {
    /** The IDs of the subnets where this canary is to run. */
    SubnetIds?: string[];
    /** The IDs of the security groups for this canary. */
    SecurityGroupIds?: string[];
    /** Set this to true to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is false */
    Ipv6AllowedForDualStack?: boolean;
}
export interface BrowserConfig {
    /** The browser type associated with this browser configuration. */
    BrowserType?: 'CHROME' | 'FIREFOX';
}
export interface S3EncryptionConfig {
    /** The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with  */
    EncryptionMode?: 'SSE_S3' | 'SSE_KMS';
    /** The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode */
    KmsKeyArn?: string;
}
export interface ArtifactConfigInput {
    /** A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Artifact encryption functionality is available only for canaries that */
    S3Encryption?: S3EncryptionConfig;
}
export interface VisualReferenceInput {
    /** An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it  */
    BaseScreenshots?: any[];
    /** Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this updat */
    BaseCanaryRunId: string;
    /** The browser type associated with this visual reference. */
    BrowserType?: 'CHROME' | 'FIREFOX';
}
export interface AssociateResourceInput {
    /** Specifies the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. */
    GroupIdentifier: string;
    /** The ARN of the canary that you want to associate with the specified group. */
    ResourceArn: string;
}
export interface CreateCanaryInput {
    /** The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can't includ */
    ArtifactS3Location: string;
    /** A structure that includes the entry point from which the canary should start running your script. If the script is stored in an Amazon S3 bucket, the bucket name, key, and version are also included. */
    Code: CanaryCodeInput;
    /** The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following perm */
    ExecutionRoleArn: string;
    /** The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary names. The c */
    Name: string;
    /** Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions. */
    RuntimeVersion: string;
    /** A structure that contains information about how often the canary is to run and when these test runs are to stop. */
    Schedule: CanaryScheduleInput;
    /** A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. */
    ArtifactConfig?: ArtifactConfigInput;
    /** CloudWatch Synthetics now supports multibrowser canaries for syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 runtimes. This feature allows you to run your canaries on both Firefox and Chrome b */
    BrowserConfigs?: BrowserConfig[];
    /** The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. This setting affects the range of informat */
    FailureRetentionPeriodInDays?: number;
    /** Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lamb */
    ProvisionedResourceCleanup?: 'AUTOMATIC' | 'OFF';
    /** To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function. If you specify this parameter and don */
    ResourcesToReplicateTags?: 'lambda-function'[];
    /** A structure that contains the configuration for individual canary runs, such as timeout value and environment variables. Environment variable keys and values are encrypted at rest using Amazon Web Ser */
    RunConfig?: CanaryRunConfigInput;
    /** The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. This setting affects the range of info */
    SuccessRetentionPeriodInDays?: number;
    /** A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary. Tags can help you organize and categorize your resources. You can also use them to scope use */
    Tags?: Record<string, string>;
    /** If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. */
    VpcConfig?: VpcConfigInput;
}
export interface CreateGroupInput {
    /** The name for the group. It can include any Unicode characters. The names for all groups in your account, across all Regions, must be unique. */
    Name: string;
    /** A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a group. Tags can help you organize and categorize your resources. You can also use them to scope user  */
    Tags?: Record<string, string>;
}
export interface DeleteCanaryInput {
    /** The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries. */
    Name: string;
    /** Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false. Your setting for this parameter is used only if the canary doesn't have AUTOMATIC for its Pr */
    DeleteLambda?: boolean;
}
export interface DeleteGroupInput {
    /** Specifies which group to delete. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. */
    GroupIdentifier: string;
}
export interface DescribeCanariesInput {
    /** Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 20 is used. */
    MaxResults?: number;
    /** Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names. If you specify this parameter, the operation is successful only if  */
    Names?: string[];
    /** A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. */
    NextToken?: string;
}
export interface DescribeCanariesLastRunInput {
    /** The type of browser to use for the canary run. */
    BrowserType?: 'CHROME' | 'FIREFOX';
    /** Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used. */
    MaxResults?: number;
    /** Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names. If you specify this parameter, the operation is successful only if  */
    Names?: string[];
    /** A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results. */
    NextToken?: string;
}
export interface DescribeRuntimeVersionsInput {
    /** Specify this parameter to limit how many runs are returned each time you use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used. */
    MaxResults?: number;
    /** A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results. */
    NextToken?: string;
}
export interface DisassociateResourceInput {
    /** Specifies the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. */
    GroupIdentifier: string;
    /** The ARN of the canary that you want to remove from the specified group. */
    ResourceArn: string;
}
export interface GetCanaryInput {
    /** The name of the canary that you want details for. */
    Name: string;
    /** The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run. */
    DryRunId?: string;
}
export interface GetCanaryRunsInput {
    /** The name of the canary that you want to see runs for. */
    Name: string;
    /** The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run. */
    DryRunId?: string;
    /** Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used. */
    MaxResults?: number;
    /** A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results. When auto retry is enabled for the canary, */
    NextToken?: string;
    /** When you provide RunType=CANARY_RUN and dryRunId, you will get an exception When a value is not provided for RunType, the default value is CANARY_RUN When CANARY_RUN is provided, all canary runs exclu */
    RunType?: 'CANARY_RUN' | 'DRY_RUN';
}
export interface GetGroupInput {
    /** Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. */
    GroupIdentifier: string;
}
export interface ListAssociatedGroupsInput {
    /** The ARN of the canary that you want to view groups for. */
    ResourceArn: string;
    /** Specify this parameter to limit how many groups are returned each time you use the ListAssociatedGroups operation. If you omit this parameter, the default of 20 is used. */
    MaxResults?: number;
    /** A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. */
    NextToken?: string;
}
export interface ListGroupResourcesInput {
    /** Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. */
    GroupIdentifier: string;
    /** Specify this parameter to limit how many canary ARNs are returned each time you use the ListGroupResources operation. If you omit this parameter, the default of 20 is used. */
    MaxResults?: number;
    /** A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. */
    NextToken?: string;
}
export interface ListGroupsInput {
    /** Specify this parameter to limit how many groups are returned each time you use the ListGroups operation. If you omit this parameter, the default of 20 is used. */
    MaxResults?: number;
    /** A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. */
    NextToken?: string;
}
export interface ListTagsForResourceInput {
    /** The ARN of the canary or group that you want to view tags for. The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN format of a group is arn:aws:synthetics:R */
    ResourceArn: string;
}
export interface StartCanaryInput {
    /** The name of the canary that you want to run. To find canary names, use DescribeCanaries. */
    Name: string;
}
export interface StartCanaryDryRunInput {
    /** The name of the canary that you want to dry run. To find canary names, use DescribeCanaries. */
    Name: string;
    ArtifactConfig?: ArtifactConfigInput;
    /** The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can't includ */
    ArtifactS3Location?: string;
    /** A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers. If not specified, browserConfigs defaults to C */
    BrowserConfigs?: BrowserConfig[];
    Code?: CanaryCodeInput;
    /** The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following perm */
    ExecutionRoleArn?: string;
    /** The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. This setting affects the range of informat */
    FailureRetentionPeriodInDays?: number;
    /** Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lamb */
    ProvisionedResourceCleanup?: 'AUTOMATIC' | 'OFF';
    RunConfig?: CanaryRunConfigInput;
    /** Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions. */
    RuntimeVersion?: string;
    /** The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. This setting affects the range of info */
    SuccessRetentionPeriodInDays?: number;
    VisualReference?: VisualReferenceInput;
    /** A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons. syn-nodejs-pu */
    VisualReferences?: VisualReferenceInput[];
    VpcConfig?: VpcConfigInput;
}
export interface StopCanaryInput {
    /** The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries. */
    Name: string;
}
export interface TagResourceInput {
    /** The ARN of the canary or group that you're adding tags to. The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN format of a group is arn:aws:synthetics:Regio */
    ResourceArn: string;
    /** The list of key-value pairs to associate with the resource. */
    Tags: Record<string, string>;
}
export interface UntagResourceInput {
    /** The ARN of the canary or group that you're removing tags from. The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN format of a group is arn:aws:synthetics:R */
    ResourceArn: string;
    /** The list of tag keys to remove from the resource. */
    TagKeys: string[];
}
export interface UpdateCanaryInput {
    /** The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries. You cannot change the name of a canary that has already been created. */
    Name: string;
    /** A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. */
    ArtifactConfig?: ArtifactConfigInput;
    /** The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can't includ */
    ArtifactS3Location?: string;
    /** A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers. If not specified, browserConfigs defaults to C */
    BrowserConfigs?: BrowserConfig[];
    /** A structure that includes the entry point from which the canary should start running your script. If the script is stored in an Amazon S3 bucket, the bucket name, key, and version are also included. */
    Code?: CanaryCodeInput;
    /** Update the existing canary using the updated configurations from the DryRun associated with the DryRunId. When you use the dryRunId field when updating a canary, the only other field you can provide i */
    DryRunId?: string;
    /** The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following perm */
    ExecutionRoleArn?: string;
    /** The number of days to retain data about failed runs of this canary. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthe */
    FailureRetentionPeriodInDays?: number;
    /** Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of  */
    ProvisionedResourceCleanup?: 'AUTOMATIC' | 'OFF';
    /** A structure that contains the timeout value that is used for each individual run of the canary. Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. How */
    RunConfig?: CanaryRunConfigInput;
    /** Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions. */
    RuntimeVersion?: string;
    /** A structure that contains information about how often the canary is to run, and when these runs are to stop. */
    Schedule?: CanaryScheduleInput;
    /** The number of days to retain data about successful runs of this canary. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Sy */
    SuccessRetentionPeriodInDays?: number;
    /** Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline s */
    VisualReference?: VisualReferenceInput;
    /** A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons. syn-nodejs-pu */
    VisualReferences?: VisualReferenceInput[];
    /** If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. */
    VpcConfig?: VpcConfigInput;
}
/** synthetics service binding for Step Functions SDK integrations. */
export declare class synthetics {
    constructor();
    associateResource<T>(params: AssociateResourceInput): Promise<T>;
    createCanary<T>(params: CreateCanaryInput): Promise<T>;
    createGroup<T>(params: CreateGroupInput): Promise<T>;
    deleteCanary<T>(params: DeleteCanaryInput): Promise<T>;
    deleteGroup<T>(params: DeleteGroupInput): Promise<T>;
    describeCanaries<T>(params: DescribeCanariesInput): Promise<T>;
    describeCanariesLastRun<T>(params: DescribeCanariesLastRunInput): Promise<T>;
    describeRuntimeVersions<T>(params: DescribeRuntimeVersionsInput): Promise<T>;
    disassociateResource<T>(params: DisassociateResourceInput): Promise<T>;
    getCanary<T>(params: GetCanaryInput): Promise<T>;
    getCanaryRuns<T>(params: GetCanaryRunsInput): Promise<T>;
    getGroup<T>(params: GetGroupInput): Promise<T>;
    listAssociatedGroups<T>(params: ListAssociatedGroupsInput): Promise<T>;
    listGroupResources<T>(params: ListGroupResourcesInput): Promise<T>;
    listGroups<T>(params: ListGroupsInput): Promise<T>;
    listTagsForResource<T>(params: ListTagsForResourceInput): Promise<T>;
    startCanary<T>(params: StartCanaryInput): Promise<T>;
    startCanaryDryRun<T>(params: StartCanaryDryRunInput): Promise<T>;
    stopCanary<T>(params: StopCanaryInput): Promise<T>;
    tagResource<T>(params: TagResourceInput): Promise<T>;
    untagResource<T>(params: UntagResourceInput): Promise<T>;
    updateCanary<T>(params: UpdateCanaryInput): Promise<T>;
}
//# sourceMappingURL=synthetics.d.ts.map