Amazonka.DynamoDBStreams.ListStreams

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.

You can call ListStreams at a maximum rate of 5 times per second.

Creating a Request

data ListStreams

Represents the input of a ListStreams operation.

See: newListStreams smart constructor.

Constructors

ListStreams'

Fields

• exclusiveStartStreamArn :: Maybe Text

  The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

• limit :: Maybe Natural

  The maximum number of streams to return. The upper limit is 100.

• tableName :: Maybe Text

  If this parameter is provided, then only the streams associated with this table name are returned.

Instances

ToJSON ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

toJSON :: ListStreams -> Value

toEncoding :: ListStreams -> Encoding

toJSONList :: [ListStreams] -> Value

toEncodingList :: [ListStreams] -> Encoding

ToHeaders ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

toHeaders :: ListStreams -> [Header]

ToPath ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

toPath :: ListStreams -> ByteString

ToQuery ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

toQuery :: ListStreams -> QueryString

AWSRequest ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Associated Types

type AWSResponse ListStreams

Methods

request :: (Service -> Service) -> ListStreams -> Request ListStreams

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStreams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStreams)))

Generic ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Associated Types

type Rep ListStreams :: Type -> Type

Methods

from :: ListStreams -> Rep ListStreams x

to :: Rep ListStreams x -> ListStreams

Read ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

readsPrec :: Int -> ReadS ListStreams

readList :: ReadS [ListStreams]

readPrec :: ReadPrec ListStreams

readListPrec :: ReadPrec [ListStreams]

Show ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

showsPrec :: Int -> ListStreams -> ShowS

show :: ListStreams -> String

showList :: [ListStreams] -> ShowS

NFData ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

rnf :: ListStreams -> ()

Eq ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

(==) :: ListStreams -> ListStreams -> Bool

(/=) :: ListStreams -> ListStreams -> Bool

Hashable ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

hashWithSalt :: Int -> ListStreams -> Int

hash :: ListStreams -> Int

type AWSResponse ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

type AWSResponse ListStreams = ListStreamsResponse

type Rep ListStreams

Defined in Amazonka.DynamoDBStreams.ListStreams

type Rep ListStreams = D1 ('MetaData "ListStreams" "Amazonka.DynamoDBStreams.ListStreams" "amazonka-dynamodb-streams-2.0-3efN0DbUklbJSr9bxtKOG6" 'False) (C1 ('MetaCons "ListStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveStartStreamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListStreams :: ListStreams

Create a value of ListStreams with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exclusiveStartStreamArn:ListStreams', listStreams_exclusiveStartStreamArn - The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

$sel:limit:ListStreams', listStreams_limit - The maximum number of streams to return. The upper limit is 100.

ListStreams, listStreams_tableName - If this parameter is provided, then only the streams associated with this table name are returned.

Request Lenses

listStreams_exclusiveStartStreamArn :: Lens' ListStreams (Maybe Text)

The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

listStreams_limit :: Lens' ListStreams (Maybe Natural)

The maximum number of streams to return. The upper limit is 100.

listStreams_tableName :: Lens' ListStreams (Maybe Text)

If this parameter is provided, then only the streams associated with this table name are returned.

Destructuring the Response

data ListStreamsResponse

Represents the output of a ListStreams operation.

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse'

Fields

• lastEvaluatedStreamArn :: Maybe Text

  The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

  If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

  If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.

• streams :: Maybe [Stream]

  A list of stream descriptors associated with the current account and endpoint.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListStreamsResponse

Defined in Amazonka.DynamoDBStreams.ListStreams

Associated Types

type Rep ListStreamsResponse :: Type -> Type

Methods

from :: ListStreamsResponse -> Rep ListStreamsResponse x

to :: Rep ListStreamsResponse x -> ListStreamsResponse

Read ListStreamsResponse

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

readsPrec :: Int -> ReadS ListStreamsResponse

readList :: ReadS [ListStreamsResponse]

readPrec :: ReadPrec ListStreamsResponse

readListPrec :: ReadPrec [ListStreamsResponse]

Show ListStreamsResponse

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

showsPrec :: Int -> ListStreamsResponse -> ShowS

show :: ListStreamsResponse -> String

showList :: [ListStreamsResponse] -> ShowS

NFData ListStreamsResponse

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

rnf :: ListStreamsResponse -> ()

Eq ListStreamsResponse

Defined in Amazonka.DynamoDBStreams.ListStreams

Methods

(==) :: ListStreamsResponse -> ListStreamsResponse -> Bool

(/=) :: ListStreamsResponse -> ListStreamsResponse -> Bool

type Rep ListStreamsResponse

Defined in Amazonka.DynamoDBStreams.ListStreams

type Rep ListStreamsResponse = D1 ('MetaData "ListStreamsResponse" "Amazonka.DynamoDBStreams.ListStreams" "amazonka-dynamodb-streams-2.0-3efN0DbUklbJSr9bxtKOG6" 'False) (C1 ('MetaCons "ListStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lastEvaluatedStreamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Stream])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStreamsResponse

Arguments

:: Int

$sel:httpStatus:ListStreamsResponse'

-> ListStreamsResponse

Create a value of ListStreamsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lastEvaluatedStreamArn:ListStreamsResponse', listStreamsResponse_lastEvaluatedStreamArn - The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.

$sel:streams:ListStreamsResponse', listStreamsResponse_streams - A list of stream descriptors associated with the current account and endpoint.

$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.

Response Lenses

listStreamsResponse_lastEvaluatedStreamArn :: Lens' ListStreamsResponse (Maybe Text)

The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.

listStreamsResponse_streams :: Lens' ListStreamsResponse (Maybe [Stream])

A list of stream descriptors associated with the current account and endpoint.

listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int

The response's http status code.