Serialized Form (AWS SDK for Android - Amazon Kinesis 2.13.2 API)

Package com.amazonaws.services.kinesis.model
- Class com.amazonaws.services.kinesis.model.AddTagsToStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - tags
```
Map<K,V> tags
```
      The set of key-value pairs to use to create the tags.
- Class com.amazonaws.services.kinesis.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      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.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - shardCount
```
Integer shardCount
```
      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;
      
      Constraints:
      Range: 1 - 100000
- Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream to modify.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - retentionPeriodHours
```
Integer retentionPeriodHours
```
      The new retention period of the stream, in hours. Must be less than the current retention period.
      
      Constraints:
      Range: 1 - 168
- Class com.amazonaws.services.kinesis.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream to delete.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
- Class com.amazonaws.services.kinesis.model.DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.kinesis.model.DescribeLimitsResult extends Object implements Serializable
  - Serialized Fields
    - shardLimit
```
Integer shardLimit
```
      The maximum number of shards.
      
      Constraints:
      Range: 0 - 1000000
    - openShardCount
```
Integer openShardCount
```
      The number of open shards.
      
      Constraints:
      Range: 0 - 1000000
- Class com.amazonaws.services.kinesis.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream to describe.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - limit
```
Integer limit
```
      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.
      
      Constraints:
      Range: 1 - 10000
    - exclusiveStartShardId
```
String exclusiveStartShardId
```
      The shard ID of the shard to start with.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
- Class com.amazonaws.services.kinesis.model.DescribeStreamResult extends Object implements Serializable
  - Serialized Fields
    - streamDescription
```
StreamDescription streamDescription
```
      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.
- Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream to describe.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
- Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryResult extends Object implements Serializable
  - Serialized Fields
    - streamDescriptionSummary
```
StreamDescriptionSummary streamDescriptionSummary
```
      A StreamDescriptionSummary containing information about the stream.
- Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the Kinesis data stream for which to disable enhanced monitoring.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - shardLevelMetrics
```
List<E> shardLevelMetrics
```
      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.
- Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringResult extends Object implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the Kinesis data stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - currentShardLevelMetrics
```
List<E> currentShardLevelMetrics
```
      Represents the current state of the metrics that are in the enhanced state before the operation.
    - desiredShardLevelMetrics
```
List<E> desiredShardLevelMetrics
```
      Represents the list of all the metrics that would be in the enhanced state after the operation.
- Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream for which to enable enhanced monitoring.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - shardLevelMetrics
```
List<E> shardLevelMetrics
```
      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.
- Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringResult extends Object implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the Kinesis data stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - currentShardLevelMetrics
```
List<E> currentShardLevelMetrics
```
      Represents the current state of the metrics that are in the enhanced state before the operation.
    - desiredShardLevelMetrics
```
List<E> desiredShardLevelMetrics
```
      Represents the list of all the metrics that would be in the enhanced state after the operation.
- Class com.amazonaws.services.kinesis.model.EnhancedMetrics extends Object implements Serializable
  - Serialized Fields
    - shardLevelMetrics
```
List<E> shardLevelMetrics
```
      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.
- Class com.amazonaws.services.kinesis.model.ExpiredIteratorException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.ExpiredNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.GetRecordsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - shardIterator
```
String shardIterator
```
      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.
      
      Constraints:
      Length: 1 - 512
    - limit
```
Integer limit
```
      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.
      
      Constraints:
      Range: 1 - 10000
- Class com.amazonaws.services.kinesis.model.GetRecordsResult extends Object implements Serializable
  - Serialized Fields
    - records
```
List<E> records
```
      The data records retrieved from the shard.
    - nextShardIterator
```
String nextShardIterator
```
      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.
      
      Constraints:
      Length: 1 - 512
    - millisBehindLatest
```
Long millisBehindLatest
```
      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.
      
      Constraints:
      Range: 0 -
