// // Copyright 2010-2020 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. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSKinesisErrorDomain; typedef NS_ENUM(NSInteger, AWSKinesisErrorType) { AWSKinesisErrorUnknown, AWSKinesisErrorExpiredIterator, AWSKinesisErrorExpiredNextToken, AWSKinesisErrorInvalidArgument, AWSKinesisErrorKMSAccessDenied, AWSKinesisErrorKMSDisabled, AWSKinesisErrorKMSInvalidState, AWSKinesisErrorKMSNotFound, AWSKinesisErrorKMSOptInRequired, AWSKinesisErrorKMSThrottling, AWSKinesisErrorLimitExceeded, AWSKinesisErrorProvisionedThroughputExceeded, AWSKinesisErrorResourceInUse, AWSKinesisErrorResourceNotFound, }; typedef NS_ENUM(NSInteger, AWSKinesisEncryptionType) { AWSKinesisEncryptionTypeUnknown, AWSKinesisEncryptionTypeNone, AWSKinesisEncryptionTypeKms, }; typedef NS_ENUM(NSInteger, AWSKinesisMetricsName) { AWSKinesisMetricsNameUnknown, AWSKinesisMetricsNameIncomingBytes, AWSKinesisMetricsNameIncomingRecords, AWSKinesisMetricsNameOutgoingBytes, AWSKinesisMetricsNameOutgoingRecords, AWSKinesisMetricsNameWriteProvisionedThroughputExceeded, AWSKinesisMetricsNameReadProvisionedThroughputExceeded, AWSKinesisMetricsNameIteratorAgeMilliseconds, AWSKinesisMetricsNameAll, }; typedef NS_ENUM(NSInteger, AWSKinesisScalingType) { AWSKinesisScalingTypeUnknown, AWSKinesisScalingTypeUniformScaling, }; typedef NS_ENUM(NSInteger, AWSKinesisShardIteratorType) { AWSKinesisShardIteratorTypeUnknown, AWSKinesisShardIteratorTypeAtSequenceNumber, AWSKinesisShardIteratorTypeAfterSequenceNumber, AWSKinesisShardIteratorTypeTrimHorizon, AWSKinesisShardIteratorTypeLatest, AWSKinesisShardIteratorTypeAtTimestamp, }; typedef NS_ENUM(NSInteger, AWSKinesisStreamStatus) { AWSKinesisStreamStatusUnknown, AWSKinesisStreamStatusCreating, AWSKinesisStreamStatusDeleting, AWSKinesisStreamStatusActive, AWSKinesisStreamStatusUpdating, }; @class AWSKinesisAddTagsToStreamInput; @class AWSKinesisCreateStreamInput; @class AWSKinesisDecreaseStreamRetentionPeriodInput; @class AWSKinesisDeleteStreamInput; @class AWSKinesisDescribeLimitsInput; @class AWSKinesisDescribeLimitsOutput; @class AWSKinesisDescribeStreamInput; @class AWSKinesisDescribeStreamOutput; @class AWSKinesisDescribeStreamSummaryInput; @class AWSKinesisDescribeStreamSummaryOutput; @class AWSKinesisDisableEnhancedMonitoringInput; @class AWSKinesisEnableEnhancedMonitoringInput; @class AWSKinesisEnhancedMetrics; @class AWSKinesisEnhancedMonitoringOutput; @class AWSKinesisGetRecordsInput; @class AWSKinesisGetRecordsOutput; @class AWSKinesisGetShardIteratorInput; @class AWSKinesisGetShardIteratorOutput; @class AWSKinesisHashKeyRange; @class AWSKinesisIncreaseStreamRetentionPeriodInput; @class AWSKinesisListShardsInput; @class AWSKinesisListShardsOutput; @class AWSKinesisListStreamsInput; @class AWSKinesisListStreamsOutput; @class AWSKinesisListTagsForStreamInput; @class AWSKinesisListTagsForStreamOutput; @class AWSKinesisMergeShardsInput; @class AWSKinesisPutRecordInput; @class AWSKinesisPutRecordOutput; @class AWSKinesisPutRecordsInput; @class AWSKinesisPutRecordsOutput; @class AWSKinesisPutRecordsRequestEntry; @class AWSKinesisPutRecordsResultEntry; @class AWSKinesisRecord; @class AWSKinesisRemoveTagsFromStreamInput; @class AWSKinesisSequenceNumberRange; @class AWSKinesisShard; @class AWSKinesisSplitShardInput; @class AWSKinesisStartStreamEncryptionInput; @class AWSKinesisStopStreamEncryptionInput; @class AWSKinesisStreamDescription; @class AWSKinesisStreamDescriptionSummary; @class AWSKinesisTag; @class AWSKinesisUpdateShardCountInput; @class AWSKinesisUpdateShardCountOutput; /**

