AWSSyntheticsClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.synthetics.AWSSyntheticsClient

All Implemented Interfaces:

AWSSynthetics

Direct Known Subclasses:

AWSSyntheticsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSyntheticsClient
extends AmazonWebServiceClient
implements AWSSynthetics
```
Client for accessing Synthetics. All service calls made using this client are blocking, and will not return until the service call completes.
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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.synthetics.AWSSynthetics
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateResourceResult`	`associateResource(AssociateResourceRequest request)` Associates a canary with a group.
`static AWSSyntheticsClientBuilder`	`builder()`
`CreateCanaryResult`	`createCanary(CreateCanaryRequest request)` Creates a canary.
`CreateGroupResult`	`createGroup(CreateGroupRequest request)` Creates a group which you can use to associate canaries with each other, including cross-Region canaries.
`DeleteCanaryResult`	`deleteCanary(DeleteCanaryRequest request)` Permanently deletes the specified canary.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Deletes a group.
`DescribeCanariesResult`	`describeCanaries(DescribeCanariesRequest request)` This operation returns a list of the canaries in your account, along with full details about each canary.
`DescribeCanariesLastRunResult`	`describeCanariesLastRun(DescribeCanariesLastRunRequest request)` Use this operation to see information from the most recent run of each canary that you have created.
`DescribeRuntimeVersionsResult`	`describeRuntimeVersions(DescribeRuntimeVersionsRequest request)` Returns a list of Synthetics canary runtime versions.
`DisassociateResourceResult`	`disassociateResource(DisassociateResourceRequest request)` Removes a canary from a group.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetCanaryResult`	`getCanary(GetCanaryRequest request)` Retrieves complete information about one canary.
`GetCanaryRunsResult`	`getCanaryRuns(GetCanaryRunsRequest request)` Retrieves a list of runs for a specified canary.
`GetGroupResult`	`getGroup(GetGroupRequest request)` Returns information about one group.
`ListAssociatedGroupsResult`	`listAssociatedGroups(ListAssociatedGroupsRequest request)` Returns a list of the groups that the specified canary is associated with.
`ListGroupResourcesResult`	`listGroupResources(ListGroupResourcesRequest request)` This operation returns a list of the ARNs of the canaries that are associated with the specified group.
`ListGroupsResult`	`listGroups(ListGroupsRequest request)` Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Displays the tags associated with a canary or group.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartCanaryResult`	`startCanary(StartCanaryRequest request)` Use this operation to run a canary that has already been created.
`StopCanaryResult`	`stopCanary(StopCanaryRequest request)` Stops the canary to prevent all future runs.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns one or more tags (key-value pairs) to the specified canary or group.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from the specified resource.
`UpdateCanaryResult`	`updateCanary(UpdateCanaryRequest request)` Updates the configuration of a canary that has already been created.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSSyntheticsClientBuilder builder()
```
  - associateResource
```
public AssociateResourceResult associateResource(AssociateResourceRequest request)
```
    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.
    
    Specified by:
    
    associateResource in interface AWSSynthetics
    
    Parameters:
    
    associateResourceRequest -
    
    Returns:
    
    Result of the AssociateResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    ServiceQuotaExceededException - The request exceeded a service quota value.
    
    See Also:
    
    AWS API Documentation
  - createCanary
```
public CreateCanaryResult createCanary(CreateCanaryRequest request)
```
    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.
    
    Specified by:
    
    createCanary in interface AWSSynthetics
    
    Parameters:
    
    createCanaryRequest -
    
    Returns:
    
    Result of the CreateCanary operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    RequestEntityTooLargeException - One of the input resources is larger than is allowed.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    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.
    
    Specified by:
    
    createGroup in interface AWSSynthetics
    
    Parameters:
    
    createGroupRequest -
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ConflictException - A conflicting operation is already in progress.
    
    ServiceQuotaExceededException - The request exceeded a service quota value.
    
    See Also:
    
    AWS API Documentation
  - deleteCanary
```
public DeleteCanaryResult deleteCanary(DeleteCanaryRequest request)
```
    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.
    Specified by:
    
    deleteCanary in interface AWSSynthetics
    
    Parameters:
    
    deleteCanaryRequest -
    
    Returns:
    
    Result of the DeleteCanary operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    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.
    
    Specified by:
    
    deleteGroup in interface AWSSynthetics
    
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - describeCanaries
```
public DescribeCanariesResult describeCanaries(DescribeCanariesRequest request)
```
    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.
    
    Specified by:
    
    describeCanaries in interface AWSSynthetics
    
    Parameters:
    
    describeCanariesRequest -
    
    Returns:
    
    Result of the DescribeCanaries operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - describeCanariesLastRun
```
public DescribeCanariesLastRunResult describeCanariesLastRun(DescribeCanariesLastRunRequest request)
```
    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.
    
    Specified by:
    
    describeCanariesLastRun in interface AWSSynthetics
    
    Parameters:
    
    describeCanariesLastRunRequest -
    
    Returns:
    
    Result of the DescribeCanariesLastRun operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - describeRuntimeVersions
```
public DescribeRuntimeVersionsResult describeRuntimeVersions(DescribeRuntimeVersionsRequest request)
```
    Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
    
    Specified by:
    
    describeRuntimeVersions in interface AWSSynthetics
    
    Parameters:
    
    describeRuntimeVersionsRequest -
    
    Returns:
    
    Result of the DescribeRuntimeVersions operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - disassociateResource
```
public DisassociateResourceResult disassociateResource(DisassociateResourceRequest request)
```
    Removes a canary from a group. You must run this operation in the Region where the canary exists.
    
    Specified by:
    
    disassociateResource in interface AWSSynthetics
    
    Parameters:
    
    disassociateResourceRequest -
    
    Returns:
    
    Result of the DisassociateResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - getCanary
```
public GetCanaryResult getCanary(GetCanaryRequest request)
```
    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.
    
    Specified by:
    
    getCanary in interface AWSSynthetics
    
    Parameters:
    
    getCanaryRequest -
    
    Returns:
    
    Result of the GetCanary operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - getCanaryRuns
```
public GetCanaryRunsResult getCanaryRuns(GetCanaryRunsRequest request)
```
    Retrieves a list of runs for a specified canary.
    
    Specified by:
    
    getCanaryRuns in interface AWSSynthetics
    
    Parameters:
    
    getCanaryRunsRequest -
    
    Returns:
    
    Result of the GetCanaryRuns operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    See Also:
    
    AWS API Documentation
  - getGroup
```
public GetGroupResult getGroup(GetGroupRequest request)
```
    Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
    
    Specified by:
    
    getGroup in interface AWSSynthetics
    
    Parameters:
    
    getGroupRequest -
    
    Returns:
    
    Result of the GetGroup operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedGroups
```
public ListAssociatedGroupsResult listAssociatedGroups(ListAssociatedGroupsRequest request)
```
    Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.
    
    Specified by:
    
    listAssociatedGroups in interface AWSSynthetics
    
    Parameters:
    
    listAssociatedGroupsRequest -
    
    Returns:
    
    Result of the ListAssociatedGroups operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    See Also:
    
    AWS API Documentation
  - listGroupResources
```
public ListGroupResourcesResult listGroupResources(ListGroupResourcesRequest request)
```
    This operation returns a list of the ARNs of the canaries that are associated with the specified group.
    
    Specified by:
    
    listGroupResources in interface AWSSynthetics
    
    Parameters:
    
    listGroupResourcesRequest -
    
    Returns:
    
    Result of the ListGroupResources operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.
    
    Specified by:
    
    listGroups in interface AWSSynthetics
    
    Parameters:
    
    listGroupsRequest -
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Displays the tags associated with a canary or group.
    
    Specified by:
    
    listTagsForResource in interface AWSSynthetics
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    BadRequestException - The request was not valid.
    
    NotFoundException - The specified resource was not found.
    
    TooManyRequestsException - There were too many simultaneous requests. Try the operation again.
    
    ConflictException - A conflicting operation is already in progress.
    
    InternalFailureException - An internal failure occurred. Try the operation again.
    
    See Also:
    
    AWS API Documentation
  - startCanary
```
public StartCanaryResult startCanary(StartCanaryRequest request)
```
    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.
    
    Specified by:
    
    startCanary in interface AWSSynthetics
    
    Parameters:
    
    startCanaryRequest -
    
    Returns:
    
    Result of the StartCanary operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - stopCanary
```
public StopCanaryResult stopCanary(StopCanaryRequest request)
```
    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.
    
    Specified by:
    
    stopCanary in interface AWSSynthetics
    
    Parameters:
    
    stopCanaryRequest -
    
    Returns:
    
    Result of the StopCanary operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AWSSynthetics
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    BadRequestException - The request was not valid.
    
    NotFoundException - The specified resource was not found.
    
    TooManyRequestsException - There were too many simultaneous requests. Try the operation again.
    
    ConflictException - A conflicting operation is already in progress.
    
    InternalFailureException - An internal failure occurred. Try the operation again.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from the specified resource.
    
    Specified by:
    
    untagResource in interface AWSSynthetics
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    BadRequestException - The request was not valid.
    
    NotFoundException - The specified resource was not found.
    
    TooManyRequestsException - There were too many simultaneous requests. Try the operation again.
    
    ConflictException - A conflicting operation is already in progress.
    
    InternalFailureException - An internal failure occurred. Try the operation again.
    
    See Also:
    
    AWS API Documentation
  - updateCanary
```
public UpdateCanaryResult updateCanary(UpdateCanaryRequest request)
```
    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.
    
    Specified by:
    
    updateCanary in interface AWSSynthetics
    
    Parameters:
    
    updateCanaryRequest -
    
    Returns:
    
    Result of the UpdateCanary operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ValidationException - A parameter could not be validated.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ConflictException - A conflicting operation is already in progress.
    
    RequestEntityTooLargeException - One of the input resources is larger than is allowed.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSSynthetics
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSSynthetics
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSSyntheticsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.synthetics.AWSSynthetics

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

associateResource

createCanary

createGroup

deleteCanary

deleteGroup

describeCanaries

describeCanariesLastRun

describeRuntimeVersions

disassociateResource

getCanary

getCanaryRuns

getGroup

listAssociatedGroups

listGroupResources

listGroups

listTagsForResource

startCanary

stopCanary

tagResource

untagResource

updateCanary

getCachedResponseMetadata

shutdown