Serialized Form (AWS Java SDK for Synthetics 1.12.131 API)

Package com.amazonaws.services.synthetics.model
- Class com.amazonaws.services.synthetics.model.ArtifactConfigInput extends Object implements Serializable
  - Serialized Fields
    - s3Encryption
```
S3EncryptionConfig 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
- Class com.amazonaws.services.synthetics.model.ArtifactConfigOutput extends Object implements Serializable
  - Serialized Fields
    - s3Encryption
```
S3EncryptionConfig s3Encryption
```
      A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.
- Class com.amazonaws.services.synthetics.model.AWSSyntheticsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.synthetics.model.BaseScreenshot extends Object implements Serializable
  - Serialized Fields
    - screenshotName
```
String 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.
    - ignoreCoordinates
```
List<E> 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}
- Class com.amazonaws.services.synthetics.model.Canary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique ID of this canary.
    - name
```
String name
```
      The name of the canary.
    - code
```
CanaryCodeOutput code
```
    - executionRoleArn
```
String 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.
    - schedule
```
CanaryScheduleOutput schedule
```
      A structure that contains information about how often the canary is to run, and when these runs are to stop.
    - runConfig
```
CanaryRunConfigOutput runConfig
```
    - successRetentionPeriodInDays
```
Integer successRetentionPeriodInDays
```
      The number of days to retain data about successful runs of this canary.
    - failureRetentionPeriodInDays
```
Integer failureRetentionPeriodInDays
```
      The number of days to retain data about failed runs of this canary.
    - status
```
CanaryStatus status
```
      A structure that contains information about the canary's status.
    - timeline
```
CanaryTimeline timeline
```
      A structure that contains information about when the canary was created, modified, and most recently run.
    - artifactS3Location
```
String 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.
    - engineArn
```
String 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.
    - runtimeVersion
```
String runtimeVersion
```
      Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
    - vpcConfig
```
VpcConfigOutput vpcConfig
```
    - visualReference
```
VisualReferenceOutput 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.
    - tags
```
Map<K,V> tags
```
      The list of key-value pairs that are associated with the canary.
    - artifactConfig
```
ArtifactConfigOutput 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.
- Class com.amazonaws.services.synthetics.model.CanaryCodeInput extends Object implements Serializable
  - Serialized Fields
    - s3Bucket
```
String 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.
    - s3Key
```
String s3Key
```
      The S3 key of your script. For more information, see Working with Amazon S3 Objects.
    - s3Version
```
String s3Version
```
      The S3 version ID of your script.
    - zipFile
```
ByteBuffer 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.
    - handler
