AmazonKinesisFirehose (AWS SDK for Java

All Known Subinterfaces:

AmazonKinesisFirehoseAsync

All Known Implementing Classes:

AbstractAmazonKinesisFirehose, AbstractAmazonKinesisFirehoseAsync, AmazonKinesisFirehoseAsyncClient, AmazonKinesisFirehoseClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisFirehose
```
Interface for accessing Firehose.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisFirehose instead.

Amazon Kinesis Data Firehose API Reference
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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CreateDeliveryStreamResult`	`createDeliveryStream(CreateDeliveryStreamRequest createDeliveryStreamRequest)` Creates a Kinesis Data Firehose 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.
`ListTagsForDeliveryStreamResult`	`listTagsForDeliveryStream(ListTagsForDeliveryStreamRequest listTagsForDeliveryStreamRequest)` Lists the tags for the specified delivery stream.
`PutRecordResult`	`putRecord(PutRecordRequest putRecordRequest)` Writes a single data record into an Amazon Kinesis Data 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.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagDeliveryStreamResult`	`tagDeliveryStream(TagDeliveryStreamRequest tagDeliveryStreamRequest)` Adds or updates tags for the specified delivery stream.
`UntagDeliveryStreamResult`	`untagDeliveryStream(UntagDeliveryStreamRequest untagDeliveryStreamRequest)` Removes tags from the specified delivery stream.
`UpdateDestinationResult`	`updateDestination(UpdateDestinationRequest updateDestinationRequest)` Updates the specified destination of the specified delivery stream.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://firehose.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    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.
    
    Parameters:
    
    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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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 ClientConfiguration 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.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createDeliveryStream
```
CreateDeliveryStreamResult createDeliveryStream(CreateDeliveryStreamRequest createDeliveryStreamRequest)
```
    Creates a Kinesis Data Firehose delivery stream.
    
    By default, you can create up to 50 delivery streams per AWS Region.
    
    This 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.
    
    A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.
    
    A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.
    
    When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be 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 Amazon Redshift as a destination:
    - An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
    - The compression formats 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.
    - We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.
    Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
    Parameters:
    
    createDeliveryStreamRequest -
    
    Returns:
    
    Result of the CreateDeliveryStream operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - The specified input parameter has a 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.
    
    See Also:
    
    AWS API Documentation
  - deleteDeliveryStream
```
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 might continue to accept the records, but it 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.
    
    Parameters:
    
    deleteDeliveryStreamRequest -
    
    Returns:
    
    Result of the DeleteDeliveryStream operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The resource is already in use and not available for this operation.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    See Also:
    
    AWS API Documentation
  - describeDeliveryStream
```
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 whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.
    
    Parameters:
    
    describeDeliveryStreamRequest -
    
    Returns:
    
    Result of the DescribeDeliveryStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    See Also:
    
    AWS API Documentation
  - listDeliveryStreams
```
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.
    
    Parameters:
    
    listDeliveryStreamsRequest -
    
    Returns:
    
    Result of the ListDeliveryStreams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForDeliveryStream
```
ListTagsForDeliveryStreamResult listTagsForDeliveryStream(ListTagsForDeliveryStreamRequest listTagsForDeliveryStreamRequest)
```
    Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.
    
    Parameters:
    
    listTagsForDeliveryStreamRequest -
    
    Returns:
    
    Result of the ListTagsForDeliveryStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidArgumentException - The specified input parameter has a value that is not valid.
    
    LimitExceededException - You have already reached the limit for a requested resource.
    
    See Also:
    
    AWS API Documentation
  - putRecord
```
PutRecordResult putRecord(PutRecordRequest putRecordRequest)
```
    Writes a single data record into an Amazon Kinesis Data 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. 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 Data 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, it can 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 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 Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
    
    Parameters:
    
    putRecordRequest -
    
    Returns:
    
    Result of the PutRecord operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidArgumentException - The specified input parameter has a 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 Data Firehose Limits.
    
    See Also:
    
    AWS API Documentation
  - putRecordBatch
```
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.
    
    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. 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 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: ServiceUnavailable or InternalFailure. 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 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.
    
    If PutRecordBatch throws 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 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.
    
    Parameters:
    
    putRecordBatchRequest -
    
    Returns:
    
    Result of the PutRecordBatch operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidArgumentException - The specified input parameter has a 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 Data Firehose Limits.
    
    See Also:
    
    AWS API Documentation
  - tagDeliveryStream
```
TagDeliveryStreamResult tagDeliveryStream(TagDeliveryStreamRequest tagDeliveryStreamRequest)
```
    Adds or updates tags for the specified delivery stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
    
    Each delivery stream can have up to 50 tags.
    
    This operation has a limit of five transactions per second per account.
    
    Parameters:
    
    tagDeliveryStreamRequest -
    
    Returns:
    
    Result of the TagDeliveryStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    ResourceInUseException - The resource is already in use and not available for this operation.
    
    InvalidArgumentException - The specified input parameter has a value that is not valid.
    
    LimitExceededException - You have already reached the limit for a requested resource.
    
    See Also:
    
    AWS API Documentation
  - untagDeliveryStream
```
UntagDeliveryStreamResult untagDeliveryStream(UntagDeliveryStreamRequest untagDeliveryStreamRequest)
```
    Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.
    
    If you specify a tag that doesn't exist, the operation ignores it.
    
    This operation has a limit of five transactions per second per account.
    
    Parameters:
    
    untagDeliveryStreamRequest -
    
    Returns:
    
    Result of the UntagDeliveryStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    ResourceInUseException - The resource is already in use and not available for this operation.
    
    InvalidArgumentException - The specified input parameter has a value that is not valid.
    
    LimitExceededException - You have already reached the limit for a requested resource.
    
    See Also:
    
    AWS API Documentation
  - updateDestination
```
UpdateDestinationResult updateDestination(UpdateDestinationRequest updateDestinationRequest)
```
    Updates the specified destination of the specified delivery stream.
    
    Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might 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 usually effective within a few minutes.
    
    Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.
    
    If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values 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, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.
    
    Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
    
    Parameters:
    
    updateDestinationRequest -
    
    Returns:
    
    Result of the UpdateDestination operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - The specified input parameter has a 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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. 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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonKinesisFirehose

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

createDeliveryStream

deleteDeliveryStream

describeDeliveryStream

listDeliveryStreams

listTagsForDeliveryStream

putRecord

putRecordBatch

tagDeliveryStream

untagDeliveryStream

updateDestination

shutdown

getCachedResponseMetadata