- Class com.amazonaws.services.kinesis.model.GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the Amazon Kinesis data stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - shardId
```
String shardId
```
      The shard ID of the Kinesis Data Streams shard to get the iterator for.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - shardIteratorType
```
String shardIteratorType
```
      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.
      
      Constraints:
      Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    - startingSequenceNumber
```
String startingSequenceNumber
```
      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.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,128})
    - timestamp
```
Date timestamp
```
      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).
- Class com.amazonaws.services.kinesis.model.GetShardIteratorResult extends Object implements Serializable
  - Serialized Fields
    - shardIterator
```
String shardIterator
```
      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.
      
      Constraints:
      Length: 1 - 512
- Class com.amazonaws.services.kinesis.model.HashKeyRange extends Object implements Serializable
  - Serialized Fields
    - startingHashKey
```
String startingHashKey
```
      The starting hash key of the hash key range.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,38})
    - endingHashKey
```
String endingHashKey
```
      The ending hash key of the hash key range.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,38})
- Class com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream to modify.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - retentionPeriodHours
```
Integer retentionPeriodHours
```
      The new retention period of the stream, in hours. Must be more than the current retention period.
      
      Constraints:
      Range: 1 - 168
- Class com.amazonaws.services.kinesis.model.InvalidArgumentException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.KMSAccessDeniedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.KMSDisabledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.KMSInvalidStateException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.KMSNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.KMSOptInRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.KMSThrottlingException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.ListShardsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the data stream whose shards you want to list.
      
      You cannot specify this parameter if you specify the NextToken parameter.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - nextToken
```
String nextToken
```
      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.
      
      Constraints:
      Length: 1 - 1048576
    - exclusiveStartShardId
```
String exclusiveStartShardId
```
      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.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - maxResults
```
Integer maxResults
```
      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.
      
      Constraints:
      Range: 1 - 10000
    - streamCreationTimestamp
```
Date streamCreationTimestamp
```
      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.
- Class com.amazonaws.services.kinesis.model.ListShardsResult extends Object implements Serializable
  - Serialized Fields
    - shards
```
List<E> shards
```
      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.
    - nextToken
```
String nextToken
```
      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.
      
      Constraints:
      Length: 1 - 1048576
- Class com.amazonaws.services.kinesis.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of streams to list.
      
      Constraints:
      Range: 1 - 10000
    - exclusiveStartStreamName
```
String exclusiveStartStreamName
```
      The name of the stream to start the list with.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
- Class com.amazonaws.services.kinesis.model.ListStreamsResult extends Object implements Serializable
  - Serialized Fields
    - streamNames
```
List<E> streamNames
```
      The names of the streams that are associated with the AWS account making the ListStreams request.
    - hasMoreStreams
```
Boolean hasMoreStreams
```
      If set to true, there are more streams available to list.
- Class com.amazonaws.services.kinesis.model.ListTagsForStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - exclusiveStartTagKey
```
String exclusiveStartTagKey
```
      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.
      
      Constraints:
      Length: 1 - 128
    - limit
```
Integer limit
```
      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.
      
      Constraints:
      Range: 1 - 10
- Class com.amazonaws.services.kinesis.model.ListTagsForStreamResult extends Object implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
    - hasMoreTags
```
Boolean hasMoreTags
```
      If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.
- Class com.amazonaws.services.kinesis.model.MergeShardsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream for the merge.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - shardToMerge
```
String shardToMerge
```
      The shard ID of the shard to combine with the adjacent shard for the merge.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - adjacentShardToMerge
```
String adjacentShardToMerge
```
      The shard ID of the adjacent shard for the merge.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
- Class com.amazonaws.services.kinesis.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.PutRecordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream to put the data record into.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - data
```
ByteBuffer data
```
      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).
      
      Constraints:
      Length: 0 - 1048576
    - partitionKey
```
String partitionKey
```
      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.
      
      Constraints:
      Length: 1 - 256
    - explicitHashKey