```
String 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.
- Class com.amazonaws.services.synthetics.model.CanaryCodeOutput extends Object implements Serializable
  - Serialized Fields
    - sourceLocationArn
```
String sourceLocationArn
```
      The ARN of the Lambda layer where Synthetics stores the canary script code.
    - handler
```
String handler
```
      The entry point to use for the source code when running the canary.
- Class com.amazonaws.services.synthetics.model.CanaryLastRun extends Object implements Serializable
  - Serialized Fields
    - canaryName
```
String canaryName
```
      The name of the canary.
    - lastRun
```
CanaryRun lastRun
```
      The results from this canary's most recent run.
- Class com.amazonaws.services.synthetics.model.CanaryRun extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      A unique ID that identifies this canary run.
    - name
```
String name
```
      The name of the canary.
    - status
```
CanaryRunStatus status
```
      The status of this run.
    - timeline
```
CanaryRunTimeline timeline
```
      A structure that contains the start and end times of this run.
    - artifactS3Location
```
String artifactS3Location
```
      The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.
- Class com.amazonaws.services.synthetics.model.CanaryRunConfigInput extends Object implements Serializable
  - Serialized Fields
    - timeoutInSeconds
```
Integer timeoutInSeconds
```
      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 used as this value, up to a maximum of 14 minutes.
    - memoryInMB
```
Integer memoryInMB
```
      The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
    - activeTracing
```
Boolean activeTracing
```
      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 hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.
      
      You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      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 be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
- Class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput extends Object implements Serializable
  - Serialized Fields
    - timeoutInSeconds
```
Integer timeoutInSeconds
```
      How long the canary is allowed to run before it must stop.
    - memoryInMB
```
Integer memoryInMB
```
      The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
    - activeTracing
```
Boolean activeTracing
```
      Displays whether this canary run used active X-Ray tracing.
- Class com.amazonaws.services.synthetics.model.CanaryRunStatus extends Object implements Serializable
  - Serialized Fields
    - state
```
String state
```
      The current state of the run.
    - stateReason
```
String stateReason
```
      If run of the canary failed, this field contains the reason for the error.
    - stateReasonCode
```
String stateReasonCode
```
      If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.
- Class com.amazonaws.services.synthetics.model.CanaryRunTimeline extends Object implements Serializable
  - Serialized Fields
    - started
```
Date started
```
      The start time of the run.
    - completed
```
Date completed
```
      The end time of the run.
- Class com.amazonaws.services.synthetics.model.CanaryScheduleInput extends Object implements Serializable
  - Serialized Fields
    - expression
```
String expression
```
      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 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
      
      Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
      
      Use cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
    - durationInSeconds
```
Long durationInSeconds
```
      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 omit this field, the default of 0 is used.
- Class com.amazonaws.services.synthetics.model.CanaryScheduleOutput extends Object implements Serializable
  - Serialized Fields
    - expression
```
String expression
```
      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 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
      
      Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
      
      Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
    - durationInSeconds
```
Long durationInSeconds
```
      How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
- Class com.amazonaws.services.synthetics.model.CanaryStatus extends Object implements Serializable
  - Serialized Fields
    - state
```
String state
```
      The current state of the canary.
    - stateReason
```
String stateReason
```
      If the canary has insufficient permissions to run, this field provides more details.
    - stateReasonCode
```
String stateReasonCode
```
      If the canary cannot run or has failed, this field displays the reason.
- Class com.amazonaws.services.synthetics.model.CanaryTimeline extends Object implements Serializable
  - Serialized Fields
    - created
```
Date created
```
      The date and time the canary was created.
    - lastModified
```
Date lastModified
```
      The date and time the canary was most recently modified.
    - lastStarted
```
Date lastStarted
```
      The date and time that the canary's most recent run started.
    - lastStopped
```
Date lastStopped
```
      The date and time that the canary's most recent run ended.
- Class com.amazonaws.services.synthetics.model.ConflictException extends AWSSyntheticsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.synthetics.model.CreateCanaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      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 canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
    - code
```
CanaryCodeInput code
```
      A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
    - artifactS3Location
```
String artifactS3Location
```
      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 S3 bucket can't include a period (.).
    - executionRoleArn
```
String executionRoleArn
```
      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 permissions:
      
      s3:PutObject
      
      s3:GetBucketLocation
      
      s3:ListAllMyBuckets
      
      cloudwatch:PutMetricData
      
      logs:CreateLogGroup
      
      logs:CreateLogStream
      
      logs:PutLogEvents
    - schedule
```
CanaryScheduleInput schedule
```
      A structure that contains information about how often the canary is to run and when these test runs are to stop.
    - runConfig
```
CanaryRunConfigInput runConfig
```
      A structure that contains the configuration for individual canary runs, such as timeout value.
    - successRetentionPeriodInDays
```
Integer successRetentionPeriodInDays
```
      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.
    - failureRetentionPeriodInDays
```
Integer failureRetentionPeriodInDays
```
      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.
    - runtimeVersion
```
String runtimeVersion
```
      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.
    - vpcConfig
```
VpcConfigInput vpcConfig
```
      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.
    - tags
```
Map<K,V> tags
```
      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 user permissions, by granting a user permission to access or change only the resources that have certain tag values.
    - artifactConfig
```
ArtifactConfigInput 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.
- Class com.amazonaws.services.synthetics.model.CreateCanaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - canary
```
Canary canary
```
      The full details about the canary you have created.
- Class com.amazonaws.services.synthetics.model.DeleteCanaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.
- Class com.amazonaws.services.synthetics.model.DeleteCanaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
    - maxResults
```
Integer maxResults
```
      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.
- Class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - canariesLastRun
```
List<E> canariesLastRun
```
      An array that contains the information from the most recent run of each canary.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.synthetics.model.DescribeCanariesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      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.
    - maxResults
