com.amazonaws.services.config

Class AmazonConfigClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.config.AmazonConfigClient

All Implemented Interfaces:

AmazonConfig

Direct Known Subclasses:

AmazonConfigAsyncClient

public class AmazonConfigClient
extends AmazonWebServiceClient
implements AmazonConfig

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

AWS Config

AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see Supported AWS Resources .

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config

This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.

The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process .

For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config? in the AWS Config Developer Guide .

Field Summary

Fields

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest) Deletes the specified delivery channel.
DeliverConfigSnapshotResult	deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest) Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
DescribeConfigurationRecordersResult	describeConfigurationRecorders() Returns the name of one or more specified configuration recorders.
DescribeConfigurationRecordersResult	describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest) Returns the name of one or more specified configuration recorders.
DescribeConfigurationRecorderStatusResult	describeConfigurationRecorderStatus() Returns the current status of the specified configuration recorder.
DescribeConfigurationRecorderStatusResult	describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest) Returns the current status of the specified configuration recorder.
DescribeDeliveryChannelsResult	describeDeliveryChannels() Returns details about the specified delivery channel.
DescribeDeliveryChannelsResult	describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest) Returns details about the specified delivery channel.
DescribeDeliveryChannelStatusResult	describeDeliveryChannelStatus() Returns the current status of the specified delivery channel.
DescribeDeliveryChannelStatusResult	describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest) Returns the current status of the specified delivery channel.
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.
GetResourceConfigHistoryResult	getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest) Returns a list of configuration items for the specified resource.
void	putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest) Creates a new configuration recorder to record the resource configurations.
void	putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest) Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
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.
void	startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest) Starts recording configurations of all the resources associated with the account.
void	stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest) Stops recording configurations of all the resources associated with the account.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, 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.config.AmazonConfig

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

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

List of exception unmarshallers for all AmazonConfig exceptions.

Constructor Detail

AmazonConfigClient

public AmazonConfigClient()

Constructs a new client to invoke service methods on AmazonConfig. 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

AmazonConfigClient

public AmazonConfigClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonConfig. 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 AmazonConfig (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonConfigClient

public AmazonConfigClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonConfig 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.

AmazonConfigClient

public AmazonConfigClient(AWSCredentials awsCredentials,
                  ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonConfig 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 AmazonConfig (ex: proxy settings, retry counts, etc.).

AmazonConfigClient

public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonConfig 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.

AmazonConfigClient

public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider,
                  ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonConfig 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 AmazonConfig (ex: proxy settings, retry counts, etc.).

AmazonConfigClient

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

Constructs a new client to invoke service methods on AmazonConfig 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 AmazonConfig (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

describeDeliveryChannelStatus

public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

NOTE:Currently, you can specify only one delivery channel per account.

Specified by:

describeDeliveryChannelStatus in interface AmazonConfig

Parameters:

describeDeliveryChannelStatusRequest - Container for the necessary parameters to execute the DescribeDeliveryChannelStatus service method on AmazonConfig.

Returns:

The response from the DescribeDeliveryChannelStatus service method, as returned by AmazonConfig.

Throws:

NoSuchDeliveryChannelException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

describeConfigurationRecorders

public DescribeConfigurationRecordersResult describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)

Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.

NOTE: Currently, you can specify only one configuration recorder per account.

Specified by:

describeConfigurationRecorders in interface AmazonConfig

Parameters:

describeConfigurationRecordersRequest - Container for the necessary parameters to execute the DescribeConfigurationRecorders service method on AmazonConfig.

Returns:

The response from the DescribeConfigurationRecorders service method, as returned by AmazonConfig.

Throws:

NoSuchConfigurationRecorderException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

startConfigurationRecorder

public void startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest)

Starts recording configurations of all the resources associated with the account.

You must have created at least one delivery channel to successfully start the configuration recorder.

Specified by:

startConfigurationRecorder in interface AmazonConfig

Parameters:

startConfigurationRecorderRequest - Container for the necessary parameters to execute the StartConfigurationRecorder service method on AmazonConfig.

Throws:

NoSuchConfigurationRecorderException

NoAvailableDeliveryChannelException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

putDeliveryChannel

public void putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest)

Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

NOTE: Currently, you can specify only one delivery channel per account.

Specified by:

putDeliveryChannel in interface AmazonConfig

Parameters:

putDeliveryChannelRequest - Container for the necessary parameters to execute the PutDeliveryChannel service method on AmazonConfig.

Throws:

InvalidDeliveryChannelNameException

InvalidS3KeyPrefixException

NoAvailableConfigurationRecorderException

NoSuchBucketException

InvalidSNSTopicARNException

InsufficientDeliveryPolicyException

MaxNumberOfDeliveryChannelsExceededException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

deleteDeliveryChannel

public void deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)

Deletes the specified delivery channel.

The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action.

Specified by:

deleteDeliveryChannel in interface AmazonConfig

Parameters:

deleteDeliveryChannelRequest - Container for the necessary parameters to execute the DeleteDeliveryChannel service method on AmazonConfig.

