Interface SyntheticsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide.
Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateResourceResponse
associateResource
(Consumer<AssociateResourceRequest.Builder> associateResourceRequest) Associates a canary with a group.default AssociateResourceResponse
associateResource
(AssociateResourceRequest associateResourceRequest) Associates a canary with a group.static SyntheticsClientBuilder
builder()
Create a builder that can be used to configure and create aSyntheticsClient
.static SyntheticsClient
create()
Create aSyntheticsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateCanaryResponse
createCanary
(Consumer<CreateCanaryRequest.Builder> createCanaryRequest) Creates a canary.default CreateCanaryResponse
createCanary
(CreateCanaryRequest createCanaryRequest) Creates a canary.default CreateGroupResponse
createGroup
(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates a group which you can use to associate canaries with each other, including cross-Region canaries.default CreateGroupResponse
createGroup
(CreateGroupRequest createGroupRequest) Creates a group which you can use to associate canaries with each other, including cross-Region canaries.default DeleteCanaryResponse
deleteCanary
(Consumer<DeleteCanaryRequest.Builder> deleteCanaryRequest) Permanently deletes the specified canary.default DeleteCanaryResponse
deleteCanary
(DeleteCanaryRequest deleteCanaryRequest) Permanently deletes the specified canary.default DeleteGroupResponse
deleteGroup
(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Deletes a group.default DeleteGroupResponse
deleteGroup
(DeleteGroupRequest deleteGroupRequest) Deletes a group.default DescribeCanariesResponse
describeCanaries
(Consumer<DescribeCanariesRequest.Builder> describeCanariesRequest) This operation returns a list of the canaries in your account, along with full details about each canary.default DescribeCanariesResponse
describeCanaries
(DescribeCanariesRequest describeCanariesRequest) This operation returns a list of the canaries in your account, along with full details about each canary.default DescribeCanariesLastRunResponse
describeCanariesLastRun
(Consumer<DescribeCanariesLastRunRequest.Builder> describeCanariesLastRunRequest) Use this operation to see information from the most recent run of each canary that you have created.default DescribeCanariesLastRunResponse
describeCanariesLastRun
(DescribeCanariesLastRunRequest describeCanariesLastRunRequest) Use this operation to see information from the most recent run of each canary that you have created.default DescribeCanariesLastRunIterable
describeCanariesLastRunPaginator
(Consumer<DescribeCanariesLastRunRequest.Builder> describeCanariesLastRunRequest) This is a variant ofdescribeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation.default DescribeCanariesLastRunIterable
describeCanariesLastRunPaginator
(DescribeCanariesLastRunRequest describeCanariesLastRunRequest) This is a variant ofdescribeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation.default DescribeCanariesIterable
describeCanariesPaginator
(Consumer<DescribeCanariesRequest.Builder> describeCanariesRequest) This is a variant ofdescribeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest)
operation.default DescribeCanariesIterable
describeCanariesPaginator
(DescribeCanariesRequest describeCanariesRequest) This is a variant ofdescribeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest)
operation.default DescribeRuntimeVersionsResponse
describeRuntimeVersions
(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest) Returns a list of Synthetics canary runtime versions.default DescribeRuntimeVersionsResponse
describeRuntimeVersions
(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest) Returns a list of Synthetics canary runtime versions.default DescribeRuntimeVersionsIterable
describeRuntimeVersionsPaginator
(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest) This is a variant ofdescribeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation.default DescribeRuntimeVersionsIterable
describeRuntimeVersionsPaginator
(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest) This is a variant ofdescribeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation.default DisassociateResourceResponse
disassociateResource
(Consumer<DisassociateResourceRequest.Builder> disassociateResourceRequest) Removes a canary from a group.default DisassociateResourceResponse
disassociateResource
(DisassociateResourceRequest disassociateResourceRequest) Removes a canary from a group.default GetCanaryResponse
getCanary
(Consumer<GetCanaryRequest.Builder> getCanaryRequest) Retrieves complete information about one canary.default GetCanaryResponse
getCanary
(GetCanaryRequest getCanaryRequest) Retrieves complete information about one canary.default GetCanaryRunsResponse
getCanaryRuns
(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest) Retrieves a list of runs for a specified canary.default GetCanaryRunsResponse
getCanaryRuns
(GetCanaryRunsRequest getCanaryRunsRequest) Retrieves a list of runs for a specified canary.default GetCanaryRunsIterable
getCanaryRunsPaginator
(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest) This is a variant ofgetCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest)
operation.default GetCanaryRunsIterable
getCanaryRunsPaginator
(GetCanaryRunsRequest getCanaryRunsRequest) This is a variant ofgetCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest)
operation.default GetGroupResponse
getGroup
(Consumer<GetGroupRequest.Builder> getGroupRequest) Returns information about one group.default GetGroupResponse
getGroup
(GetGroupRequest getGroupRequest) Returns information about one group.default ListAssociatedGroupsResponse
listAssociatedGroups
(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest) Returns a list of the groups that the specified canary is associated with.default ListAssociatedGroupsResponse
listAssociatedGroups
(ListAssociatedGroupsRequest listAssociatedGroupsRequest) Returns a list of the groups that the specified canary is associated with.default ListAssociatedGroupsIterable
listAssociatedGroupsPaginator
(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest) This is a variant oflistAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation.default ListAssociatedGroupsIterable
listAssociatedGroupsPaginator
(ListAssociatedGroupsRequest listAssociatedGroupsRequest) This is a variant oflistAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation.default ListGroupResourcesResponse
listGroupResources
(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest) This operation returns a list of the ARNs of the canaries that are associated with the specified group.default ListGroupResourcesResponse
listGroupResources
(ListGroupResourcesRequest listGroupResourcesRequest) This operation returns a list of the ARNs of the canaries that are associated with the specified group.default ListGroupResourcesIterable
listGroupResourcesPaginator
(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest) This is a variant oflistGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation.default ListGroupResourcesIterable
listGroupResourcesPaginator
(ListGroupResourcesRequest listGroupResourcesRequest) This is a variant oflistGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation.default ListGroupsResponse
listGroups
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.default ListGroupsResponse
listGroups
(ListGroupsRequest listGroupsRequest) Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.default ListGroupsIterable
listGroupsPaginator
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation.default ListGroupsIterable
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Displays the tags associated with a canary or group.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with a canary or group.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartCanaryResponse
startCanary
(Consumer<StartCanaryRequest.Builder> startCanaryRequest) Use this operation to run a canary that has already been created.default StartCanaryResponse
startCanary
(StartCanaryRequest startCanaryRequest) Use this operation to run a canary that has already been created.default StopCanaryResponse
stopCanary
(Consumer<StopCanaryRequest.Builder> stopCanaryRequest) Stops the canary to prevent all future runs.default StopCanaryResponse
stopCanary
(StopCanaryRequest stopCanaryRequest) Stops the canary to prevent all future runs.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified canary or group.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified canary or group.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.default UpdateCanaryResponse
updateCanary
(Consumer<UpdateCanaryRequest.Builder> updateCanaryRequest) Updates the configuration of a canary that has already been created.default UpdateCanaryResponse
updateCanary
(UpdateCanaryRequest updateCanaryRequest) Updates the configuration of a canary that has already been created.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateResource
default AssociateResourceResponse associateResource(AssociateResourceRequest associateResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SyntheticsException Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.
You must run this operation in the Region where the canary exists.
- Parameters:
associateResourceRequest
-- Returns:
- Result of the AssociateResource operation returned by the service.
- See Also:
-
associateResource
default AssociateResourceResponse associateResource(Consumer<AssociateResourceRequest.Builder> associateResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SyntheticsException Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.
You must run this operation in the Region where the canary exists.
This is a convenience which creates an instance of the
AssociateResourceRequest.Builder
avoiding the need to create one manually viaAssociateResourceRequest.builder()
- Parameters:
associateResourceRequest
- AConsumer
that will call methods onAssociateResourceRequest.Builder
to create a request.- Returns:
- Result of the AssociateResource operation returned by the service.
- See Also:
-
createCanary
default CreateCanaryResponse createCanary(CreateCanaryRequest createCanaryRequest) throws InternalServerException, ValidationException, RequestEntityTooLargeException, AwsServiceException, SdkClientException, SyntheticsException Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.
Do not use
CreateCanary
to modify an existing canary. Use UpdateCanary instead.To create canaries, you must have the
CloudWatchSyntheticsFullAccess
policy. If you are creating a new IAM role for the canary, you also need theiam:CreateRole
,iam:CreatePolicy
andiam:AttachRolePolicy
permissions. For more information, see Necessary Roles and Permissions.Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
- Parameters:
createCanaryRequest
-- Returns:
- Result of the CreateCanary operation returned by the service.
- See Also:
-
createCanary
default CreateCanaryResponse createCanary(Consumer<CreateCanaryRequest.Builder> createCanaryRequest) throws InternalServerException, ValidationException, RequestEntityTooLargeException, AwsServiceException, SdkClientException, SyntheticsException Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.
Do not use
CreateCanary
to modify an existing canary. Use UpdateCanary instead.To create canaries, you must have the
CloudWatchSyntheticsFullAccess
policy. If you are creating a new IAM role for the canary, you also need theiam:CreateRole
,iam:CreatePolicy
andiam:AttachRolePolicy
permissions. For more information, see Necessary Roles and Permissions.Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
This is a convenience which creates an instance of the
CreateCanaryRequest.Builder
avoiding the need to create one manually viaCreateCanaryRequest.builder()
- Parameters:
createCanaryRequest
- AConsumer
that will call methods onCreateCanaryRequest.Builder
to create a request.- Returns:
- Result of the CreateCanary operation returned by the service.
- See Also:
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws InternalServerException, ValidationException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SyntheticsException Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.
Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.
Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region.
Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.
- Parameters:
createGroupRequest
-- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
createGroup
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws InternalServerException, ValidationException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SyntheticsException Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.
Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.
Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region.
Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.
This is a convenience which creates an instance of the
CreateGroupRequest.Builder
avoiding the need to create one manually viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
deleteCanary
default DeleteCanaryResponse deleteCanary(DeleteCanaryRequest deleteCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Permanently deletes the specified canary.
If you specify
DeleteLambda
totrue
, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:
-
The CloudWatch alarms created for this canary. These alarms have a name of
Synthetics-SharpDrop-Alarm-MyCanaryName
. -
Amazon S3 objects and buckets, such as the canary's artifact location.
-
IAM roles created for the canary. If they were created in the console, these roles have the name
role/service-role/CloudWatchSyntheticsRole-MyCanaryName
. -
CloudWatch Logs log groups created for the canary. These logs groups have the name
/aws/lambda/cwsyn-MyCanaryName
.
Before you delete a canary, you might want to use
GetCanary
to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.- Parameters:
deleteCanaryRequest
-- Returns:
- Result of the DeleteCanary operation returned by the service.
- See Also:
-
-
deleteCanary
default DeleteCanaryResponse deleteCanary(Consumer<DeleteCanaryRequest.Builder> deleteCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Permanently deletes the specified canary.
If you specify
DeleteLambda
totrue
, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:
-
The CloudWatch alarms created for this canary. These alarms have a name of
Synthetics-SharpDrop-Alarm-MyCanaryName
. -
Amazon S3 objects and buckets, such as the canary's artifact location.
-
IAM roles created for the canary. If they were created in the console, these roles have the name
role/service-role/CloudWatchSyntheticsRole-MyCanaryName
. -
CloudWatch Logs log groups created for the canary. These logs groups have the name
/aws/lambda/cwsyn-MyCanaryName
.
Before you delete a canary, you might want to use
GetCanary
to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.
This is a convenience which creates an instance of the
DeleteCanaryRequest.Builder
avoiding the need to create one manually viaDeleteCanaryRequest.builder()
- Parameters:
deleteCanaryRequest
- AConsumer
that will call methods onDeleteCanaryRequest.Builder
to create a request.- Returns:
- Result of the DeleteCanary operation returned by the service.
- See Also:
-
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.
Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN.
- Parameters:
deleteGroupRequest
-- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.
Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builder
avoiding the need to create one manually viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
describeCanaries
default DescribeCanariesResponse describeCanaries(DescribeCanariesRequest describeCanariesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This operation returns a list of the canaries in your account, along with full details about each canary.
This operation supports resource-level authorization using an IAM policy and the
Names
parameter. If you specify theNames
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.- Parameters:
describeCanariesRequest
-- Returns:
- Result of the DescribeCanaries operation returned by the service.
- See Also:
-
describeCanaries
default DescribeCanariesResponse describeCanaries(Consumer<DescribeCanariesRequest.Builder> describeCanariesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This operation returns a list of the canaries in your account, along with full details about each canary.
This operation supports resource-level authorization using an IAM policy and the
Names
parameter. If you specify theNames
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.
This is a convenience which creates an instance of the
DescribeCanariesRequest.Builder
avoiding the need to create one manually viaDescribeCanariesRequest.builder()
- Parameters:
describeCanariesRequest
- AConsumer
that will call methods onDescribeCanariesRequest.Builder
to create a request.- Returns:
- Result of the DescribeCanaries operation returned by the service.
- See Also:
-
describeCanariesPaginator
default DescribeCanariesIterable describeCanariesPaginator(DescribeCanariesRequest describeCanariesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
describeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesIterable responses = client.describeCanariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesIterable responses = client .describeCanariesPaginator(request); for (software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesIterable responses = client.describeCanariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest)
operation.- Parameters:
describeCanariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCanariesPaginator
default DescribeCanariesIterable describeCanariesPaginator(Consumer<DescribeCanariesRequest.Builder> describeCanariesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
describeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesIterable responses = client.describeCanariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesIterable responses = client .describeCanariesPaginator(request); for (software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesIterable responses = client.describeCanariesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest)
operation.
This is a convenience which creates an instance of the
DescribeCanariesRequest.Builder
avoiding the need to create one manually viaDescribeCanariesRequest.builder()
- Parameters:
describeCanariesRequest
- AConsumer
that will call methods onDescribeCanariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCanariesLastRun
default DescribeCanariesLastRunResponse describeCanariesLastRun(DescribeCanariesLastRunRequest describeCanariesLastRunRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Use this operation to see information from the most recent run of each canary that you have created.
This operation supports resource-level authorization using an IAM policy and the
Names
parameter. If you specify theNames
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.- Parameters:
describeCanariesLastRunRequest
-- Returns:
- Result of the DescribeCanariesLastRun operation returned by the service.
- See Also:
-
describeCanariesLastRun
default DescribeCanariesLastRunResponse describeCanariesLastRun(Consumer<DescribeCanariesLastRunRequest.Builder> describeCanariesLastRunRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Use this operation to see information from the most recent run of each canary that you have created.
This operation supports resource-level authorization using an IAM policy and the
Names
parameter. If you specify theNames
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.
This is a convenience which creates an instance of the
DescribeCanariesLastRunRequest.Builder
avoiding the need to create one manually viaDescribeCanariesLastRunRequest.builder()
- Parameters:
describeCanariesLastRunRequest
- AConsumer
that will call methods onDescribeCanariesLastRunRequest.Builder
to create a request.- Returns:
- Result of the DescribeCanariesLastRun operation returned by the service.
- See Also:
-
describeCanariesLastRunPaginator
default DescribeCanariesLastRunIterable describeCanariesLastRunPaginator(DescribeCanariesLastRunRequest describeCanariesLastRunRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
describeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunIterable responses = client.describeCanariesLastRunPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunIterable responses = client .describeCanariesLastRunPaginator(request); for (software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunIterable responses = client.describeCanariesLastRunPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation.- Parameters:
describeCanariesLastRunRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCanariesLastRunPaginator
default DescribeCanariesLastRunIterable describeCanariesLastRunPaginator(Consumer<DescribeCanariesLastRunRequest.Builder> describeCanariesLastRunRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
describeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunIterable responses = client.describeCanariesLastRunPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunIterable responses = client .describeCanariesLastRunPaginator(request); for (software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunIterable responses = client.describeCanariesLastRunPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation.
This is a convenience which creates an instance of the
DescribeCanariesLastRunRequest.Builder
avoiding the need to create one manually viaDescribeCanariesLastRunRequest.builder()
- Parameters:
describeCanariesLastRunRequest
- AConsumer
that will call methods onDescribeCanariesLastRunRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRuntimeVersions
default DescribeRuntimeVersionsResponse describeRuntimeVersions(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
- Parameters:
describeRuntimeVersionsRequest
-- Returns:
- Result of the DescribeRuntimeVersions operation returned by the service.
- See Also:
-
describeRuntimeVersions
default DescribeRuntimeVersionsResponse describeRuntimeVersions(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
This is a convenience which creates an instance of the
DescribeRuntimeVersionsRequest.Builder
avoiding the need to create one manually viaDescribeRuntimeVersionsRequest.builder()
- Parameters:
describeRuntimeVersionsRequest
- AConsumer
that will call methods onDescribeRuntimeVersionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeRuntimeVersions operation returned by the service.
- See Also:
-
describeRuntimeVersionsPaginator
default DescribeRuntimeVersionsIterable describeRuntimeVersionsPaginator(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
describeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsIterable responses = client.describeRuntimeVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsIterable responses = client .describeRuntimeVersionsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsIterable responses = client.describeRuntimeVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation.- Parameters:
describeRuntimeVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRuntimeVersionsPaginator
default DescribeRuntimeVersionsIterable describeRuntimeVersionsPaginator(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
describeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsIterable responses = client.describeRuntimeVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsIterable responses = client .describeRuntimeVersionsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsIterable responses = client.describeRuntimeVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRuntimeVersionsRequest.Builder
avoiding the need to create one manually viaDescribeRuntimeVersionsRequest.builder()
- Parameters:
describeRuntimeVersionsRequest
- AConsumer
that will call methods onDescribeRuntimeVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
disassociateResource
default DisassociateResourceResponse disassociateResource(DisassociateResourceRequest disassociateResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Removes a canary from a group. You must run this operation in the Region where the canary exists.
- Parameters:
disassociateResourceRequest
-- Returns:
- Result of the DisassociateResource operation returned by the service.
- See Also:
-
disassociateResource
default DisassociateResourceResponse disassociateResource(Consumer<DisassociateResourceRequest.Builder> disassociateResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Removes a canary from a group. You must run this operation in the Region where the canary exists.
This is a convenience which creates an instance of the
DisassociateResourceRequest.Builder
avoiding the need to create one manually viaDisassociateResourceRequest.builder()
- Parameters:
disassociateResourceRequest
- AConsumer
that will call methods onDisassociateResourceRequest.Builder
to create a request.- Returns:
- Result of the DisassociateResource operation returned by the service.
- See Also:
-
getCanary
default GetCanaryResponse getCanary(GetCanaryRequest getCanaryRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.
- Parameters:
getCanaryRequest
-- Returns:
- Result of the GetCanary operation returned by the service.
- See Also:
-
getCanary
default GetCanaryResponse getCanary(Consumer<GetCanaryRequest.Builder> getCanaryRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.
This is a convenience which creates an instance of the
GetCanaryRequest.Builder
avoiding the need to create one manually viaGetCanaryRequest.builder()
- Parameters:
getCanaryRequest
- AConsumer
that will call methods onGetCanaryRequest.Builder
to create a request.- Returns:
- Result of the GetCanary operation returned by the service.
- See Also:
-
getCanaryRuns
default GetCanaryRunsResponse getCanaryRuns(GetCanaryRunsRequest getCanaryRunsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException Retrieves a list of runs for a specified canary.
- Parameters:
getCanaryRunsRequest
-- Returns:
- Result of the GetCanaryRuns operation returned by the service.
- See Also:
-
getCanaryRuns
default GetCanaryRunsResponse getCanaryRuns(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException Retrieves a list of runs for a specified canary.
This is a convenience which creates an instance of the
GetCanaryRunsRequest.Builder
avoiding the need to create one manually viaGetCanaryRunsRequest.builder()
- Parameters:
getCanaryRunsRequest
- AConsumer
that will call methods onGetCanaryRunsRequest.Builder
to create a request.- Returns:
- Result of the GetCanaryRuns operation returned by the service.
- See Also:
-
getCanaryRunsPaginator
default GetCanaryRunsIterable getCanaryRunsPaginator(GetCanaryRunsRequest getCanaryRunsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
getCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsIterable responses = client.getCanaryRunsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsIterable responses = client .getCanaryRunsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.GetCanaryRunsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsIterable responses = client.getCanaryRunsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest)
operation.- Parameters:
getCanaryRunsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getCanaryRunsPaginator
default GetCanaryRunsIterable getCanaryRunsPaginator(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
getCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsIterable responses = client.getCanaryRunsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsIterable responses = client .getCanaryRunsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.GetCanaryRunsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsIterable responses = client.getCanaryRunsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest)
operation.
This is a convenience which creates an instance of the
GetCanaryRunsRequest.Builder
avoiding the need to create one manually viaGetCanaryRunsRequest.builder()
- Parameters:
getCanaryRunsRequest
- AConsumer
that will call methods onGetCanaryRunsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getGroup
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
- Parameters:
getGroupRequest
-- Returns:
- Result of the GetGroup operation returned by the service.
- See Also:
-
getGroup
default GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
This is a convenience which creates an instance of the
GetGroupRequest.Builder
avoiding the need to create one manually viaGetGroupRequest.builder()
- Parameters:
getGroupRequest
- AConsumer
that will call methods onGetGroupRequest.Builder
to create a request.- Returns:
- Result of the GetGroup operation returned by the service.
- See Also:
-
listAssociatedGroups
default ListAssociatedGroupsResponse listAssociatedGroups(ListAssociatedGroupsRequest listAssociatedGroupsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.
- Parameters:
listAssociatedGroupsRequest
-- Returns:
- Result of the ListAssociatedGroups operation returned by the service.
- See Also:
-
listAssociatedGroups
default ListAssociatedGroupsResponse listAssociatedGroups(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.
This is a convenience which creates an instance of the
ListAssociatedGroupsRequest.Builder
avoiding the need to create one manually viaListAssociatedGroupsRequest.builder()
- Parameters:
listAssociatedGroupsRequest
- AConsumer
that will call methods onListAssociatedGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListAssociatedGroups operation returned by the service.
- See Also:
-
listAssociatedGroupsPaginator
default ListAssociatedGroupsIterable listAssociatedGroupsPaginator(ListAssociatedGroupsRequest listAssociatedGroupsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
listAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsIterable responses = client.listAssociatedGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsIterable responses = client .listAssociatedGroupsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsIterable responses = client.listAssociatedGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation.- Parameters:
listAssociatedGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssociatedGroupsPaginator
default ListAssociatedGroupsIterable listAssociatedGroupsPaginator(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
listAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsIterable responses = client.listAssociatedGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsIterable responses = client .listAssociatedGroupsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsIterable responses = client.listAssociatedGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListAssociatedGroupsRequest.Builder
avoiding the need to create one manually viaListAssociatedGroupsRequest.builder()
- Parameters:
listAssociatedGroupsRequest
- AConsumer
that will call methods onListAssociatedGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupResources
default ListGroupResourcesResponse listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException This operation returns a list of the ARNs of the canaries that are associated with the specified group.
- Parameters:
listGroupResourcesRequest
-- Returns:
- Result of the ListGroupResources operation returned by the service.
- See Also:
-
listGroupResources
default ListGroupResourcesResponse listGroupResources(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException This operation returns a list of the ARNs of the canaries that are associated with the specified group.
This is a convenience which creates an instance of the
ListGroupResourcesRequest.Builder
avoiding the need to create one manually viaListGroupResourcesRequest.builder()
- Parameters:
listGroupResourcesRequest
- AConsumer
that will call methods onListGroupResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListGroupResources operation returned by the service.
- See Also:
-
listGroupResourcesPaginator
default ListGroupResourcesIterable listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
listGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesIterable responses = client .listGroupResourcesPaginator(request); for (software.amazon.awssdk.services.synthetics.model.ListGroupResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation.- Parameters:
listGroupResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupResourcesPaginator
default ListGroupResourcesIterable listGroupResourcesPaginator(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
listGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesIterable responses = client .listGroupResourcesPaginator(request); for (software.amazon.awssdk.services.synthetics.model.ListGroupResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListGroupResourcesRequest.Builder
avoiding the need to create one manually viaListGroupResourcesRequest.builder()
- Parameters:
listGroupResourcesRequest
- AConsumer
that will call methods onListGroupResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.
- Parameters:
listGroupsRequest
-- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.
This is a convenience which creates an instance of the
ListGroupsRequest.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
listGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.ListGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation.- Parameters:
listGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SyntheticsException This is a variant of
listGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.synthetics.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.synthetics.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.synthetics.model.ListGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.synthetics.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListGroupsRequest.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, SyntheticsException Displays the tags associated with a canary or group.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, SyntheticsException Displays the tags associated with a canary or group.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startCanary
default StartCanaryResponse startCanary(StartCanaryRequest startCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's
Schedule
. To see a canary's schedule, use GetCanary.- Parameters:
startCanaryRequest
-- Returns:
- Result of the StartCanary operation returned by the service.
- See Also:
-
startCanary
default StartCanaryResponse startCanary(Consumer<StartCanaryRequest.Builder> startCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's
Schedule
. To see a canary's schedule, use GetCanary.
This is a convenience which creates an instance of the
StartCanaryRequest.Builder
avoiding the need to create one manually viaStartCanaryRequest.builder()
- Parameters:
startCanaryRequest
- AConsumer
that will call methods onStartCanaryRequest.Builder
to create a request.- Returns:
- Result of the StartCanary operation returned by the service.
- See Also:
-
stopCanary
default StopCanaryResponse stopCanary(StopCanaryRequest stopCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.
You can use
StartCanary
to start it running again with the canary’s current schedule at any point in the future.- Parameters:
stopCanaryRequest
-- Returns:
- Result of the StopCanary operation returned by the service.
- See Also:
-
stopCanary
default StopCanaryResponse stopCanary(Consumer<StopCanaryRequest.Builder> stopCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SyntheticsException Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.
You can use
StartCanary
to start it running again with the canary’s current schedule at any point in the future.
This is a convenience which creates an instance of the
StopCanaryRequest.Builder
avoiding the need to create one manually viaStopCanaryRequest.builder()
- Parameters:
stopCanaryRequest
- AConsumer
that will call methods onStopCanaryRequest.Builder
to create a request.- Returns:
- Result of the StopCanary operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, SyntheticsException Assigns one or more tags (key-value pairs) to the specified canary or 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 resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a canary or group.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, SyntheticsException Assigns one or more tags (key-value pairs) to the specified canary or 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 resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a canary or group.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, SyntheticsException Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, SyntheticsException Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCanary
default UpdateCanaryResponse updateCanary(UpdateCanaryRequest updateCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, RequestEntityTooLargeException, AwsServiceException, SdkClientException, SyntheticsException Updates the configuration of a canary that has already been created.
You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
- Parameters:
updateCanaryRequest
-- Returns:
- Result of the UpdateCanary operation returned by the service.
- See Also:
-
updateCanary
default UpdateCanaryResponse updateCanary(Consumer<UpdateCanaryRequest.Builder> updateCanaryRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, ConflictException, RequestEntityTooLargeException, AwsServiceException, SdkClientException, SyntheticsException Updates the configuration of a canary that has already been created.
You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
This is a convenience which creates an instance of the
UpdateCanaryRequest.Builder
avoiding the need to create one manually viaUpdateCanaryRequest.builder()
- Parameters:
updateCanaryRequest
- AConsumer
that will call methods onUpdateCanaryRequest.Builder
to create a request.- Returns:
- Result of the UpdateCanary operation returned by the service.
- See Also:
-
create
Create aSyntheticsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSyntheticsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-