```
String explicitHashKey
```
      The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,38})
    - sequenceNumberForOrdering
```
String sequenceNumberForOrdering
```
      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.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,128})
- Class com.amazonaws.services.kinesis.model.PutRecordResult extends Object implements Serializable
  - Serialized Fields
    - shardId
```
String shardId
```
      The shard ID of the shard where the data record was placed.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - sequenceNumber
```
String sequenceNumber
```
      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.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,128})
    - encryptionType
```
String encryptionType
```
      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.
      
      Constraints:
      Allowed Values: NONE, KMS
- Class com.amazonaws.services.kinesis.model.PutRecordsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - records
```
List<E> records
```
      The records associated with the request.
    - streamName
```
String streamName
```
      The stream name associated with the request.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
- Class com.amazonaws.services.kinesis.model.PutRecordsRequestEntry extends Object implements Serializable
  - Serialized Fields
    - data
```
ByteBuffer data
```
      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).
      
      Constraints:
      Length: 0 - 1048576
    - explicitHashKey
```
String explicitHashKey
```
      The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,38})
    - partitionKey
```
String partitionKey
```
      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.
      
      Constraints:
      Length: 1 - 256
- Class com.amazonaws.services.kinesis.model.PutRecordsResult extends Object implements Serializable
  - Serialized Fields
    - failedRecordCount
```
Integer failedRecordCount
```
      The number of unsuccessfully processed records in a PutRecords request.
      
      Constraints:
      Range: 1 - 100000
    - records
```
List<E> records
```
      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.
    - encryptionType
```
String encryptionType
```
      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.
      
      Constraints:
      Allowed Values: NONE, KMS
- Class com.amazonaws.services.kinesis.model.PutRecordsResultEntry extends Object implements Serializable
  - Serialized Fields
    - sequenceNumber
```
String sequenceNumber
```
      The sequence number for an individual record result.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,128})
    - shardId
```
String shardId
```
      The shard ID for an individual record result.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - errorCode
```
String errorCode
```
      The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.
    - errorMessage
```
String errorMessage
```
      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".
- Class com.amazonaws.services.kinesis.model.Record extends Object implements Serializable
  - Serialized Fields
    - sequenceNumber
```
String sequenceNumber
```
      The unique identifier of the record within its shard.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,128})
    - approximateArrivalTimestamp
```
Date approximateArrivalTimestamp
```
      The approximate time that the record was inserted into the stream.
    - data
```
ByteBuffer data
```
      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).
      
      Constraints:
      Length: 0 - 1048576
    - partitionKey
```
String partitionKey
```
      Identifies which shard in the stream the data record is assigned to.
      
      Constraints:
      Length: 1 - 256
    - encryptionType
```
String encryptionType
```
      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.
      
      Constraints:
      Allowed Values: NONE, KMS
- Class com.amazonaws.services.kinesis.model.RemoveTagsFromStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - tagKeys
```
List<E> tagKeys
```
      A list of tag keys. Each corresponding tag is removed from the stream.
- Class com.amazonaws.services.kinesis.model.ResourceInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesis.model.SequenceNumberRange extends Object implements Serializable
  - Serialized Fields
    - startingSequenceNumber
```
String startingSequenceNumber
```
      The starting sequence number for the range.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,128})
    - endingSequenceNumber
```
String endingSequenceNumber
```
      The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,128})
- Class com.amazonaws.services.kinesis.model.Shard extends Object implements Serializable
  - Serialized Fields
    - shardId
```
String shardId
```
      The unique identifier of the shard within the stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - parentShardId
```
String parentShardId
```
      The shard ID of the shard's parent.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - adjacentParentShardId
```
String adjacentParentShardId
```
      The shard ID of the shard adjacent to the shard's parent.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - hashKeyRange
```
HashKeyRange hashKeyRange
```
      The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
    - sequenceNumberRange
```
SequenceNumberRange sequenceNumberRange
```
      The range of possible sequence numbers for the shard.
