com.amazonaws.services.kinesisfirehose

Class AmazonKinesisFirehoseClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kinesisfirehose.AmazonKinesisFirehoseClient

All Implemented Interfaces:

AmazonKinesisFirehose

public class AmazonKinesisFirehoseClient
extends AmazonWebServiceClient
implements AmazonKinesisFirehose

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

Amazon Kinesis Firehose API Reference

Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.

Field Summary

Fields

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Constructor Summary

Constructors

Constructor and Description
AmazonKinesisFirehoseClient() Deprecated.
AmazonKinesisFirehoseClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonKinesisFirehose using the specified AWS account credentials.
AmazonKinesisFirehoseClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonKinesisFirehose using the specified AWS account credentials and client configuration options.
AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonKinesisFirehose using the specified AWS account credentials provider.
AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonKinesisFirehose using the specified AWS account credentials provider and client configuration options.
AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonKinesisFirehose using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated.
AmazonKinesisFirehoseClient(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.
PutRecordBatchResult	putRecordBatch(PutRecordBatchRequest putRecordBatchRequest) Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, 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.kinesisfirehose.AmazonKinesisFirehose

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

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

List of exception unmarshallers for all Amazon Kinesis Firehose exceptions.

Constructor Detail

AmazonKinesisFirehoseClient

@Deprecated
public AmazonKinesisFirehoseClient()

Deprecated.

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

AmazonKinesisFirehoseClient

@Deprecated
public AmazonKinesisFirehoseClient(ClientConfiguration clientConfiguration)

Deprecated.

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonKinesisFirehoseClient

public AmazonKinesisFirehoseClient(AWSCredentials awsCredentials)

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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.

AmazonKinesisFirehoseClient

public AmazonKinesisFirehoseClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration)

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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

AmazonKinesisFirehoseClient

public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider)

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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.

AmazonKinesisFirehoseClient

public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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

AmazonKinesisFirehoseClient

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

Deprecated.

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

requestMetricCollector - optional request metric collector

AmazonKinesisFirehoseClient

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

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

httpClient - A http client

Method Detail

putRecordBatch

public PutRecordBatchResult putRecordBatch(PutRecordBatchRequest putRecordBatchRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.

Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on.

Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.

The PutRecordBatch response includes a count of any failed records, FailedPutCount, and an array of responses, RequestResponses. The FailedPutCount value is a count of records that failed. Each entry in the RequestResponses array gives additional information of the processed record. Each entry in RequestResponses directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. RequestResponses always includes the same number of records as the request array. RequestResponses both successfully and unsuccessfully processed records. Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes a RecordId value, which is a unique value identified for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error.

If FailedPutCount is greater than 0 (zero), retry the request. A retry of the entire batch of records is possible; however, we strongly recommend that you inspect the entire response and resend only those records that failed processing. This minimizes duplicate records and also reduces the total bytes sent (and corresponding charges).

If the PutRecordBatch operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Specified by:

putRecordBatch in interface AmazonKinesisFirehose

Parameters:

putRecordBatchRequest -

Contains the parameters for PutRecordBatch.

Returns:

putRecordBatchResult The response from the PutRecordBatch service method, as returned by Amazon Kinesis Firehose.

Throws:

ResourceNotFoundException

InvalidArgumentException

ServiceUnavailableException

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 Kinesis Firehose 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 AmazonKinesisFirehose

Parameters:

request - The originally executed request

Returns:

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