API version 2017-10-11 of the Amazon Synthetics SDK configuration.

A parameter could not be validated.

A conflicting operation is already in progress.

An unknown internal error occurred.

One of the specified resources was not found.

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

See: newArtifactConfigInput smart constructor.

Create a value of ArtifactConfigInput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Encryption:ArtifactConfigInput', artifactConfigInput_s3Encryption - 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 use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts

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 use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

See: newArtifactConfigOutput smart constructor.

Create a value of ArtifactConfigOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Encryption:ArtifactConfigOutput', artifactConfigOutput_s3Encryption - A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.

A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

See: newBaseScreenshot smart constructor.

Create a value of BaseScreenshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ignoreCoordinates:BaseScreenshot', baseScreenshot_ignoreCoordinates - Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

$sel:screenshotName:BaseScreenshot', baseScreenshot_screenshotName - The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

This structure contains all information about one canary in your account.

See: newCanary smart constructor.

Create a value of Canary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:Canary', canary_status - A structure that contains information about the canary's status.

$sel:successRetentionPeriodInDays:Canary', canary_successRetentionPeriodInDays - The number of days to retain data about successful runs of this canary.

$sel:schedule:Canary', canary_schedule - A structure that contains information about how often the canary is to run, and when these runs are to stop.

$sel:artifactS3Location:Canary', canary_artifactS3Location - The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

$sel:runConfig:Canary', canary_runConfig - Undocumented member.

$sel:executionRoleArn:Canary', canary_executionRoleArn - The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

$sel:runtimeVersion:Canary', canary_runtimeVersion - Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

$sel:failureRetentionPeriodInDays:Canary', canary_failureRetentionPeriodInDays - The number of days to retain data about failed runs of this canary.

$sel:artifactConfig:Canary', canary_artifactConfig - A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

$sel:vpcConfig:Canary', canary_vpcConfig - Undocumented member.

$sel:visualReference:Canary', canary_visualReference - If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

$sel:name:Canary', canary_name - The name of the canary.

$sel:id:Canary', canary_id - The unique ID of this canary.

$sel:code:Canary', canary_code - Undocumented member.

$sel:timeline:Canary', canary_timeline - A structure that contains information about when the canary was created, modified, and most recently run.

$sel:engineArn:Canary', canary_engineArn - The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

$sel:tags:Canary', canary_tags - The list of key-value pairs that are associated with the canary.

A structure that contains information about the canary's status.

The number of days to retain data about successful runs of this canary.

A structure that contains information about how often the canary is to run, and when these runs are to stop.

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Undocumented member.

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

The number of days to retain data about failed runs of this canary.

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Undocumented member.

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

The name of the canary.

The unique ID of this canary.

Undocumented member.

A structure that contains information about when the canary was created, modified, and most recently run.

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

The list of key-value pairs that are associated with the canary.

Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.

See: newCanaryCodeInput smart constructor.

Create a value of CanaryCodeInput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Key:CanaryCodeInput', canaryCodeInput_s3Key - The S3 key of your script. For more information, see Working with Amazon S3 Objects.

$sel:s3Version:CanaryCodeInput', canaryCodeInput_s3Version - The S3 version ID of your script.

$sel:zipFile:CanaryCodeInput', canaryCodeInput_zipFile - If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:s3Bucket:CanaryCodeInput', canaryCodeInput_s3Bucket - If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

$sel:handler:CanaryCodeInput', canaryCodeInput_handler - The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

The S3 version ID of your script.

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 256 Kb.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.

See: newCanaryCodeOutput smart constructor.

Create a value of CanaryCodeOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceLocationArn:CanaryCodeOutput', canaryCodeOutput_sourceLocationArn - The ARN of the Lambda layer where Synthetics stores the canary script code.

$sel:handler:CanaryCodeOutput', canaryCodeOutput_handler - The entry point to use for the source code when running the canary.

The ARN of the Lambda layer where Synthetics stores the canary script code.

The entry point to use for the source code when running the canary.

This structure contains information about the most recent run of a single canary.

See: newCanaryLastRun smart constructor.

Create a value of CanaryLastRun with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:canaryName:CanaryLastRun', canaryLastRun_canaryName - The name of the canary.

$sel:lastRun:CanaryLastRun', canaryLastRun_lastRun - The results from this canary's most recent run.

The name of the canary.

The results from this canary's most recent run.

This structure contains the details about one run of one canary.

See: newCanaryRun smart constructor.

Create a value of CanaryRun with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:CanaryRun', canaryRun_status - The status of this run.

$sel:artifactS3Location:CanaryRun', canaryRun_artifactS3Location - The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

$sel:name:CanaryRun', canaryRun_name - The name of the canary.

$sel:id:CanaryRun', canaryRun_id - A unique ID that identifies this canary run.

$sel:timeline:CanaryRun', canaryRun_timeline - A structure that contains the start and end times of this run.

The status of this run.

The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

The name of the canary.

A unique ID that identifies this canary run.

A structure that contains the start and end times of this run.