/* * 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 kinesis-2013-12-02.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Kinesis.Model; namespace Amazon.Kinesis { /// /// Interface for accessing Kinesis /// /// Amazon Kinesis Data Streams Service API Reference /// /// Amazon Kinesis Data Streams is a managed service that scales elastically for real-time /// processing of streaming big data. /// /// public partial interface IAmazonKinesis : IAmazonService, IDisposable { #region AddTagsToStream /// /// Initiates the asynchronous execution of the AddTagsToStream operation. /// /// /// Container for the necessary parameters to execute the AddTagsToStream operation on AmazonKinesisClient. /// 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 AddTagsToStream Operation void AddTagsToStreamAsync(AddTagsToStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region CreateStream /// /// Initiates the asynchronous execution of the CreateStream operation. /// /// /// Container for the necessary parameters to execute the CreateStream operation on AmazonKinesisClient. /// 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 CreateStream Operation void CreateStreamAsync(CreateStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DecreaseStreamRetentionPeriod /// /// Decreases the Kinesis data stream's retention period, which is the length of time /// data records are accessible after they are added to the stream. The minimum value /// of a stream's retention period is 24 hours. /// /// /// /// This operation may result in lost data. For example, if the stream's retention period /// is 48 hours and is decreased to 24 hours, any data already in the stream that is older /// than 24 hours is inaccessible. /// /// /// The name of the stream to modify. /// The new retention period of the stream, in hours. Must be less than the current retention period. /// 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 DecreaseStreamRetentionPeriod service method, as returned by Kinesis. /// /// A specified parameter exceeds its restrictions, is not supported, or can't be used. /// For more information, see the returned message. /// /// /// The requested resource exceeds the maximum number allowed, or the number of concurrent /// stream requests exceeds the maximum number allowed. /// /// /// The resource is not available for this operation. For successful operation, the resource /// must be in the ACTIVE state. /// /// /// The requested resource could not be found. The stream might not be specified correctly. /// /// REST API Reference for DecreaseStreamRetentionPeriod Operation void DecreaseStreamRetentionPeriodAsync(string streamName, int retentionPeriodHours, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the DecreaseStreamRetentionPeriod operation. /// /// /// Container for the necessary parameters to execute the DecreaseStreamRetentionPeriod operation on AmazonKinesisClient. /// 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 DecreaseStreamRetentionPeriod Operation void DecreaseStreamRetentionPeriodAsync(DecreaseStreamRetentionPeriodRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DeleteStream /// /// Initiates the asynchronous execution of the DeleteStream operation. /// /// /// Container for the necessary parameters to execute the DeleteStream operation on AmazonKinesisClient. /// 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 DeleteStream Operation void DeleteStreamAsync(DeleteStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DeregisterStreamConsumer /// /// Initiates the asynchronous execution of the DeregisterStreamConsumer operation. /// /// /// Container for the necessary parameters to execute the DeregisterStreamConsumer operation on AmazonKinesisClient. /// 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 DeregisterStreamConsumer Operation void DeregisterStreamConsumerAsync(DeregisterStreamConsumerRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DescribeLimits /// /// Initiates the asynchronous execution of the DescribeLimits operation. /// /// /// Container for the necessary parameters to execute the DescribeLimits operation on AmazonKinesisClient. /// 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 DescribeLimits Operation void DescribeLimitsAsync(DescribeLimitsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DescribeStream /// /// Initiates the asynchronous execution of the DescribeStream operation. /// /// /// Container for the necessary parameters to execute the DescribeStream operation on AmazonKinesisClient. /// 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 DescribeStream Operation void DescribeStreamAsync(DescribeStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DescribeStreamConsumer /// /// Initiates the asynchronous execution of the DescribeStreamConsumer operation. /// /// /// Container for the necessary parameters to execute the DescribeStreamConsumer operation on AmazonKinesisClient. /// 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 DescribeStreamConsumer Operation void DescribeStreamConsumerAsync(DescribeStreamConsumerRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DescribeStreamSummary /// /// Initiates the asynchronous execution of the DescribeStreamSummary operation. /// /// /// Container for the necessary parameters to execute the DescribeStreamSummary operation on AmazonKinesisClient. /// 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 DescribeStreamSummary Operation void DescribeStreamSummaryAsync(DescribeStreamSummaryRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region DisableEnhancedMonitoring /// /// Initiates the asynchronous execution of the DisableEnhancedMonitoring operation. /// /// /// Container for the necessary parameters to execute the DisableEnhancedMonitoring operation on AmazonKinesisClient. /// 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 DisableEnhancedMonitoring Operation void DisableEnhancedMonitoringAsync(DisableEnhancedMonitoringRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region EnableEnhancedMonitoring /// /// Initiates the asynchronous execution of the EnableEnhancedMonitoring operation. /// /// /// Container for the necessary parameters to execute the EnableEnhancedMonitoring operation on AmazonKinesisClient. /// 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 EnableEnhancedMonitoring Operation void EnableEnhancedMonitoringAsync(EnableEnhancedMonitoringRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region GetRecords /// /// Initiates the asynchronous execution of the GetRecords operation. /// /// /// Container for the necessary parameters to execute the GetRecords operation on AmazonKinesisClient. /// 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 GetRecords Operation void GetRecordsAsync(GetRecordsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region GetShardIterator /// /// Initiates the asynchronous execution of the GetShardIterator operation. /// /// /// Container for the necessary parameters to execute the GetShardIterator operation on AmazonKinesisClient. /// 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 GetShardIterator Operation void GetShardIteratorAsync(GetShardIteratorRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region IncreaseStreamRetentionPeriod /// /// Increases the Kinesis data stream's retention period, which is the length of time /// data records are accessible after they are added to the stream. The maximum value /// of a stream's retention period is 168 hours (7 days). /// /// /// /// If you choose a longer stream retention period, this operation increases the time /// period during which records that have not yet expired are accessible. However, it /// does not make previous, expired data (older than the stream's previous retention period) /// accessible after the operation has been called. For example, if a stream's retention /// period is set to 24 hours and is increased to 168 hours, any data that is older than /// 24 hours remains inaccessible to consumer applications. /// /// /// The name of the stream to modify. /// The new retention period of the stream, in hours. Must be more than the current retention period. /// 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 IncreaseStreamRetentionPeriod service method, as returned by Kinesis. /// /// A specified parameter exceeds its restrictions, is not supported, or can't be used. /// For more information, see the returned message. /// /// /// The requested resource exceeds the maximum number allowed, or the number of concurrent /// stream requests exceeds the maximum number allowed. /// /// /// The resource is not available for this operation. For successful operation, the resource /// must be in the ACTIVE state. /// /// /// The requested resource could not be found. The stream might not be specified correctly. /// /// REST API Reference for IncreaseStreamRetentionPeriod Operation void IncreaseStreamRetentionPeriodAsync(string streamName, int retentionPeriodHours, AmazonServiceCallback callback, AsyncOptions options = null); /// /// Initiates the asynchronous execution of the IncreaseStreamRetentionPeriod operation. /// /// /// Container for the necessary parameters to execute the IncreaseStreamRetentionPeriod operation on AmazonKinesisClient. /// 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 IncreaseStreamRetentionPeriod Operation void IncreaseStreamRetentionPeriodAsync(IncreaseStreamRetentionPeriodRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListShards /// /// Initiates the asynchronous execution of the ListShards operation. /// /// /// Container for the necessary parameters to execute the ListShards operation on AmazonKinesisClient. /// 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 ListShards Operation void ListShardsAsync(ListShardsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListStreamConsumers /// /// Initiates the asynchronous execution of the ListStreamConsumers operation. /// /// /// Container for the necessary parameters to execute the ListStreamConsumers operation on AmazonKinesisClient. /// 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 ListStreamConsumers Operation void ListStreamConsumersAsync(ListStreamConsumersRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListStreams /// /// Initiates the asynchronous execution of the ListStreams operation. /// /// /// Container for the necessary parameters to execute the ListStreams operation on AmazonKinesisClient. /// 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 ListStreams Operation void ListStreamsAsync(ListStreamsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region ListTagsForStream /// /// Initiates the asynchronous execution of the ListTagsForStream operation. /// /// /// Container for the necessary parameters to execute the ListTagsForStream operation on AmazonKinesisClient. /// 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 ListTagsForStream Operation void ListTagsForStreamAsync(ListTagsForStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region MergeShards /// /// Initiates the asynchronous execution of the MergeShards operation. /// /// /// Container for the necessary parameters to execute the MergeShards operation on AmazonKinesisClient. /// 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 MergeShards Operation void MergeShardsAsync(MergeShardsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region PutRecord /// /// Initiates the asynchronous execution of the PutRecord operation. /// /// /// Container for the necessary parameters to execute the PutRecord operation on AmazonKinesisClient. /// 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 PutRecords /// /// Initiates the asynchronous execution of the PutRecords operation. /// /// /// Container for the necessary parameters to execute the PutRecords operation on AmazonKinesisClient. /// 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 PutRecords Operation void PutRecordsAsync(PutRecordsRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region RegisterStreamConsumer /// /// Initiates the asynchronous execution of the RegisterStreamConsumer operation. /// /// /// Container for the necessary parameters to execute the RegisterStreamConsumer operation on AmazonKinesisClient. /// 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 RegisterStreamConsumer Operation void RegisterStreamConsumerAsync(RegisterStreamConsumerRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region RemoveTagsFromStream /// /// Initiates the asynchronous execution of the RemoveTagsFromStream operation. /// /// /// Container for the necessary parameters to execute the RemoveTagsFromStream operation on AmazonKinesisClient. /// 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 RemoveTagsFromStream Operation void RemoveTagsFromStreamAsync(RemoveTagsFromStreamRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region SplitShard /// /// Initiates the asynchronous execution of the SplitShard operation. /// /// /// Container for the necessary parameters to execute the SplitShard operation on AmazonKinesisClient. /// 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 SplitShard Operation void SplitShardAsync(SplitShardRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region StartStreamEncryption /// /// Initiates the asynchronous execution of the StartStreamEncryption operation. /// /// /// Container for the necessary parameters to execute the StartStreamEncryption operation on AmazonKinesisClient. /// 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 StartStreamEncryption Operation void StartStreamEncryptionAsync(StartStreamEncryptionRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region StopStreamEncryption /// /// Initiates the asynchronous execution of the StopStreamEncryption operation. /// /// /// Container for the necessary parameters to execute the StopStreamEncryption operation on AmazonKinesisClient. /// 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 StopStreamEncryption Operation void StopStreamEncryptionAsync(StopStreamEncryptionRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion #region UpdateShardCount /// /// Initiates the asynchronous execution of the UpdateShardCount operation. /// /// /// Container for the necessary parameters to execute the UpdateShardCount operation on AmazonKinesisClient. /// 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 UpdateShardCount Operation void UpdateShardCountAsync(UpdateShardCountRequest request, AmazonServiceCallback callback, AsyncOptions options = null); #endregion } }