@Generated(value="software.amazon.awssdk:codegen") public interface SyntheticsAsyncClient extends 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.
| 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 |
|---|---|
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<DeleteCanaryResponse> |
deleteCanary(Consumer<DeleteCanaryRequest.Builder> deleteCanaryRequest)
Permanently deletes the specified canary.
|
default CompletableFuture<DeleteCanaryResponse> |
deleteCanary(DeleteCanaryRequest deleteCanaryRequest)
Permanently deletes the specified canary.
|
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<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<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a canary.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a canary.
|
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.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified canary.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified canary.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified canary.
|
default CompletableFuture<UpdateCanaryResponse> |
updateCanary(Consumer<UpdateCanaryRequest.Builder> updateCanaryRequest)
Use this operation to change the settings of a canary that has already been created.
|
default CompletableFuture<UpdateCanaryResponse> |
updateCanary(UpdateCanaryRequest updateCanaryRequest)
Use this operation to change the settings of a canary that has already been created.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static SyntheticsAsyncClient create()
SyntheticsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SyntheticsAsyncClientBuilder builder()
SyntheticsAsyncClient.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 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 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<DeleteCanaryResponse> deleteCanary(DeleteCanaryRequest deleteCanaryRequest)
Permanently deletes the specified canary.
When you delete a canary, 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 Lambda functions and layers used by this canary. These have the prefix
cwsyn-MyCanaryName .
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.
When you delete a canary, 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 Lambda functions and layers used by this canary. These have the prefix
cwsyn-MyCanaryName .
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<DescribeCanariesResponse> describeCanaries(DescribeCanariesRequest describeCanariesRequest)
This operation returns a list of the canaries in your account, along with full details about each canary.
This operation does not have resource-level authorization, so if a user is able to use
DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be
used to restrict access to all canaries. It cannot be used on specific resources.
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 does not have resource-level authorization, so if a user is able to use
DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be
used to restrict access to all canaries. It cannot be used on specific resources.
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.
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 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 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 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 does not have resource-level authorization, so if a user is able to use
DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be
used to restrict access to all canaries. It cannot be used on specific resources.
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 does not have resource-level authorization, so if a user is able to use
DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be
used to restrict access to all canaries. It cannot be used on specific resources.
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<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<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a canary.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a canary.
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, Synthetics stops waiting for the current run of the specified canary to complete. 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, Synthetics stops waiting for the current run of the specified canary to complete. 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.
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 AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a canary that already has tags. If you specify a new tag key
for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
is already associated with the alarm, 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.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified canary.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a canary that already has tags. If you specify a new tag key
for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
is already associated with the alarm, 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.
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 canary.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified canary.
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)
Use this operation to change the settings 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)
Use this operation to change the settings 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.