@ThreadSafe public class AmazonKinesisFirehoseClient extends AmazonWebServiceClient implements AmazonKinesisFirehose
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.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Firehose exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonKinesisFirehoseClient()
Constructs a new client to invoke service methods on Firehose.
|
AmazonKinesisFirehoseClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Firehose using the
specified AWS account credentials.
|
AmazonKinesisFirehoseClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Firehose using the
specified AWS account credentials and client configuration options.
|
AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Firehose using the
specified AWS account credentials provider.
|
AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Firehose using the
specified AWS account credentials provider and client configuration
options.
|
AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Firehose using the
specified AWS account credentials provider, client configuration options,
and request metric collector.
|
AmazonKinesisFirehoseClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Firehose.
|
Modifier and Type | Method and Description |
---|---|
CreateDeliveryStreamResult |
createDeliveryStream(CreateDeliveryStreamRequest createDeliveryStreamRequest)
Creates a delivery stream.
|
DeleteDeliveryStreamResult |
deleteDeliveryStream(DeleteDeliveryStreamRequest deleteDeliveryStreamRequest)
Deletes a delivery stream and its data.
|
DescribeDeliveryStreamResult |
describeDeliveryStream(DescribeDeliveryStreamRequest describeDeliveryStreamRequest)
Describes the specified delivery stream and gets the status.
|
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.
|
ListDeliveryStreamsResult |
listDeliveryStreams(ListDeliveryStreamsRequest listDeliveryStreamsRequest)
Lists your delivery streams.
|
PutRecordResult |
putRecord(PutRecordRequest putRecordRequest)
Writes a single data record into an Amazon Kinesis Firehose delivery
stream.
|
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.
|
UpdateDestinationResult |
updateDestination(UpdateDestinationRequest updateDestinationRequest)
Updates the specified destination of the specified delivery stream.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers
public AmazonKinesisFirehoseClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonKinesisFirehoseClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Firehose (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonKinesisFirehoseClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonKinesisFirehoseClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Firehose (ex: proxy settings, retry counts, etc.).public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Firehose (ex: proxy settings, retry counts, etc.).public AmazonKinesisFirehoseClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Firehose (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic CreateDeliveryStreamResult createDeliveryStream(CreateDeliveryStreamRequest createDeliveryStreamRequest)
Creates a delivery stream.
CreateDeliveryStream is an asynchronous operation that immediately
returns. The initial status of the delivery stream is
CREATING
. After the delivery stream is created, its status
is ACTIVE
and it now accepts data. Attempts to send data to
a delivery stream that is not in the ACTIVE
state cause an
exception. To check the state of a delivery stream, use
DescribeDeliveryStream.
The name of a delivery stream identifies it. You can't have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name.
By default, you can create up to 20 delivery streams per region.
A delivery stream can only be configured with a single destination, Amazon S3 or Amazon Redshift. For correct CreateDeliveryStream request syntax, specify only one destination configuration parameter: either ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration or S3DestinationConfiguration
As part of S3DestinationConfiguration, optional values BufferingHints, EncryptionConfiguration, and CompressionFormat can be provided. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about RedshiftDestinationConfiguration:
COPY
syntax to load data into an Amazon Redshift table. This
is specified in the
RedshiftDestinationConfiguration.S3Configuration parameter
element.SNAPPY
or ZIP
cannot be specified in
RedshiftDestinationConfiguration.S3Configuration because the
Amazon Redshift COPY
operation that reads from the S3 bucket
doesn't support these compression formats.INSERT
permissions.Firehose assumes the IAM role that is configured as part of destinations. The IAM role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide.
createDeliveryStream
in interface AmazonKinesisFirehose
createDeliveryStreamRequest
- Contains the parameters for CreateDeliveryStream.InvalidArgumentException
- The specified input parameter has an value that is not valid.LimitExceededException
- You have already reached the limit for a requested resource.ResourceInUseException
- The resource is already in use and not available for this
operation.public DeleteDeliveryStreamResult deleteDeliveryStream(DeleteDeliveryStreamRequest deleteDeliveryStreamRequest)
Deletes a delivery stream and its data.
You can delete a delivery stream only if it is in ACTIVE
or
DELETING
state, and not in the CREATING
state.
While the deletion request is in process, the delivery stream is in the
DELETING
state.
To check the state of a delivery stream, use DescribeDeliveryStream.
While the delivery stream is DELETING
state, the service may
continue to accept the records, but the service doesn't make any
guarantees with respect to delivering the data. Therefore, as a best
practice, you should first stop any applications that are sending records
before deleting a delivery stream.
deleteDeliveryStream
in interface AmazonKinesisFirehose
deleteDeliveryStreamRequest
- Contains the parameters for DeleteDeliveryStream.ResourceInUseException
- The resource is already in use and not available for this
operation.ResourceNotFoundException
- The specified resource could not be found.public DescribeDeliveryStreamResult describeDeliveryStream(DescribeDeliveryStreamRequest describeDeliveryStreamRequest)
Describes the specified delivery stream and gets the status. For example,
after your delivery stream is created, call DescribeDeliveryStream
to see if the delivery stream is ACTIVE
and therefore ready
for data to be sent to it.
describeDeliveryStream
in interface AmazonKinesisFirehose
describeDeliveryStreamRequest
- Contains the parameters for DescribeDeliveryStream.ResourceNotFoundException
- The specified resource could not be found.public ListDeliveryStreamsResult listDeliveryStreams(ListDeliveryStreamsRequest listDeliveryStreamsRequest)
Lists your delivery streams.
The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call.
listDeliveryStreams
in interface AmazonKinesisFirehose
listDeliveryStreamsRequest
- Contains the parameters for ListDeliveryStreams.public PutRecordResult putRecord(PutRecordRequest putRecordRequest)
Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. 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. 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, etc.
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 PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.
If the PutRecord 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.
putRecord
in interface AmazonKinesisFirehose
putRecordRequest
- Contains the parameters for PutRecord.ResourceNotFoundException
- The specified resource could not be found.InvalidArgumentException
- The specified input parameter has an value that is not valid.ServiceUnavailableException
- The service is unavailable, back off and retry the operation. If
you continue to see the exception, throughput limits for the
delivery stream may have been exceeded. For more information
about limits and how to request an increase, see Amazon Kinesis Firehose Limits.public 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. 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.
putRecordBatch
in interface AmazonKinesisFirehose
putRecordBatchRequest
- Contains the parameters for PutRecordBatch.ResourceNotFoundException
- The specified resource could not be found.InvalidArgumentException
- The specified input parameter has an value that is not valid.ServiceUnavailableException
- The service is unavailable, back off and retry the operation. If
you continue to see the exception, throughput limits for the
delivery stream may have been exceeded. For more information
about limits and how to request an increase, see Amazon Kinesis Firehose Limits.public UpdateDestinationResult updateDestination(UpdateDestinationRequest updateDestinationRequest)
Updates the specified destination of the specified delivery stream. Note: Switching between Elasticsearch and other services is not supported. For Elasticsearch destination, you can only update an existing Elasticsearch destination with this operation.
This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are normally effective within a few minutes.
If the destination type is the same, Firehose merges the configuration parameters specified in the UpdateDestination request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified then the existing EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified.
Firehose uses the CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the VersionId. After the update is applied successfully, the VersionId is updated, which can be retrieved with the DescribeDeliveryStream operation. The new VersionId should be uses to set CurrentDeliveryStreamVersionId in the next UpdateDestination operation.
updateDestination
in interface AmazonKinesisFirehose
updateDestinationRequest
- Contains the parameters for UpdateDestination.InvalidArgumentException
- The specified input parameter has an value that is not valid.ResourceInUseException
- The resource is already in use and not available for this
operation.ResourceNotFoundException
- The specified resource could not be found.ConcurrentModificationException
- Another modification has already happened. Fetch VersionId
again and use it to update the destination.public 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 the request.
getCachedResponseMetadata
in interface AmazonKinesisFirehose
request
- The originally executed requestCopyright © 2016. All rights reserved.