com.amazonaws.services.synthetics.AWSSyntheticsClient 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 org.w3c.dom.*;
import java.net.*;
import java.util.*;
import javax.annotation.Generated;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.annotation.SdkInternalApi;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.internal.*;
import com.amazonaws.internal.auth.*;
import com.amazonaws.metrics.*;
import com.amazonaws.regions.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.protocol.json.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.annotation.ThreadSafe;
import com.amazonaws.client.AwsSyncClientParams;
import com.amazonaws.client.builder.AdvancedConfig;
import com.amazonaws.services.synthetics.AWSSyntheticsClientBuilder;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.synthetics.model.*;
import com.amazonaws.services.synthetics.model.transform.*;
/**
* 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.
*
*/
@ThreadSafe
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AWSSyntheticsClient extends AmazonWebServiceClient implements AWSSynthetics {
/** Provider for AWS credentials. */
private final AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AWSSynthetics.class);
/** Default signing name for the service. */
private static final String DEFAULT_SIGNING_NAME = "synthetics";
/** Client configuration factory providing ClientConfigurations tailored to this client */
protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory();
private final AdvancedConfig advancedConfig;
private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory(
new JsonClientMetadata()
.withProtocolVersion("1.1")
.withSupportsCbor(false)
.withSupportsIon(false)
.withContentTypeOverride("")
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller(
com.amazonaws.services.synthetics.model.transform.ConflictExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller(
com.amazonaws.services.synthetics.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller(
com.amazonaws.services.synthetics.model.transform.ValidationExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller(
com.amazonaws.services.synthetics.model.transform.InternalServerExceptionUnmarshaller.getInstance()))
.withBaseServiceExceptionClass(com.amazonaws.services.synthetics.model.AWSSyntheticsException.class));
public static AWSSyntheticsClientBuilder builder() {
return AWSSyntheticsClientBuilder.standard();
}
/**
* Constructs a new client to invoke service methods on Synthetics using the specified parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AWSSyntheticsClient(AwsSyncClientParams clientParams) {
this(clientParams, false);
}
/**
* Constructs a new client to invoke service methods on Synthetics using the specified parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AWSSyntheticsClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) {
super(clientParams);
this.awsCredentialsProvider = clientParams.getCredentialsProvider();
this.advancedConfig = clientParams.getAdvancedConfig();
init();
}
private void init() {
setServiceNameIntern(DEFAULT_SIGNING_NAME);
setEndpointPrefix(ENDPOINT_PREFIX);
// calling this.setEndPoint(...) will also modify the signer accordingly
setEndpoint("synthetics.us-east-1.amazonaws.com");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/synthetics/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/synthetics/request.handler2s"));
requestHandler2s.addAll(chainFactory.getGlobalHandlers());
}
/**
*
* 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
*/
@Override
public CreateCanaryResult createCanary(CreateCanaryRequest request) {
request = beforeClientExecution(request);
return executeCreateCanary(request);
}
@SdkInternalApi
final CreateCanaryResult executeCreateCanary(CreateCanaryRequest createCanaryRequest) {
ExecutionContext executionContext = createExecutionContext(createCanaryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateCanaryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(createCanaryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateCanary");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateCanaryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public DeleteCanaryResult deleteCanary(DeleteCanaryRequest request) {
request = beforeClientExecution(request);
return executeDeleteCanary(request);
}
@SdkInternalApi
final DeleteCanaryResult executeDeleteCanary(DeleteCanaryRequest deleteCanaryRequest) {
ExecutionContext executionContext = createExecutionContext(deleteCanaryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteCanaryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(deleteCanaryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DeleteCanary");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeleteCanaryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public DescribeCanariesResult describeCanaries(DescribeCanariesRequest request) {
request = beforeClientExecution(request);
return executeDescribeCanaries(request);
}
@SdkInternalApi
final DescribeCanariesResult executeDescribeCanaries(DescribeCanariesRequest describeCanariesRequest) {
ExecutionContext executionContext = createExecutionContext(describeCanariesRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeCanariesRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeCanariesRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeCanaries");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeCanariesResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public DescribeCanariesLastRunResult describeCanariesLastRun(DescribeCanariesLastRunRequest request) {
request = beforeClientExecution(request);
return executeDescribeCanariesLastRun(request);
}
@SdkInternalApi
final DescribeCanariesLastRunResult executeDescribeCanariesLastRun(DescribeCanariesLastRunRequest describeCanariesLastRunRequest) {
ExecutionContext executionContext = createExecutionContext(describeCanariesLastRunRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeCanariesLastRunRequestProtocolMarshaller(protocolFactory).marshall(super
.beforeMarshalling(describeCanariesLastRunRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeCanariesLastRun");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new DescribeCanariesLastRunResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public DescribeRuntimeVersionsResult describeRuntimeVersions(DescribeRuntimeVersionsRequest request) {
request = beforeClientExecution(request);
return executeDescribeRuntimeVersions(request);
}
@SdkInternalApi
final DescribeRuntimeVersionsResult executeDescribeRuntimeVersions(DescribeRuntimeVersionsRequest describeRuntimeVersionsRequest) {
ExecutionContext executionContext = createExecutionContext(describeRuntimeVersionsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeRuntimeVersionsRequestProtocolMarshaller(protocolFactory).marshall(super
.beforeMarshalling(describeRuntimeVersionsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeRuntimeVersions");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new DescribeRuntimeVersionsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public GetCanaryResult getCanary(GetCanaryRequest request) {
request = beforeClientExecution(request);
return executeGetCanary(request);
}
@SdkInternalApi
final GetCanaryResult executeGetCanary(GetCanaryRequest getCanaryRequest) {
ExecutionContext executionContext = createExecutionContext(getCanaryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetCanaryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getCanaryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetCanary");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetCanaryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public GetCanaryRunsResult getCanaryRuns(GetCanaryRunsRequest request) {
request = beforeClientExecution(request);
return executeGetCanaryRuns(request);
}
@SdkInternalApi
final GetCanaryRunsResult executeGetCanaryRuns(GetCanaryRunsRequest getCanaryRunsRequest) {
ExecutionContext executionContext = createExecutionContext(getCanaryRunsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetCanaryRunsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getCanaryRunsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetCanaryRuns");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetCanaryRunsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) {
request = beforeClientExecution(request);
return executeListTagsForResource(request);
}
@SdkInternalApi
final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) {
ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListTagsForResourceRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listTagsForResourceRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListTagsForResource");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListTagsForResourceResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public StartCanaryResult startCanary(StartCanaryRequest request) {
request = beforeClientExecution(request);
return executeStartCanary(request);
}
@SdkInternalApi
final StartCanaryResult executeStartCanary(StartCanaryRequest startCanaryRequest) {
ExecutionContext executionContext = createExecutionContext(startCanaryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new StartCanaryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(startCanaryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "StartCanary");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new StartCanaryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public StopCanaryResult stopCanary(StopCanaryRequest request) {
request = beforeClientExecution(request);
return executeStopCanary(request);
}
@SdkInternalApi
final StopCanaryResult executeStopCanary(StopCanaryRequest stopCanaryRequest) {
ExecutionContext executionContext = createExecutionContext(stopCanaryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new StopCanaryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(stopCanaryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "StopCanary");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new StopCanaryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public TagResourceResult tagResource(TagResourceRequest request) {
request = beforeClientExecution(request);
return executeTagResource(request);
}
@SdkInternalApi
final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) {
ExecutionContext executionContext = createExecutionContext(tagResourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new TagResourceRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(tagResourceRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "TagResource");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new TagResourceResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public UntagResourceResult untagResource(UntagResourceRequest request) {
request = beforeClientExecution(request);
return executeUntagResource(request);
}
@SdkInternalApi
final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) {
ExecutionContext executionContext = createExecutionContext(untagResourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UntagResourceRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(untagResourceRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UntagResource");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UntagResourceResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*/
@Override
public UpdateCanaryResult updateCanary(UpdateCanaryRequest request) {
request = beforeClientExecution(request);
return executeUpdateCanary(request);
}
@SdkInternalApi
final UpdateCanaryResult executeUpdateCanary(UpdateCanaryRequest updateCanaryRequest) {
ExecutionContext executionContext = createExecutionContext(updateCanaryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UpdateCanaryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(updateCanaryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "synthetics");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UpdateCanary");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UpdateCanaryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
return invoke(request, responseHandler, executionContext, null, null);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI cachedEndpoint, URI uriFromEndpointTrait) {
executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider));
return doInvoke(request, responseHandler, executionContext, cachedEndpoint, uriFromEndpointTrait);
}
/**
* Invoke with no authentication. Credentials are not required and any credentials set on the client or request will
* be ignored for this operation.
**/
private Response anonymousInvoke(Request request,
HttpResponseHandler> responseHandler, ExecutionContext executionContext) {
return doInvoke(request, responseHandler, executionContext, null, null);
}
/**
* Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the
* ExecutionContext beforehand.
**/
private Response doInvoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI discoveredEndpoint, URI uriFromEndpointTrait) {
if (discoveredEndpoint != null) {
request.setEndpoint(discoveredEndpoint);
request.getOriginalRequest().getRequestClientOptions().appendUserAgent("endpoint-discovery");
} else if (uriFromEndpointTrait != null) {
request.setEndpoint(uriFromEndpointTrait);
} else {
request.setEndpoint(endpoint);
}
request.setTimeOffset(timeOffset);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata());
return client.execute(request, responseHandler, errorResponseHandler, executionContext);
}
@com.amazonaws.annotation.SdkInternalApi
static com.amazonaws.protocol.json.SdkJsonProtocolFactory getProtocolFactory() {
return protocolFactory;
}
}