Class: AWS.Kinesis

var params = {
  StreamName: 'STRING_VALUE', /* required */
  ShardCount: 'NUMBER_VALUE',
  StreamModeDetails: {
    StreamMode: PROVISIONED | ON_DEMAND /* required */
  }
};
kinesis.createStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

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

  • ShardCount — (Integer)

    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.

  • StreamModeDetails — (map)

    Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

    • StreamMode — required — (String)

      Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

      Possible values include:
      • "PROVISIONED"
      • "ON_DEMAND"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RetentionPeriodHours: 'NUMBER_VALUE', /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.decreaseStreamRetentionPeriod(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream to modify.

  • RetentionPeriodHours — (Integer)

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

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
kinesis.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The Amazon Resource Name (ARN) of the data stream or consumer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EnforceConsumerDeletion: true || false,
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.deleteStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream to delete.

  • EnforceConsumerDeletion — (Boolean)

    If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConsumerARN: 'STRING_VALUE',
  ConsumerName: 'STRING_VALUE',
  StreamARN: 'STRING_VALUE'
};
kinesis.deregisterStreamConsumer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamARN — (String)

    The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

  • ConsumerName — (String)

    The name that you gave to the consumer.

  • ConsumerARN — (String)

    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
};
kinesis.describeLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ShardLimit — (Integer)

      The maximum number of shards.

    • OpenShardCount — (Integer)

      The number of open shards.

    • OnDemandStreamCount — (Integer)

      Indicates the number of data streams with the on-demand capacity mode.

    • OnDemandStreamCountLimit — (Integer)

      The maximum number of data streams with the on-demand capacity mode.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExclusiveStartShardId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.describeStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream to describe.

  • Limit — (Integer)

    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 results are returned.

  • ExclusiveStartShardId — (String)

    The shard ID of the shard to start with.

    Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId.

    If you don't specify this parameter, the default behavior for DescribeStream is to describe the stream starting with the first shard in the stream.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StreamDescription — (map)

      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.

      • StreamName — required — (String)

        The name of the stream being described.

      • StreamARN — required — (String)

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

      • StreamStatus — required — (String)

        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.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
        • "UPDATING"
      • StreamModeDetails — (map)

        Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

        • StreamMode — required — (String)

          Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

          Possible values include:
          • "PROVISIONED"
          • "ON_DEMAND"
      • Shards — required — (Array<map>)

        The shards that comprise the stream.

        • ShardId — required — (String)

          The unique identifier of the shard within the stream.

        • ParentShardId — (String)

          The shard ID of the shard's parent.

        • AdjacentParentShardId — (String)

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

        • HashKeyRange — required — (map)

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

          • StartingHashKey — required — (String)

            The starting hash key of the hash key range.

          • EndingHashKey — required — (String)

            The ending hash key of the hash key range.

        • SequenceNumberRange — required — (map)

          The range of possible sequence numbers for the shard.

          • StartingSequenceNumber — required — (String)

            The starting sequence number for the range.

          • EndingSequenceNumber — (String)

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

      • HasMoreShards — required — (Boolean)

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

      • RetentionPeriodHours — required — (Integer)

        The current retention period, in hours. Minimum value of 24. Maximum value of 168.

      • StreamCreationTimestamp — required — (Date)

        The approximate time that the stream was created.

      • EnhancedMonitoring — required — (Array<map>)

        Represents the current enhanced monitoring settings of the stream.

        • ShardLevelMetrics — (Array<String>)

          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.

      • EncryptionType — (String)

        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 Amazon Web Services KMS key.

        Possible values include:
        • "NONE"
        • "KMS"
      • KeyId — (String)

        The GUID for the customer-managed Amazon Web Services 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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• streamExists

• streamNotExists