Throws:

NoSuchDeliveryChannelException

LastDeliveryChannelDeleteFailedException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

stopConfigurationRecorder

public void stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest)

Stops recording configurations of all the resources associated with the account.

Specified by:

stopConfigurationRecorder in interface AmazonConfig

Parameters:

stopConfigurationRecorderRequest - Container for the necessary parameters to execute the StopConfigurationRecorder service method on AmazonConfig.

Throws:

NoSuchConfigurationRecorderException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

deliverConfigSnapshot

public DeliverConfigSnapshotResult deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.

• Notification of starting the delivery.
• Notification of delivery completed, if the delivery was successfully completed.
• Notification of delivery failure, if the delivery failed to complete.

Specified by:

deliverConfigSnapshot in interface AmazonConfig

Parameters:

deliverConfigSnapshotRequest - Container for the necessary parameters to execute the DeliverConfigSnapshot service method on AmazonConfig.

Returns:

The response from the DeliverConfigSnapshot service method, as returned by AmazonConfig.

Throws:

NoSuchDeliveryChannelException

NoAvailableConfigurationRecorderException

NoRunningConfigurationRecorderException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

putConfigurationRecorder

public void putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)

Creates a new configuration recorder to record the resource configurations.

You can use this action to change the role ( roleARN ) of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

NOTE: Currently, you can specify only one configuration recorder per account.

Specified by:

putConfigurationRecorder in interface AmazonConfig

Parameters:

putConfigurationRecorderRequest - Container for the necessary parameters to execute the PutConfigurationRecorder service method on AmazonConfig.

Throws:

InvalidRoleException

InvalidConfigurationRecorderNameException

MaxNumberOfConfigurationRecordersExceededException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

getResourceConfigHistory

public GetResourceConfigHistoryResult getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)

Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. You can specify a limit on the number of results returned on the page. If a limit is specified, a nextToken is returned as part of the result that you can use to continue this request.

NOTE: Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken .

Specified by:

getResourceConfigHistory in interface AmazonConfig

Parameters:

getResourceConfigHistoryRequest - Container for the necessary parameters to execute the GetResourceConfigHistory service method on AmazonConfig.

Returns:

The response from the GetResourceConfigHistory service method, as returned by AmazonConfig.

Throws:

InvalidNextTokenException

NoAvailableConfigurationRecorderException

ValidationException

ResourceNotDiscoveredException

InvalidTimeRangeException

InvalidLimitException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

describeDeliveryChannels

public DescribeDeliveryChannelsResult describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

NOTE: Currently, you can specify only one delivery channel per account.

Specified by:

describeDeliveryChannels in interface AmazonConfig

Parameters:

describeDeliveryChannelsRequest - Container for the necessary parameters to execute the DescribeDeliveryChannels service method on AmazonConfig.

Returns:

The response from the DescribeDeliveryChannels service method, as returned by AmazonConfig.

Throws:

NoSuchDeliveryChannelException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

describeConfigurationRecorderStatus

public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.

NOTE:Currently, you can specify only one configuration recorder per account.

Specified by:

describeConfigurationRecorderStatus in interface AmazonConfig

Parameters:

describeConfigurationRecorderStatusRequest - Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus service method on AmazonConfig.

Returns:

The response from the DescribeConfigurationRecorderStatus service method, as returned by AmazonConfig.

Throws:

NoSuchConfigurationRecorderException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

describeDeliveryChannelStatus

public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

NOTE:Currently, you can specify only one delivery channel per account.

Specified by:

describeDeliveryChannelStatus in interface AmazonConfig

Returns:

The response from the DescribeDeliveryChannelStatus service method, as returned by AmazonConfig.

Throws:

NoSuchDeliveryChannelException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

describeConfigurationRecorders

public DescribeConfigurationRecordersResult describeConfigurationRecorders()
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.

NOTE: Currently, you can specify only one configuration recorder per account.

Specified by:

describeConfigurationRecorders in interface AmazonConfig

Returns:

The response from the DescribeConfigurationRecorders service method, as returned by AmazonConfig.

Throws:

NoSuchConfigurationRecorderException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

describeDeliveryChannels

public DescribeDeliveryChannelsResult describeDeliveryChannels()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

NOTE: Currently, you can specify only one delivery channel per account.

Specified by:

describeDeliveryChannels in interface AmazonConfig

Returns:

The response from the DescribeDeliveryChannels service method, as returned by AmazonConfig.

Throws:

NoSuchDeliveryChannelException

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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

describeConfigurationRecorderStatus

public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus()
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.

NOTE:Currently, you can specify only one configuration recorder per account.

Specified by:

describeConfigurationRecorderStatus in interface AmazonConfig

Returns:

The response from the DescribeConfigurationRecorderStatus service method, as returned by AmazonConfig.

Throws:

NoSuchConfigurationRecorderException

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 AmazonConfig 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 AmazonConfig

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 AmazonConfig

Parameters:

request - The originally executed request

Returns:

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