com.amazonaws.services.synthetics.AWSSynthetics Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.synthetics.model.*;
/**
* Interface for accessing Synthetics.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.synthetics.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSynthetics {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "synthetics";
/**
*
* 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.
*
*
* @param createCanaryRequest
* @return Result of the CreateCanary operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.CreateCanary
* @see AWS API
* Documentation
*/
CreateCanaryResult createCanary(CreateCanaryRequest createCanaryRequest);
/**
*
* Permanently deletes the specified canary.
*
*
* When you delete a canary, resources used and created by the canary are not automatically deleted. After you
* delete a canary that you do not intend to use again, you should also delete the following:
*
*
* -
*
* The Lambda functions and layers used by this canary. These have the prefix
* cwsyn-MyCanaryName .
*
*
* -
*
* The CloudWatch alarms created for this canary. These alarms have a name of
* Synthetics-SharpDrop-Alarm-MyCanaryName .
*
*
* -
*
* Amazon S3 objects and buckets, such as the canary's artifact location.
*
*
* -
*
* IAM roles created for the canary. If they were created in the console, these roles have the name
* role/service-role/CloudWatchSyntheticsRole-MyCanaryName .
*
*
* -
*
* CloudWatch Logs log groups created for the canary. These logs groups have the name
* /aws/lambda/cwsyn-MyCanaryName .
*
*
*
*
* Before you delete a canary, you might want to use GetCanary to display the information about this
* canary. Make note of the information returned by this operation so that you can delete these resources after you
* delete the canary.
*
*
* @param deleteCanaryRequest
* @return Result of the DeleteCanary operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @throws ConflictException
* A conflicting operation is already in progress.
* @sample AWSSynthetics.DeleteCanary
* @see AWS API
* Documentation
*/
DeleteCanaryResult deleteCanary(DeleteCanaryRequest deleteCanaryRequest);
/**
*
* This operation returns a list of the canaries in your account, along with full details about each canary.
*
*
* This operation does not have resource-level authorization, so if a user is able to use
* DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be
* used to restrict access to all canaries. It cannot be used on specific resources.
*
*
* @param describeCanariesRequest
* @return Result of the DescribeCanaries operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.DescribeCanaries
* @see AWS
* API Documentation
*/
DescribeCanariesResult describeCanaries(DescribeCanariesRequest describeCanariesRequest);
/**
*
* Use this operation to see information from the most recent run of each canary that you have created.
*
*
* @param describeCanariesLastRunRequest
* @return Result of the DescribeCanariesLastRun operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.DescribeCanariesLastRun
* @see AWS API Documentation
*/
DescribeCanariesLastRunResult describeCanariesLastRun(DescribeCanariesLastRunRequest describeCanariesLastRunRequest);
/**
*
* Returns a list of Synthetics canary runtime versions. For more information, see
* Canary Runtime Versions.
*
*
* @param describeRuntimeVersionsRequest
* @return Result of the DescribeRuntimeVersions operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.DescribeRuntimeVersions
* @see AWS API Documentation
*/
DescribeRuntimeVersionsResult describeRuntimeVersions(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest);
/**
*
* 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 Result of the GetCanary operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.GetCanary
* @see AWS API
* Documentation
*/
GetCanaryResult getCanary(GetCanaryRequest getCanaryRequest);
/**
*
* Retrieves a list of runs for a specified canary.
*
*
* @param getCanaryRunsRequest
* @return Result of the GetCanaryRuns operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @sample AWSSynthetics.GetCanaryRuns
* @see AWS API
* Documentation
*/
GetCanaryRunsResult getCanaryRuns(GetCanaryRunsRequest getCanaryRunsRequest);
/**
*
* Displays the tags associated with a canary.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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 Result of the StartCanary operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @throws ConflictException
* A conflicting operation is already in progress.
* @sample AWSSynthetics.StartCanary
* @see AWS API
* Documentation
*/
StartCanaryResult startCanary(StartCanaryRequest startCanaryRequest);
/**
*
* 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.
*
*
* @param stopCanaryRequest
* @return Result of the StopCanary operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @throws ConflictException
* A conflicting operation is already in progress.
* @sample AWSSynthetics.StopCanary
* @see AWS API
* Documentation
*/
StopCanaryResult stopCanary(StopCanaryRequest stopCanaryRequest);
/**
*
* Assigns one or more tags (key-value pairs) to the specified canary.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
* granting a user permission to access or change only resources with certain tag values.
*
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
*
*
* You can use the TagResource action with a canary that already has tags. If you specify a new tag key
* for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
* is already associated with the alarm, the new tag value that you specify replaces the previous value for that
* tag.
*
*
* You can associate as many as 50 tags with a canary.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes one or more tags from the specified canary.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @throws ValidationException
* A parameter could not be validated.
* @sample AWSSynthetics.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
*
*
* @param updateCanaryRequest
* @return Result of the UpdateCanary operation returned by the service.
* @throws InternalServerException
* An unknown internal error occurred.
* @throws ValidationException
* A parameter could not be validated.
* @throws ResourceNotFoundException
* One of the specified resources was not found.
* @throws ConflictException
* A conflicting operation is already in progress.
* @sample AWSSynthetics.UpdateCanary
* @see AWS API
* Documentation
*/
UpdateCanaryResult updateCanary(UpdateCanaryRequest updateCanaryRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}