com.amazonaws.services.pinpointanalytics

Class AmazonPinpointAnalyticsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.pinpointanalytics.AmazonPinpointAnalyticsClient

All Implemented Interfaces:

AmazonPinpointAnalytics

public class AmazonPinpointAnalyticsClient
extends AmazonWebServiceClient
implements AmazonPinpointAnalytics

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

Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale.

Field Summary

Fields

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
void	putEvents(PutEventsRequest putEventsRequest) The PutEvents operation records one or more events.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, 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.pinpointanalytics.AmazonPinpointAnalytics

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

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

List of exception unmarshallers for all Amazon Pinpoint exceptions.

Constructor Detail

AmazonPinpointAnalyticsClient

@Deprecated
public AmazonPinpointAnalyticsClient()

Deprecated.

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

AmazonPinpointAnalyticsClient

@Deprecated
public AmazonPinpointAnalyticsClient(ClientConfiguration clientConfiguration)

Deprecated.

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonPinpointAnalyticsClient

public AmazonPinpointAnalyticsClient(AWSCredentials awsCredentials)

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

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPinpointAnalyticsClient client = new AmazonPinpointAnalyticsClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

AmazonPinpointAnalyticsClient

public AmazonPinpointAnalyticsClient(AWSCredentials awsCredentials,
                                     ClientConfiguration clientConfiguration)

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

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPinpointAnalyticsClient client = new AmazonPinpointAnalyticsClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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 AmazonPinpointAnalytics (ex: proxy settings, retry counts, etc.).

AmazonPinpointAnalyticsClient

public AmazonPinpointAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider)

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

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPinpointAnalyticsClient client = new AmazonPinpointAnalyticsClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

AmazonPinpointAnalyticsClient

public AmazonPinpointAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration)

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

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonPinpointAnalyticsClient client = new AmazonPinpointAnalyticsClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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 AmazonPinpointAnalytics (ex: proxy settings, retry counts, etc.).

AmazonPinpointAnalyticsClient

@Deprecated
public AmazonPinpointAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider,
                                                 ClientConfiguration clientConfiguration,
                                                 RequestMetricCollector requestMetricCollector)

Deprecated.

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

requestMetricCollector - optional request metric collector

AmazonPinpointAnalyticsClient

public AmazonPinpointAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration,
                                     HttpClient httpClient)

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

httpClient - A http client

Method Detail

putEvents

public void putEvents(PutEventsRequest putEventsRequest)
               throws AmazonServiceException,
                      AmazonClientException

The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values.

Specified by:

putEvents in interface AmazonPinpointAnalytics

Parameters:

putEventsRequest -

A container for the data needed for a PutEvent operation

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

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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 AmazonPinpointAnalytics

Parameters:

request - The originally executed request

Returns:

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