AWSSynthetics (AWS SDK for Java

All Known Subinterfaces:

AWSSyntheticsAsync

All Known Implementing Classes:

AbstractAWSSynthetics, AbstractAWSSyntheticsAsync, AWSSyntheticsAsyncClient, AWSSyntheticsClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSynthetics
```
Interface for accessing Synthetics.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSynthetics 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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateCanaryResult`	`createCanary(CreateCanaryRequest createCanaryRequest)` Creates a canary.
`DeleteCanaryResult`	`deleteCanary(DeleteCanaryRequest deleteCanaryRequest)` Permanently deletes the specified canary.
`DescribeCanariesResult`	`describeCanaries(DescribeCanariesRequest describeCanariesRequest)` This operation returns a list of the canaries in your account, along with full details about each canary.
`DescribeCanariesLastRunResult`	`describeCanariesLastRun(DescribeCanariesLastRunRequest describeCanariesLastRunRequest)` Use this operation to see information from the most recent run of each canary that you have created.
`DescribeRuntimeVersionsResult`	`describeRuntimeVersions(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)` Returns a list of Synthetics canary runtime versions.
`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 getCanaryRequest)` Retrieves complete information about one canary.
`GetCanaryRunsResult`	`getCanaryRuns(GetCanaryRunsRequest getCanaryRunsRequest)` Retrieves a list of runs for a specified canary.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Displays the tags associated with a canary.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartCanaryResult`	`startCanary(StartCanaryRequest startCanaryRequest)` Use this operation to run a canary that has already been created.
`StopCanaryResult`	`stopCanary(StopCanaryRequest stopCanaryRequest)` Stops the canary to prevent all future runs.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Assigns one or more tags (key-value pairs) to the specified canary.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags from the specified canary.
`UpdateCanaryResult`	`updateCanary(UpdateCanaryRequest updateCanaryRequest)` Use this operation to change the settings of a canary that has already been created.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createCanary
```
CreateCanaryResult createCanary(CreateCanaryRequest createCanaryRequest)
```
    Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.
    
    Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.
    
    To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.
    
    Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
    
    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
  - deleteCanary
```
DeleteCanaryResult deleteCanary(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 esources 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.
    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
  - describeCanaries
```
DescribeCanariesResult describeCanaries(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.
    
    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
```
DescribeCanariesLastRunResult describeCanariesLastRun(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.
    
    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
```
DescribeRuntimeVersionsResult describeRuntimeVersions(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest)
```
    Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
    
    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
  - getCanary
```
GetCanaryResult getCanary(GetCanaryRequest getCanaryRequest)
```
    Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.
    
    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
```
GetCanaryRunsResult getCanaryRuns(GetCanaryRunsRequest getCanaryRunsRequest)
```
    Retrieves a list of runs for a specified canary.
    
    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
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Displays the tags associated with a canary.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - startCanary
```
StartCanaryResult startCanary(StartCanaryRequest startCanaryRequest)
```
    Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.
    
    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
```
StopCanaryResult stopCanary(StopCanaryRequest stopCanaryRequest)
```
    Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. The run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.
    
    You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.
    
    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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Assigns one or more tags (key-value pairs) to the specified canary.
    
    Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
    
    Tags don't have any semantic meaning to Amazon Web Services 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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes one or more tags from the specified canary.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unknown internal error occurred.
    
    ResourceNotFoundException - One of the specified resources was not found.
    
    ValidationException - A parameter could not be validated.
    
    See Also:
    
    AWS API Documentation
  - updateCanary
```
UpdateCanaryResult updateCanary(UpdateCanaryRequest updateCanaryRequest)
```
    Use this operation to change the settings of a canary that has already been created.
    
    You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSSynthetics

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createCanary

deleteCanary

describeCanaries

describeCanariesLastRun

describeRuntimeVersions

getCanary

getCanaryRuns

listTagsForResource

startCanary

stopCanary

tagResource

untagResource

updateCanary

shutdown

getCachedResponseMetadata