/* * Copyright 2010-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.kinesisfirehose; import java.util.*; import com.amazonaws.*; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.metrics.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.services.kinesisfirehose.model.*; import com.amazonaws.services.kinesisfirehose.model.transform.*; /** * 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 Data Firehose is a fully managed service that delivers * real-time streaming data to destinations such as Amazon Simple Storage * Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and * various other supportd destinations. *
*/ public class AmazonKinesisFirehoseClient extends AmazonWebServiceClient implements AmazonKinesisFirehose { /** Provider for AWS credentials. */ private AWSCredentialsProvider awsCredentialsProvider; /** * List of exception unmarshallers for all Amazon Kinesis Firehose * exceptions. */ protected List* All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonKinesisFirehoseClient() { this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration()); } /** * Constructs a new client to invoke service methods on * AmazonKinesisFirehose. A credentials provider chain will be used that * searches for credentials in this order: *
* All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @param clientConfiguration The client configuration options controlling * how this client connects to AmazonKinesisFirehose (ex: proxy * settings, retry counts, etc.). * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonKinesisFirehoseClient(ClientConfiguration clientConfiguration) { this(new DefaultAWSCredentialsProviderChain(), clientConfiguration); } /** * Constructs a new client to invoke service methods on * AmazonKinesisFirehose using the specified AWS account credentials. *
* The client requests are authenticated using the {@link 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 {@link AWSMobileClient}. Please see * https://aws-amplify.github.io/docs/android/authentication for * instructions on how to enable {@link AWSMobileClient}. * *
* AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { * @Override * public void onResult(final UserStateDetails details) { * AmazonKinesisFirehoseClient client = new AmazonKinesisFirehoseClient(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. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. */ public AmazonKinesisFirehoseClient(AWSCredentials awsCredentials) { this(awsCredentials, new ClientConfiguration()); } /** * Constructs a new client to invoke service methods on * AmazonKinesisFirehose using the specified AWS account credentials and * client configuration options. *
* The client requests are authenticated using the {@link 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 {@link AWSMobileClient}. Please see * https://aws-amplify.github.io/docs/android/authentication for * instructions on how to enable {@link AWSMobileClient}. * *
* AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { * @Override * public void onResult(final UserStateDetails details) { * AmazonKinesisFirehoseClient client = new AmazonKinesisFirehoseClient(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. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. * @param clientConfiguration The client configuration options controlling * how this client connects to AmazonKinesisFirehose (ex: proxy * settings, retry counts, etc.). */ public AmazonKinesisFirehoseClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) { this(new StaticCredentialsProvider(awsCredentials), clientConfiguration); } /** * Constructs a new client to invoke service methods on * AmazonKinesisFirehose using the specified AWS account credentials * provider. *
* The client requests are authenticated using the {@link AWSCredentials} * provided by the {@link AWSCredentialsProvider}. 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 {@link AWSMobileClient}. Please see * https://aws-amplify.github.io/docs/android/authentication for * instructions on how to enable {@link AWSMobileClient}. * *
* AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { * @Override * public void onResult(final UserStateDetails details) { * AmazonKinesisFirehoseClient client = new AmazonKinesisFirehoseClient(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. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. */ public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, new ClientConfiguration()); } /** * Constructs a new client to invoke service methods on * AmazonKinesisFirehose using the specified AWS account credentials * provider and client configuration options. *
* The client requests are authenticated using the {@link AWSCredentials} * provided by the {@link AWSCredentialsProvider}. 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 {@link AWSMobileClient}. Please see * https://aws-amplify.github.io/docs/android/authentication for * instructions on how to enable {@link AWSMobileClient}. * *
* AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { * @Override * public void onResult(final UserStateDetails details) { * AmazonKinesisFirehoseClient client = new AmazonKinesisFirehoseClient(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. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration The client configuration options controlling * how this client connects to AmazonKinesisFirehose (ex: proxy * settings, retry counts, etc.). */ public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, new UrlHttpClient(clientConfiguration)); } /** * 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. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration The client configuration options controlling * how this client connects to AmazonKinesisFirehose (ex: proxy * settings, retry counts, etc.). * @param requestMetricCollector optional request metric collector */ @Deprecated public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) { super(adjustClientConfiguration(clientConfiguration), requestMetricCollector); this.awsCredentialsProvider = awsCredentialsProvider; init(); } /** * Constructs a new client to invoke service methods on * AmazonKinesisFirehose using the specified AWS account credentials * provider, client configuration options and request metric collector. *
* The client requests are authenticated using the {@link AWSCredentials} * provided by the {@link AWSCredentialsProvider}. 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 {@link AWSMobileClient}. Please see * https://aws-amplify.github.io/docs/android/authentication for * instructions on how to enable {@link AWSMobileClient}. * *
* AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { * @Override * public void onResult(final UserStateDetails details) { * AmazonKinesisFirehoseClient client = new AmazonKinesisFirehoseClient(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.
*
* @param awsCredentialsProvider The AWS credentials provider which will
* provide credentials to authenticate requests with AWS
* services.
* @param clientConfiguration The client configuration options controlling
* how this client connects to AmazonKinesisFirehose (ex: proxy
* settings, retry counts, etc.).
* @param httpClient A http client
*/
public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration, HttpClient httpClient) {
super(adjustClientConfiguration(clientConfiguration), httpClient);
this.awsCredentialsProvider = awsCredentialsProvider;
init();
}
private void init() {
jsonErrorUnmarshallers = new ArrayList
* 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.
*
* For information about service quota, see Amazon
* Kinesis Data Firehose Quota.
*
* Each PutRecordBatch request supports up to 500 records. Each
* record in the request can be as large as 1,000 KB (before base64
* encoding), up to a limit of 4 MB for the entire request. These limits
* cannot be changed.
*
* 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, it could be
* a segment from a log file, geographic location data, website clickstream
* data, and so on.
*
* Kinesis Data 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 (
*
* The PutRecordBatch response includes a count of failed records,
*
* A successfully processed record includes a
* If there is an internal server error or a timeout, the write might have
* completed or it might have failed. If
* If PutRecordBatch throws
* Data records sent to Kinesis Data 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.
*
* Don't concatenate two or more base64 strings to form the data fields of
* your records. Instead, concatenate the raw data, then perform base64
* encoding.
*
* 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.
*
* @param request The originally executed request
* @return The response metadata for the specified request, or null if none
* is available.
* @deprecated ResponseMetadata cache can hold up to 50 requests and
* responses in memory and will cause memory issue. This method
* now always returns null.
*/
@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
private \n
) or some other character unique within the data. This
* allows the consumer application to parse individual data items when
* reading the data from the destination.
* FailedPutCount
, and an array of responses,
* RequestResponses
. Even if the PutRecordBatch call
* succeeds, the value of FailedPutCount
may be greater than 0,
* indicating that there are records for which the operation didn't succeed.
* Each entry in the RequestResponses
array provides additional
* information about the processed record. It directly correlates with a
* record in the request array using the same ordering, from the top to the
* bottom. The response array always includes the same number of records as
* the request array. RequestResponses
includes both
* successfully and unsuccessfully processed records. Kinesis Data Firehose
* tries to process all records in each PutRecordBatch request. A
* single record failure does not stop the processing of subsequent records.
* RecordId
value,
* which is unique 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: ServiceUnavailableException
or
* InternalFailure
. ErrorMessage
provides more
* detailed information about the error.
* FailedPutCount
is
* greater than 0, retry the request, resending only those records that
* might have failed processing. This minimizes the possible duplicate
* records and also reduces the total bytes sent (and corresponding
* charges). We recommend that you handle any duplicates at the destination.
* ServiceUnavailableException
,
* back off and retry. If the exception persists, it is possible that the
* throughput limits have been exceeded for the delivery stream.
*