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.ListChannels

Description

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

This operation returns paginated results.

Synopsis

Creating a Request

data ListChannels Source #

See: newListChannels smart constructor.

Constructors

ListChannels' 

Fields

Instances

Instances details
Eq ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Read ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Show ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Generic ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Associated Types

type Rep ListChannels :: Type -> Type #

NFData ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Methods

rnf :: ListChannels -> () #

Hashable ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

ToJSON ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

AWSPager ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

AWSRequest ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Associated Types

type AWSResponse ListChannels #

ToHeaders ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

ToPath ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

ToQuery ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

type Rep ListChannels Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

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

Defined in Amazonka.IVS.ListChannels

newListChannels :: ListChannels Source #

Create a value of ListChannels 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:filterByName:ListChannels', listChannels_filterByName - Filters the channel list to match the specified name.

$sel:nextToken:ListChannels', listChannels_nextToken - The first channel to retrieve. This is used for pagination; see the nextToken response field.

$sel:filterByRecordingConfigurationArn:ListChannels', listChannels_filterByRecordingConfigurationArn - Filters the channel list to match the specified recording-configuration ARN.

$sel:maxResults:ListChannels', listChannels_maxResults - Maximum number of channels to return. Default: 50.

Request Lenses

listChannels_filterByName :: Lens' ListChannels (Maybe Text) Source #

Filters the channel list to match the specified name.

listChannels_nextToken :: Lens' ListChannels (Maybe Text) Source #

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

listChannels_filterByRecordingConfigurationArn :: Lens' ListChannels (Maybe Text) Source #

Filters the channel list to match the specified recording-configuration ARN.

listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #

Maximum number of channels to return. Default: 50.

Destructuring the Response

data ListChannelsResponse Source #

See: newListChannelsResponse smart constructor.

Constructors

ListChannelsResponse' 

Fields

Instances

Instances details
Eq ListChannelsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Read ListChannelsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Show ListChannelsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Generic ListChannelsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Associated Types

type Rep ListChannelsResponse :: Type -> Type #

NFData ListChannelsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

Methods

rnf :: ListChannelsResponse -> () #

type Rep ListChannelsResponse Source # 
Instance details

Defined in Amazonka.IVS.ListChannels

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

newListChannelsResponse Source #

Create a value of ListChannelsResponse 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:ListChannels', listChannelsResponse_nextToken - If there are more channels than maxResults, use nextToken in the request to get the next set.

$sel:httpStatus:ListChannelsResponse', listChannelsResponse_httpStatus - The response's http status code.

$sel:channels:ListChannelsResponse', listChannelsResponse_channels - List of the matching channels.

Response Lenses

listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #

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