software.amazon.awssdk.services.firehose.DefaultFirehoseClient Maven / Gradle / Ivy
Show all versions of firehose Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.firehose;
import java.util.Collections;
import java.util.List;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.awscore.client.handler.AwsSyncClientHandler;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.awscore.internal.AwsProtocolMetadata;
import software.amazon.awssdk.awscore.internal.AwsServiceProtocol;
import software.amazon.awssdk.awscore.retry.AwsRetryStrategy;
import software.amazon.awssdk.core.RequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkPlugin;
import software.amazon.awssdk.core.SdkRequest;
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientOption;
import software.amazon.awssdk.core.client.handler.ClientExecutionParams;
import software.amazon.awssdk.core.client.handler.SyncClientHandler;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.core.http.HttpResponseHandler;
import software.amazon.awssdk.core.metrics.CoreMetric;
import software.amazon.awssdk.core.retry.RetryMode;
import software.amazon.awssdk.metrics.MetricCollector;
import software.amazon.awssdk.metrics.MetricPublisher;
import software.amazon.awssdk.metrics.NoOpMetricCollector;
import software.amazon.awssdk.protocols.core.ExceptionMetadata;
import software.amazon.awssdk.protocols.json.AwsJsonProtocol;
import software.amazon.awssdk.protocols.json.AwsJsonProtocolFactory;
import software.amazon.awssdk.protocols.json.BaseAwsJsonProtocolFactory;
import software.amazon.awssdk.protocols.json.JsonOperationMetadata;
import software.amazon.awssdk.retries.api.RetryStrategy;
import software.amazon.awssdk.services.firehose.internal.FirehoseServiceClientConfigurationBuilder;
import software.amazon.awssdk.services.firehose.model.ConcurrentModificationException;
import software.amazon.awssdk.services.firehose.model.CreateDeliveryStreamRequest;
import software.amazon.awssdk.services.firehose.model.CreateDeliveryStreamResponse;
import software.amazon.awssdk.services.firehose.model.DeleteDeliveryStreamRequest;
import software.amazon.awssdk.services.firehose.model.DeleteDeliveryStreamResponse;
import software.amazon.awssdk.services.firehose.model.DescribeDeliveryStreamRequest;
import software.amazon.awssdk.services.firehose.model.DescribeDeliveryStreamResponse;
import software.amazon.awssdk.services.firehose.model.FirehoseException;
import software.amazon.awssdk.services.firehose.model.InvalidArgumentException;
import software.amazon.awssdk.services.firehose.model.InvalidKmsResourceException;
import software.amazon.awssdk.services.firehose.model.InvalidSourceException;
import software.amazon.awssdk.services.firehose.model.LimitExceededException;
import software.amazon.awssdk.services.firehose.model.ListDeliveryStreamsRequest;
import software.amazon.awssdk.services.firehose.model.ListDeliveryStreamsResponse;
import software.amazon.awssdk.services.firehose.model.ListTagsForDeliveryStreamRequest;
import software.amazon.awssdk.services.firehose.model.ListTagsForDeliveryStreamResponse;
import software.amazon.awssdk.services.firehose.model.PutRecordBatchRequest;
import software.amazon.awssdk.services.firehose.model.PutRecordBatchResponse;
import software.amazon.awssdk.services.firehose.model.PutRecordRequest;
import software.amazon.awssdk.services.firehose.model.PutRecordResponse;
import software.amazon.awssdk.services.firehose.model.ResourceInUseException;
import software.amazon.awssdk.services.firehose.model.ResourceNotFoundException;
import software.amazon.awssdk.services.firehose.model.ServiceUnavailableException;
import software.amazon.awssdk.services.firehose.model.StartDeliveryStreamEncryptionRequest;
import software.amazon.awssdk.services.firehose.model.StartDeliveryStreamEncryptionResponse;
import software.amazon.awssdk.services.firehose.model.StopDeliveryStreamEncryptionRequest;
import software.amazon.awssdk.services.firehose.model.StopDeliveryStreamEncryptionResponse;
import software.amazon.awssdk.services.firehose.model.TagDeliveryStreamRequest;
import software.amazon.awssdk.services.firehose.model.TagDeliveryStreamResponse;
import software.amazon.awssdk.services.firehose.model.UntagDeliveryStreamRequest;
import software.amazon.awssdk.services.firehose.model.UntagDeliveryStreamResponse;
import software.amazon.awssdk.services.firehose.model.UpdateDestinationRequest;
import software.amazon.awssdk.services.firehose.model.UpdateDestinationResponse;
import software.amazon.awssdk.services.firehose.transform.CreateDeliveryStreamRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.DeleteDeliveryStreamRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.DescribeDeliveryStreamRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.ListDeliveryStreamsRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.ListTagsForDeliveryStreamRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.PutRecordBatchRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.PutRecordRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.StartDeliveryStreamEncryptionRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.StopDeliveryStreamEncryptionRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.TagDeliveryStreamRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.UntagDeliveryStreamRequestMarshaller;
import software.amazon.awssdk.services.firehose.transform.UpdateDestinationRequestMarshaller;
import software.amazon.awssdk.utils.Logger;
/**
* Internal implementation of {@link FirehoseClient}.
*
* @see FirehoseClient#builder()
*/
@Generated("software.amazon.awssdk:codegen")
@SdkInternalApi
final class DefaultFirehoseClient implements FirehoseClient {
private static final Logger log = Logger.loggerFor(DefaultFirehoseClient.class);
private static final AwsProtocolMetadata protocolMetadata = AwsProtocolMetadata.builder()
.serviceProtocol(AwsServiceProtocol.AWS_JSON).build();
private final SyncClientHandler clientHandler;
private final AwsJsonProtocolFactory protocolFactory;
private final SdkClientConfiguration clientConfiguration;
protected DefaultFirehoseClient(SdkClientConfiguration clientConfiguration) {
this.clientHandler = new AwsSyncClientHandler(clientConfiguration);
this.clientConfiguration = clientConfiguration.toBuilder().option(SdkClientOption.SDK_CLIENT, this).build();
this.protocolFactory = init(AwsJsonProtocolFactory.builder()).build();
}
/**
*
* Creates a Firehose stream.
*
*
* By default, you can create up to 50 Firehose streams per Amazon Web Services Region.
*
*
* This is an asynchronous operation that immediately returns. The initial status of the Firehose stream is
* CREATING. After the Firehose stream is created, its status is ACTIVE and it now accepts
* data. If the Firehose stream creation fails, the status transitions to CREATING_FAILED. Attempts to
* send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the
* state of a Firehose stream, use DescribeDeliveryStream.
*
*
* If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't
* invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream
* operation to delete it.
*
*
* A Firehose 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.
*
*
* To create a Firehose stream with server-side encryption (SSE) enabled, include
* DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke
* StartDeliveryStreamEncryption to turn on SSE for an existing Firehose stream that doesn't have SSE
* enabled.
*
*
* A Firehose stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3),
* Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or
* HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace,
* LogicMonitor, MongoDB, New Relic, and Sumo Logic. 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, 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. 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 Firehose, and that the
* permissions for the account are restricted for Amazon Redshift INSERT permissions.
*
*
*
*
* Firehose assumes the IAM role that is configured as part of the destination. The role should allow the 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 Firehose Access
* to an Amazon S3 Destination in the Amazon Firehose Developer Guide.
*
*
* @param createDeliveryStreamRequest
* @return Result of the CreateDeliveryStream operation returned by the service.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws LimitExceededException
* You have already reached the limit for a requested resource.
* @throws ResourceInUseException
* The resource is already in use and not available for this operation.
* @throws InvalidKmsResourceException
* Firehose throws this exception when an attempt to put records or to start or stop Firehose stream
* encryption fails. This happens when the KMS service throws one of the following exception types:
* AccessDeniedException, InvalidStateException, DisabledException,
* or NotFoundException.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.CreateDeliveryStream
* @see AWS
* API Documentation
*/
@Override
public CreateDeliveryStreamResponse createDeliveryStream(CreateDeliveryStreamRequest createDeliveryStreamRequest)
throws InvalidArgumentException, LimitExceededException, ResourceInUseException, InvalidKmsResourceException,
AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, CreateDeliveryStreamResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(createDeliveryStreamRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, createDeliveryStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "CreateDeliveryStream");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("CreateDeliveryStream").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(createDeliveryStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new CreateDeliveryStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Deletes a Firehose stream and its data.
*
*
* You can delete a Firehose stream only if it is in one of the following states: ACTIVE,
* DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a Firehose
* stream that is in the CREATING state. To check the state of a Firehose stream, use
* DescribeDeliveryStream.
*
*
* DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the Firehose
* stream is marked for deletion, and it goes into the DELETING state.While the Firehose stream is in
* the DELETING state, the service might continue to accept records, but it doesn't make any guarantees
* with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending
* records before you delete a Firehose stream.
*
*
* Removal of a Firehose stream that is in the DELETING state is a low priority operation for the
* service. A stream may remain in the DELETING state for several minutes. Therefore, as a best
* practice, applications should not wait for streams in the DELETING state to be removed.
*
*
* @param deleteDeliveryStreamRequest
* @return Result of the DeleteDeliveryStream operation returned by the service.
* @throws ResourceInUseException
* The resource is already in use and not available for this operation.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.DeleteDeliveryStream
* @see AWS
* API Documentation
*/
@Override
public DeleteDeliveryStreamResponse deleteDeliveryStream(DeleteDeliveryStreamRequest deleteDeliveryStreamRequest)
throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DeleteDeliveryStreamResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(deleteDeliveryStreamRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteDeliveryStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteDeliveryStream");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DeleteDeliveryStream").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(deleteDeliveryStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteDeliveryStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Describes the specified Firehose stream and its status. For example, after your Firehose stream is created, call
* DescribeDeliveryStream to see whether the Firehose stream is ACTIVE and therefore ready
* for data to be sent to it.
*
*
* If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't
* invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation
* to delete it. If the status is DELETING_FAILED, you can force deletion by invoking
* DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.
*
*
* @param describeDeliveryStreamRequest
* @return Result of the DescribeDeliveryStream operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.DescribeDeliveryStream
* @see AWS API Documentation
*/
@Override
public DescribeDeliveryStreamResponse describeDeliveryStream(DescribeDeliveryStreamRequest describeDeliveryStreamRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, DescribeDeliveryStreamResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(describeDeliveryStreamRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeDeliveryStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeDeliveryStream");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DescribeDeliveryStream").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(describeDeliveryStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeDeliveryStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Lists your Firehose streams in alphabetical order of their names.
*
*
* The number of Firehose streams might be too large to return using a single call to
* ListDeliveryStreams. You can limit the number of Firehose 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 Firehose streams to list, you can request
* them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to
* the name of the last Firehose stream returned in the last call.
*
*
* @param listDeliveryStreamsRequest
* @return Result of the ListDeliveryStreams operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.ListDeliveryStreams
* @see AWS
* API Documentation
*/
@Override
public ListDeliveryStreamsResponse listDeliveryStreams(ListDeliveryStreamsRequest listDeliveryStreamsRequest)
throws AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, ListDeliveryStreamsResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(listDeliveryStreamsRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, listDeliveryStreamsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListDeliveryStreams");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("ListDeliveryStreams").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(listDeliveryStreamsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListDeliveryStreamsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Lists the tags for the specified Firehose stream. This operation has a limit of five transactions per second per
* account.
*
*
* @param listTagsForDeliveryStreamRequest
* @return Result of the ListTagsForDeliveryStream operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws LimitExceededException
* You have already reached the limit for a requested resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.ListTagsForDeliveryStream
* @see AWS API Documentation
*/
@Override
public ListTagsForDeliveryStreamResponse listTagsForDeliveryStream(
ListTagsForDeliveryStreamRequest listTagsForDeliveryStreamRequest) throws ResourceNotFoundException,
InvalidArgumentException, LimitExceededException, AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, ListTagsForDeliveryStreamResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(listTagsForDeliveryStreamRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, listTagsForDeliveryStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListTagsForDeliveryStream");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("ListTagsForDeliveryStream").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(listTagsForDeliveryStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListTagsForDeliveryStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Writes a single data record into an Firehose stream. To write multiple data records into a Firehose stream, use
* PutRecordBatch. Applications using these operations are referred to as producers.
*
*
* By default, each Firehose 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 Firehose stream. For more information about limits and how to request an increase, see Amazon Firehose Limits.
*
*
* Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is
* possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due
* to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch
* metrics.
*
*
* You must specify the name of the Firehose stream and the data record when using PutRecord. The data record
* consists of a data blob that can be up to 1,000 KiB 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.
*
*
* For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than
* 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work
* as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of
* de-aggregated base64 decoded records.
*
*
* 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, the API is
* automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits
* have been exceeded for the Firehose stream.
*
*
* Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For
* larger data assets, allow for a longer time out before retrying Put API operations.
*
*
* Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose 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.
*
*
*
* 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.
*
*
*
* @param putRecordRequest
* @return Result of the PutRecord operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws InvalidKmsResourceException
* Firehose throws this exception when an attempt to put records or to start or stop Firehose stream
* encryption fails. This happens when the KMS service throws one of the following exception types:
* AccessDeniedException, InvalidStateException, DisabledException,
* or NotFoundException.
* @throws InvalidSourceException
* Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
* @throws ServiceUnavailableException
* The service is unavailable. Back off and retry the operation. If you continue to see the exception,
* throughput limits for the Firehose stream may have been exceeded. For more information about limits and
* how to request an increase, see Amazon Firehose Limits.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.PutRecord
* @see AWS API
* Documentation
*/
@Override
public PutRecordResponse putRecord(PutRecordRequest putRecordRequest) throws ResourceNotFoundException,
InvalidArgumentException, InvalidKmsResourceException, InvalidSourceException, ServiceUnavailableException,
AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
PutRecordResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(putRecordRequest, this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, putRecordRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutRecord");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutRecord").withProtocolMetadata(protocolMetadata).withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withRequestConfiguration(clientConfiguration)
.withInput(putRecordRequest).withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutRecordRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Writes multiple data records into a Firehose stream in a single call, which can achieve higher throughput per
* producer than when writing single records. To write single data records into a Firehose stream, use
* PutRecord. Applications using these operations are referred to as producers.
*
*
* Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is
* possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due
* to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch
* metrics.
*
*
* For information about service quota, see Amazon 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 Firehose 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.
*
*
* For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than
* 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work
* as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of
* de-aggregated base64 decoded records.
*
*
* 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. 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:
* ServiceUnavailableException 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, the API is automatically reinvoked
* (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for
* the Firehose stream.
*
*
* Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For
* larger data assets, allow for a longer time out before retrying Put API operations.
*
*
* Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose 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.
*
*
*
* @param putRecordBatchRequest
* @return Result of the PutRecordBatch operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws InvalidKmsResourceException
* Firehose throws this exception when an attempt to put records or to start or stop Firehose stream
* encryption fails. This happens when the KMS service throws one of the following exception types:
* AccessDeniedException, InvalidStateException, DisabledException,
* or NotFoundException.
* @throws InvalidSourceException
* Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
* @throws ServiceUnavailableException
* The service is unavailable. Back off and retry the operation. If you continue to see the exception,
* throughput limits for the Firehose stream may have been exceeded. For more information about limits and
* how to request an increase, see Amazon Firehose Limits.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.PutRecordBatch
* @see AWS API
* Documentation
*/
@Override
public PutRecordBatchResponse putRecordBatch(PutRecordBatchRequest putRecordBatchRequest) throws ResourceNotFoundException,
InvalidArgumentException, InvalidKmsResourceException, InvalidSourceException, ServiceUnavailableException,
AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
PutRecordBatchResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(putRecordBatchRequest, this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, putRecordBatchRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutRecordBatch");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutRecordBatch").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(putRecordBatchRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutRecordBatchRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Enables server-side encryption (SSE) for the Firehose stream.
*
*
* This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption
* status of the stream to ENABLING, and then to ENABLED. The encryption status of a
* Firehose stream is the Status property in DeliveryStreamEncryptionConfiguration. If the
* operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and
* write data to your Firehose stream while the encryption status is ENABLING, but the data is not
* encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all
* records written to the Firehose stream are encrypted. To find out whether a record or a batch of records was
* encrypted, check the response elements PutRecordOutput$Encrypted and
* PutRecordBatchOutput$Encrypted, respectively.
*
*
* To check the encryption status of a Firehose stream, use DescribeDeliveryStream.
*
*
* Even if encryption is currently enabled for a Firehose stream, you can still invoke this operation on it to
* change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK
* is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement.
* If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the
* new CMK to encrypt and decrypt data and to manage the grant.
*
*
* For the KMS grant creation to be successful, the Firehose API operations
* StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with
* session credentials that are more than 6 hours old.
*
*
* If a Firehose stream already has encryption enabled and then you invoke this operation to change the ARN of the
* CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change
* the CMK failed. In this case, encryption remains enabled with the old CMK.
*
*
* If the encryption status of your Firehose stream is ENABLING_FAILED, you can invoke this operation
* again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for
* Firehose to invoke KMS encrypt and decrypt operations.
*
*
* You can enable SSE for a Firehose stream only if it's a Firehose stream that uses DirectPut as its
* source.
*
*
* The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a
* combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call
* StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for
* the same Firehose stream in a 24-hour period.
*
*
* @param startDeliveryStreamEncryptionRequest
* @return Result of the StartDeliveryStreamEncryption operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ResourceInUseException
* The resource is already in use and not available for this operation.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws LimitExceededException
* You have already reached the limit for a requested resource.
* @throws InvalidKmsResourceException
* Firehose throws this exception when an attempt to put records or to start or stop Firehose stream
* encryption fails. This happens when the KMS service throws one of the following exception types:
* AccessDeniedException, InvalidStateException, DisabledException,
* or NotFoundException.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.StartDeliveryStreamEncryption
* @see AWS API Documentation
*/
@Override
public StartDeliveryStreamEncryptionResponse startDeliveryStreamEncryption(
StartDeliveryStreamEncryptionRequest startDeliveryStreamEncryptionRequest) throws ResourceNotFoundException,
ResourceInUseException, InvalidArgumentException, LimitExceededException, InvalidKmsResourceException,
AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, StartDeliveryStreamEncryptionResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(startDeliveryStreamEncryptionRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration,
startDeliveryStreamEncryptionRequest.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "StartDeliveryStreamEncryption");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("StartDeliveryStreamEncryption").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(startDeliveryStreamEncryptionRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new StartDeliveryStreamEncryptionRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Disables server-side encryption (SSE) for the Firehose stream.
*
*
* This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption
* status of the stream to DISABLING, and then to DISABLED. You can continue to read and
* write data to your stream while its status is DISABLING. It can take up to 5 seconds after the
* encryption status changes to DISABLED before all records written to the Firehose stream are no
* longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the
* response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
*
*
* To check the encryption state of a Firehose stream, use DescribeDeliveryStream.
*
*
* If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption,
* Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished
* delivering records to the destination.
*
*
* The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a
* combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call
* StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for
* the same Firehose stream in a 24-hour period.
*
*
* @param stopDeliveryStreamEncryptionRequest
* @return Result of the StopDeliveryStreamEncryption operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ResourceInUseException
* The resource is already in use and not available for this operation.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws LimitExceededException
* You have already reached the limit for a requested resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.StopDeliveryStreamEncryption
* @see AWS API Documentation
*/
@Override
public StopDeliveryStreamEncryptionResponse stopDeliveryStreamEncryption(
StopDeliveryStreamEncryptionRequest stopDeliveryStreamEncryptionRequest) throws ResourceNotFoundException,
ResourceInUseException, InvalidArgumentException, LimitExceededException, AwsServiceException, SdkClientException,
FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, StopDeliveryStreamEncryptionResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(stopDeliveryStreamEncryptionRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, stopDeliveryStreamEncryptionRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "StopDeliveryStreamEncryption");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("StopDeliveryStreamEncryption").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(stopDeliveryStreamEncryptionRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new StopDeliveryStreamEncryptionRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Adds or updates tags for the specified Firehose stream. A tag is a key-value pair that you can define and assign
* to Amazon Web Services 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 Firehose stream. For more
* information about tags, see Using Cost Allocation
* Tags in the Amazon Web Services Billing and Cost Management User Guide.
*
*
* Each Firehose stream can have up to 50 tags.
*
*
* This operation has a limit of five transactions per second per account.
*
*
* @param tagDeliveryStreamRequest
* @return Result of the TagDeliveryStream operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ResourceInUseException
* The resource is already in use and not available for this operation.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws LimitExceededException
* You have already reached the limit for a requested resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.TagDeliveryStream
* @see AWS
* API Documentation
*/
@Override
public TagDeliveryStreamResponse tagDeliveryStream(TagDeliveryStreamRequest tagDeliveryStreamRequest)
throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException,
AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
TagDeliveryStreamResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(tagDeliveryStreamRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, tagDeliveryStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "TagDeliveryStream");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("TagDeliveryStream").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(tagDeliveryStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new TagDeliveryStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Removes tags from the specified Firehose 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.
*
*
* @param untagDeliveryStreamRequest
* @return Result of the UntagDeliveryStream operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ResourceInUseException
* The resource is already in use and not available for this operation.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws LimitExceededException
* You have already reached the limit for a requested resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.UntagDeliveryStream
* @see AWS
* API Documentation
*/
@Override
public UntagDeliveryStreamResponse untagDeliveryStream(UntagDeliveryStreamRequest untagDeliveryStreamRequest)
throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException,
AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(
operationMetadata, UntagDeliveryStreamResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(untagDeliveryStreamRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, untagDeliveryStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "UntagDeliveryStream");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("UntagDeliveryStream").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(untagDeliveryStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new UntagDeliveryStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Updates the specified destination of the specified Firehose 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 Firehose stream remains active while
* the configurations are updated, so data writes to the Firehose stream can continue during this process. The
* updated configurations are usually effective within a few minutes.
*
*
* Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service
* destination, you can only update to another Amazon OpenSearch Service destination.
*
*
* If the destination type is the same, 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,
* Firehose does not merge any parameters. In this case, all parameters must be specified.
*
*
* 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.
*
*
* @param updateDestinationRequest
* @return Result of the UpdateDestination operation returned by the service.
* @throws InvalidArgumentException
* The specified input parameter has a value that is not valid.
* @throws ResourceInUseException
* The resource is already in use and not available for this operation.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ConcurrentModificationException
* Another modification has already happened. Fetch VersionId again and use it to update the
* destination.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws FirehoseException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample FirehoseClient.UpdateDestination
* @see AWS
* API Documentation
*/
@Override
public UpdateDestinationResponse updateDestination(UpdateDestinationRequest updateDestinationRequest)
throws InvalidArgumentException, ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException,
AwsServiceException, SdkClientException, FirehoseException {
JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
.isPayloadJson(true).build();
HttpResponseHandler responseHandler = protocolFactory.createResponseHandler(operationMetadata,
UpdateDestinationResponse::builder);
HttpResponseHandler errorResponseHandler = createErrorResponseHandler(protocolFactory,
operationMetadata);
SdkClientConfiguration clientConfiguration = updateSdkClientConfiguration(updateDestinationRequest,
this.clientConfiguration);
List metricPublishers = resolveMetricPublishers(clientConfiguration, updateDestinationRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Firehose");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "UpdateDestination");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("UpdateDestination").withProtocolMetadata(protocolMetadata)
.withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
.withRequestConfiguration(clientConfiguration).withInput(updateDestinationRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new UpdateDestinationRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
@Override
public final String serviceName() {
return SERVICE_NAME;
}
private static List resolveMetricPublishers(SdkClientConfiguration clientConfiguration,
RequestOverrideConfiguration requestOverrideConfiguration) {
List publishers = null;
if (requestOverrideConfiguration != null) {
publishers = requestOverrideConfiguration.metricPublishers();
}
if (publishers == null || publishers.isEmpty()) {
publishers = clientConfiguration.option(SdkClientOption.METRIC_PUBLISHERS);
}
if (publishers == null) {
publishers = Collections.emptyList();
}
return publishers;
}
private HttpResponseHandler createErrorResponseHandler(BaseAwsJsonProtocolFactory protocolFactory,
JsonOperationMetadata operationMetadata) {
return protocolFactory.createErrorResponseHandler(operationMetadata);
}
private void updateRetryStrategyClientConfiguration(SdkClientConfiguration.Builder configuration) {
ClientOverrideConfiguration.Builder builder = configuration.asOverrideConfigurationBuilder();
RetryMode retryMode = builder.retryMode();
if (retryMode != null) {
configuration.option(SdkClientOption.RETRY_STRATEGY, AwsRetryStrategy.forRetryMode(retryMode));
} else {
Consumer> configurator = builder.retryStrategyConfigurator();
if (configurator != null) {
RetryStrategy.Builder defaultBuilder = AwsRetryStrategy.defaultRetryStrategy().toBuilder();
configurator.accept(defaultBuilder);
configuration.option(SdkClientOption.RETRY_STRATEGY, defaultBuilder.build());
} else {
RetryStrategy retryStrategy = builder.retryStrategy();
if (retryStrategy != null) {
configuration.option(SdkClientOption.RETRY_STRATEGY, retryStrategy);
}
}
}
configuration.option(SdkClientOption.CONFIGURED_RETRY_MODE, null);
configuration.option(SdkClientOption.CONFIGURED_RETRY_STRATEGY, null);
configuration.option(SdkClientOption.CONFIGURED_RETRY_CONFIGURATOR, null);
}
private SdkClientConfiguration updateSdkClientConfiguration(SdkRequest request, SdkClientConfiguration clientConfiguration) {
List plugins = request.overrideConfiguration().map(c -> c.plugins()).orElse(Collections.emptyList());
SdkClientConfiguration.Builder configuration = clientConfiguration.toBuilder();
if (plugins.isEmpty()) {
return configuration.build();
}
FirehoseServiceClientConfigurationBuilder serviceConfigBuilder = new FirehoseServiceClientConfigurationBuilder(
configuration);
for (SdkPlugin plugin : plugins) {
plugin.configureClient(serviceConfigBuilder);
}
updateRetryStrategyClientConfiguration(configuration);
return configuration.build();
}
private > T init(T builder) {
return builder
.clientConfiguration(clientConfiguration)
.defaultServiceExceptionSupplier(FirehoseException::builder)
.protocol(AwsJsonProtocol.AWS_JSON)
.protocolVersion("1.1")
.registerModeledException(
ExceptionMetadata.builder().errorCode("ConcurrentModificationException")
.exceptionBuilderSupplier(ConcurrentModificationException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("ResourceInUseException")
.exceptionBuilderSupplier(ResourceInUseException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidSourceException")
.exceptionBuilderSupplier(InvalidSourceException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidKMSResourceException")
.exceptionBuilderSupplier(InvalidKmsResourceException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("LimitExceededException")
.exceptionBuilderSupplier(LimitExceededException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidArgumentException")
.exceptionBuilderSupplier(InvalidArgumentException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("ResourceNotFoundException")
.exceptionBuilderSupplier(ResourceNotFoundException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("ServiceUnavailableException")
.exceptionBuilderSupplier(ServiceUnavailableException::builder).httpStatusCode(500).build());
}
@Override
public final FirehoseServiceClientConfiguration serviceClientConfiguration() {
return new FirehoseServiceClientConfigurationBuilder(this.clientConfiguration.toBuilder()).build();
}
@Override
public void close() {
clientHandler.close();
}
}