com.amazonaws.services.synthetics.AWSSyntheticsAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-synthetics Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.synthetics;
import javax.annotation.Generated;
import com.amazonaws.services.synthetics.model.*;
/**
* Interface for accessing Synthetics asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync} instead.
*
*
* Amazon CloudWatch Synthetics
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSyntheticsAsync extends AWSSynthetics {
/**
*
* 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.
*
*
* @param associateResourceRequest
* @return A Java Future containing the result of the AssociateResource operation returned by the service.
* @sample AWSSyntheticsAsync.AssociateResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future associateResourceAsync(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.
*
*
* @param associateResourceRequest
* @param 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.
* @return A Java Future containing the result of the AssociateResource operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.AssociateResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future associateResourceAsync(AssociateResourceRequest associateResourceRequest,
com.amazonaws.handlers.AsyncHandler 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 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.
*
*
* @param createCanaryRequest
* @return A Java Future containing the result of the CreateCanary operation returned by the service.
* @sample AWSSyntheticsAsync.CreateCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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 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.
*
*
* @param createCanaryRequest
* @param 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.
* @return A Java Future containing the result of the CreateCanary operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.CreateCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createCanaryAsync(CreateCanaryRequest createCanaryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createGroupRequest
* @return A Java Future containing the result of the CreateGroup operation returned by the service.
* @sample AWSSyntheticsAsync.CreateGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createGroupAsync(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.
*
*
* @param createGroupRequest
* @param 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.
* @return A Java Future containing the result of the CreateGroup operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.CreateGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createGroupAsync(CreateGroupRequest createGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteCanaryRequest
* @return A Java Future containing the result of the DeleteCanary operation returned by the service.
* @sample AWSSyntheticsAsync.DeleteCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteCanaryAsync(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.
*
*
* @param deleteCanaryRequest
* @param 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.
* @return A Java Future containing the result of the DeleteCanary operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.DeleteCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteCanaryAsync(DeleteCanaryRequest deleteCanaryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteGroupRequest
* @return A Java Future containing the result of the DeleteGroup operation returned by the service.
* @sample AWSSyntheticsAsync.DeleteGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteGroupAsync(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.
*
*
* @param deleteGroupRequest
* @param 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.
* @return A Java Future containing the result of the DeleteGroup operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.DeleteGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteGroupAsync(DeleteGroupRequest deleteGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeCanariesRequest
* @return A Java Future containing the result of the DescribeCanaries operation returned by the service.
* @sample AWSSyntheticsAsync.DescribeCanaries
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeCanariesAsync(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.
*
*
* @param describeCanariesRequest
* @param 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.
* @return A Java Future containing the result of the DescribeCanaries operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.DescribeCanaries
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeCanariesAsync(DescribeCanariesRequest describeCanariesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeCanariesLastRunRequest
* @return A Java Future containing the result of the DescribeCanariesLastRun operation returned by the service.
* @sample AWSSyntheticsAsync.DescribeCanariesLastRun
* @see AWS API Documentation
*/
java.util.concurrent.Future describeCanariesLastRunAsync(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.
*
*
* @param describeCanariesLastRunRequest
* @param 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.
* @return A Java Future containing the result of the DescribeCanariesLastRun operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.DescribeCanariesLastRun
* @see AWS API Documentation
*/
java.util.concurrent.Future describeCanariesLastRunAsync(DescribeCanariesLastRunRequest describeCanariesLastRunRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of Synthetics canary runtime versions. For more information, see
* Canary Runtime Versions.
*
*
* @param describeRuntimeVersionsRequest
* @return A Java Future containing the result of the DescribeRuntimeVersions operation returned by the service.
* @sample AWSSyntheticsAsync.DescribeRuntimeVersions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest);
/**
*
* Returns a list of Synthetics canary runtime versions. For more information, see
* Canary Runtime Versions.
*
*
* @param describeRuntimeVersionsRequest
* @param 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.
* @return A Java Future containing the result of the DescribeRuntimeVersions operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.DescribeRuntimeVersions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a canary from a group. You must run this operation in the Region where the canary exists.
*
*
* @param disassociateResourceRequest
* @return A Java Future containing the result of the DisassociateResource operation returned by the service.
* @sample AWSSyntheticsAsync.DisassociateResource
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateResourceAsync(DisassociateResourceRequest disassociateResourceRequest);
/**
*
* Removes a canary from a group. You must run this operation in the Region where the canary exists.
*
*
* @param disassociateResourceRequest
* @param 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.
* @return A Java Future containing the result of the DisassociateResource operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.DisassociateResource
* @see AWS API Documentation
*/
java.util.concurrent.Future disassociateResourceAsync(DisassociateResourceRequest disassociateResourceRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getCanaryRequest
* @return A Java Future containing the result of the GetCanary operation returned by the service.
* @sample AWSSyntheticsAsync.GetCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getCanaryRequest
* @param 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.
* @return A Java Future containing the result of the GetCanary operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.GetCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getCanaryAsync(GetCanaryRequest getCanaryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of runs for a specified canary.
*
*
* @param getCanaryRunsRequest
* @return A Java Future containing the result of the GetCanaryRuns operation returned by the service.
* @sample AWSSyntheticsAsync.GetCanaryRuns
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getCanaryRunsAsync(GetCanaryRunsRequest getCanaryRunsRequest);
/**
*
* Retrieves a list of runs for a specified canary.
*
*
* @param getCanaryRunsRequest
* @param 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.
* @return A Java Future containing the result of the GetCanaryRuns operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.GetCanaryRuns
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getCanaryRunsAsync(GetCanaryRunsRequest getCanaryRunsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
*
*
* @param getGroupRequest
* @return A Java Future containing the result of the GetGroup operation returned by the service.
* @sample AWSSyntheticsAsync.GetGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getGroupAsync(GetGroupRequest getGroupRequest);
/**
*
* Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
*
*
* @param getGroupRequest
* @param 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.
* @return A Java Future containing the result of the GetGroup operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.GetGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getGroupAsync(GetGroupRequest getGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in
* the current Region.
*
*
* @param listAssociatedGroupsRequest
* @return A Java Future containing the result of the ListAssociatedGroups operation returned by the service.
* @sample AWSSyntheticsAsync.ListAssociatedGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future listAssociatedGroupsAsync(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.
*
*
* @param listAssociatedGroupsRequest
* @param 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.
* @return A Java Future containing the result of the ListAssociatedGroups operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.ListAssociatedGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future listAssociatedGroupsAsync(ListAssociatedGroupsRequest listAssociatedGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* This operation returns a list of the ARNs of the canaries that are associated with the specified group.
*
*
* @param listGroupResourcesRequest
* @return A Java Future containing the result of the ListGroupResources operation returned by the service.
* @sample AWSSyntheticsAsync.ListGroupResources
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest);
/**
*
* This operation returns a list of the ARNs of the canaries that are associated with the specified group.
*
*
* @param listGroupResourcesRequest
* @param 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.
* @return A Java Future containing the result of the ListGroupResources operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.ListGroupResources
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all
* Regions are returned.
*
*
* @param listGroupsRequest
* @return A Java Future containing the result of the ListGroups operation returned by the service.
* @sample AWSSyntheticsAsync.ListGroups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listGroupsAsync(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.
*
*
* @param listGroupsRequest
* @param 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.
* @return A Java Future containing the result of the ListGroups operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.ListGroups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listGroupsAsync(ListGroupsRequest listGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Displays the tags associated with a canary or group.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSSyntheticsAsync.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Displays the tags associated with a canary or group.
*
*
* @param listTagsForResourceRequest
* @param 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.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param startCanaryRequest
* @return A Java Future containing the result of the StartCanary operation returned by the service.
* @sample AWSSyntheticsAsync.StartCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param startCanaryRequest
* @param 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.
* @return A Java Future containing the result of the StartCanary operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.StartCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startCanaryAsync(StartCanaryRequest startCanaryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param stopCanaryRequest
* @return A Java Future containing the result of the StopCanary operation returned by the service.
* @sample AWSSyntheticsAsync.StopCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopCanaryAsync(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.
*
*
* @param stopCanaryRequest
* @param 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.
* @return A Java Future containing the result of the StopCanary operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.StopCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopCanaryAsync(StopCanaryRequest stopCanaryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSSyntheticsAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(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.
*
*
* @param tagResourceRequest
* @param 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.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes one or more tags from the specified resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSSyntheticsAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes one or more tags from the specified resource.
*
*
* @param untagResourceRequest
* @param 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.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param updateCanaryRequest
* @return A Java Future containing the result of the UpdateCanary operation returned by the service.
* @sample AWSSyntheticsAsync.UpdateCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateCanaryAsync(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.
*
*
* @param updateCanaryRequest
* @param 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.
* @return A Java Future containing the result of the UpdateCanary operation returned by the service.
* @sample AWSSyntheticsAsyncHandler.UpdateCanary
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateCanaryAsync(UpdateCanaryRequest updateCanaryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}