```
Integer maxResults
```
      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 100 is used.
- Class com.amazonaws.services.synthetics.model.DescribeCanariesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - canaries
```
List<E> canaries
```
      Returns an array. Each item in the array contains the full information about one canary.
    - nextToken
```
String nextToken
```
      A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
- Class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      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.
    - maxResults
```
Integer maxResults
```
      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.
- Class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - runtimeVersions
```
List<E> runtimeVersions
```
      An array of objects that display the details about each Synthetics canary runtime version.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.synthetics.model.GetCanaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the canary that you want details for.
- Class com.amazonaws.services.synthetics.model.GetCanaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - canary
```
Canary canary
```
      A strucure that contains the full information about the canary.
- Class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the canary that you want to see runs for.
    - nextToken
```
String nextToken
```
      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.
    - maxResults
```
Integer maxResults
```
      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.
- Class com.amazonaws.services.synthetics.model.GetCanaryRunsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - canaryRuns
```
List<E> canaryRuns
```
      An array of structures. Each structure contains the details of one of the retrieved canary runs.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.synthetics.model.InternalServerException extends AWSSyntheticsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.synthetics.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the canary that you want to view tags for.
      
      The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
- Class com.amazonaws.services.synthetics.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      The list of tag keys and values associated with the canary that you specified.
- Class com.amazonaws.services.synthetics.model.ResourceNotFoundException extends AWSSyntheticsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.synthetics.model.RuntimeVersion extends Object implements Serializable
  - Serialized Fields
    - versionName
```
String versionName
```
      The name of the runtime version. For a list of valid runtime versions, see Canary Runtime Versions.
    - description
```
String description
```
      A description of the runtime version, created by Amazon.
    - releaseDate
```
Date releaseDate
```
      The date that the runtime version was released.
    - deprecationDate
```
Date deprecationDate
```
      If this runtime version is deprecated, this value is the date of deprecation.
- Class com.amazonaws.services.synthetics.model.S3EncryptionConfig extends Object implements Serializable
  - Serialized Fields
    - encryptionMode
```
String encryptionMode
```
      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 a customer-managed KMS key.
      
      If you omit this parameter, an Amazon Web Services-managed KMS key is used.
    - kmsKeyArn
```
String kmsKeyArn
```
      The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode
- Class com.amazonaws.services.synthetics.model.StartCanaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the canary that you want to run. To find canary names, use DescribeCanaries.
- Class com.amazonaws.services.synthetics.model.StartCanaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.synthetics.model.StopCanaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the canary that you want to stop. To find the names of your canaries, use DescribeCanaries.
- Class com.amazonaws.services.synthetics.model.StopCanaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.synthetics.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the canary that you're adding tags to.
      
      The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
    - tags
```
Map<K,V> tags
```
      The list of key-value pairs to associate with the canary.
- Class com.amazonaws.services.synthetics.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.synthetics.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the canary that you're removing tags from.
      
      The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
    - tagKeys
```
List<E> tagKeys
```
      The list of tag keys to remove from the resource.
- Class com.amazonaws.services.synthetics.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.synthetics.model.UpdateCanaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      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.
    - code
```
CanaryCodeInput code
```
      A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
    - executionRoleArn
```
String executionRoleArn
```
      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 permissions:
      
      s3:PutObject
      
      s3:GetBucketLocation
      
      s3:ListAllMyBuckets
      
      cloudwatch:PutMetricData
      
      logs:CreateLogGroup
      
      logs:CreateLogStream
      
      logs:CreateLogStream
    - runtimeVersion
```
String runtimeVersion
```
      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.
    - schedule
```
CanaryScheduleInput schedule
```
      A structure that contains information about how often the canary is to run, and when these runs are to stop.
    - runConfig
```
CanaryRunConfigInput runConfig
```
      A structure that contains the timeout value that is used for each individual run of the canary.
    - successRetentionPeriodInDays
```
Integer successRetentionPeriodInDays
```
      The number of days to retain data about successful runs of this canary.
    - failureRetentionPeriodInDays
```
Integer failureRetentionPeriodInDays
```
      The number of days to retain data about failed runs of this canary.
    - vpcConfig
