@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SyntheticsAsyncClient extends AwsClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateResourceResponse> |
associateResource(AssociateResourceRequest associateResourceRequest)
Associates a canary with a group.
|
default CompletableFuture<AssociateResourceResponse> |
associateResource(Consumer<AssociateResourceRequest.Builder> associateResourceRequest)
Associates a canary with a group.
|
static SyntheticsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SyntheticsAsyncClient. |
static SyntheticsAsyncClient |
create()
Create a
SyntheticsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateCanaryResponse> |
createCanary(Consumer<CreateCanaryRequest.Builder> createCanaryRequest)
Creates a canary.
|
default CompletableFuture<CreateCanaryResponse> |
createCanary(CreateCanaryRequest createCanaryRequest)
Creates a canary.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group which you can use to associate canaries with each other, including cross-Region canaries.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group which you can use to associate canaries with each other, including cross-Region canaries.
|
default CompletableFuture<DeleteCanaryResponse> |
deleteCanary(Consumer<DeleteCanaryRequest.Builder> deleteCanaryRequest)
Permanently deletes the specified canary.
|
default CompletableFuture<DeleteCanaryResponse> |
deleteCanary(DeleteCanaryRequest deleteCanaryRequest)
Permanently deletes the specified canary.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group.
|
default CompletableFuture<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 CompletableFuture<DescribeCanariesResponse> |
describeCanaries(DescribeCanariesRequest describeCanariesRequest)
This operation returns a list of the canaries in your account, along with full details about each canary.
|
default CompletableFuture<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 CompletableFuture<DescribeCanariesLastRunResponse> |
describeCanariesLastRun(DescribeCanariesLastRunRequest describeCanariesLastRunRequest)
Use this operation to see information from the most recent run of each canary that you have created.
|
default DescribeCanariesLastRunPublisher |
describeCanariesLastRunPaginator(Consumer<DescribeCanariesLastRunRequest.Builder> describeCanariesLastRunRequest)
Use this operation to see information from the most recent run of each canary that you have created.
|
default DescribeCanariesLastRunPublisher |
describeCanariesLastRunPaginator(DescribeCanariesLastRunRequest describeCanariesLastRunRequest)
Use this operation to see information from the most recent run of each canary that you have created.
|
default DescribeCanariesPublisher |
describeCanariesPaginator(Consumer<DescribeCanariesRequest.Builder> describeCanariesRequest)
This operation returns a list of the canaries in your account, along with full details about each canary.
|
default DescribeCanariesPublisher |
describeCanariesPaginator(DescribeCanariesRequest describeCanariesRequest)
This operation returns a list of the canaries in your account, along with full details about each canary.
|
default CompletableFuture<DescribeRuntimeVersionsResponse> |
describeRuntimeVersions(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions.
|
default CompletableFuture<DescribeRuntimeVersionsResponse> |
describeRuntimeVersions(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions.
|
default DescribeRuntimeVersionsPublisher |
describeRuntimeVersionsPaginator(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions.
|
default DescribeRuntimeVersionsPublisher |
describeRuntimeVersionsPaginator(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions.
|
default CompletableFuture<DisassociateResourceResponse> |
disassociateResource(Consumer<DisassociateResourceRequest.Builder> disassociateResourceRequest)
Removes a canary from a group.
|
default CompletableFuture<DisassociateResourceResponse> |
disassociateResource(DisassociateResourceRequest disassociateResourceRequest)
Removes a canary from a group.
|
default CompletableFuture<GetCanaryResponse> |
getCanary(Consumer<GetCanaryRequest.Builder> getCanaryRequest)
Retrieves complete information about one canary.
|
default CompletableFuture<GetCanaryResponse> |
getCanary(GetCanaryRequest getCanaryRequest)
Retrieves complete information about one canary.
|
default CompletableFuture<GetCanaryRunsResponse> |
getCanaryRuns(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
|
default CompletableFuture<GetCanaryRunsResponse> |
getCanaryRuns(GetCanaryRunsRequest getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
|
default GetCanaryRunsPublisher |
getCanaryRunsPaginator(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
|
default GetCanaryRunsPublisher |
getCanaryRunsPaginator(GetCanaryRunsRequest getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
|
default CompletableFuture<GetGroupResponse> |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Returns information about one group.
|
default CompletableFuture<GetGroupResponse> |
getGroup(GetGroupRequest getGroupRequest)
Returns information about one group.
|
default CompletableFuture<ListAssociatedGroupsResponse> |
listAssociatedGroups(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest)
Returns a list of the groups that the specified canary is associated with.
|
default CompletableFuture<ListAssociatedGroupsResponse> |
listAssociatedGroups(ListAssociatedGroupsRequest listAssociatedGroupsRequest)
Returns a list of the groups that the specified canary is associated with.
|
default ListAssociatedGroupsPublisher |
listAssociatedGroupsPaginator(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest)
Returns a list of the groups that the specified canary is associated with.
|
default ListAssociatedGroupsPublisher |
listAssociatedGroupsPaginator(ListAssociatedGroupsRequest listAssociatedGroupsRequest)
Returns a list of the groups that the specified canary is associated with.
|
default CompletableFuture<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 CompletableFuture<ListGroupResourcesResponse> |
listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
|
default ListGroupResourcesPublisher |
listGroupResourcesPaginator(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
|
default ListGroupResourcesPublisher |
listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest)
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(ListGroupsRequest listGroupsRequest)
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.
|
default ListGroupsPublisher |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.
|
default ListGroupsPublisher |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a canary or group.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a canary or group.
|
default SyntheticsServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartCanaryResponse> |
startCanary(Consumer<StartCanaryRequest.Builder> startCanaryRequest)
Use this operation to run a canary that has already been created.
|
default CompletableFuture<StartCanaryResponse> |
startCanary(StartCanaryRequest startCanaryRequest)
Use this operation to run a canary that has already been created.
|
default CompletableFuture<StopCanaryResponse> |
stopCanary(Consumer<StopCanaryRequest.Builder> stopCanaryRequest)
Stops the canary to prevent all future runs.
|
default CompletableFuture<StopCanaryResponse> |
stopCanary(StopCanaryRequest stopCanaryRequest)
Stops the canary to prevent all future runs.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified canary or group.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified canary or group.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CompletableFuture<UpdateCanaryResponse> |
updateCanary(Consumer<UpdateCanaryRequest.Builder> updateCanaryRequest)
Updates the configuration of a canary that has already been created.
|
default CompletableFuture<UpdateCanaryResponse> |
updateCanary(UpdateCanaryRequest updateCanaryRequest)
Updates the configuration of a canary that has already been created.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AssociateResourceResponse> associateResource(AssociateResourceRequest associateResourceRequest)
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.
associateResourceRequest - default CompletableFuture<AssociateResourceResponse> associateResource(Consumer<AssociateResourceRequest.Builder> associateResourceRequest)
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 via AssociateResourceRequest.builder()
associateResourceRequest - A Consumer that will call methods on AssociateResourceRequest.Builder to create a request.default CompletableFuture<CreateCanaryResponse> createCanary(CreateCanaryRequest createCanaryRequest)
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 the iam:CreateRole, iam:CreatePolicy and
iam: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.
createCanaryRequest - default CompletableFuture<CreateCanaryResponse> createCanary(Consumer<CreateCanaryRequest.Builder> createCanaryRequest)
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 the iam:CreateRole, iam:CreatePolicy and
iam: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 via CreateCanaryRequest.builder()
createCanaryRequest - A Consumer that will call methods on CreateCanaryRequest.Builder to create a request.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
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.
createGroupRequest - default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
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 via CreateGroupRequest.builder()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.default CompletableFuture<DeleteCanaryResponse> deleteCanary(DeleteCanaryRequest deleteCanaryRequest)
Permanently deletes the specified canary.
If you specify DeleteLambda to true, 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.
deleteCanaryRequest - default CompletableFuture<DeleteCanaryResponse> deleteCanary(Consumer<DeleteCanaryRequest.Builder> deleteCanaryRequest)
Permanently deletes the specified canary.
If you specify DeleteLambda to true, 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 via DeleteCanaryRequest.builder()
deleteCanaryRequest - A Consumer that will call methods on DeleteCanaryRequest.Builder to create a request.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
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.
deleteGroupRequest - default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
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 via DeleteGroupRequest.builder()
deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.default CompletableFuture<DescribeCanariesResponse> describeCanaries(DescribeCanariesRequest describeCanariesRequest)
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 the Names 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.
describeCanariesRequest - default CompletableFuture<DescribeCanariesResponse> describeCanaries(Consumer<DescribeCanariesRequest.Builder> describeCanariesRequest)
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 the Names 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 via DescribeCanariesRequest.builder()
describeCanariesRequest - A Consumer that will call methods on DescribeCanariesRequest.Builder to create a request.default CompletableFuture<DescribeCanariesLastRunResponse> describeCanariesLastRun(DescribeCanariesLastRunRequest describeCanariesLastRunRequest)
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 the Names 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.
describeCanariesLastRunRequest - default CompletableFuture<DescribeCanariesLastRunResponse> describeCanariesLastRun(Consumer<DescribeCanariesLastRunRequest.Builder> describeCanariesLastRunRequest)
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 the Names 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 via DescribeCanariesLastRunRequest.builder()
describeCanariesLastRunRequest - A Consumer that will call methods on DescribeCanariesLastRunRequest.Builder to create a
request.default DescribeCanariesLastRunPublisher describeCanariesLastRunPaginator(DescribeCanariesLastRunRequest describeCanariesLastRunRequest)
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 the Names 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 variant of
describeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunPublisher publisher = client.describeCanariesLastRunPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunPublisher publisher = client.describeCanariesLastRunPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
describeCanariesLastRunRequest - default DescribeCanariesLastRunPublisher describeCanariesLastRunPaginator(Consumer<DescribeCanariesLastRunRequest.Builder> describeCanariesLastRunRequest)
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 the Names 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 variant of
describeCanariesLastRun(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunPublisher publisher = client.describeCanariesLastRunPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesLastRunPublisher publisher = client.describeCanariesLastRunPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.DescribeCanariesLastRunResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via DescribeCanariesLastRunRequest.builder()
describeCanariesLastRunRequest - A Consumer that will call methods on DescribeCanariesLastRunRequest.Builder to create a
request.default DescribeCanariesPublisher describeCanariesPaginator(DescribeCanariesRequest describeCanariesRequest)
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 the Names 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 variant of
describeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesPublisher publisher = client.describeCanariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesPublisher publisher = client.describeCanariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
describeCanariesRequest - default DescribeCanariesPublisher describeCanariesPaginator(Consumer<DescribeCanariesRequest.Builder> describeCanariesRequest)
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 the Names 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 variant of
describeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesPublisher publisher = client.describeCanariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesPublisher publisher = client.describeCanariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via DescribeCanariesRequest.builder()
describeCanariesRequest - A Consumer that will call methods on DescribeCanariesRequest.Builder to create a request.default CompletableFuture<DescribeRuntimeVersionsResponse> describeRuntimeVersions(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
describeRuntimeVersionsRequest - default CompletableFuture<DescribeRuntimeVersionsResponse> describeRuntimeVersions(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest)
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 via DescribeRuntimeVersionsRequest.builder()
describeRuntimeVersionsRequest - A Consumer that will call methods on DescribeRuntimeVersionsRequest.Builder to create a
request.default DescribeRuntimeVersionsPublisher describeRuntimeVersionsPaginator(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
This is a variant of
describeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsPublisher publisher = client.describeRuntimeVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsPublisher publisher = client.describeRuntimeVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
describeRuntimeVersionsRequest - default DescribeRuntimeVersionsPublisher describeRuntimeVersionsPaginator(Consumer<DescribeRuntimeVersionsRequest.Builder> describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
This is a variant of
describeRuntimeVersions(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsPublisher publisher = client.describeRuntimeVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.DescribeRuntimeVersionsPublisher publisher = client.describeRuntimeVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.DescribeRuntimeVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via DescribeRuntimeVersionsRequest.builder()
describeRuntimeVersionsRequest - A Consumer that will call methods on DescribeRuntimeVersionsRequest.Builder to create a
request.default CompletableFuture<DisassociateResourceResponse> disassociateResource(DisassociateResourceRequest disassociateResourceRequest)
Removes a canary from a group. You must run this operation in the Region where the canary exists.
disassociateResourceRequest - default CompletableFuture<DisassociateResourceResponse> disassociateResource(Consumer<DisassociateResourceRequest.Builder> disassociateResourceRequest)
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 via DisassociateResourceRequest.builder()
disassociateResourceRequest - A Consumer that will call methods on DisassociateResourceRequest.Builder to create a
request.default CompletableFuture<GetCanaryResponse> getCanary(GetCanaryRequest getCanaryRequest)
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.
getCanaryRequest - default CompletableFuture<GetCanaryResponse> getCanary(Consumer<GetCanaryRequest.Builder> getCanaryRequest)
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 via GetCanaryRequest.builder()
getCanaryRequest - A Consumer that will call methods on GetCanaryRequest.Builder to create a request.default CompletableFuture<GetCanaryRunsResponse> getCanaryRuns(GetCanaryRunsRequest getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
getCanaryRunsRequest - default CompletableFuture<GetCanaryRunsResponse> getCanaryRuns(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest)
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 via GetCanaryRunsRequest.builder()
getCanaryRunsRequest - A Consumer that will call methods on GetCanaryRunsRequest.Builder to create a request.default GetCanaryRunsPublisher getCanaryRunsPaginator(GetCanaryRunsRequest getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
This is a variant of
getCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsPublisher publisher = client.getCanaryRunsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsPublisher publisher = client.getCanaryRunsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.GetCanaryRunsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
getCanaryRunsRequest - default GetCanaryRunsPublisher getCanaryRunsPaginator(Consumer<GetCanaryRunsRequest.Builder> getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
This is a variant of
getCanaryRuns(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsPublisher publisher = client.getCanaryRunsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.GetCanaryRunsPublisher publisher = client.getCanaryRunsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.GetCanaryRunsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.GetCanaryRunsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via GetCanaryRunsRequest.builder()
getCanaryRunsRequest - A Consumer that will call methods on GetCanaryRunsRequest.Builder to create a request.default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)
Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
getGroupRequest - default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
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 via GetGroupRequest.builder()
getGroupRequest - A Consumer that will call methods on GetGroupRequest.Builder to create a request.default CompletableFuture<ListAssociatedGroupsResponse> listAssociatedGroups(ListAssociatedGroupsRequest listAssociatedGroupsRequest)
Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.
listAssociatedGroupsRequest - default CompletableFuture<ListAssociatedGroupsResponse> listAssociatedGroups(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest)
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 via ListAssociatedGroupsRequest.builder()
listAssociatedGroupsRequest - A Consumer that will call methods on ListAssociatedGroupsRequest.Builder to create a
request.default ListAssociatedGroupsPublisher listAssociatedGroupsPaginator(ListAssociatedGroupsRequest listAssociatedGroupsRequest)
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 variant of
listAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsPublisher publisher = client.listAssociatedGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsPublisher publisher = client.listAssociatedGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listAssociatedGroupsRequest - default ListAssociatedGroupsPublisher listAssociatedGroupsPaginator(Consumer<ListAssociatedGroupsRequest.Builder> listAssociatedGroupsRequest)
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 variant of
listAssociatedGroups(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsPublisher publisher = client.listAssociatedGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.ListAssociatedGroupsPublisher publisher = client.listAssociatedGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.ListAssociatedGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListAssociatedGroupsRequest.builder()
listAssociatedGroupsRequest - A Consumer that will call methods on ListAssociatedGroupsRequest.Builder to create a
request.default CompletableFuture<ListGroupResourcesResponse> listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
listGroupResourcesRequest - default CompletableFuture<ListGroupResourcesResponse> listGroupResources(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)
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 via ListGroupResourcesRequest.builder()
listGroupResourcesRequest - A Consumer that will call methods on ListGroupResourcesRequest.Builder to create a
request.default ListGroupResourcesPublisher listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest)
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
This is a variant of
listGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.ListGroupResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listGroupResourcesRequest - default ListGroupResourcesPublisher listGroupResourcesPaginator(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)
This operation returns a list of the ARNs of the canaries that are associated with the specified group.
This is a variant of
listGroupResources(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.ListGroupResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.ListGroupResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListGroupResourcesRequest.builder()
listGroupResourcesRequest - A Consumer that will call methods on ListGroupResourcesRequest.Builder to create a
request.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.
listGroupsRequest - default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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 via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)
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 variant of listGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listGroupsRequest - default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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 variant of listGroups(software.amazon.awssdk.services.synthetics.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.synthetics.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a canary or group.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<StartCanaryResponse> startCanary(StartCanaryRequest startCanaryRequest)
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.
startCanaryRequest - default CompletableFuture<StartCanaryResponse> startCanary(Consumer<StartCanaryRequest.Builder> startCanaryRequest)
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 via StartCanaryRequest.builder()
startCanaryRequest - A Consumer that will call methods on StartCanaryRequest.Builder to create a request.default CompletableFuture<StopCanaryResponse> stopCanary(StopCanaryRequest stopCanaryRequest)
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.
stopCanaryRequest - default CompletableFuture<StopCanaryResponse> stopCanary(Consumer<StopCanaryRequest.Builder> stopCanaryRequest)
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 via StopCanaryRequest.builder()
stopCanaryRequest - A Consumer that will call methods on StopCanaryRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateCanaryResponse> updateCanary(UpdateCanaryRequest updateCanaryRequest)
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.
updateCanaryRequest - default CompletableFuture<UpdateCanaryResponse> updateCanary(Consumer<UpdateCanaryRequest.Builder> updateCanaryRequest)
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 via UpdateCanaryRequest.builder()
updateCanaryRequest - A Consumer that will call methods on UpdateCanaryRequest.Builder to create a request.default SyntheticsServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic SyntheticsAsyncClient create()
SyntheticsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SyntheticsAsyncClientBuilder builder()
SyntheticsAsyncClient.Copyright © 2023. All rights reserved.