You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Kinesis

Inherits:
AWS.Service show all
Identifier:
kinesis
API Version:
2013-12-02
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

Sending a Request Using Kinesis

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

Locking the API Version

In order to ensure that the Kinesis object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kinesis = new AWS.Kinesis({apiVersion: '2013-12-02'});

You can also set the API version globally in AWS.config.apiVersions using the kinesis service identifier:

AWS.config.apiVersions = {
  kinesis: '2013-12-02',
  // other service API versions
};

var kinesis = new AWS.Kinesis();

Version:

  • 2013-12-02

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

streamExists, streamNotExists

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Kinesis(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Kinesis object

var kinesis = new AWS.Kinesis({apiVersion: '2013-12-02'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Kinesis.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Kinesis.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Kinesis.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addTagsToStream(params = {}, callback) ⇒ AWS.Request

Adds or updates tags for the specified Kinesis data stream. Each time you invoke this operation, you can specify up to 10 tags. If you want to add more than 10 tags to your stream, you can invoke this operation multiple times. In total, each stream can have up to 50 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

AddTagsToStream has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the addTagsToStream operation

var params = {
  StreamName: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
kinesis.addTagsToStream(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.

    • Tags — (map<String>)

      A set of up to 10 key-value pairs to use to create the tags.

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.

createStream(params = {}, callback) ⇒ AWS.Request

Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.

You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.

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

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.

You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:

  • Have more than five streams in the CREATING state at any point in time.

  • Create more shards than are authorized for your account.

For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.

You can use DescribeStream to check the stream status, which is returned in StreamStatus.

CreateStream has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the createStream operation

var params = {
  ShardCount: 'NUMBER_VALUE', /* required */
  StreamName: 'STRING_VALUE' /* 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 AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

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

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.

decreaseStreamRetentionPeriod(params = {}, callback) ⇒ AWS.Request

Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

Service Reference:

Examples:

Calling the decreaseStreamRetentionPeriod operation

var params = {
  RetentionPeriodHours: 'NUMBER_VALUE', /* required */
  StreamName: 'STRING_VALUE' /* required */
};
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.

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.

deleteStream(params = {}, callback) ⇒ AWS.Request

Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException.

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the deleteStream operation

var params = {
  StreamName: 'STRING_VALUE', /* required */
  EnforceConsumerDeletion: true || false
};
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.

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.

deregisterStreamConsumer(params = {}, callback) ⇒ AWS.Request

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or 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 name and ARN.

This operation has a limit of five transactions per second per stream.

Service Reference:

Examples:

Calling the deregisterStreamConsumer operation

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

describeLimits(params = {}, callback) ⇒ AWS.Request

Describes the shard limits and usage for the account.

If you update your account limits, the old limits might be returned for a few minutes.

This operation has a limit of one transaction per second per account.

Service Reference:

Examples:

Calling the describeLimits operation

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.

Returns:

  • (AWS.Request) —

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

describeStream(params = {}, callback) ⇒ AWS.Request

Describes the specified Kinesis data stream.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

Service Reference:

Examples:

Calling the describeStream operation

var params = {
  StreamName: 'STRING_VALUE', /* required */
  ExclusiveStartShardId: 'STRING_VALUE',
  Limit: 'NUMBER_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 shards are returned.

    • ExclusiveStartShardId — (String)

      The shard ID of the shard to start with.

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"
        • 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 AWS KMS key.

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

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

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

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

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

          • Alias name example: alias/MyAliasName

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

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

describeStreamConsumer(params = {}, callback) ⇒ AWS.Request

To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, 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.

This operation has a limit of 20 transactions per second per stream.

Service Reference:

Examples:

Calling the describeStreamConsumer operation

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

describeStreamSummary(params = {}, callback) ⇒ AWS.Request

Provides a summarized description of the specified Kinesis data stream without the shard list.

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.

DescribeStreamSummary has a limit of 20 transactions per second per account.

Service Reference:

Examples:

Calling the describeStreamSummary operation

var params = {
  StreamName: 'STRING_VALUE' /* required */
};
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.

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"
        • 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 AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

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

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

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

          • Alias name example: alias/MyAliasName

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

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

disableEnhancedMonitoring(params = {}, callback) ⇒ AWS.Request

Disables enhanced monitoring.

Service Reference:

Examples:

Calling the disableEnhancedMonitoring operation

var params = {
  ShardLevelMetrics: [ /* required */
    IncomingBytes | IncomingRecords | OutgoingBytes | OutgoingRecords | WriteProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded | IteratorAgeMilliseconds | ALL,
    /* more items */
  ],
  StreamName: 'STRING_VALUE' /* required */
};
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.

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.

Returns:

  • (AWS.Request) —

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

enableEnhancedMonitoring(params = {}, callback) ⇒ AWS.Request

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

Service Reference:

Examples:

Calling the enableEnhancedMonitoring operation

var params = {
  ShardLevelMetrics: [ /* required */
    IncomingBytes | IncomingRecords | OutgoingBytes | OutgoingRecords | WriteProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded | IteratorAgeMilliseconds | ALL,
    /* more items */
  ],
  StreamName: 'STRING_VALUE' /* required */
};
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.

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.

Returns:

  • (AWS.Request) —

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

getRecords(params = {}, callback) ⇒ AWS.Request

Gets data records from a Kinesis data stream's shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.

You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000.

The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second.

To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide).

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.

This operation has a limit of five transactions per second per shard.

Service Reference:

Examples:

Calling the getRecords operation

var params = {
  ShardIterator: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_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.

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 AWS 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>)
        • ShardId — required — (String)
        • ParentShards — required — (Array<String>)
        • 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.

getShardIterator(params = {}, callback) ⇒ AWS.Request

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.

A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.

GetShardIterator has a limit of five transactions per second per account per open shard.

Service Reference:

Examples:

Calling the getShardIterator operation

var params = {
  ShardId: 'STRING_VALUE', /* required */
  ShardIteratorType: AT_SEQUENCE_NUMBER | AFTER_SEQUENCE_NUMBER | TRIM_HORIZON | LATEST | AT_TIMESTAMP, /* required */
  StreamName: 'STRING_VALUE', /* required */
  StartingSequenceNumber: '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).

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.

increaseStreamRetentionPeriod(params = {}, callback) ⇒ AWS.Request

Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.

Service Reference:

Examples:

Calling the increaseStreamRetentionPeriod operation

var params = {
  RetentionPeriodHours: 'NUMBER_VALUE', /* required */
  StreamName: 'STRING_VALUE' /* required */
};
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.

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.

listShards(params = {}, callback) ⇒ AWS.Request

Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream.

This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.

Service Reference:

Examples:

Calling the listShards operation

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
  },
  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 minimum value you can specify for this parameter is 1, and the maximum is 10,000, which is also the default.

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

    • 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)
      • Type — required — (String) Possible values include:
        • "AFTER_SHARD_ID"
        • "AT_TRIM_HORIZON"
        • "FROM_TRIM_HORIZON"
        • "AT_LATEST"
        • "AT_TIMESTAMP"
        • "FROM_TIMESTAMP"
      • ShardId — (String)
      • Timestamp — (Date)

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.

listStreamConsumers(params = {}, callback) ⇒ AWS.Request

Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.

This operation has a limit of 5 transactions per second per stream.

Service Reference:

Examples:

Calling the listStreamConsumers operation

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

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

listStreams(params = {}, callback) ⇒ AWS.Request

Lists your Kinesis data streams.

The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the listStreams operation

var params = {
  ExclusiveStartStreamName: 'STRING_VALUE',
  Limit: 'NUMBER_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.

    • ExclusiveStartStreamName — (String)

      The name of the stream to start the list with.

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 AWS account making the ListStreams request.

      • HasMoreStreams — (Boolean)

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

Returns:

  • (AWS.Request) —

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

listTagsForStream(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the listTagsForStream operation

var params = {
  StreamName: 'STRING_VALUE', /* required */
  ExclusiveStartTagKey: 'STRING_VALUE',
  Limit: 'NUMBER_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.

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.

mergeShards(params = {}, callback) ⇒ AWS.Request

Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.

If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.

You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException.

MergeShards has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the mergeShards operation

var params = {
  AdjacentShardToMerge: 'STRING_VALUE', /* required */
  ShardToMerge: 'STRING_VALUE', /* required */
  StreamName: 'STRING_VALUE' /* required */
};
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.

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.

putRecord(params = {}, callback) ⇒ AWS.Request

Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

After you write a record to a stream, you cannot modify that record or its order within the stream.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

Service Reference:

Examples:

Calling the putRecord operation

var params = {
  Data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  PartitionKey: 'STRING_VALUE', /* required */
  StreamName: 'STRING_VALUE', /* required */
  ExplicitHashKey: 'STRING_VALUE',
  SequenceNumberForOrdering: '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.

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 AWS KMS key.

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

Returns:

  • (AWS.Request) —

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

putRecords(params = {}, callback) ⇒ AWS.Request

Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.

Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. 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. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.

The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead of PutRecords, and write to the same shard.

A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.

After you write a record to a stream, you cannot modify that record or its order within the stream.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

Service Reference:

Examples:

Calling the putRecords operation

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 */
  ],
  StreamName: 'STRING_VALUE' /* required */
};
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.

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, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

        • 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 AWS KMS key.

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

Returns:

  • (AWS.Request) —

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

registerStreamConsumer(params = {}, callback) ⇒ AWS.Request

Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.

For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.

The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.

Service Reference:

Examples:

Calling the registerStreamConsumer operation

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

removeTagsFromStream(params = {}, callback) ⇒ AWS.Request

Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

If you specify a tag that does not exist, it is ignored.

RemoveTagsFromStream has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the removeTagsFromStream operation

var params = {
  StreamName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
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.

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.

splitShard(params = {}, callback) ⇒ AWS.Request

Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.

You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.

You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.

You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.

If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.

For the default shard limit for an AWS account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.

SplitShard has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the splitShard operation

var params = {
  NewStartingHashKey: 'STRING_VALUE', /* required */
  ShardToSplit: 'STRING_VALUE', /* required */
  StreamName: 'STRING_VALUE' /* required */
};
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.

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.

startStreamEncryption(params = {}, callback) ⇒ AWS.Request

Enables or updates server-side encryption using an AWS KMS key for a specified stream.

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream.

API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords.

Service Reference:

Examples:

Calling the startStreamEncryption operation

var params = {
  EncryptionType: NONE | KMS, /* required */
  KeyId: 'STRING_VALUE', /* required */
  StreamName: 'STRING_VALUE' /* required */
};
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 AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

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

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

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

      • Alias name example: alias/MyAliasName

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

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.

stopStreamEncryption(params = {}, callback) ⇒ AWS.Request

Disables server-side encryption for a specified stream.

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.

API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords.

Service Reference:

Examples:

Calling the stopStreamEncryption operation

var params = {
  EncryptionType: NONE | KMS, /* required */
  KeyId: 'STRING_VALUE', /* required */
  StreamName: 'STRING_VALUE' /* required */
};
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 AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

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

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

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

      • Alias name example: alias/MyAliasName

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

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.

updateShardCount(params = {}, callback) ⇒ AWS.Request

Updates the shard count of the specified stream to the specified number of shards.

Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.

To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region.

When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.

This operation has the following default limits. By default, you cannot do the following:

  • Scale more than ten times per rolling 24-hour period per stream

  • Scale up to more than double your current shard count for a stream

  • Scale down below half your current shard count for a stream

  • Scale up to more than 500 shards in a stream

  • Scale a stream with more than 500 shards down unless the result is less than 500 shards

  • Scale up to more than the shard limit for your account

For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.

Service Reference:

Examples:

Calling the updateShardCount operation

var params = {
  ScalingType: UNIFORM_SCALING, /* required */
  StreamName: 'STRING_VALUE', /* required */
  TargetShardCount: 'NUMBER_VALUE' /* required */
};
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 500 shards in a stream (the default limit for shard count per stream is 500 per account per region), unless you request a limit increase.

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

    • ScalingType — (String)

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

      Possible values include:
      • "UNIFORM_SCALING"

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.

Returns:

  • (AWS.Request) —

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

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Kinesis resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the streamExists state

var params = {
  StreamName: 'STRING_VALUE', /* required */
};
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:

Waiter Resource Details

kinesis.waitFor('streamExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamExists state by periodically calling the underlying Kinesis.describeStream() operation every 10 seconds (at most 18 times).

Examples:

Waiting for the streamExists state

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

Parameters:

  • params (Object) —
    • 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 shards are returned.

    • ExclusiveStartShardId — (String)

      The shard ID of the shard to start with.

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"
        • 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 AWS KMS key.

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

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

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

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

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

          • Alias name example: alias/MyAliasName

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

Returns:

  • (AWS.Request) —

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

See Also:

kinesis.waitFor('streamNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamNotExists state by periodically calling the underlying Kinesis.describeStream() operation every 10 seconds (at most 18 times).

Examples:

Waiting for the streamNotExists state

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

Parameters:

  • params (Object) —
    • 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 shards are returned.

    • ExclusiveStartShardId — (String)

      The shard ID of the shard to start with.

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"
        • 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 AWS KMS key.

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

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

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

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

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

          • Alias name example: alias/MyAliasName

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

Returns:

  • (AWS.Request) —

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

See Also: