Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- Types
- ArtifactConfigInput
- ArtifactConfigOutput
- BaseScreenshot
- Canary
- CanaryCodeInput
- CanaryCodeOutput
- CanaryLastRun
- CanaryRun
- CanaryRunConfigInput
- CanaryRunConfigOutput
- CanaryRunStatus
- CanaryRunTimeline
- CanaryScheduleInput
- CanaryScheduleOutput
- CanaryStatus
- CanaryTimeline
- Group
- GroupSummary
- RuntimeVersion
- S3EncryptionConfig
- VisualReferenceInput
- VisualReferenceOutput
- VpcConfigInput
- VpcConfigOutput
Synopsis
- associateResource_groupIdentifier :: Lens' AssociateResource Text
- associateResource_resourceArn :: Lens' AssociateResource Text
- associateResourceResponse_httpStatus :: Lens' AssociateResourceResponse Int
- createCanary_artifactConfig :: Lens' CreateCanary (Maybe ArtifactConfigInput)
- createCanary_failureRetentionPeriodInDays :: Lens' CreateCanary (Maybe Natural)
- createCanary_runConfig :: Lens' CreateCanary (Maybe CanaryRunConfigInput)
- createCanary_successRetentionPeriodInDays :: Lens' CreateCanary (Maybe Natural)
- createCanary_tags :: Lens' CreateCanary (Maybe (HashMap Text Text))
- createCanary_vpcConfig :: Lens' CreateCanary (Maybe VpcConfigInput)
- createCanary_name :: Lens' CreateCanary Text
- createCanary_code :: Lens' CreateCanary CanaryCodeInput
- createCanary_artifactS3Location :: Lens' CreateCanary Text
- createCanary_executionRoleArn :: Lens' CreateCanary Text
- createCanary_schedule :: Lens' CreateCanary CanaryScheduleInput
- createCanary_runtimeVersion :: Lens' CreateCanary Text
- createCanaryResponse_canary :: Lens' CreateCanaryResponse (Maybe Canary)
- createCanaryResponse_httpStatus :: Lens' CreateCanaryResponse Int
- createGroup_tags :: Lens' CreateGroup (Maybe (HashMap Text Text))
- createGroup_name :: Lens' CreateGroup Text
- createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group)
- createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int
- deleteCanary_deleteLambda :: Lens' DeleteCanary (Maybe Bool)
- deleteCanary_name :: Lens' DeleteCanary Text
- deleteCanaryResponse_httpStatus :: Lens' DeleteCanaryResponse Int
- deleteGroup_groupIdentifier :: Lens' DeleteGroup Text
- deleteGroupResponse_httpStatus :: Lens' DeleteGroupResponse Int
- describeCanaries_maxResults :: Lens' DescribeCanaries (Maybe Natural)
- describeCanaries_names :: Lens' DescribeCanaries (Maybe (NonEmpty Text))
- describeCanaries_nextToken :: Lens' DescribeCanaries (Maybe Text)
- describeCanariesResponse_canaries :: Lens' DescribeCanariesResponse (Maybe [Canary])
- describeCanariesResponse_nextToken :: Lens' DescribeCanariesResponse (Maybe Text)
- describeCanariesResponse_httpStatus :: Lens' DescribeCanariesResponse Int
- describeCanariesLastRun_maxResults :: Lens' DescribeCanariesLastRun (Maybe Natural)
- describeCanariesLastRun_names :: Lens' DescribeCanariesLastRun (Maybe (NonEmpty Text))
- describeCanariesLastRun_nextToken :: Lens' DescribeCanariesLastRun (Maybe Text)
- describeCanariesLastRunResponse_canariesLastRun :: Lens' DescribeCanariesLastRunResponse (Maybe [CanaryLastRun])
- describeCanariesLastRunResponse_nextToken :: Lens' DescribeCanariesLastRunResponse (Maybe Text)
- describeCanariesLastRunResponse_httpStatus :: Lens' DescribeCanariesLastRunResponse Int
- describeRuntimeVersions_maxResults :: Lens' DescribeRuntimeVersions (Maybe Natural)
- describeRuntimeVersions_nextToken :: Lens' DescribeRuntimeVersions (Maybe Text)
- describeRuntimeVersionsResponse_nextToken :: Lens' DescribeRuntimeVersionsResponse (Maybe Text)
- describeRuntimeVersionsResponse_runtimeVersions :: Lens' DescribeRuntimeVersionsResponse (Maybe [RuntimeVersion])
- describeRuntimeVersionsResponse_httpStatus :: Lens' DescribeRuntimeVersionsResponse Int
- disassociateResource_groupIdentifier :: Lens' DisassociateResource Text
- disassociateResource_resourceArn :: Lens' DisassociateResource Text
- disassociateResourceResponse_httpStatus :: Lens' DisassociateResourceResponse Int
- getCanary_name :: Lens' GetCanary Text
- getCanaryResponse_canary :: Lens' GetCanaryResponse (Maybe Canary)
- getCanaryResponse_httpStatus :: Lens' GetCanaryResponse Int
- getCanaryRuns_maxResults :: Lens' GetCanaryRuns (Maybe Natural)
- getCanaryRuns_nextToken :: Lens' GetCanaryRuns (Maybe Text)
- getCanaryRuns_name :: Lens' GetCanaryRuns Text
- getCanaryRunsResponse_canaryRuns :: Lens' GetCanaryRunsResponse (Maybe [CanaryRun])
- getCanaryRunsResponse_nextToken :: Lens' GetCanaryRunsResponse (Maybe Text)
- getCanaryRunsResponse_httpStatus :: Lens' GetCanaryRunsResponse Int
- getGroup_groupIdentifier :: Lens' GetGroup Text
- getGroupResponse_group :: Lens' GetGroupResponse (Maybe Group)
- getGroupResponse_httpStatus :: Lens' GetGroupResponse Int
- listAssociatedGroups_maxResults :: Lens' ListAssociatedGroups (Maybe Natural)
- listAssociatedGroups_nextToken :: Lens' ListAssociatedGroups (Maybe Text)
- listAssociatedGroups_resourceArn :: Lens' ListAssociatedGroups Text
- listAssociatedGroupsResponse_groups :: Lens' ListAssociatedGroupsResponse (Maybe [GroupSummary])
- listAssociatedGroupsResponse_nextToken :: Lens' ListAssociatedGroupsResponse (Maybe Text)
- listAssociatedGroupsResponse_httpStatus :: Lens' ListAssociatedGroupsResponse Int
- listGroupResources_maxResults :: Lens' ListGroupResources (Maybe Natural)
- listGroupResources_nextToken :: Lens' ListGroupResources (Maybe Text)
- listGroupResources_groupIdentifier :: Lens' ListGroupResources Text
- listGroupResourcesResponse_nextToken :: Lens' ListGroupResourcesResponse (Maybe Text)
- listGroupResourcesResponse_resources :: Lens' ListGroupResourcesResponse (Maybe [Text])
- listGroupResourcesResponse_httpStatus :: Lens' ListGroupResourcesResponse Int
- listGroups_maxResults :: Lens' ListGroups (Maybe Natural)
- listGroups_nextToken :: Lens' ListGroups (Maybe Text)
- listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupSummary])
- listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
- listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- startCanary_name :: Lens' StartCanary Text
- startCanaryResponse_httpStatus :: Lens' StartCanaryResponse Int
- stopCanary_name :: Lens' StopCanary Text
- stopCanaryResponse_httpStatus :: Lens' StopCanaryResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateCanary_artifactConfig :: Lens' UpdateCanary (Maybe ArtifactConfigInput)
- updateCanary_artifactS3Location :: Lens' UpdateCanary (Maybe Text)
- updateCanary_code :: Lens' UpdateCanary (Maybe CanaryCodeInput)
- updateCanary_executionRoleArn :: Lens' UpdateCanary (Maybe Text)
- updateCanary_failureRetentionPeriodInDays :: Lens' UpdateCanary (Maybe Natural)
- updateCanary_runConfig :: Lens' UpdateCanary (Maybe CanaryRunConfigInput)
- updateCanary_runtimeVersion :: Lens' UpdateCanary (Maybe Text)
- updateCanary_schedule :: Lens' UpdateCanary (Maybe CanaryScheduleInput)
- updateCanary_successRetentionPeriodInDays :: Lens' UpdateCanary (Maybe Natural)
- updateCanary_visualReference :: Lens' UpdateCanary (Maybe VisualReferenceInput)
- updateCanary_vpcConfig :: Lens' UpdateCanary (Maybe VpcConfigInput)
- updateCanary_name :: Lens' UpdateCanary Text
- updateCanaryResponse_httpStatus :: Lens' UpdateCanaryResponse Int
- artifactConfigInput_s3Encryption :: Lens' ArtifactConfigInput (Maybe S3EncryptionConfig)
- artifactConfigOutput_s3Encryption :: Lens' ArtifactConfigOutput (Maybe S3EncryptionConfig)
- baseScreenshot_ignoreCoordinates :: Lens' BaseScreenshot (Maybe [Text])
- baseScreenshot_screenshotName :: Lens' BaseScreenshot Text
- canary_artifactConfig :: Lens' Canary (Maybe ArtifactConfigOutput)
- canary_artifactS3Location :: Lens' Canary (Maybe Text)
- canary_code :: Lens' Canary (Maybe CanaryCodeOutput)
- canary_engineArn :: Lens' Canary (Maybe Text)
- canary_executionRoleArn :: Lens' Canary (Maybe Text)
- canary_failureRetentionPeriodInDays :: Lens' Canary (Maybe Natural)
- canary_id :: Lens' Canary (Maybe Text)
- canary_name :: Lens' Canary (Maybe Text)
- canary_runConfig :: Lens' Canary (Maybe CanaryRunConfigOutput)
- canary_runtimeVersion :: Lens' Canary (Maybe Text)
- canary_schedule :: Lens' Canary (Maybe CanaryScheduleOutput)
- canary_status :: Lens' Canary (Maybe CanaryStatus)
- canary_successRetentionPeriodInDays :: Lens' Canary (Maybe Natural)
- canary_tags :: Lens' Canary (Maybe (HashMap Text Text))
- canary_timeline :: Lens' Canary (Maybe CanaryTimeline)
- canary_visualReference :: Lens' Canary (Maybe VisualReferenceOutput)
- canary_vpcConfig :: Lens' Canary (Maybe VpcConfigOutput)
- canaryCodeInput_s3Bucket :: Lens' CanaryCodeInput (Maybe Text)
- canaryCodeInput_s3Key :: Lens' CanaryCodeInput (Maybe Text)
- canaryCodeInput_s3Version :: Lens' CanaryCodeInput (Maybe Text)
- canaryCodeInput_zipFile :: Lens' CanaryCodeInput (Maybe ByteString)
- canaryCodeInput_handler :: Lens' CanaryCodeInput Text
- canaryCodeOutput_handler :: Lens' CanaryCodeOutput (Maybe Text)
- canaryCodeOutput_sourceLocationArn :: Lens' CanaryCodeOutput (Maybe Text)
- canaryLastRun_canaryName :: Lens' CanaryLastRun (Maybe Text)
- canaryLastRun_lastRun :: Lens' CanaryLastRun (Maybe CanaryRun)
- canaryRun_artifactS3Location :: Lens' CanaryRun (Maybe Text)
- canaryRun_id :: Lens' CanaryRun (Maybe Text)
- canaryRun_name :: Lens' CanaryRun (Maybe Text)
- canaryRun_status :: Lens' CanaryRun (Maybe CanaryRunStatus)
- canaryRun_timeline :: Lens' CanaryRun (Maybe CanaryRunTimeline)
- canaryRunConfigInput_activeTracing :: Lens' CanaryRunConfigInput (Maybe Bool)
- canaryRunConfigInput_environmentVariables :: Lens' CanaryRunConfigInput (Maybe (HashMap Text Text))
- canaryRunConfigInput_memoryInMB :: Lens' CanaryRunConfigInput (Maybe Natural)
- canaryRunConfigInput_timeoutInSeconds :: Lens' CanaryRunConfigInput (Maybe Natural)
- canaryRunConfigOutput_activeTracing :: Lens' CanaryRunConfigOutput (Maybe Bool)
- canaryRunConfigOutput_memoryInMB :: Lens' CanaryRunConfigOutput (Maybe Natural)
- canaryRunConfigOutput_timeoutInSeconds :: Lens' CanaryRunConfigOutput (Maybe Natural)
- canaryRunStatus_state :: Lens' CanaryRunStatus (Maybe CanaryRunState)
- canaryRunStatus_stateReason :: Lens' CanaryRunStatus (Maybe Text)
- canaryRunStatus_stateReasonCode :: Lens' CanaryRunStatus (Maybe CanaryRunStateReasonCode)
- canaryRunTimeline_completed :: Lens' CanaryRunTimeline (Maybe UTCTime)
- canaryRunTimeline_started :: Lens' CanaryRunTimeline (Maybe UTCTime)
- canaryScheduleInput_durationInSeconds :: Lens' CanaryScheduleInput (Maybe Natural)
- canaryScheduleInput_expression :: Lens' CanaryScheduleInput Text
- canaryScheduleOutput_durationInSeconds :: Lens' CanaryScheduleOutput (Maybe Natural)
- canaryScheduleOutput_expression :: Lens' CanaryScheduleOutput (Maybe Text)
- canaryStatus_state :: Lens' CanaryStatus (Maybe CanaryState)
- canaryStatus_stateReason :: Lens' CanaryStatus (Maybe Text)
- canaryStatus_stateReasonCode :: Lens' CanaryStatus (Maybe CanaryStateReasonCode)
- canaryTimeline_created :: Lens' CanaryTimeline (Maybe UTCTime)
- canaryTimeline_lastModified :: Lens' CanaryTimeline (Maybe UTCTime)
- canaryTimeline_lastStarted :: Lens' CanaryTimeline (Maybe UTCTime)
- canaryTimeline_lastStopped :: Lens' CanaryTimeline (Maybe UTCTime)
- group_arn :: Lens' Group (Maybe Text)
- group_createdTime :: Lens' Group (Maybe UTCTime)
- group_id :: Lens' Group (Maybe Text)
- group_lastModifiedTime :: Lens' Group (Maybe UTCTime)
- group_name :: Lens' Group (Maybe Text)
- group_tags :: Lens' Group (Maybe (HashMap Text Text))
- groupSummary_arn :: Lens' GroupSummary (Maybe Text)
- groupSummary_id :: Lens' GroupSummary (Maybe Text)
- groupSummary_name :: Lens' GroupSummary (Maybe Text)
- runtimeVersion_deprecationDate :: Lens' RuntimeVersion (Maybe UTCTime)
- runtimeVersion_description :: Lens' RuntimeVersion (Maybe Text)
- runtimeVersion_releaseDate :: Lens' RuntimeVersion (Maybe UTCTime)
- runtimeVersion_versionName :: Lens' RuntimeVersion (Maybe Text)
- s3EncryptionConfig_encryptionMode :: Lens' S3EncryptionConfig (Maybe EncryptionMode)
- s3EncryptionConfig_kmsKeyArn :: Lens' S3EncryptionConfig (Maybe Text)
- visualReferenceInput_baseScreenshots :: Lens' VisualReferenceInput (Maybe [BaseScreenshot])
- visualReferenceInput_baseCanaryRunId :: Lens' VisualReferenceInput Text
- visualReferenceOutput_baseCanaryRunId :: Lens' VisualReferenceOutput (Maybe Text)
- visualReferenceOutput_baseScreenshots :: Lens' VisualReferenceOutput (Maybe [BaseScreenshot])
- vpcConfigInput_securityGroupIds :: Lens' VpcConfigInput (Maybe [Text])
- vpcConfigInput_subnetIds :: Lens' VpcConfigInput (Maybe [Text])
- vpcConfigOutput_securityGroupIds :: Lens' VpcConfigOutput (Maybe [Text])
- vpcConfigOutput_subnetIds :: Lens' VpcConfigOutput (Maybe [Text])
- vpcConfigOutput_vpcId :: Lens' VpcConfigOutput (Maybe Text)
Operations
AssociateResource
associateResource_groupIdentifier :: Lens' AssociateResource Text Source #
Specifies the group. You can specify the group name, the ARN, or the
group ID as the GroupIdentifier
.
associateResource_resourceArn :: Lens' AssociateResource Text Source #
The ARN of the canary that you want to associate with the specified group.
associateResourceResponse_httpStatus :: Lens' AssociateResourceResponse Int Source #
The response's http status code.
CreateCanary
createCanary_artifactConfig :: Lens' CreateCanary (Maybe ArtifactConfigInput) Source #
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
createCanary_failureRetentionPeriodInDays :: Lens' CreateCanary (Maybe Natural) Source #
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.
createCanary_runConfig :: Lens' CreateCanary (Maybe CanaryRunConfigInput) Source #
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
createCanary_successRetentionPeriodInDays :: Lens' CreateCanary (Maybe Natural) Source #
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.
createCanary_tags :: Lens' CreateCanary (Maybe (HashMap Text Text)) Source #
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.
createCanary_vpcConfig :: Lens' CreateCanary (Maybe VpcConfigInput) Source #
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.
createCanary_name :: Lens' CreateCanary Text Source #
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.
createCanary_code :: Lens' CreateCanary CanaryCodeInput Source #
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.
createCanary_artifactS3Location :: Lens' CreateCanary Text Source #
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 (.).
createCanary_executionRoleArn :: Lens' CreateCanary Text Source #
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
createCanary_schedule :: Lens' CreateCanary CanaryScheduleInput Source #
A structure that contains information about how often the canary is to run and when these test runs are to stop.
createCanary_runtimeVersion :: Lens' CreateCanary Text Source #
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.
createCanaryResponse_canary :: Lens' CreateCanaryResponse (Maybe Canary) Source #
The full details about the canary you have created.
createCanaryResponse_httpStatus :: Lens' CreateCanaryResponse Int Source #
The response's http status code.
CreateGroup
createGroup_tags :: Lens' CreateGroup (Maybe (HashMap Text Text)) Source #
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 permissions, by granting a user permission to access or change only the resources that have certain tag values.
createGroup_name :: Lens' CreateGroup Text Source #
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.
createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group) Source #
A structure that contains information about the group that was just created.
createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int Source #
The response's http status code.
DeleteCanary
deleteCanary_deleteLambda :: Lens' DeleteCanary (Maybe Bool) Source #
Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.
Type: Boolean
deleteCanary_name :: Lens' DeleteCanary Text Source #
The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.
deleteCanaryResponse_httpStatus :: Lens' DeleteCanaryResponse Int Source #
The response's http status code.
DeleteGroup
deleteGroup_groupIdentifier :: Lens' DeleteGroup Text Source #
Specifies which group to delete. You can specify the group name, the
ARN, or the group ID as the GroupIdentifier
.
deleteGroupResponse_httpStatus :: Lens' DeleteGroupResponse Int Source #
The response's http status code.
DescribeCanaries
describeCanaries_maxResults :: Lens' DescribeCanaries (Maybe Natural) Source #
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.
describeCanaries_names :: Lens' DescribeCanaries (Maybe (NonEmpty Text)) Source #
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 you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.
You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.
describeCanaries_nextToken :: Lens' DescribeCanaries (Maybe Text) Source #
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.
describeCanariesResponse_canaries :: Lens' DescribeCanariesResponse (Maybe [Canary]) Source #
Returns an array. Each item in the array contains the full information about one canary.
describeCanariesResponse_nextToken :: Lens' DescribeCanariesResponse (Maybe Text) Source #
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.
describeCanariesResponse_httpStatus :: Lens' DescribeCanariesResponse Int Source #
The response's http status code.
DescribeCanariesLastRun
describeCanariesLastRun_maxResults :: Lens' DescribeCanariesLastRun (Maybe Natural) Source #
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.
describeCanariesLastRun_names :: Lens' DescribeCanariesLastRun (Maybe (NonEmpty Text)) Source #
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 you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.
You are required to use the Names
parameter if you are logged on to a
user or role that has an IAM policy that restricts which canaries that
you are allowed to view. For more information, see
Limiting a user to viewing specific canaries.
describeCanariesLastRun_nextToken :: Lens' DescribeCanariesLastRun (Maybe Text) Source #
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.
describeCanariesLastRunResponse_canariesLastRun :: Lens' DescribeCanariesLastRunResponse (Maybe [CanaryLastRun]) Source #
An array that contains the information from the most recent run of each canary.
describeCanariesLastRunResponse_nextToken :: Lens' DescribeCanariesLastRunResponse (Maybe Text) Source #
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.
describeCanariesLastRunResponse_httpStatus :: Lens' DescribeCanariesLastRunResponse Int Source #
The response's http status code.
DescribeRuntimeVersions
describeRuntimeVersions_maxResults :: Lens' DescribeRuntimeVersions (Maybe Natural) Source #
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.
describeRuntimeVersions_nextToken :: Lens' DescribeRuntimeVersions (Maybe Text) Source #
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.
describeRuntimeVersionsResponse_nextToken :: Lens' DescribeRuntimeVersionsResponse (Maybe Text) Source #
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.
describeRuntimeVersionsResponse_runtimeVersions :: Lens' DescribeRuntimeVersionsResponse (Maybe [RuntimeVersion]) Source #
An array of objects that display the details about each Synthetics canary runtime version.
describeRuntimeVersionsResponse_httpStatus :: Lens' DescribeRuntimeVersionsResponse Int Source #
The response's http status code.
DisassociateResource
disassociateResource_groupIdentifier :: Lens' DisassociateResource Text Source #
Specifies the group. You can specify the group name, the ARN, or the
group ID as the GroupIdentifier
.
disassociateResource_resourceArn :: Lens' DisassociateResource Text Source #
The ARN of the canary that you want to remove from the specified group.
disassociateResourceResponse_httpStatus :: Lens' DisassociateResourceResponse Int Source #
The response's http status code.
GetCanary
getCanaryResponse_canary :: Lens' GetCanaryResponse (Maybe Canary) Source #
A structure that contains the full information about the canary.
getCanaryResponse_httpStatus :: Lens' GetCanaryResponse Int Source #
The response's http status code.
GetCanaryRuns
getCanaryRuns_maxResults :: Lens' GetCanaryRuns (Maybe Natural) Source #
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.
getCanaryRuns_nextToken :: Lens' GetCanaryRuns (Maybe Text) Source #
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.
getCanaryRuns_name :: Lens' GetCanaryRuns Text Source #
The name of the canary that you want to see runs for.
getCanaryRunsResponse_canaryRuns :: Lens' GetCanaryRunsResponse (Maybe [CanaryRun]) Source #
An array of structures. Each structure contains the details of one of the retrieved canary runs.
getCanaryRunsResponse_nextToken :: Lens' GetCanaryRunsResponse (Maybe Text) Source #
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.
getCanaryRunsResponse_httpStatus :: Lens' GetCanaryRunsResponse Int Source #
The response's http status code.
GetGroup
getGroup_groupIdentifier :: Lens' GetGroup Text Source #
Specifies the group to return information for. You can specify the group
name, the ARN, or the group ID as the GroupIdentifier
.
getGroupResponse_group :: Lens' GetGroupResponse (Maybe Group) Source #
A structure that contains information about the group.
getGroupResponse_httpStatus :: Lens' GetGroupResponse Int Source #
The response's http status code.
ListAssociatedGroups
listAssociatedGroups_maxResults :: Lens' ListAssociatedGroups (Maybe Natural) Source #
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.
listAssociatedGroups_nextToken :: Lens' ListAssociatedGroups (Maybe Text) Source #
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.
listAssociatedGroups_resourceArn :: Lens' ListAssociatedGroups Text Source #
The ARN of the canary that you want to view groups for.
listAssociatedGroupsResponse_groups :: Lens' ListAssociatedGroupsResponse (Maybe [GroupSummary]) Source #
An array of structures that contain information about the groups that this canary is associated with.
listAssociatedGroupsResponse_nextToken :: Lens' ListAssociatedGroupsResponse (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent ListAssociatedGroups
operation to retrieve
the next set of results.
listAssociatedGroupsResponse_httpStatus :: Lens' ListAssociatedGroupsResponse Int Source #
The response's http status code.
ListGroupResources
listGroupResources_maxResults :: Lens' ListGroupResources (Maybe Natural) Source #
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.
listGroupResources_nextToken :: Lens' ListGroupResources (Maybe Text) Source #
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.
listGroupResources_groupIdentifier :: Lens' ListGroupResources Text Source #
Specifies the group to return information for. You can specify the group
name, the ARN, or the group ID as the GroupIdentifier
.
listGroupResourcesResponse_nextToken :: Lens' ListGroupResourcesResponse (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent ListGroupResources
operation to retrieve
the next set of results.
listGroupResourcesResponse_resources :: Lens' ListGroupResourcesResponse (Maybe [Text]) Source #
An array of ARNs. These ARNs are for the canaries that are associated with the group.
listGroupResourcesResponse_httpStatus :: Lens' ListGroupResourcesResponse Int Source #
The response's http status code.
ListGroups
listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #
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.
listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #
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.
listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupSummary]) Source #
An array of structures that each contain information about one group.
listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent ListGroups
operation to retrieve the next
set of results.
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
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:
Region
:
account-id
:group:
group-name
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with the resource that you specified.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
StartCanary
startCanary_name :: Lens' StartCanary Text Source #
The name of the canary that you want to run. To find canary names, use DescribeCanaries.
startCanaryResponse_httpStatus :: Lens' StartCanaryResponse Int Source #
The response's http status code.
StopCanary
stopCanary_name :: Lens' StopCanary Text Source #
The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.
stopCanaryResponse_httpStatus :: Lens' StopCanaryResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
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:
Region
:
account-id
:group:
group-name
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The list of key-value pairs to associate with the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
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:
Region
:
account-id
:group:
group-name
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The list of tag keys to remove from the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateCanary
updateCanary_artifactConfig :: Lens' UpdateCanary (Maybe ArtifactConfigInput) Source #
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
updateCanary_artifactS3Location :: Lens' UpdateCanary (Maybe Text) Source #
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 (.).
updateCanary_code :: Lens' UpdateCanary (Maybe CanaryCodeInput) Source #
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.
updateCanary_executionRoleArn :: Lens' UpdateCanary (Maybe Text) Source #
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
updateCanary_failureRetentionPeriodInDays :: Lens' UpdateCanary (Maybe Natural) Source #
The number of days to retain data about failed runs of this canary.
updateCanary_runConfig :: Lens' UpdateCanary (Maybe CanaryRunConfigInput) Source #
A structure that contains the timeout value that is used for each individual run of the canary.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
updateCanary_runtimeVersion :: Lens' UpdateCanary (Maybe Text) Source #
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.
updateCanary_schedule :: Lens' UpdateCanary (Maybe CanaryScheduleInput) Source #
A structure that contains information about how often the canary is to run, and when these runs are to stop.
updateCanary_successRetentionPeriodInDays :: Lens' UpdateCanary (Maybe Natural) Source #
The number of days to retain data about successful runs of this canary.
updateCanary_visualReference :: Lens' UpdateCanary (Maybe VisualReferenceInput) Source #
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
updateCanary_vpcConfig :: Lens' UpdateCanary (Maybe VpcConfigInput) Source #
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.
updateCanary_name :: Lens' UpdateCanary Text Source #
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.
updateCanaryResponse_httpStatus :: Lens' UpdateCanaryResponse Int Source #
The response's http status code.
Types
ArtifactConfigInput
artifactConfigInput_s3Encryption :: Lens' ArtifactConfigInput (Maybe S3EncryptionConfig) Source #
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
ArtifactConfigOutput
artifactConfigOutput_s3Encryption :: Lens' ArtifactConfigOutput (Maybe S3EncryptionConfig) Source #
A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.
BaseScreenshot
baseScreenshot_ignoreCoordinates :: Lens' BaseScreenshot (Maybe [Text]) Source #
Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary
baseScreenshot_screenshotName :: Lens' BaseScreenshot Text Source #
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.
Canary
canary_artifactConfig :: Lens' Canary (Maybe ArtifactConfigOutput) Source #
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
canary_artifactS3Location :: Lens' Canary (Maybe Text) Source #
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
canary_code :: Lens' Canary (Maybe CanaryCodeOutput) Source #
Undocumented member.
canary_engineArn :: Lens' Canary (Maybe Text) Source #
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.
canary_executionRoleArn :: Lens' Canary (Maybe Text) Source #
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.
canary_failureRetentionPeriodInDays :: Lens' Canary (Maybe Natural) Source #
The number of days to retain data about failed runs of this canary.
canary_runConfig :: Lens' Canary (Maybe CanaryRunConfigOutput) Source #
Undocumented member.
canary_runtimeVersion :: Lens' Canary (Maybe Text) Source #
Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
canary_schedule :: Lens' Canary (Maybe CanaryScheduleOutput) Source #
A structure that contains information about how often the canary is to run, and when these runs are to stop.
canary_status :: Lens' Canary (Maybe CanaryStatus) Source #
A structure that contains information about the canary's status.
canary_successRetentionPeriodInDays :: Lens' Canary (Maybe Natural) Source #
The number of days to retain data about successful runs of this canary.
canary_tags :: Lens' Canary (Maybe (HashMap Text Text)) Source #
The list of key-value pairs that are associated with the canary.
canary_timeline :: Lens' Canary (Maybe CanaryTimeline) Source #
A structure that contains information about when the canary was created, modified, and most recently run.
canary_visualReference :: Lens' Canary (Maybe VisualReferenceOutput) Source #
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.
canary_vpcConfig :: Lens' Canary (Maybe VpcConfigOutput) Source #
Undocumented member.
CanaryCodeInput
canaryCodeInput_s3Bucket :: Lens' CanaryCodeInput (Maybe Text) Source #
If your canary script is located in S3, specify the bucket name here. Do
not include s3://
as the start of the bucket name.
canaryCodeInput_s3Key :: Lens' CanaryCodeInput (Maybe Text) Source #
The S3 key of your script. For more information, see Working with Amazon S3 Objects.
canaryCodeInput_s3Version :: Lens' CanaryCodeInput (Maybe Text) Source #
The S3 version ID of your script.
canaryCodeInput_zipFile :: Lens' CanaryCodeInput (Maybe ByteString) Source #
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 225 Kb.
For large canary scripts, we recommend that you use an S3 location
instead of inputting it directly with this parameter.--
-- 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.
canaryCodeInput_handler :: Lens' CanaryCodeInput Text Source #
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
,
the handler must be specified as
fileName
.handler
. For
syn-python-selenium-1.1
, syn-nodejs.puppeteer-3.4
, and later
runtimes, the handler can be specified as
fileName
.
functionName
, or you can specify a folder where
canary scripts reside as
folder
/
fileName
.
functionName
.
CanaryCodeOutput
canaryCodeOutput_handler :: Lens' CanaryCodeOutput (Maybe Text) Source #
The entry point to use for the source code when running the canary.
canaryCodeOutput_sourceLocationArn :: Lens' CanaryCodeOutput (Maybe Text) Source #
The ARN of the Lambda layer where Synthetics stores the canary script code.
CanaryLastRun
canaryLastRun_canaryName :: Lens' CanaryLastRun (Maybe Text) Source #
The name of the canary.
canaryLastRun_lastRun :: Lens' CanaryLastRun (Maybe CanaryRun) Source #
The results from this canary's most recent run.
CanaryRun
canaryRun_artifactS3Location :: Lens' CanaryRun (Maybe Text) Source #
The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.
canaryRun_status :: Lens' CanaryRun (Maybe CanaryRunStatus) Source #
The status of this run.
canaryRun_timeline :: Lens' CanaryRun (Maybe CanaryRunTimeline) Source #
A structure that contains the start and end times of this run.
CanaryRunConfigInput
canaryRunConfigInput_activeTracing :: Lens' CanaryRunConfigInput (Maybe Bool) Source #
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.
canaryRunConfigInput_environmentVariables :: Lens' CanaryRunConfigInput (Maybe (HashMap Text Text)) Source #
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.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
canaryRunConfigInput_memoryInMB :: Lens' CanaryRunConfigInput (Maybe Natural) Source #
The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
canaryRunConfigInput_timeoutInSeconds :: Lens' CanaryRunConfigInput (Maybe Natural) Source #
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.
CanaryRunConfigOutput
canaryRunConfigOutput_activeTracing :: Lens' CanaryRunConfigOutput (Maybe Bool) Source #
Displays whether this canary run used active X-Ray tracing.
canaryRunConfigOutput_memoryInMB :: Lens' CanaryRunConfigOutput (Maybe Natural) Source #
The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
canaryRunConfigOutput_timeoutInSeconds :: Lens' CanaryRunConfigOutput (Maybe Natural) Source #
How long the canary is allowed to run before it must stop.
CanaryRunStatus
canaryRunStatus_state :: Lens' CanaryRunStatus (Maybe CanaryRunState) Source #
The current state of the run.
canaryRunStatus_stateReason :: Lens' CanaryRunStatus (Maybe Text) Source #
If run of the canary failed, this field contains the reason for the error.
canaryRunStatus_stateReasonCode :: Lens' CanaryRunStatus (Maybe CanaryRunStateReasonCode) Source #
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.
CanaryRunTimeline
canaryRunTimeline_completed :: Lens' CanaryRunTimeline (Maybe UTCTime) Source #
The end time of the run.
canaryRunTimeline_started :: Lens' CanaryRunTimeline (Maybe UTCTime) Source #
The start time of the run.
CanaryScheduleInput
canaryScheduleInput_durationInSeconds :: Lens' CanaryScheduleInput (Maybe Natural) Source #
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.
canaryScheduleInput_expression :: Lens' CanaryScheduleInput Text Source #
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.
CanaryScheduleOutput
canaryScheduleOutput_durationInSeconds :: Lens' CanaryScheduleOutput (Maybe Natural) Source #
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.
canaryScheduleOutput_expression :: Lens' CanaryScheduleOutput (Maybe Text) Source #
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.
CanaryStatus
canaryStatus_state :: Lens' CanaryStatus (Maybe CanaryState) Source #
The current state of the canary.
canaryStatus_stateReason :: Lens' CanaryStatus (Maybe Text) Source #
If the canary has insufficient permissions to run, this field provides more details.
canaryStatus_stateReasonCode :: Lens' CanaryStatus (Maybe CanaryStateReasonCode) Source #
If the canary cannot run or has failed, this field displays the reason.
CanaryTimeline
canaryTimeline_created :: Lens' CanaryTimeline (Maybe UTCTime) Source #
The date and time the canary was created.
canaryTimeline_lastModified :: Lens' CanaryTimeline (Maybe UTCTime) Source #
The date and time the canary was most recently modified.
canaryTimeline_lastStarted :: Lens' CanaryTimeline (Maybe UTCTime) Source #
The date and time that the canary's most recent run started.
canaryTimeline_lastStopped :: Lens' CanaryTimeline (Maybe UTCTime) Source #
The date and time that the canary's most recent run ended.
Group
group_createdTime :: Lens' Group (Maybe UTCTime) Source #
The date and time that the group was created.
group_lastModifiedTime :: Lens' Group (Maybe UTCTime) Source #
The date and time that the group was most recently updated.
group_tags :: Lens' Group (Maybe (HashMap Text Text)) Source #
The list of key-value pairs that are associated with the canary.
GroupSummary
groupSummary_arn :: Lens' GroupSummary (Maybe Text) Source #
The ARN of the group.
groupSummary_id :: Lens' GroupSummary (Maybe Text) Source #
The unique ID of the group.
groupSummary_name :: Lens' GroupSummary (Maybe Text) Source #
The name of the group.
RuntimeVersion
runtimeVersion_deprecationDate :: Lens' RuntimeVersion (Maybe UTCTime) Source #
If this runtime version is deprecated, this value is the date of deprecation.
runtimeVersion_description :: Lens' RuntimeVersion (Maybe Text) Source #
A description of the runtime version, created by Amazon.
runtimeVersion_releaseDate :: Lens' RuntimeVersion (Maybe UTCTime) Source #
The date that the runtime version was released.
runtimeVersion_versionName :: Lens' RuntimeVersion (Maybe Text) Source #
The name of the runtime version. For a list of valid runtime versions, see Canary Runtime Versions.
S3EncryptionConfig
s3EncryptionConfig_encryptionMode :: Lens' S3EncryptionConfig (Maybe EncryptionMode) Source #
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.
s3EncryptionConfig_kmsKeyArn :: Lens' S3EncryptionConfig (Maybe Text) Source #
The ARN of the customer-managed KMS key to use, if you specify SSE-KMS
for EncryptionMode
VisualReferenceInput
visualReferenceInput_baseScreenshots :: Lens' VisualReferenceInput (Maybe [BaseScreenshot]) Source #
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.
visualReferenceInput_baseCanaryRunId :: Lens' VisualReferenceInput Text Source #
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.
VisualReferenceOutput
visualReferenceOutput_baseCanaryRunId :: Lens' VisualReferenceOutput (Maybe Text) Source #
The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
visualReferenceOutput_baseScreenshots :: Lens' VisualReferenceOutput (Maybe [BaseScreenshot]) Source #
An array of screenshots that are used as the baseline for comparisons during visual monitoring.
VpcConfigInput
vpcConfigInput_securityGroupIds :: Lens' VpcConfigInput (Maybe [Text]) Source #
The IDs of the security groups for this canary.
vpcConfigInput_subnetIds :: Lens' VpcConfigInput (Maybe [Text]) Source #
The IDs of the subnets where this canary is to run.
VpcConfigOutput
vpcConfigOutput_securityGroupIds :: Lens' VpcConfigOutput (Maybe [Text]) Source #
The IDs of the security groups for this canary.
vpcConfigOutput_subnetIds :: Lens' VpcConfigOutput (Maybe [Text]) Source #
The IDs of the subnets where this canary is to run.
vpcConfigOutput_vpcId :: Lens' VpcConfigOutput (Maybe Text) Source #
The IDs of the VPC where this canary is to run.