Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . keyspacesstreams ]

get-stream¶

Description¶

Returns detailed information about a specific data capture stream for an Amazon Keyspaces table. The information includes the stream’s Amazon Resource Name (ARN), creation time, current status, retention period, shard composition, and associated table details. This operation helps you monitor and manage the configuration of your Amazon Keyspaces data streams.

Synopsis¶

  get-stream
--stream-arn <value>
[--shard-filter <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--stream-arn (string)

The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.

--shard-filter (structure)

Optional filter criteria to apply when retrieving shards. You can filter shards based on their state or other attributes to narrow down the results returned by the GetStream operation.

type -> (string)

The type of shard filter to use, which determines how the shardId parameter is interpreted.

shardId -> (string)

The identifier of a specific shard used to filter results based on the specified filter type.

Shorthand Syntax:

type=string,shardId=string

JSON Syntax:

{
  "type": "CHILD_SHARDS",
  "shardId": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

streamArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

streamLabel -> (string)

A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

streamStatus -> (string)

The current status of the stream. Values can be ENABLING , ENABLED , DISABLING , or DISABLED . Operations on the stream depend on its current status.

streamViewType -> (string)

The format of the data records in this stream. Currently, this can be one of the following options:

NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

NEW_IMAGE - the version of the row after the change.

OLD_IMAGE - the version of the row before the change.

KEYS_ONLY - the partition and clustering keys of the row that was changed.

creationRequestDateTime -> (timestamp)

The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

keyspaceName -> (string)

The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table’s hierarchical identifier in Amazon Keyspaces.

tableName -> (string)

The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.

shards -> (list)

An array of shard objects associated with this stream. Each shard contains a subset of the stream’s data records and has its own unique identifier. The collection of shards represents the complete stream data.

(structure)

Represents a uniquely identified group of change records within a change data capture stream for Amazon Keyspaces.

shardId -> (string)

A unique identifier for this shard within the stream.

sequenceNumberRange -> (structure)

The range of sequence numbers contained within this shard.

startingSequenceNumber -> (string)

The starting sequence number of the range.

endingSequenceNumber -> (string)

The ending sequence number of the range, which may be null for open-ended ranges.

parentShardIds -> (list)

The identifiers of parent shards that this shard evolved from, if this shard was created through resharding.

(string)

nextToken -> (string)

A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

Table of Contents

Feedback

User Guide