var params = {
  ConsumerARN: 'STRING_VALUE',
  ConsumerName: 'STRING_VALUE',
  StreamARN: 'STRING_VALUE'
};
kinesis.describeStreamConsumer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamARN — (String)

    The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

  • ConsumerName — (String)

    The name that you gave to the consumer.

  • ConsumerARN — (String)

    The ARN returned by Kinesis Data Streams when you registered the consumer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ConsumerDescription — (map)

      An object that represents the details of the consumer.

      • ConsumerName — required — (String)

        The name of the consumer is something you choose when you register the consumer.

      • ConsumerARN — required — (String)

        When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

        If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

      • ConsumerStatus — required — (String)

        A consumer can't read data while in the CREATING or DELETING states.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
      • ConsumerCreationTimestamp — required — (Date)

      • StreamARN — required — (String)

        The ARN of the stream with which you registered the consumer.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.describeStreamSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream to describe.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StreamDescriptionSummary — (map)

      A StreamDescriptionSummary containing information about the stream.

      • StreamName — required — (String)

        The name of the stream being described.

      • StreamARN — required — (String)

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

      • StreamStatus — required — (String)

        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.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
        • "UPDATING"
      • StreamModeDetails — (map)

        Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.

        • StreamMode — required — (String)

          Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

          Possible values include:
          • "PROVISIONED"
          • "ON_DEMAND"
      • RetentionPeriodHours — required — (Integer)

        The current retention period, in hours.

      • StreamCreationTimestamp — required — (Date)

        The approximate time that the stream was created.

      • EnhancedMonitoring — required — (Array<map>)

        Represents the current enhanced monitoring settings of the stream.

        • ShardLevelMetrics — (Array<String>)

          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.

      • EncryptionType — (String)

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

        • KMS

        • NONE

        Possible values include:
        • "NONE"
        • "KMS"
      • KeyId — (String)

        The GUID for the customer-managed Amazon Web Services 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

      • OpenShardCount — required — (Integer)

        The number of open shards in the stream.

      • ConsumerCount — (Integer)

        The number of enhanced fan-out consumers registered with the stream.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ShardLevelMetrics: [ /* required */
    IncomingBytes | IncomingRecords | OutgoingBytes | OutgoingRecords | WriteProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded | IteratorAgeMilliseconds | ALL,
    /* more items */
  ],
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.disableEnhancedMonitoring(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

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

  • ShardLevelMetrics — (Array<String>)

    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.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StreamName — (String)

      The name of the Kinesis data stream.

    • CurrentShardLevelMetrics — (Array<String>)

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

    • DesiredShardLevelMetrics — (Array<String>)

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

    • StreamARN — (String)

      The ARN of the stream.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ShardLevelMetrics: [ /* required */
    IncomingBytes | IncomingRecords | OutgoingBytes | OutgoingRecords | WriteProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded | IteratorAgeMilliseconds | ALL,
    /* more items */
  ],
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.enableEnhancedMonitoring(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

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

  • ShardLevelMetrics — (Array<String>)

    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.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StreamName — (String)

      The name of the Kinesis data stream.

    • CurrentShardLevelMetrics — (Array<String>)

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

    • DesiredShardLevelMetrics — (Array<String>)

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

    • StreamARN — (String)

      The ARN of the stream.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ShardIterator: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  StreamARN: 'STRING_VALUE'
};
kinesis.getRecords(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ShardIterator — (String)

    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.

  • Limit — (Integer)

    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. The default value is 10,000.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Records — (Array<map>)

      The data records retrieved from the shard.

      • SequenceNumber — required — (String)

        The unique identifier of the record within its shard.

      • ApproximateArrivalTimestamp — (Date)

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

      • Data — required — (Buffer, Typed Array, Blob, String)

        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 MiB).

      • PartitionKey — required — (String)

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

      • EncryptionType — (String)

        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 Amazon Web Services KMS key.

        Possible values include:
        • "NONE"
        • "KMS"
    • NextShardIterator — (String)

      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.

    • MillisBehindLatest — (Integer)

      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.

    • ChildShards — (Array<map>)

      The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

      • ShardId — required — (String)

        The shard ID of the existing child shard of the current shard.

      • ParentShards — required — (Array<String>)

        The current shard that is the parent of the existing child shard.

      • HashKeyRange — required — (map)

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

        • StartingHashKey — required — (String)

          The starting hash key of the hash key range.

        • EndingHashKey — required — (String)

          The ending hash key of the hash key range.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
kinesis.getResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The Amazon Resource Name (ARN) of the data stream or consumer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Policy — (String)

      Details of the resource policy. This is formatted as a JSON string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ShardId: 'STRING_VALUE', /* required */
  ShardIteratorType: AT_SEQUENCE_NUMBER | AFTER_SEQUENCE_NUMBER | TRIM_HORIZON | LATEST | AT_TIMESTAMP, /* required */
  StartingSequenceNumber: 'STRING_VALUE',
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE',
  Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
kinesis.getShardIterator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the Amazon Kinesis data stream.

  • ShardId — (String)

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

  • ShardIteratorType — (String)

    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.

    Possible values include:
    • "AT_SEQUENCE_NUMBER"
    • "AFTER_SEQUENCE_NUMBER"
    • "TRIM_HORIZON"
    • "LATEST"
    • "AT_TIMESTAMP"
  • StartingSequenceNumber — (String)

    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.

  • Timestamp — (Date)

    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).

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ShardIterator — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RetentionPeriodHours: 'NUMBER_VALUE', /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.increaseStreamRetentionPeriod(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream to modify.

  • RetentionPeriodHours — (Integer)

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

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExclusiveStartShardId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ShardFilter: {
    Type: AFTER_SHARD_ID | AT_TRIM_HORIZON | FROM_TRIM_HORIZON | AT_LATEST | AT_TIMESTAMP | FROM_TIMESTAMP, /* required */
    ShardId: 'STRING_VALUE',
    Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  StreamARN: 'STRING_VALUE',
  StreamCreationTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  StreamName: 'STRING_VALUE'
};
kinesis.listShards(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

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

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

  • NextToken — (String)

    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.

  • ExclusiveStartShardId — (String)

    Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.

    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.

  • MaxResults — (Integer)

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

    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.

  • StreamCreationTimestamp — (Date)

    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.

  • ShardFilter — (map)

    Enables you to filter out the response of the ListShards API. You can only specify one filter at a time.

    If you use the ShardFilter parameter when invoking the ListShards API, the Type is the required property and must be specified. If you specify the AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or AT_LATEST types, you do not need to specify either the ShardId or the Timestamp optional properties.

    If you specify the AFTER_SHARD_ID type, you must also provide the value for the optional ShardId property. The ShardId property is identical in fuctionality to the ExclusiveStartShardId parameter of the ListShards API. When ShardId property is specified, the response includes the shards starting with the shard whose ID immediately follows the ShardId that you provided.

    If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must also provide the value for the optional Timestamp property. If you specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the provided timestamp to TIP are returned.

    • Type — required — (String)

      The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.

      You can specify the following valid values:

      • AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.

      • AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.

      • FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).

      • AT_LATEST - the response includes only the currently open shards of the data stream.

      • AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.

      • FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.

      Possible values include:
      • "AFTER_SHARD_ID"
      • "AT_TRIM_HORIZON"
      • "FROM_TRIM_HORIZON"
      • "AT_LATEST"
      • "AT_TIMESTAMP"
      • "FROM_TIMESTAMP"
    • ShardId — (String)

      The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.

    • Timestamp — (Date)

      The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Shards — (Array<map>)

      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.

      • ShardId — required — (String)

        The unique identifier of the shard within the stream.

      • ParentShardId — (String)

        The shard ID of the shard's parent.

      • AdjacentParentShardId — (String)

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

      • HashKeyRange — required — (map)

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

        • StartingHashKey — required — (String)

          The starting hash key of the hash key range.

        • EndingHashKey — required — (String)

          The ending hash key of the hash key range.

      • SequenceNumberRange — required — (map)

        The range of possible sequence numbers for the shard.

        • StartingSequenceNumber — required — (String)

          The starting sequence number for the range.

        • EndingSequenceNumber — (String)

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

    • NextToken — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  StreamARN: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StreamCreationTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
kinesis.listStreamConsumers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamARN — (String)

    The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

  • NextToken — (String)

    When the number of consumers that are registered with 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 consumers that are registered with the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers.

    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 consumers 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 ListStreamConsumers operation to list the next set of consumers.

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

  • MaxResults — (Integer)

    The maximum number of consumers that you want a single call of ListStreamConsumers to return. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

  • StreamCreationTimestamp — (Date)

    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 consumers for.

    You can't specify this parameter if you specify the NextToken parameter.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Consumers — (Array<map>)

      An array of JSON objects. Each object represents one registered consumer.

      • ConsumerName — required — (String)

        The name of the consumer is something you choose when you register the consumer.

      • ConsumerARN — required — (String)

        When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

        If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

      • ConsumerStatus — required — (String)

        A consumer can't read data while in the CREATING or DELETING states.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
      • ConsumerCreationTimestamp — required — (Date)

    • NextToken — (String)

      When the number of consumers that are registered with 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 registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExclusiveStartStreamName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kinesis.listStreams(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Limit — (Integer)

    The maximum number of streams to list. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

  • ExclusiveStartStreamName — (String)

    The name of the stream to start the list with.

  • NextToken — (String)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StreamNames — (Array<String>)

      The names of the streams that are associated with the Amazon Web Services account making the ListStreams request.

    • HasMoreStreams — (Boolean)

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

    • NextToken — (String)

    • StreamSummaries — (Array<map>)
      • StreamName — required — (String)

        The name of a stream.

      • StreamARN — required — (String)

        The ARN of the stream.

      • StreamStatus — required — (String)

        The status of the stream.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
        • "UPDATING"
      • StreamModeDetails — (map)

        Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

        • StreamMode — required — (String)

          Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

          Possible values include:
          • "PROVISIONED"
          • "ON_DEMAND"
      • StreamCreationTimestamp — (Date)

        The timestamp at which the stream was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExclusiveStartTagKey: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.listTagsForStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream.

  • ExclusiveStartTagKey — (String)

    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.

  • Limit — (Integer)

    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.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

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

      • Key — required — (String)

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

      • Value — (String)

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

    • HasMoreTags — (Boolean)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AdjacentShardToMerge: 'STRING_VALUE', /* required */
  ShardToMerge: 'STRING_VALUE', /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.mergeShards(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream for the merge.

  • ShardToMerge — (String)

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

  • AdjacentShardToMerge — (String)

    The shard ID of the adjacent shard for the merge.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  PartitionKey: 'STRING_VALUE', /* required */
  ExplicitHashKey: 'STRING_VALUE',
  SequenceNumberForOrdering: 'STRING_VALUE',
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.putRecord(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

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

  • Data — (Buffer, Typed Array, Blob, String)

    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 MiB).

  • PartitionKey — (String)

    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.

  • ExplicitHashKey — (String)

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

  • SequenceNumberForOrdering — (String)

    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.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ShardId — (String)

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

    • SequenceNumber — (String)

      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.

    • EncryptionType — (String)

      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 Amazon Web Services KMS key.

      Possible values include:
      • "NONE"
      • "KMS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Records: [ /* required */
    {
      Data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
      PartitionKey: 'STRING_VALUE', /* required */
      ExplicitHashKey: 'STRING_VALUE'
    },
    /* more items */
  ],
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.putRecords(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Records — (Array<map>)

    The records associated with the request.

    • Data — required — (Buffer, Typed Array, Blob, String)

      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 MiB).

    • ExplicitHashKey — (String)

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

    • PartitionKey — required — (String)

      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.

  • StreamName — (String)

    The stream name associated with the request.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • FailedRecordCount — (Integer)

      The number of unsuccessfully processed records in a PutRecords request.

    • Records — (Array<map>)

      An array of successfully and unsuccessfully processed record results. 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.

      • SequenceNumber — (String)

        The sequence number for an individual record result.

      • ShardId — (String)

        The shard ID for an individual record result.

      • ErrorCode — (String)

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

      • ErrorMessage — (String)

        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".

    • EncryptionType — (String)

      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 Amazon Web Services KMS key.

      Possible values include:
      • "NONE"
      • "KMS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Policy: 'STRING_VALUE', /* required */
  ResourceARN: 'STRING_VALUE' /* required */
};
kinesis.putResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The Amazon Resource Name (ARN) of the data stream or consumer.

  • Policy — (String)

    Details of the resource policy. It must include the identity of the principal and the actions allowed on this resource. This is formatted as a JSON string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConsumerName: 'STRING_VALUE', /* required */
  StreamARN: 'STRING_VALUE' /* required */
};
kinesis.registerStreamConsumer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamARN — (String)

    The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

  • ConsumerName — (String)

    For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Consumer — (map)

      An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.

      • ConsumerName — required — (String)

        The name of the consumer is something you choose when you register the consumer.

      • ConsumerARN — required — (String)

        When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

        If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

      • ConsumerStatus — required — (String)

        A consumer can't read data while in the CREATING or DELETING states.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
      • ConsumerCreationTimestamp — required — (Date)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.removeTagsFromStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream.

  • TagKeys — (Array<String>)

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

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NewStartingHashKey: 'STRING_VALUE', /* required */
  ShardToSplit: 'STRING_VALUE', /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.splitShard(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream for the shard split.

  • ShardToSplit — (String)

    The shard ID of the shard to split.

  • NewStartingHashKey — (String)

    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.

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EncryptionType: NONE | KMS, /* required */
  KeyId: 'STRING_VALUE', /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.startStreamEncryption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

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

  • EncryptionType — (String)

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

    Possible values include:
    • "NONE"
    • "KMS"
  • KeyId — (String)

    The GUID for the customer-managed Amazon Web Services 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

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EncryptionType: NONE | KMS, /* required */
  KeyId: 'STRING_VALUE', /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.stopStreamEncryption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

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

  • EncryptionType — (String)

    The encryption type. The only valid value is KMS.

    Possible values include:
    • "NONE"
    • "KMS"
  • KeyId — (String)

    The GUID for the customer-managed Amazon Web Services 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

  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ScalingType: UNIFORM_SCALING, /* required */
  TargetShardCount: 'NUMBER_VALUE', /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesis.updateShardCount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamName — (String)

    The name of the stream.

  • TargetShardCount — (Integer)

    The new number of shards. This value has the following default limits. By default, you cannot do the following:

    • Set this value to more than double your current shard count for a stream.

    • Set this value below half your current shard count for a stream.

    • Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.

    • Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

  • ScalingType — (String)

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

    Possible values include:
    • "UNIFORM_SCALING"
  • StreamARN — (String)

    The ARN of the stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StreamName — (String)

      The name of the stream.

    • CurrentShardCount — (Integer)

      The current number of shards.

    • TargetShardCount — (Integer)

      The updated number of shards.

    • StreamARN — (String)

      The ARN of the stream.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  StreamARN: 'STRING_VALUE', /* required */
  StreamModeDetails: { /* required */
    StreamMode: PROVISIONED | ON_DEMAND /* required */
  }
};
kinesis.updateStreamMode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StreamARN — (String)

    Specifies the ARN of the data stream whose capacity mode you want to update.

  • StreamModeDetails — (map)

    Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

    • StreamMode — required — (String)

      Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

      Possible values include:
      • "PROVISIONED"
      • "ON_DEMAND"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  // ... input parameters ...
};
kinesis.waitFor('streamExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• streamExists

• streamNotExists