com.amazonaws.services.logs

Class AWSLogsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.logs.AWSLogsClient

All Implemented Interfaces:

AWSLogs

Direct Known Subclasses:

AWSLogsAsyncClient

public class AWSLogsClient
extends AmazonWebServiceClient
implements AWSLogs

Client for accessing AWSLogs. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon CloudWatch Logs Service API Reference

This is the Amazon CloudWatch Logs API Reference . Amazon CloudWatch Logs is a managed service for real time monitoring and archival of application logs. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Logs Developer Guide .

Use the following links to get started using the Amazon CloudWatch Logs API Reference :

• Actions : An alphabetical list of all Amazon CloudWatch Logs actions.
• Data Types : An alphabetical list of all Amazon CloudWatch Logs data types.
• Common Parameters : Parameters that all Query actions can use.
• Common Errors : Client and server errors that all actions can return.
• Regions and Endpoints : Itemized regions and endpoints for all AWS products.

In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.

• AWS SDK for Java Documentation
• AWS SDK for .NET Documentation
• AWS SDK for PHP Documentation
• AWS SDK for Ruby Documentation

Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:

• AWS Java Developer Center
• AWS PHP Developer Center
• AWS Python Developer Center
• AWS Ruby Developer Center
• AWS Windows and .NET Developer Center

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSLogs exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSLogsClient() Constructs a new client to invoke service methods on AWSLogs.
AWSLogsClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials.
AWSLogsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials and client configuration options.
AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials provider.
AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials provider and client configuration options.
AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSLogsClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLogs.

Method Summary

Methods

Modifier and Type	Method and Description
void	createLogGroup(CreateLogGroupRequest createLogGroupRequest) Creates a new log group with the specified name.
void	createLogStream(CreateLogStreamRequest createLogStreamRequest) Creates a new log stream in the specified log group.
void	deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
void	deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) Deletes a log stream and permanently deletes all the archived log events associated with it.
void	deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) Deletes a metric filter associated with the specified log group.
void	deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the retention policy of the specified log group.
DescribeLogGroupsResult	describeLogGroups() Returns all the log groups that are associated with the AWS account making the request.
DescribeLogGroupsResult	describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) Returns all the log groups that are associated with the AWS account making the request.
DescribeLogStreamsResult	describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) Returns all the log streams that are associated with the specified log group.
DescribeMetricFiltersResult	describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) Returns all the metrics filters associated with the specified log 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.
GetLogEventsResult	getLogEvents(GetLogEventsRequest getLogEventsRequest) Retrieves log events from the specified log stream.
PutLogEventsResult	putLogEvents(PutLogEventsRequest putLogEventsRequest) Uploads a batch of log events to the specified log stream.
void	putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) Creates or updates a metric filter and associates it with the specified log group.
void	putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) Sets the retention of the specified log group.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
TestMetricFilterResult	testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) Tests the filter pattern of a metric filter against a sample of log event messages.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.logs.AWSLogs

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AWSLogs exceptions.

Constructor Detail

AWSLogsClient

public AWSLogsClient()

Constructs a new client to invoke service methods on AWSLogs. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSLogsClient

public AWSLogsClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSLogs. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSLogs (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSLogsClient

public AWSLogsClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSLogsClient

public AWSLogsClient(AWSCredentials awsCredentials,
             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSLogs (ex: proxy settings, retry counts, etc.).

AWSLogsClient

public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSLogsClient

public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider,
             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSLogs (ex: proxy settings, retry counts, etc.).

AWSLogsClient

public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider,
             ClientConfiguration clientConfiguration,
             RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWSLogs using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSLogs (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

putRetentionPolicy

public void putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

Specified by:

putRetentionPolicy in interface AWSLogs

Parameters:

putRetentionPolicyRequest - Container for the necessary parameters to execute the PutRetentionPolicy service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeMetricFilters

public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)

Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

Specified by:

describeMetricFilters in interface AWSLogs

Parameters:

describeMetricFiltersRequest - Container for the necessary parameters to execute the DescribeMetricFilters service method on AWSLogs.

Returns:

The response from the DescribeMetricFilters service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeLogStreams

public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)

Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request.

Specified by:

describeLogStreams in interface AWSLogs

Parameters:

describeLogStreamsRequest - Container for the necessary parameters to execute the DescribeLogStreams service method on AWSLogs.

Returns:

The response from the DescribeLogStreams service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteLogGroup

public void deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)

Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.

