Skip to content

/AWS1/IF_KNS=>LISTSHARDS()

About ListShards

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

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard.

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.

Method Signature

METHODS /AWS1/IF_KNS~LISTSHARDS
  IMPORTING
    !IV_STREAMNAME TYPE /AWS1/KNSSTREAMNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/KNSNEXTTOKEN OPTIONAL
    !IV_EXCLUSIVESTARTSHARDID TYPE /AWS1/KNSSHARDID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/KNSLISTSHARDSINPUTLIMIT OPTIONAL
    !IV_STREAMCREATIONTIMESTAMP TYPE /AWS1/KNSTIMESTAMP OPTIONAL
    !IO_SHARDFILTER TYPE REF TO /AWS1/CL_KNSSHARDFILTER OPTIONAL
    !IV_STREAMARN TYPE /AWS1/KNSSTREAMARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knslistshardsoutput
  RAISING
    /AWS1/CX_KNSACCESSDENIEDEX
    /AWS1/CX_KNSEXPIREDNEXTTOKENEX
    /AWS1/CX_KNSINVALIDARGUMENTEX
    /AWS1/CX_KNSLIMITEXCEEDEDEX
    /AWS1/CX_KNSRESOURCEINUSEEX
    /AWS1/CX_KNSRESOURCENOTFOUNDEX
    /AWS1/CX_KNSCLIENTEXC
    /AWS1/CX_KNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_streamname TYPE /AWS1/KNSSTREAMNAME /AWS1/KNSSTREAMNAME

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

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

iv_nexttoken TYPE /AWS1/KNSNEXTTOKEN /AWS1/KNSNEXTTOKEN

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.

iv_exclusivestartshardid TYPE /AWS1/KNSSHARDID /AWS1/KNSSHARDID

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.

iv_maxresults TYPE /AWS1/KNSLISTSHARDSINPUTLIMIT /AWS1/KNSLISTSHARDSINPUTLIMIT

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

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

iv_streamcreationtimestamp TYPE /AWS1/KNSTIMESTAMP /AWS1/KNSTIMESTAMP

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.

io_shardfilter TYPE REF TO /AWS1/CL_KNSSHARDFILTER /AWS1/CL_KNSSHARDFILTER

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

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

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

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

iv_streamarn TYPE /AWS1/KNSSTREAMARN /AWS1/KNSSTREAMARN

The ARN of the stream.

RETURNING

oo_output TYPE REF TO /aws1/cl_knslistshardsoutput /AWS1/CL_KNSLISTSHARDSOUTPUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listshards(
  io_shardfilter = new /aws1/cl_knsshardfilter(
    iv_shardid = |string|
    iv_timestamp = '20150101000000.0000000'
    iv_type = |string|
  )
  iv_exclusivestartshardid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_streamarn = |string|
  iv_streamcreationtimestamp = '20150101000000.0000000'
  iv_streamname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_shards( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_shardid = lo_row_1->get_shardid( ).
      lv_shardid = lo_row_1->get_parentshardid( ).
      lv_shardid = lo_row_1->get_adjacentparentshardid( ).
      lo_hashkeyrange = lo_row_1->get_hashkeyrange( ).
      IF lo_hashkeyrange IS NOT INITIAL.
        lv_hashkey = lo_hashkeyrange->get_startinghashkey( ).
        lv_hashkey = lo_hashkeyrange->get_endinghashkey( ).
      ENDIF.
      lo_sequencenumberrange = lo_row_1->get_sequencenumberrange( ).
      IF lo_sequencenumberrange IS NOT INITIAL.
        lv_sequencenumber = lo_sequencenumberrange->get_startingsequencenumber( ).
        lv_sequencenumber = lo_sequencenumberrange->get_endingsequencenumber( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.