libZSservicesZSamazonka-ivsZSamazonka-ivs
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.IVS.ListStreams

Description

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

This operation returns paginated results.

Synopsis

Creating a Request

data ListStreams Source #

See: newListStreams smart constructor.

Constructors

ListStreams' 

Fields

Instances

Instances details
Eq ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Read ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Show ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Generic ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Associated Types

type Rep ListStreams :: Type -> Type #

NFData ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Methods

rnf :: ListStreams -> () #

Hashable ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

ToJSON ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

AWSPager ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

AWSRequest ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Associated Types

type AWSResponse ListStreams #

ToHeaders ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Methods

toHeaders :: ListStreams -> [Header] #

ToPath ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

ToQuery ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

type Rep ListStreams Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

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

Defined in Amazonka.IVS.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 - The first stream to retrieve. This is used for pagination; see the nextToken response field.

$sel:maxResults:ListStreams', listStreams_maxResults - Maximum number of streams to return. Default: 50.

Request Lenses

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

The first stream to retrieve. This is used for pagination; see the nextToken response field.

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

Maximum number of streams to return. Default: 50.

Destructuring the Response

data ListStreamsResponse Source #

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse' 

Fields

Instances

Instances details
Eq ListStreamsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Read ListStreamsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Show ListStreamsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Generic ListStreamsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Associated Types

type Rep ListStreamsResponse :: Type -> Type #

NFData ListStreamsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

Methods

rnf :: ListStreamsResponse -> () #

type Rep ListStreamsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListStreams

type Rep ListStreamsResponse = D1 ('MetaData "ListStreamsResponse" "Amazonka.IVS.ListStreams" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "ListStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "streams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [StreamSummary]))))

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:nextToken:ListStreams', listStreamsResponse_nextToken - If there are more streams than maxResults, use nextToken in the request to get the next set.

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

$sel:streams:ListStreamsResponse', listStreamsResponse_streams - List of streams.

Response Lenses

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

If there are more streams than maxResults, use nextToken in the request to get the next set.