@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSyntheticsAsync extends AWSSynthetics
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSyntheticsAsync instead.
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.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<CreateCanaryResult> |
createCanaryAsync(CreateCanaryRequest createCanaryRequest)
Creates a canary.
|
Future<CreateCanaryResult> |
createCanaryAsync(CreateCanaryRequest createCanaryRequest,
AsyncHandler<CreateCanaryRequest,CreateCanaryResult> asyncHandler)
Creates a canary.
|
Future<DeleteCanaryResult> |
deleteCanaryAsync(DeleteCanaryRequest deleteCanaryRequest)
Permanently deletes the specified canary.
|
Future<DeleteCanaryResult> |
deleteCanaryAsync(DeleteCanaryRequest deleteCanaryRequest,
AsyncHandler<DeleteCanaryRequest,DeleteCanaryResult> asyncHandler)
Permanently deletes the specified canary.
|
Future<DescribeCanariesResult> |
describeCanariesAsync(DescribeCanariesRequest describeCanariesRequest)
This operation returns a list of the canaries in your account, along with full details about each canary.
|
Future<DescribeCanariesResult> |
describeCanariesAsync(DescribeCanariesRequest describeCanariesRequest,
AsyncHandler<DescribeCanariesRequest,DescribeCanariesResult> asyncHandler)
This operation returns a list of the canaries in your account, along with full details about each canary.
|
Future<DescribeCanariesLastRunResult> |
describeCanariesLastRunAsync(DescribeCanariesLastRunRequest describeCanariesLastRunRequest)
Use this operation to see information from the most recent run of each canary that you have created.
|
Future<DescribeCanariesLastRunResult> |
describeCanariesLastRunAsync(DescribeCanariesLastRunRequest describeCanariesLastRunRequest,
AsyncHandler<DescribeCanariesLastRunRequest,DescribeCanariesLastRunResult> asyncHandler)
Use this operation to see information from the most recent run of each canary that you have created.
|
Future<DescribeRuntimeVersionsResult> |
describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions.
|
Future<DescribeRuntimeVersionsResult> |
describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest,
AsyncHandler<DescribeRuntimeVersionsRequest,DescribeRuntimeVersionsResult> asyncHandler)
Returns a list of Synthetics canary runtime versions.
|
Future<GetCanaryResult> |
getCanaryAsync(GetCanaryRequest getCanaryRequest)
Retrieves complete information about one canary.
|
Future<GetCanaryResult> |
getCanaryAsync(GetCanaryRequest getCanaryRequest,
AsyncHandler<GetCanaryRequest,GetCanaryResult> asyncHandler)
Retrieves complete information about one canary.
|
Future<GetCanaryRunsResult> |
getCanaryRunsAsync(GetCanaryRunsRequest getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
|
Future<GetCanaryRunsResult> |
getCanaryRunsAsync(GetCanaryRunsRequest getCanaryRunsRequest,
AsyncHandler<GetCanaryRunsRequest,GetCanaryRunsResult> asyncHandler)
Retrieves a list of runs for a specified canary.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a canary.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with a canary.
|
Future<StartCanaryResult> |
startCanaryAsync(StartCanaryRequest startCanaryRequest)
Use this operation to run a canary that has already been created.
|
Future<StartCanaryResult> |
startCanaryAsync(StartCanaryRequest startCanaryRequest,
AsyncHandler<StartCanaryRequest,StartCanaryResult> asyncHandler)
Use this operation to run a canary that has already been created.
|
Future<StopCanaryResult> |
stopCanaryAsync(StopCanaryRequest stopCanaryRequest)
Stops the canary to prevent all future runs.
|
Future<StopCanaryResult> |
stopCanaryAsync(StopCanaryRequest stopCanaryRequest,
AsyncHandler<StopCanaryRequest,StopCanaryResult> asyncHandler)
Stops the canary to prevent all future runs.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified canary.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns one or more tags (key-value pairs) to the specified canary.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified canary.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified canary.
|
Future<UpdateCanaryResult> |
updateCanaryAsync(UpdateCanaryRequest updateCanaryRequest)
Use this operation to change the settings of a canary that has already been created.
|
Future<UpdateCanaryResult> |
updateCanaryAsync(UpdateCanaryRequest updateCanaryRequest,
AsyncHandler<UpdateCanaryRequest,UpdateCanaryResult> asyncHandler)
Use this operation to change the settings of a canary that has already been created.
|
createCanary, deleteCanary, describeCanaries, describeCanariesLastRun, describeRuntimeVersions, getCachedResponseMetadata, getCanary, getCanaryRuns, listTagsForResource, shutdown, startCanary, stopCanary, tagResource, untagResource, updateCanaryFuture<CreateCanaryResult> createCanaryAsync(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 - Future<CreateCanaryResult> createCanaryAsync(CreateCanaryRequest createCanaryRequest, AsyncHandler<CreateCanaryRequest,CreateCanaryResult> asyncHandler)
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 - asyncHandler - 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.Future<DeleteCanaryResult> deleteCanaryAsync(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 - Future<DeleteCanaryResult> deleteCanaryAsync(DeleteCanaryRequest deleteCanaryRequest, AsyncHandler<DeleteCanaryRequest,DeleteCanaryResult> asyncHandler)
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 - asyncHandler - 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.Future<DescribeCanariesResult> describeCanariesAsync(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 - Future<DescribeCanariesResult> describeCanariesAsync(DescribeCanariesRequest describeCanariesRequest, AsyncHandler<DescribeCanariesRequest,DescribeCanariesResult> asyncHandler)
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 - asyncHandler - 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.Future<DescribeCanariesLastRunResult> describeCanariesLastRunAsync(DescribeCanariesLastRunRequest describeCanariesLastRunRequest)
Use this operation to see information from the most recent run of each canary that you have created.
describeCanariesLastRunRequest - Future<DescribeCanariesLastRunResult> describeCanariesLastRunAsync(DescribeCanariesLastRunRequest describeCanariesLastRunRequest, AsyncHandler<DescribeCanariesLastRunRequest,DescribeCanariesLastRunResult> asyncHandler)
Use this operation to see information from the most recent run of each canary that you have created.
describeCanariesLastRunRequest - asyncHandler - 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.Future<DescribeRuntimeVersionsResult> describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)
Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
describeRuntimeVersionsRequest - Future<DescribeRuntimeVersionsResult> describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest, AsyncHandler<DescribeRuntimeVersionsRequest,DescribeRuntimeVersionsResult> asyncHandler)
Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
describeRuntimeVersionsRequest - asyncHandler - 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.Future<GetCanaryResult> getCanaryAsync(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 - Future<GetCanaryResult> getCanaryAsync(GetCanaryRequest getCanaryRequest, AsyncHandler<GetCanaryRequest,GetCanaryResult> asyncHandler)
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 - asyncHandler - 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.Future<GetCanaryRunsResult> getCanaryRunsAsync(GetCanaryRunsRequest getCanaryRunsRequest)
Retrieves a list of runs for a specified canary.
getCanaryRunsRequest - Future<GetCanaryRunsResult> getCanaryRunsAsync(GetCanaryRunsRequest getCanaryRunsRequest, AsyncHandler<GetCanaryRunsRequest,GetCanaryRunsResult> asyncHandler)
Retrieves a list of runs for a specified canary.
getCanaryRunsRequest - asyncHandler - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a canary.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with a canary.
listTagsForResourceRequest - asyncHandler - 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.Future<StartCanaryResult> startCanaryAsync(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 - Future<StartCanaryResult> startCanaryAsync(StartCanaryRequest startCanaryRequest, AsyncHandler<StartCanaryRequest,StartCanaryResult> asyncHandler)
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 - asyncHandler - 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.Future<StopCanaryResult> stopCanaryAsync(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 - Future<StopCanaryResult> stopCanaryAsync(StopCanaryRequest stopCanaryRequest, AsyncHandler<StopCanaryRequest,StopCanaryResult> asyncHandler)
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 - asyncHandler - 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.Future<TagResourceResult> tagResourceAsync(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 - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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 - asyncHandler - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified canary.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified canary.
untagResourceRequest - asyncHandler - 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.Future<UpdateCanaryResult> updateCanaryAsync(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 - Future<UpdateCanaryResult> updateCanaryAsync(UpdateCanaryRequest updateCanaryRequest, AsyncHandler<UpdateCanaryRequest,UpdateCanaryResult> asyncHandler)
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 - asyncHandler - 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.