@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSynthetics extends Object implements AWSSynthetics
AWSSynthetics. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
CreateCanaryResult |
createCanary(CreateCanaryRequest request)
Creates a canary.
|
DeleteCanaryResult |
deleteCanary(DeleteCanaryRequest request)
Permanently deletes the specified canary.
|
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.
|
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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
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 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.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified canary.
|
UpdateCanaryResult |
updateCanary(UpdateCanaryRequest request)
Use this operation to change the settings of a canary that has already been created.
|
public CreateCanaryResult createCanary(CreateCanaryRequest request)
AWSSyntheticsCreates 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.
createCanary in interface AWSSyntheticspublic DeleteCanaryResult deleteCanary(DeleteCanaryRequest request)
AWSSyntheticsPermanently 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.
deleteCanary in interface AWSSyntheticspublic DescribeCanariesResult describeCanaries(DescribeCanariesRequest request)
AWSSyntheticsThis 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.
describeCanaries in interface AWSSyntheticspublic DescribeCanariesLastRunResult describeCanariesLastRun(DescribeCanariesLastRunRequest request)
AWSSyntheticsUse this operation to see information from the most recent run of each canary that you have created.
describeCanariesLastRun in interface AWSSyntheticspublic DescribeRuntimeVersionsResult describeRuntimeVersions(DescribeRuntimeVersionsRequest request)
AWSSyntheticsReturns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
describeRuntimeVersions in interface AWSSyntheticspublic GetCanaryResult getCanary(GetCanaryRequest request)
AWSSyntheticsRetrieves 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.
getCanary in interface AWSSyntheticspublic GetCanaryRunsResult getCanaryRuns(GetCanaryRunsRequest request)
AWSSyntheticsRetrieves a list of runs for a specified canary.
getCanaryRuns in interface AWSSyntheticspublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSyntheticsDisplays the tags associated with a canary.
listTagsForResource in interface AWSSyntheticspublic StartCanaryResult startCanary(StartCanaryRequest request)
AWSSynthetics
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.
startCanary in interface AWSSyntheticspublic StopCanaryResult stopCanary(StopCanaryRequest request)
AWSSyntheticsStops 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.
stopCanary in interface AWSSyntheticspublic TagResourceResult tagResource(TagResourceRequest request)
AWSSyntheticsAssigns 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.
tagResource in interface AWSSyntheticspublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSSyntheticsRemoves one or more tags from the specified canary.
untagResource in interface AWSSyntheticspublic UpdateCanaryResult updateCanary(UpdateCanaryRequest request)
AWSSyntheticsUse 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.
updateCanary in interface AWSSyntheticspublic void shutdown()
AWSSyntheticsshutdown in interface AWSSyntheticspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSyntheticsResponse 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.
getCachedResponseMetadata in interface AWSSyntheticsrequest - The originally executed request.