Represents the input for AddTagsToStream.

Required parameters: [StreamName, Tags] */ @interface AWSKinesisAddTagsToStreamInput : AWSRequest /**

The name of the stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; /**

The set of key-value pairs to use to create the tags.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /**

Represents the input for CreateStream.

Required parameters: [StreamName, ShardCount] */ @interface AWSKinesisCreateStreamInput : AWSRequest /**

The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

DefaultShardLimit;

*/ @property (nonatomic, strong) NSNumber * _Nullable shardCount; /**

A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the input for DecreaseStreamRetentionPeriod.

Required parameters: [StreamName, RetentionPeriodHours] */ @interface AWSKinesisDecreaseStreamRetentionPeriodInput : AWSRequest /**

The new retention period of the stream, in hours. Must be less than the current retention period.

*/ @property (nonatomic, strong) NSNumber * _Nullable retentionPeriodHours; /**

The name of the stream to modify.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the input for DeleteStream.

Required parameters: [StreamName] */ @interface AWSKinesisDeleteStreamInput : AWSRequest /**

The name of the stream to delete.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /** */ @interface AWSKinesisDescribeLimitsInput : AWSRequest @end /** */ @interface AWSKinesisDescribeLimitsOutput : AWSModel /**

The number of open shards.

*/ @property (nonatomic, strong) NSNumber * _Nullable openShardCount; /**

The maximum number of shards.

*/ @property (nonatomic, strong) NSNumber * _Nullable shardLimit; @end /**

Represents the input for DescribeStream.

Required parameters: [StreamName] */ @interface AWSKinesisDescribeStreamInput : AWSRequest /**

The shard ID of the shard to start with.

*/ @property (nonatomic, strong) NSString * _Nullable exclusiveStartShardId; /**

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

The name of the stream to describe.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the output for DescribeStream.

Required parameters: [StreamDescription] */ @interface AWSKinesisDescribeStreamOutput : AWSModel /**

The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.

*/ @property (nonatomic, strong) AWSKinesisStreamDescription * _Nullable streamDescription; @end /** */ @interface AWSKinesisDescribeStreamSummaryInput : AWSRequest /**

The name of the stream to describe.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /** */ @interface AWSKinesisDescribeStreamSummaryOutput : AWSModel /**

A StreamDescriptionSummary containing information about the stream.

*/ @property (nonatomic, strong) AWSKinesisStreamDescriptionSummary * _Nullable streamDescriptionSummary; @end /**

Represents the input for DisableEnhancedMonitoring.

Required parameters: [StreamName, ShardLevelMetrics] */ @interface AWSKinesisDisableEnhancedMonitoringInput : AWSRequest /**

List of shard-level metrics to disable.

The following are the valid shard-level metrics. The value "ALL" disables every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable shardLevelMetrics; /**

The name of the Kinesis data stream for which to disable enhanced monitoring.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the input for EnableEnhancedMonitoring.

Required parameters: [StreamName, ShardLevelMetrics] */ @interface AWSKinesisEnableEnhancedMonitoringInput : AWSRequest /**

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value "ALL" enables every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable shardLevelMetrics; /**

The name of the stream for which to enable enhanced monitoring.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents enhanced metrics types.

*/ @interface AWSKinesisEnhancedMetrics : AWSModel /**

List of shard-level metrics.

The following are the valid shard-level metrics. The value "ALL" enhances every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable shardLevelMetrics; @end /**

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

*/ @interface AWSKinesisEnhancedMonitoringOutput : AWSModel /**

Represents the current state of the metrics that are in the enhanced state before the operation.

*/ @property (nonatomic, strong) NSArray * _Nullable currentShardLevelMetrics; /**

Represents the list of all the metrics that would be in the enhanced state after the operation.

*/ @property (nonatomic, strong) NSArray * _Nullable desiredShardLevelMetrics; /**

The name of the Kinesis data stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the input for GetRecords.

Required parameters: [ShardIterator] */ @interface AWSKinesisGetRecordsInput : AWSRequest /**

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

*/ @property (nonatomic, strong) NSString * _Nullable shardIterator; @end /**

Represents the output for GetRecords.

Required parameters: [Records] */ @interface AWSKinesisGetRecordsOutput : AWSModel /**

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

*/ @property (nonatomic, strong) NSNumber * _Nullable millisBehindLatest; /**

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

*/ @property (nonatomic, strong) NSString * _Nullable nextShardIterator; /**

The data records retrieved from the shard.

*/ @property (nonatomic, strong) NSArray * _Nullable records; @end /**

Represents the input for GetShardIterator.

Required parameters: [StreamName, ShardId, ShardIteratorType] */ @interface AWSKinesisGetShardIteratorInput : AWSRequest /**

The shard ID of the Kinesis Data Streams shard to get the iterator for.

*/ @property (nonatomic, strong) NSString * _Nullable shardId; /**

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

  • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

  • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

  • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

*/ @property (nonatomic, assign) AWSKinesisShardIteratorType shardIteratorType; /**

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

*/ @property (nonatomic, strong) NSString * _Nullable startingSequenceNumber; /**

The name of the Amazon Kinesis data stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; /**

The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

*/ @property (nonatomic, strong) NSDate * _Nullable timestamp; @end /**

Represents the output for GetShardIterator.

*/ @interface AWSKinesisGetShardIteratorOutput : AWSModel /**

The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

*/ @property (nonatomic, strong) NSString * _Nullable shardIterator; @end /**

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

Required parameters: [StartingHashKey, EndingHashKey] */ @interface AWSKinesisHashKeyRange : AWSModel /**

The ending hash key of the hash key range.

*/ @property (nonatomic, strong) NSString * _Nullable endingHashKey; /**

The starting hash key of the hash key range.

*/ @property (nonatomic, strong) NSString * _Nullable startingHashKey; @end /**

Represents the input for IncreaseStreamRetentionPeriod.

Required parameters: [StreamName, RetentionPeriodHours] */ @interface AWSKinesisIncreaseStreamRetentionPeriodInput : AWSRequest /**

The new retention period of the stream, in hours. Must be more than the current retention period.

*/ @property (nonatomic, strong) NSNumber * _Nullable retentionPeriodHours; /**

The name of the stream to modify.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /** */ @interface AWSKinesisListShardsInput : AWSRequest /**

The ID of the shard to start the list with.

If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.

You cannot specify this parameter if you specify NextToken.

*/ @property (nonatomic, strong) NSString * _Nullable exclusiveStartShardId; /**

The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.

When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

 */ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.

