libZSservicesZSamazonka-kinesisZSamazonka-kinesis
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Kinesis.ListStreamConsumers

Description

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.

This operation returns paginated results.

Synopsis

Creating a Request

data ListStreamConsumers Source #

See: newListStreamConsumers smart constructor.

Constructors

ListStreamConsumers' 

Fields

  • nextToken :: Maybe Text

    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.

  • streamCreationTimestamp :: Maybe POSIX

    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.

  • maxResults :: Maybe Natural

    The maximum number of consumers that you want a single call of ListStreamConsumers to return.

  • streamARN :: Text

    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.

Instances

Instances details
Eq ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Read ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Show ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Generic ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Associated Types

type Rep ListStreamConsumers :: Type -> Type #

NFData ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Methods

rnf :: ListStreamConsumers -> () #

Hashable ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

ToJSON ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

AWSPager ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

AWSRequest ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Associated Types

type AWSResponse ListStreamConsumers #

ToHeaders ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

ToPath ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

ToQuery ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

type Rep ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

type Rep ListStreamConsumers = D1 ('MetaData "ListStreamConsumers" "Amazonka.Kinesis.ListStreamConsumers" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListStreamConsumers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListStreamConsumers Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

newListStreamConsumers Source #

Create a value of ListStreamConsumers 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:nextToken:ListStreamConsumers', listStreamConsumers_nextToken - 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.

$sel:streamCreationTimestamp:ListStreamConsumers', listStreamConsumers_streamCreationTimestamp - 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.

$sel:maxResults:ListStreamConsumers', listStreamConsumers_maxResults - The maximum number of consumers that you want a single call of ListStreamConsumers to return.

$sel:streamARN:ListStreamConsumers', listStreamConsumers_streamARN - 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.

Request Lenses

listStreamConsumers_nextToken :: Lens' ListStreamConsumers (Maybe Text) Source #

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.

listStreamConsumers_streamCreationTimestamp :: Lens' ListStreamConsumers (Maybe UTCTime) Source #

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.

listStreamConsumers_maxResults :: Lens' ListStreamConsumers (Maybe Natural) Source #

The maximum number of consumers that you want a single call of ListStreamConsumers to return.

listStreamConsumers_streamARN :: Lens' ListStreamConsumers Text Source #

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.

Destructuring the Response

data ListStreamConsumersResponse Source #

See: newListStreamConsumersResponse smart constructor.

Constructors

ListStreamConsumersResponse' 

Fields

  • nextToken :: Maybe Text

    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.

  • consumers :: Maybe [Consumer]

    An array of JSON objects. Each object represents one registered consumer.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListStreamConsumersResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Read ListStreamConsumersResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Show ListStreamConsumersResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Generic ListStreamConsumersResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

Associated Types

type Rep ListStreamConsumersResponse :: Type -> Type #

NFData ListStreamConsumersResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

type Rep ListStreamConsumersResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListStreamConsumers

type Rep ListStreamConsumersResponse = D1 ('MetaData "ListStreamConsumersResponse" "Amazonka.Kinesis.ListStreamConsumers" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListStreamConsumersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "consumers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Consumer])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStreamConsumersResponse Source #

Create a value of ListStreamConsumersResponse 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:nextToken:ListStreamConsumers', listStreamConsumersResponse_nextToken - 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.

$sel:consumers:ListStreamConsumersResponse', listStreamConsumersResponse_consumers - An array of JSON objects. Each object represents one registered consumer.

$sel:httpStatus:ListStreamConsumersResponse', listStreamConsumersResponse_httpStatus - The response's http status code.

Response Lenses

listStreamConsumersResponse_nextToken :: Lens' ListStreamConsumersResponse (Maybe Text) Source #

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.

listStreamConsumersResponse_consumers :: Lens' ListStreamConsumersResponse (Maybe [Consumer]) Source #

An array of JSON objects. Each object represents one registered consumer.