- Class com.amazonaws.services.kinesis.model.SplitShardRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream for the shard split.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - shardToSplit
```
String shardToSplit
```
      The shard ID of the shard to split.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - newStartingHashKey
```
String newStartingHashKey
```
      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.
      
      Constraints:
      Pattern: 0|([1-9]\d{0,38})
- Class com.amazonaws.services.kinesis.model.StartStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream for which to start encrypting records.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - encryptionType
```
String encryptionType
```
      The encryption type to use. The only valid value is KMS.
      
      Constraints:
      Allowed Values: NONE, KMS
    - keyId
```
String keyId
```
      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
      
      Constraints:
      Length: 1 - 2048
- Class com.amazonaws.services.kinesis.model.StopStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream on which to stop encrypting records.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - encryptionType
```
String encryptionType
```
      The encryption type. The only valid value is KMS.
      
      Constraints:
      Allowed Values: NONE, KMS
    - keyId
```
String keyId
```
      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
      
      Constraints:
      Length: 1 - 2048
- Class com.amazonaws.services.kinesis.model.StreamDescription extends Object implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream being described.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - streamARN
```
String streamARN
```
      The Amazon Resource Name (ARN) for the stream being described.
    - streamStatus
```
String streamStatus
```
      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.
      
      Constraints:
      Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
    - shards
```
List<E> shards
```
      The shards that comprise the stream.
    - hasMoreShards
```
Boolean hasMoreShards
```
      If set to true, more shards in the stream are available to describe.
    - retentionPeriodHours
```
Integer retentionPeriodHours
```
      The current retention period, in hours.
      
      Constraints:
      Range: 1 - 168
    - streamCreationTimestamp
```
Date streamCreationTimestamp
```
      The approximate time that the stream was created.
    - enhancedMonitoring
```
List<E> enhancedMonitoring
```
      Represents the current enhanced monitoring settings of the stream.
    - encryptionType
```
String encryptionType
```
      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.
      
      Constraints:
      Allowed Values: NONE, KMS
    - keyId
```
String keyId
```
      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
      
      Constraints:
      Length: 1 - 2048
- Class com.amazonaws.services.kinesis.model.StreamDescriptionSummary extends Object implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream being described.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - streamARN
```
String streamARN
```
      The Amazon Resource Name (ARN) for the stream being described.
    - streamStatus
```
String streamStatus
```
      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.
      
      Constraints:
      Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
    - retentionPeriodHours
```
Integer retentionPeriodHours
```
      The current retention period, in hours.
      
      Constraints:
      Range: 1 - 100000
    - streamCreationTimestamp
```
Date streamCreationTimestamp
```
      The approximate time that the stream was created.
    - enhancedMonitoring
```
List<E> enhancedMonitoring
```
      Represents the current enhanced monitoring settings of the stream.
    - encryptionType
```
String encryptionType
```
      The encryption type used. This value is one of the following:
      
      KMS
      
      NONE
      
      Constraints:
      Allowed Values: NONE, KMS
    - keyId
```
String keyId
```
      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
      
      Constraints:
      Length: 1 - 2048
    - openShardCount
```
Integer openShardCount
```
      The number of open shards in the stream.
      
      Constraints:
      Range: 0 - 1000000
- Class com.amazonaws.services.kinesis.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
      
      Constraints:
      Length: 1 - 128
    - value
```
String value
```
      An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
      
      Constraints:
      Length: 0 - 256
- Class com.amazonaws.services.kinesis.model.UpdateShardCountRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - targetShardCount
```
Integer targetShardCount
```
      The new number of shards.
      
      Constraints:
      Range: 1 - 100000
    - scalingType
```
String scalingType
```
      The scaling type. Uniform scaling creates shards of equal size.
      
      Constraints:
      Allowed Values: UNIFORM_SCALING