You cannot specify this parameter if you specify the NextToken parameter.

*/ @property (nonatomic, strong) NSDate * _Nullable streamCreationTimestamp; /**

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /** */ @interface AWSKinesisListShardsOutput : AWSModel /**

When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

 */ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

*/ @property (nonatomic, strong) NSArray * _Nullable shards; @end /**

Represents the input for ListStreams.

*/ @interface AWSKinesisListStreamsInput : AWSRequest /**

The name of the stream to start the list with.

*/ @property (nonatomic, strong) NSString * _Nullable exclusiveStartStreamName; /**

The maximum number of streams to list.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; @end /**

Represents the output for ListStreams.

Required parameters: [StreamNames, HasMoreStreams] */ @interface AWSKinesisListStreamsOutput : AWSModel /**

If set to true, there are more streams available to list.

*/ @property (nonatomic, strong) NSNumber * _Nullable hasMoreStreams; /**

The names of the streams that are associated with the AWS account making the ListStreams request.

*/ @property (nonatomic, strong) NSArray * _Nullable streamNames; @end /**

Represents the input for ListTagsForStream.

Required parameters: [StreamName] */ @interface AWSKinesisListTagsForStreamInput : AWSRequest /**

The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

*/ @property (nonatomic, strong) NSString * _Nullable exclusiveStartTagKey; /**

The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

The name of the stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the output for ListTagsForStream.

Required parameters: [Tags, HasMoreTags] */ @interface AWSKinesisListTagsForStreamOutput : AWSModel /**

If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

*/ @property (nonatomic, strong) NSNumber * _Nullable hasMoreTags; /**

A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /**

Represents the input for MergeShards.

Required parameters: [StreamName, ShardToMerge, AdjacentShardToMerge] */ @interface AWSKinesisMergeShardsInput : AWSRequest /**

The shard ID of the adjacent shard for the merge.

*/ @property (nonatomic, strong) NSString * _Nullable adjacentShardToMerge; /**

The shard ID of the shard to combine with the adjacent shard for the merge.

*/ @property (nonatomic, strong) NSString * _Nullable shardToMerge; /**

The name of the stream for the merge.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the input for PutRecord.

Required parameters: [StreamName, Data, PartitionKey] */ @interface AWSKinesisPutRecordInput : AWSRequest /**

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

*/ @property (nonatomic, strong) NSData * _Nullable data; /**

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

*/ @property (nonatomic, strong) NSString * _Nullable explicitHashKey; /**

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

*/ @property (nonatomic, strong) NSString * _Nullable partitionKey; /**

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

*/ @property (nonatomic, strong) NSString * _Nullable sequenceNumberForOrdering; /**

The name of the stream to put the data record into.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the output for PutRecord.

Required parameters: [ShardId, SequenceNumber] */ @interface AWSKinesisPutRecordOutput : AWSModel /**

The encryption type to use on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

*/ @property (nonatomic, assign) AWSKinesisEncryptionType encryptionType; /**

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

*/ @property (nonatomic, strong) NSString * _Nullable sequenceNumber; /**

The shard ID of the shard where the data record was placed.

*/ @property (nonatomic, strong) NSString * _Nullable shardId; @end /**

A PutRecords request.

Required parameters: [Records, StreamName] */ @interface AWSKinesisPutRecordsInput : AWSRequest /**

The records associated with the request.

*/ @property (nonatomic, strong) NSArray * _Nullable records; /**

The stream name associated with the request.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

PutRecords results.

Required parameters: [Records] */ @interface AWSKinesisPutRecordsOutput : AWSModel /**

The encryption type used on the records. This parameter can be one of the following values:

  • NONE: Do not encrypt the records.

  • KMS: Use server-side encryption on the records using a customer-managed AWS KMS key.

*/ @property (nonatomic, assign) AWSKinesisEncryptionType encryptionType; /**

The number of unsuccessfully processed records in a PutRecords request.

*/ @property (nonatomic, strong) NSNumber * _Nullable failedRecordCount; /**

An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

*/ @property (nonatomic, strong) NSArray * _Nullable records; @end /**

Represents the output for PutRecords.

Required parameters: [Data, PartitionKey] */ @interface AWSKinesisPutRecordsRequestEntry : AWSModel /**

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

*/ @property (nonatomic, strong) NSData * _Nullable data; /**

The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

*/ @property (nonatomic, strong) NSString * _Nullable explicitHashKey; /**

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

*/ @property (nonatomic, strong) NSString * _Nullable partitionKey; @end /**

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

*/ @interface AWSKinesisPutRecordsResultEntry : AWSModel /**

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

*/ @property (nonatomic, strong) NSString * _Nullable errorCode; /**

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

*/ @property (nonatomic, strong) NSString * _Nullable errorMessage; /**

The sequence number for an individual record result.

*/ @property (nonatomic, strong) NSString * _Nullable sequenceNumber; /**

The shard ID for an individual record result.

*/ @property (nonatomic, strong) NSString * _Nullable shardId; @end /**

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

Required parameters: [SequenceNumber, Data, PartitionKey] */ @interface AWSKinesisRecord : AWSModel /**

The approximate time that the record was inserted into the stream.

*/ @property (nonatomic, strong) NSDate * _Nullable approximateArrivalTimestamp; /**

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

*/ @property (nonatomic, strong) NSData * _Nullable data; /**

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

*/ @property (nonatomic, assign) AWSKinesisEncryptionType encryptionType; /**

Identifies which shard in the stream the data record is assigned to.

*/ @property (nonatomic, strong) NSString * _Nullable partitionKey; /**

The unique identifier of the record within its shard.

*/ @property (nonatomic, strong) NSString * _Nullable sequenceNumber; @end /**

Represents the input for RemoveTagsFromStream.

Required parameters: [StreamName, TagKeys] */ @interface AWSKinesisRemoveTagsFromStreamInput : AWSRequest /**

The name of the stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; /**

A list of tag keys. Each corresponding tag is removed from the stream.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /**

The range of possible sequence numbers for the shard.

Required parameters: [StartingSequenceNumber] */ @interface AWSKinesisSequenceNumberRange : AWSModel /**

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

*/ @property (nonatomic, strong) NSString * _Nullable endingSequenceNumber; /**

The starting sequence number for the range.

*/ @property (nonatomic, strong) NSString * _Nullable startingSequenceNumber; @end /**

A uniquely identified group of data records in a Kinesis data stream.

Required parameters: [ShardId, HashKeyRange, SequenceNumberRange] */ @interface AWSKinesisShard : AWSModel /**

The shard ID of the shard adjacent to the shard's parent.

*/ @property (nonatomic, strong) NSString * _Nullable adjacentParentShardId; /**

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

*/ @property (nonatomic, strong) AWSKinesisHashKeyRange * _Nullable hashKeyRange; /**

The shard ID of the shard's parent.

*/ @property (nonatomic, strong) NSString * _Nullable parentShardId; /**

The range of possible sequence numbers for the shard.

*/ @property (nonatomic, strong) AWSKinesisSequenceNumberRange * _Nullable sequenceNumberRange; /**

The unique identifier of the shard within the stream.

*/ @property (nonatomic, strong) NSString * _Nullable shardId; @end /**

Represents the input for SplitShard.

Required parameters: [StreamName, ShardToSplit, NewStartingHashKey] */ @interface AWSKinesisSplitShardInput : AWSRequest /**

A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

*/ @property (nonatomic, strong) NSString * _Nullable latestStartingHashKey; /**

The shard ID of the shard to split.

*/ @property (nonatomic, strong) NSString * _Nullable shardToSplit; /**

The name of the stream for the shard split.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /** */ @interface AWSKinesisStartStreamEncryptionInput : AWSRequest /**

The encryption type to use. The only valid value is KMS.

*/ @property (nonatomic, assign) AWSKinesisEncryptionType encryptionType; /**

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The name of the stream for which to start encrypting records.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /** */ @interface AWSKinesisStopStreamEncryptionInput : AWSRequest /**

The encryption type. The only valid value is KMS.

*/ @property (nonatomic, assign) AWSKinesisEncryptionType encryptionType; /**

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The name of the stream on which to stop encrypting records.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; @end /**

Represents the output for DescribeStream.

Required parameters: [StreamName, StreamARN, StreamStatus, Shards, HasMoreShards, RetentionPeriodHours, StreamCreationTimestamp, EnhancedMonitoring] */ @interface AWSKinesisStreamDescription : AWSModel /**

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

*/ @property (nonatomic, assign) AWSKinesisEncryptionType encryptionType; /**

Represents the current enhanced monitoring settings of the stream.

*/ @property (nonatomic, strong) NSArray * _Nullable enhancedMonitoring; /**

If set to true, more shards in the stream are available to describe.

*/ @property (nonatomic, strong) NSNumber * _Nullable hasMoreShards; /**

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The current retention period, in hours.

*/ @property (nonatomic, strong) NSNumber * _Nullable retentionPeriodHours; /**

The shards that comprise the stream.

*/ @property (nonatomic, strong) NSArray * _Nullable shards; /**

The Amazon Resource Name (ARN) for the stream being described.

*/ @property (nonatomic, strong) NSString * _Nullable streamARN; /**

The approximate time that the stream was created.

*/ @property (nonatomic, strong) NSDate * _Nullable streamCreationTimestamp; /**

The name of the stream being described.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; /**

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

*/ @property (nonatomic, assign) AWSKinesisStreamStatus streamStatus; @end /**

Represents the output for DescribeStreamSummary

Required parameters: [StreamName, StreamARN, StreamStatus, RetentionPeriodHours, StreamCreationTimestamp, EnhancedMonitoring, OpenShardCount] */ @interface AWSKinesisStreamDescriptionSummary : AWSModel /**

The encryption type used. This value is one of the following:

  • KMS

  • NONE

*/ @property (nonatomic, assign) AWSKinesisEncryptionType encryptionType; /**

Represents the current enhanced monitoring settings of the stream.

*/ @property (nonatomic, strong) NSArray * _Nullable enhancedMonitoring; /**

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The number of open shards in the stream.

*/ @property (nonatomic, strong) NSNumber * _Nullable openShardCount; /**

The current retention period, in hours.

*/ @property (nonatomic, strong) NSNumber * _Nullable retentionPeriodHours; /**

The Amazon Resource Name (ARN) for the stream being described.

*/ @property (nonatomic, strong) NSString * _Nullable streamARN; /**

The approximate time that the stream was created.

*/ @property (nonatomic, strong) NSDate * _Nullable streamCreationTimestamp; /**

The name of the stream being described.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; /**

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

*/ @property (nonatomic, assign) AWSKinesisStreamStatus streamStatus; @end /**

Metadata assigned to the stream, consisting of a key-value pair.

Required parameters: [Key] */ @interface AWSKinesisTag : AWSModel /**

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

*/ @property (nonatomic, strong) NSString * _Nullable value; @end /** */ @interface AWSKinesisUpdateShardCountInput : AWSRequest /**

The scaling type. Uniform scaling creates shards of equal size.

*/ @property (nonatomic, assign) AWSKinesisScalingType scalingType; /**

The name of the stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; /**

The new number of shards.

*/ @property (nonatomic, strong) NSNumber * _Nullable targetShardCount; @end /** */ @interface AWSKinesisUpdateShardCountOutput : AWSModel /**

The current number of shards.

*/ @property (nonatomic, strong) NSNumber * _Nullable currentShardCount; /**

The name of the stream.

*/ @property (nonatomic, strong) NSString * _Nullable streamName; /**

The updated number of shards.

*/ @property (nonatomic, strong) NSNumber * _Nullable targetShardCount; @end NS_ASSUME_NONNULL_END