@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSyntheticsAsyncClient extends AWSSyntheticsClient implements AWSSyntheticsAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createCanary, deleteCanary, describeCanaries, describeCanariesLastRun, describeRuntimeVersions, getCachedResponseMetadata, getCanary, getCanaryRuns, listTagsForResource, startCanary, stopCanary, tagResource, untagResource, updateCanaryaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateCanary, deleteCanary, describeCanaries, describeCanariesLastRun, describeRuntimeVersions, getCachedResponseMetadata, getCanary, getCanaryRuns, listTagsForResource, startCanary, stopCanary, tagResource, untagResource, updateCanarypublic static AWSSyntheticsAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateCanaryResult> createCanaryAsync(CreateCanaryRequest request)
AWSSyntheticsAsyncCreates 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.
createCanaryAsync in interface AWSSyntheticsAsyncpublic Future<CreateCanaryResult> createCanaryAsync(CreateCanaryRequest request, AsyncHandler<CreateCanaryRequest,CreateCanaryResult> asyncHandler)
AWSSyntheticsAsyncCreates 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.
createCanaryAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCanaryResult> deleteCanaryAsync(DeleteCanaryRequest request)
AWSSyntheticsAsyncPermanently 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.
deleteCanaryAsync in interface AWSSyntheticsAsyncpublic Future<DeleteCanaryResult> deleteCanaryAsync(DeleteCanaryRequest request, AsyncHandler<DeleteCanaryRequest,DeleteCanaryResult> asyncHandler)
AWSSyntheticsAsyncPermanently 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.
deleteCanaryAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCanariesResult> describeCanariesAsync(DescribeCanariesRequest request)
AWSSyntheticsAsyncThis 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.
describeCanariesAsync in interface AWSSyntheticsAsyncpublic Future<DescribeCanariesResult> describeCanariesAsync(DescribeCanariesRequest request, AsyncHandler<DescribeCanariesRequest,DescribeCanariesResult> asyncHandler)
AWSSyntheticsAsyncThis 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.
describeCanariesAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCanariesLastRunResult> describeCanariesLastRunAsync(DescribeCanariesLastRunRequest request)
AWSSyntheticsAsyncUse this operation to see information from the most recent run of each canary that you have created.
describeCanariesLastRunAsync in interface AWSSyntheticsAsyncpublic Future<DescribeCanariesLastRunResult> describeCanariesLastRunAsync(DescribeCanariesLastRunRequest request, AsyncHandler<DescribeCanariesLastRunRequest,DescribeCanariesLastRunResult> asyncHandler)
AWSSyntheticsAsyncUse this operation to see information from the most recent run of each canary that you have created.
describeCanariesLastRunAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRuntimeVersionsResult> describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest request)
AWSSyntheticsAsyncReturns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
describeRuntimeVersionsAsync in interface AWSSyntheticsAsyncpublic Future<DescribeRuntimeVersionsResult> describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest request, AsyncHandler<DescribeRuntimeVersionsRequest,DescribeRuntimeVersionsResult> asyncHandler)
AWSSyntheticsAsyncReturns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
describeRuntimeVersionsAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCanaryResult> getCanaryAsync(GetCanaryRequest request)
AWSSyntheticsAsyncRetrieves 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.
getCanaryAsync in interface AWSSyntheticsAsyncpublic Future<GetCanaryResult> getCanaryAsync(GetCanaryRequest request, AsyncHandler<GetCanaryRequest,GetCanaryResult> asyncHandler)
AWSSyntheticsAsyncRetrieves 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.
getCanaryAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCanaryRunsResult> getCanaryRunsAsync(GetCanaryRunsRequest request)
AWSSyntheticsAsyncRetrieves a list of runs for a specified canary.
getCanaryRunsAsync in interface AWSSyntheticsAsyncpublic Future<GetCanaryRunsResult> getCanaryRunsAsync(GetCanaryRunsRequest request, AsyncHandler<GetCanaryRunsRequest,GetCanaryRunsResult> asyncHandler)
AWSSyntheticsAsyncRetrieves a list of runs for a specified canary.
getCanaryRunsAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSSyntheticsAsyncDisplays the tags associated with a canary.
listTagsForResourceAsync in interface AWSSyntheticsAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSSyntheticsAsyncDisplays the tags associated with a canary.
listTagsForResourceAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartCanaryResult> startCanaryAsync(StartCanaryRequest request)
AWSSyntheticsAsync
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.
startCanaryAsync in interface AWSSyntheticsAsyncpublic Future<StartCanaryResult> startCanaryAsync(StartCanaryRequest request, AsyncHandler<StartCanaryRequest,StartCanaryResult> asyncHandler)
AWSSyntheticsAsync
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.
startCanaryAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopCanaryResult> stopCanaryAsync(StopCanaryRequest request)
AWSSyntheticsAsyncStops 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.
stopCanaryAsync in interface AWSSyntheticsAsyncpublic Future<StopCanaryResult> stopCanaryAsync(StopCanaryRequest request, AsyncHandler<StopCanaryRequest,StopCanaryResult> asyncHandler)
AWSSyntheticsAsyncStops 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.
stopCanaryAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSSyntheticsAsyncAssigns 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.
tagResourceAsync in interface AWSSyntheticsAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSSyntheticsAsyncAssigns 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.
tagResourceAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSSyntheticsAsyncRemoves one or more tags from the specified canary.
untagResourceAsync in interface AWSSyntheticsAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSSyntheticsAsyncRemoves one or more tags from the specified canary.
untagResourceAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateCanaryResult> updateCanaryAsync(UpdateCanaryRequest request)
AWSSyntheticsAsyncUse 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.
updateCanaryAsync in interface AWSSyntheticsAsyncpublic Future<UpdateCanaryResult> updateCanaryAsync(UpdateCanaryRequest request, AsyncHandler<UpdateCanaryRequest,UpdateCanaryResult> asyncHandler)
AWSSyntheticsAsyncUse 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.
updateCanaryAsync in interface AWSSyntheticsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSSyntheticsshutdown in class AmazonWebServiceClient