com.amazonaws.services.mobileanalytics

Class AmazonMobileAnalyticsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mobileanalytics.AmazonMobileAnalyticsClient

All Implemented Interfaces:

AmazonMobileAnalytics

Direct Known Subclasses:

AmazonMobileAnalyticsAsyncClient

public class AmazonMobileAnalyticsClient
extends AmazonWebServiceClient
implements AmazonMobileAnalytics

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

A service which is used to record Amazon Mobile Analytics events

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonMobileAnalytics exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	putEvents(PutEventsRequest putEventsRequest) Record a batch of events
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(java.lang.String endpoint, java.lang.String serviceName, java.lang.String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.

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.mobileanalytics.AmazonMobileAnalytics

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected java.util.List<JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonMobileAnalytics exceptions.

Constructor Detail

AmazonMobileAnalyticsClient

public AmazonMobileAnalyticsClient()

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

AmazonMobileAnalyticsClient

public AmazonMobileAnalyticsClient(ClientConfiguration clientConfiguration)

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonMobileAnalyticsClient

public AmazonMobileAnalyticsClient(AWSCredentials awsCredentials)

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

AmazonMobileAnalyticsClient

public AmazonMobileAnalyticsClient(AWSCredentials awsCredentials,
                           ClientConfiguration clientConfiguration)

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

AmazonMobileAnalyticsClient

public AmazonMobileAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider)

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

AmazonMobileAnalyticsClient

public AmazonMobileAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration)

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

AmazonMobileAnalyticsClient

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

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

requestMetricCollector - optional request metric collector

Method Detail

putEvents

public void putEvents(PutEventsRequest putEventsRequest)

Record a batch of events

Specified by:

putEvents in interface AmazonMobileAnalytics

Parameters:

putEventsRequest - Container for the necessary parameters to execute the PutEvents service method on AmazonMobileAnalytics.

Throws:

BadRequestException

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

setEndpoint

public void setEndpoint(java.lang.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 AmazonMobileAnalytics

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(java.lang.String endpoint,
               java.lang.String serviceName,
               java.lang.String regionId)
                 throws java.lang.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:

java.lang.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 AmazonMobileAnalytics

Parameters:

request - The originally executed request

Returns:

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