- Class com.amazonaws.services.kinesis.model.UpdateShardCountResult extends Object implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the stream.
      
      Constraints:
      Length: 1 - 128
      Pattern: [a-zA-Z0-9_.-]+
    - currentShardCount
```
Integer currentShardCount
```
      The current number of shards.
      
      Constraints:
      Range: 1 - 100000
    - targetShardCount
```
Integer targetShardCount
```
      The updated number of shards.
      
      Constraints:
      Range: 1 - 100000
Package com.amazonaws.services.kinesisfirehose.model
- Class com.amazonaws.services.kinesisfirehose.model.InvalidArgumentException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deliveryStreamName
```
String deliveryStreamName
```
      The name of the delivery stream.
      
      Constraints:
      Length: 1 - 64
      Pattern: [a-zA-Z0-9_.-]+
    - records
```
List<E> records
```
      One or more records.
- Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResponseEntry extends Object implements Serializable
  - Serialized Fields
    - recordId
```
String recordId
```
      The ID of the record.
      
      Constraints:
      Length: 1 -
    - errorCode
```
String errorCode
```
      The error code for an individual record result.
    - errorMessage
```
String errorMessage
```
      The error message for an individual record result.
- Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResult extends Object implements Serializable
  - Serialized Fields
    - failedPutCount
```
Integer failedPutCount
```
      The number of records that might have failed processing. This number might be greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount to determine whether there are records that you need to resend.
      
      Constraints:
      Range: 0 -
    - encrypted
```
Boolean encrypted
```
      Indicates whether server-side encryption (SSE) was enabled during this operation.
    - requestResponses
```
List<E> requestResponses
```
      The results array. For each record, the index of the response element is the same as the index used in the request array.
- Class com.amazonaws.services.kinesisfirehose.model.Record extends Object implements Serializable
  - Serialized Fields
    - data
```
ByteBuffer data
```
      The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.
      
      Constraints:
      Length: 0 - 1024000
- Class com.amazonaws.services.kinesisfirehose.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kinesisfirehose.model.ServiceUnavailableException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L

Serialized Form

Package com.amazonaws.services.kinesis.model

Class com.amazonaws.services.kinesis.model.AddTagsToStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

tags

Class com.amazonaws.services.kinesis.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

shardCount

Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

retentionPeriodHours

Class com.amazonaws.services.kinesis.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

Class com.amazonaws.services.kinesis.model.DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.kinesis.model.DescribeLimitsResult extends Object implements Serializable

Serialized Fields

shardLimit

openShardCount

Class com.amazonaws.services.kinesis.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

limit

exclusiveStartShardId

Class com.amazonaws.services.kinesis.model.DescribeStreamResult extends Object implements Serializable

Serialized Fields

streamDescription

Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryResult extends Object implements Serializable

Serialized Fields

streamDescriptionSummary

Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

shardLevelMetrics

Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringResult extends Object implements Serializable

Serialized Fields

streamName

currentShardLevelMetrics

desiredShardLevelMetrics

Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

shardLevelMetrics

Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringResult extends Object implements Serializable

Serialized Fields

streamName

currentShardLevelMetrics

desiredShardLevelMetrics

Class com.amazonaws.services.kinesis.model.EnhancedMetrics extends Object implements Serializable

Serialized Fields

shardLevelMetrics

Class com.amazonaws.services.kinesis.model.ExpiredIteratorException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.kinesis.model.ExpiredNextTokenException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.kinesis.model.GetRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shardIterator

limit

Class com.amazonaws.services.kinesis.model.GetRecordsResult extends Object implements Serializable

Serialized Fields

records

nextShardIterator

millisBehindLatest

Class com.amazonaws.services.kinesis.model.GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

shardId

shardIteratorType

startingSequenceNumber

timestamp

Class com.amazonaws.services.kinesis.model.GetShardIteratorResult extends Object implements Serializable

Serialized Fields

shardIterator

Class com.amazonaws.services.kinesis.model.HashKeyRange extends Object implements Serializable

Serialized Fields