```
VpcConfigInput vpcConfig
```
      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.
    - visualReference
```
VisualReferenceInput visualReference
```
      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 screenshots that the canary might be using already.
      
      Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint
    - artifactS3Location
```
String artifactS3Location
```
      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 S3 bucket can't include a period (.).
    - artifactConfig
```
ArtifactConfigInput 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.
- Class com.amazonaws.services.synthetics.model.UpdateCanaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.synthetics.model.ValidationException extends AWSSyntheticsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.synthetics.model.VisualReferenceInput extends Object implements Serializable
  - Serialized Fields
    - baseScreenshots
```
List<E> baseScreenshots
```
      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 from this array.
    - baseCanaryRunId
```
String baseCanaryRunId
```
      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 update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from any past run of this canary.
- Class com.amazonaws.services.synthetics.model.VisualReferenceOutput extends Object implements Serializable
  - Serialized Fields
    - baseScreenshots
```
List<E> baseScreenshots
```
      An array of screenshots that are used as the baseline for comparisons during visual monitoring.
    - baseCanaryRunId
```
String baseCanaryRunId
```
      The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.
- Class com.amazonaws.services.synthetics.model.VpcConfigInput extends Object implements Serializable
  - Serialized Fields
    - subnetIds
```
List<E> subnetIds
```
      The IDs of the subnets where this canary is to run.
    - securityGroupIds
```
List<E> securityGroupIds
```
      The IDs of the security groups for this canary.
- Class com.amazonaws.services.synthetics.model.VpcConfigOutput extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The IDs of the VPC where this canary is to run.
    - subnetIds
```
List<E> subnetIds
```
      The IDs of the subnets where this canary is to run.
    - securityGroupIds
```
List<E> securityGroupIds
```
      The IDs of the security groups for this canary.

Serialized Form

Package com.amazonaws.services.synthetics.model

Class com.amazonaws.services.synthetics.model.ArtifactConfigInput extends Object implements Serializable

Serialized Fields

s3Encryption

Class com.amazonaws.services.synthetics.model.ArtifactConfigOutput extends Object implements Serializable

Serialized Fields

s3Encryption

Class com.amazonaws.services.synthetics.model.AWSSyntheticsException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.synthetics.model.BaseScreenshot extends Object implements Serializable

Serialized Fields

screenshotName

ignoreCoordinates

Class com.amazonaws.services.synthetics.model.Canary extends Object implements Serializable

Serialized Fields

id

name

code

executionRoleArn

schedule

runConfig

successRetentionPeriodInDays

failureRetentionPeriodInDays

status

timeline

artifactS3Location

engineArn

runtimeVersion

vpcConfig

visualReference

tags

artifactConfig

Class com.amazonaws.services.synthetics.model.CanaryCodeInput extends Object implements Serializable

Serialized Fields

s3Bucket

s3Key

s3Version

zipFile

handler

Class com.amazonaws.services.synthetics.model.CanaryCodeOutput extends Object implements Serializable

Serialized Fields

sourceLocationArn

handler

Class com.amazonaws.services.synthetics.model.CanaryLastRun extends Object implements Serializable

Serialized Fields

canaryName

lastRun

Class com.amazonaws.services.synthetics.model.CanaryRun extends Object implements Serializable

Serialized Fields

id

name

status

timeline

artifactS3Location

Class com.amazonaws.services.synthetics.model.CanaryRunConfigInput extends Object implements Serializable

Serialized Fields

timeoutInSeconds

memoryInMB

activeTracing

environmentVariables

Class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput extends Object implements Serializable

Serialized Fields

timeoutInSeconds

memoryInMB

activeTracing

Class com.amazonaws.services.synthetics.model.CanaryRunStatus extends Object implements Serializable

Serialized Fields

state

stateReason

stateReasonCode

Class com.amazonaws.services.synthetics.model.CanaryRunTimeline extends Object implements Serializable

Serialized Fields

started

completed

Class com.amazonaws.services.synthetics.model.CanaryScheduleInput extends Object implements Serializable

Serialized Fields

expression

durationInSeconds

Class com.amazonaws.services.synthetics.model.CanaryScheduleOutput extends Object implements Serializable

Serialized Fields