libZSservicesZSamazonka-kinesis-videoZSamazonka-kinesis-video
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.KinesisVideo.ListStreams

Description

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

This operation returns paginated results.

Synopsis

Creating a Request

data ListStreams Source #

See: newListStreams smart constructor.

Constructors

ListStreams' 

Fields

  • nextToken :: Maybe Text

    If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

  • streamNameCondition :: Maybe StreamNameCondition

    Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

  • maxResults :: Maybe Natural

    The maximum number of streams to return in the response. The default is 10,000.

Instances

Instances details
Eq ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Read ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Show ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Generic ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Associated Types

type Rep ListStreams :: Type -> Type #

NFData ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Methods

rnf :: ListStreams -> () #

Hashable ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

ToJSON ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

AWSPager ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

AWSRequest ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Associated Types

type AWSResponse ListStreams #

ToHeaders ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Methods

toHeaders :: ListStreams -> [Header] #

ToPath ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

ToQuery ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

type Rep ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

type Rep ListStreams = D1 ('MetaData "ListStreams" "Amazonka.KinesisVideo.ListStreams" "libZSservicesZSamazonka-kinesis-videoZSamazonka-kinesis-video" 'False) (C1 ('MetaCons "ListStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamNameCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamNameCondition)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListStreams Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

newListStreams :: ListStreams Source #

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:nextToken:ListStreams', listStreams_nextToken - If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

$sel:streamNameCondition:ListStreams', listStreams_streamNameCondition - Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

$sel:maxResults:ListStreams', listStreams_maxResults - The maximum number of streams to return in the response. The default is 10,000.

Request Lenses

listStreams_nextToken :: Lens' ListStreams (Maybe Text) Source #

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

listStreams_streamNameCondition :: Lens' ListStreams (Maybe StreamNameCondition) Source #

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

listStreams_maxResults :: Lens' ListStreams (Maybe Natural) Source #

The maximum number of streams to return in the response. The default is 10,000.

Destructuring the Response

data ListStreamsResponse Source #

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse' 

Fields

Instances

Instances details
Eq ListStreamsResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Read ListStreamsResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Show ListStreamsResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Generic ListStreamsResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Associated Types

type Rep ListStreamsResponse :: Type -> Type #

NFData ListStreamsResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

Methods

rnf :: ListStreamsResponse -> () #

type Rep ListStreamsResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListStreams

type Rep ListStreamsResponse = D1 ('MetaData "ListStreamsResponse" "Amazonka.KinesisVideo.ListStreams" "libZSservicesZSamazonka-kinesis-videoZSamazonka-kinesis-video" 'False) (C1 ('MetaCons "ListStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StreamInfo])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStreamsResponse Source #

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:streamInfoList:ListStreamsResponse', listStreamsResponse_streamInfoList - An array of StreamInfo objects.

$sel:nextToken:ListStreams', listStreamsResponse_nextToken - If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

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

Response Lenses

listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #

If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.