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)