public interface AmazonKinesisFirehose
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 Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.
|Modifier and Type||Method and Description|
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records.
Overrides the default endpoint for this client ("https://firehose.us-east-1.amazonaws.com").
An alternative to
Shuts down this client object, releasing any resources that might be held open.
void setEndpoint(java.lang.String endpoint) throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex:
"firehose.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://firehose.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
This method is not threadsafe. An endpoint 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 or retrying.
endpoint- The endpoint (ex: "firehose.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://firehose.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
java.lang.IllegalArgumentException- If any problems are detected with the specified endpoint.
void setRegion(Region region) throws java.lang.IllegalArgumentException
setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the
supplied at construction.
This method is not threadsafe. A region 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 or retrying.
region- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)for accessing a given region.
java.lang.IllegalArgumentException- If the given region is null, or if this service isn't available in the given region. See
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
PutRecordBatchResult putRecordBatch(PutRecordBatchRequest putRecordBatchRequest) throws AmazonClientException, AmazonServiceException
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.
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. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits.
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. 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 (
\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.
The PutRecordBatch response includes a count of failed records,
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.
A successfully processed record includes a
which is unique for the record. An unsuccessfully processed record
ErrorCode reflects the type of error, and is one of the
ErrorMessage provides more
detailed information about the error.
If there is an internal server error or a timeout, the write might have
completed or it might have failed. If
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.
If PutRecordBatch throws
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 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.
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.
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request- The originally executed request.
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.