Specified by:

deleteLogGroup in interface AWSLogs

Parameters:

deleteLogGroupRequest - Container for the necessary parameters to execute the DeleteLogGroup service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

createLogGroup

public void createLogGroup(CreateLogGroupRequest createLogGroupRequest)

Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

You must use the following guidelines when naming a log group:

• Log group names can be between 1 and 512 characters long.
• Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Specified by:

createLogGroup in interface AWSLogs

Parameters:

createLogGroupRequest - Container for the necessary parameters to execute the CreateLogGroup service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceAlreadyExistsException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

putMetricFilter

public void putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.

Specified by:

putMetricFilter in interface AWSLogs

Parameters:

putMetricFilterRequest - Container for the necessary parameters to execute the PutMetricFilter service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteMetricFilter

public void deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)

Deletes a metric filter associated with the specified log group.

Specified by:

deleteMetricFilter in interface AWSLogs

Parameters:

deleteMetricFilterRequest - Container for the necessary parameters to execute the DeleteMetricFilter service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

testMetricFilter

public TestMetricFilterResult testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

Specified by:

testMetricFilter in interface AWSLogs

Parameters:

testMetricFilterRequest - Container for the necessary parameters to execute the TestMetricFilter service method on AWSLogs.

Returns:

The response from the TestMetricFilter service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

putLogEvents

public PutLogEventsResult putLogEvents(PutLogEventsRequest putLogEventsRequest)

Uploads a batch of log events to the specified log stream.

Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken .

The batch of events must satisfy the following constraints:

• The maximum batch size is 32,768 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
• None of the log events in the batch can be more than 2 hours in the future.
• None of the log events in the batch can be older than 14 days or the retention period of the log group.
• The log events in the batch must be in chronological ordered by their timestamp .
• The maximum number of log events in a batch is 1,000.

Specified by:

putLogEvents in interface AWSLogs

Parameters:

putLogEventsRequest - Container for the necessary parameters to execute the PutLogEvents service method on AWSLogs.

Returns:

The response from the PutLogEvents service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

InvalidSequenceTokenException

DataAlreadyAcceptedException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteRetentionPolicy

public void deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)

Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

Specified by:

deleteRetentionPolicy in interface AWSLogs

Parameters:

deleteRetentionPolicyRequest - Container for the necessary parameters to execute the DeleteRetentionPolicy service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

getLogEvents

public GetLogEventsResult getLogEvents(GetLogEventsRequest getLogEventsRequest)

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp .

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

Specified by:

getLogEvents in interface AWSLogs

Parameters:

getLogEventsRequest - Container for the necessary parameters to execute the GetLogEvents service method on AWSLogs.

Returns:

The response from the GetLogEvents service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

createLogStream

public void createLogStream(CreateLogStreamRequest createLogStreamRequest)

Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

You must use the following guidelines when naming a log stream:

• Log stream names can be between 1 and 512 characters long.
• The ':' colon character is not allowed.

Specified by:

createLogStream in interface AWSLogs

Parameters:

createLogStreamRequest - Container for the necessary parameters to execute the CreateLogStream service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

ResourceAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteLogStream

public void deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)

Deletes a log stream and permanently deletes all the archived log events associated with it.

Specified by:

deleteLogStream in interface AWSLogs

Parameters:

deleteLogStreamRequest - Container for the necessary parameters to execute the DeleteLogStream service method on AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeLogGroups

public DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)

Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

Specified by:

describeLogGroups in interface AWSLogs

Parameters:

describeLogGroupsRequest - Container for the necessary parameters to execute the DescribeLogGroups service method on AWSLogs.

Returns:

The response from the DescribeLogGroups service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeLogGroups

public DescribeLogGroupsResult describeLogGroups()
                                          throws AmazonServiceException,
                                                 AmazonClientException

Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

Specified by:

describeLogGroups in interface AWSLogs

Returns:

The response from the DescribeLogGroups service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Specified by:

setEndpoint in interface AWSLogs

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

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 AWSLogs

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.