/* * Copyright 2010-2014 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. */ /* * Do not modify this file. This file is generated from the firehose-2015-08-04.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.KinesisFirehose.Model; namespace Amazon.KinesisFirehose { /// /// Interface for accessing KinesisFirehose /// /// 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. /// /// public partial interface IAmazonKinesisFirehose : IAmazonService, IDisposable { #region CreateDeliveryStream /// /// Initiates the asynchronous execution of the CreateDeliveryStream operation. /// /// /// Container for the necessary parameters to execute the CreateDeliveryStream operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for CreateDeliveryStream Operation void CreateDeliveryStreamAsync(CreateDeliveryStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DeleteDeliveryStream /// /// Deletes a delivery stream and its data. /// /// /// /// To check the state of a delivery stream, use DescribeDeliveryStream. You can /// delete a delivery stream only if it is in one of the following states: ACTIVE, /// DELETING, CREATING_FAILED, or DELETING_FAILED. /// You can't delete a delivery stream that is in the CREATING state. While /// the deletion request is in process, the delivery stream is in the DELETING /// state. /// /// /// /// While the delivery 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 delivery stream. /// /// /// The name of the delivery stream. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the DeleteDeliveryStream service method, as returned by KinesisFirehose. /// /// The resource is already in use and not available for this operation. /// /// /// The specified resource could not be found. /// /// REST API Reference for DeleteDeliveryStream Operation void DeleteDeliveryStreamAsync(string deliveryStreamName, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the DeleteDeliveryStream operation. /// /// /// Container for the necessary parameters to execute the DeleteDeliveryStream operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for DeleteDeliveryStream Operation void DeleteDeliveryStreamAsync(DeleteDeliveryStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DescribeDeliveryStream /// /// Initiates the asynchronous execution of the DescribeDeliveryStream operation. /// /// /// Container for the necessary parameters to execute the DescribeDeliveryStream operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for DescribeDeliveryStream Operation void DescribeDeliveryStreamAsync(DescribeDeliveryStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListDeliveryStreams /// /// Initiates the asynchronous execution of the ListDeliveryStreams operation. /// /// /// Container for the necessary parameters to execute the ListDeliveryStreams operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ListDeliveryStreams Operation void ListDeliveryStreamsAsync(ListDeliveryStreamsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListTagsForDeliveryStream /// /// Initiates the asynchronous execution of the ListTagsForDeliveryStream operation. /// /// /// Container for the necessary parameters to execute the ListTagsForDeliveryStream operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for ListTagsForDeliveryStream Operation void ListTagsForDeliveryStreamAsync(ListTagsForDeliveryStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region PutRecord /// /// 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. /// /// /// /// 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. /// /// /// /// The name of the delivery stream. /// The record. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the PutRecord service method, as returned by KinesisFirehose. /// /// The specified input parameter has a value that is not valid. /// /// /// Kinesis Data Firehose throws this exception when an attempt to put records or to start /// or stop delivery stream encryption fails. This happens when the KMS service throws /// one of the following exception types: AccessDeniedException, InvalidStateException, /// DisabledException, or NotFoundException. /// /// /// The specified resource could not be found. /// /// /// 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. /// /// REST API Reference for PutRecord Operation void PutRecordAsync(string deliveryStreamName, Record record, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the PutRecord operation. /// /// /// Container for the necessary parameters to execute the PutRecord operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for PutRecord Operation void PutRecordAsync(PutRecordRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region PutRecordBatch /// /// Writes multiple data records into a delivery stream in a single call, which can achieve /// higher throughput per producer than when writing single records. To write single data /// records into a delivery stream, use PutRecord. Applications using these operations /// are referred to as producers. /// /// /// /// By default, each delivery stream can take in up to 2,000 transactions per second, /// 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, /// the limits are an aggregate across these two operations for each delivery stream. /// For more information about limits, see Amazon /// Kinesis Data Firehose Limits. /// /// /// /// Each PutRecordBatch request supports up to 500 records. Each record in the /// request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB /// for the entire request. These limits cannot be changed. /// /// /// /// You must specify the name of the delivery stream and the data record when using PutRecord. /// The data record consists of a data blob that can be up to 1,000 KB in size, and any /// kind of data. For example, it could be a segment from a log file, geographic location /// data, website clickstream data, and so on. /// /// /// /// Kinesis Data Firehose buffers records before delivering them to the destination. To /// disambiguate the data blobs at the destination, a common solution is to use delimiters /// in the data, such as a newline (\n) or some other character unique within /// the data. This allows the consumer application to parse individual data items when /// reading the data from the destination. /// /// /// /// The PutRecordBatch response includes a count of failed records, FailedPutCount, /// and an array of responses, RequestResponses. Even if the PutRecordBatch /// call succeeds, the value of FailedPutCount may be greater than 0, indicating /// that there are records for which the operation didn't succeed. Each entry in the RequestResponses /// array provides additional information about the processed record. It directly correlates /// with a record in the request array using the same ordering, from the top to the bottom. /// The response array always includes the same number of records as the request array. /// RequestResponses includes both successfully and unsuccessfully processed /// records. Kinesis Data Firehose tries to process all records in each PutRecordBatch /// request. A single record failure does not stop the processing of subsequent records. /// /// /// /// /// A successfully processed record includes a 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, back off /// and retry. If the exception persists, it is possible that the throughput limits have /// been exceeded for the delivery stream. /// /// /// /// Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they /// are added to a delivery stream as it attempts to send the records to the destination. /// If the destination is unreachable for more than 24 hours, the data is no longer available. /// /// /// /// Don't concatenate two or more base64 strings to form the data fields of your records. /// Instead, concatenate the raw data, then perform base64 encoding. /// /// /// /// The name of the delivery stream. /// One or more records. /// An Action delegate that is invoked when the operation completes. /// /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// /// The response from the PutRecordBatch service method, as returned by KinesisFirehose. /// /// The specified input parameter has a value that is not valid. /// /// /// Kinesis Data Firehose throws this exception when an attempt to put records or to start /// or stop delivery stream encryption fails. This happens when the KMS service throws /// one of the following exception types: AccessDeniedException, InvalidStateException, /// DisabledException, or NotFoundException. /// /// /// The specified resource could not be found. /// /// /// 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. /// /// REST API Reference for PutRecordBatch Operation void PutRecordBatchAsync(string deliveryStreamName, List records, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the PutRecordBatch operation. /// /// /// Container for the necessary parameters to execute the PutRecordBatch operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for PutRecordBatch Operation void PutRecordBatchAsync(PutRecordBatchRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region StartDeliveryStreamEncryption /// /// Initiates the asynchronous execution of the StartDeliveryStreamEncryption operation. /// /// /// Container for the necessary parameters to execute the StartDeliveryStreamEncryption operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for StartDeliveryStreamEncryption Operation void StartDeliveryStreamEncryptionAsync(StartDeliveryStreamEncryptionRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region StopDeliveryStreamEncryption /// /// Initiates the asynchronous execution of the StopDeliveryStreamEncryption operation. /// /// /// Container for the necessary parameters to execute the StopDeliveryStreamEncryption operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for StopDeliveryStreamEncryption Operation void StopDeliveryStreamEncryptionAsync(StopDeliveryStreamEncryptionRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region TagDeliveryStream /// /// Initiates the asynchronous execution of the TagDeliveryStream operation. /// /// /// Container for the necessary parameters to execute the TagDeliveryStream operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for TagDeliveryStream Operation void TagDeliveryStreamAsync(TagDeliveryStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region UntagDeliveryStream /// /// Initiates the asynchronous execution of the UntagDeliveryStream operation. /// /// /// Container for the necessary parameters to execute the UntagDeliveryStream operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for UntagDeliveryStream Operation void UntagDeliveryStreamAsync(UntagDeliveryStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region UpdateDestination /// /// Initiates the asynchronous execution of the UpdateDestination operation. /// /// /// Container for the necessary parameters to execute the UpdateDestination operation on AmazonKinesisFirehoseClient. /// An Action delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// REST API Reference for UpdateDestination Operation void UpdateDestinationAsync(UpdateDestinationRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion } }