Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IVS.ListChannels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

filterByName :: Maybe Text
Filters the channel list to match the specified name.
filterByRecordingConfigurationArn :: Maybe Text
Filters the channel list to match the specified recording-configuration ARN.
maxResults :: Maybe Natural
Maximum number of channels to return. Default: 100.
nextToken :: Maybe Text
The first channel to retrieve. This is used for pagination; see the nextToken response field.

Instances

Instances details

ToJSON ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods toJSON :: ListChannels -> Value # toEncoding :: ListChannels -> Encoding # toJSONList :: [ListChannels] -> Value # toEncodingList :: [ListChannels] -> Encoding #
ToHeaders ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods toHeaders :: ListChannels -> [Header] #
ToPath ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods toPath :: ListChannels -> ByteString #
ToQuery ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods toQuery :: ListChannels -> QueryString #
AWSPager ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods page :: ListChannels -> AWSResponse ListChannels -> Maybe ListChannels #
AWSRequest ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Associated Types type AWSResponse ListChannels # Methods request :: (Service -> Service) -> ListChannels -> Request ListChannels # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListChannels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListChannels))) #
Generic ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Associated Types type Rep ListChannels :: Type -> Type # Methods from :: ListChannels -> Rep ListChannels x # to :: Rep ListChannels x -> ListChannels #
Read ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods readsPrec :: Int -> ReadS ListChannels # readList :: ReadS [ListChannels] # readPrec :: ReadPrec ListChannels # readListPrec :: ReadPrec [ListChannels] #
Show ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods showsPrec :: Int -> ListChannels -> ShowS # show :: ListChannels -> String # showList :: [ListChannels] -> ShowS #
NFData ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods rnf :: ListChannels -> () #
Eq ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods (==) :: ListChannels -> ListChannels -> Bool # (/=) :: ListChannels -> ListChannels -> Bool #
Hashable ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods hashWithSalt :: Int -> ListChannels -> Int # hash :: ListChannels -> Int #
type AWSResponse ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels type AWSResponse ListChannels = ListChannelsResponse
type Rep ListChannels Source #
Instance details Defined in Amazonka.IVS.ListChannels type Rep ListChannels = D1 ('MetaData "ListChannels" "Amazonka.IVS.ListChannels" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "ListChannels'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterByName") '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)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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: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: 100.

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

Request Lenses

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

Filters the channel list to match the specified name.

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: 100.

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

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

Destructuring the Response

data ListChannelsResponse Source #

See: newListChannelsResponse smart constructor.

Constructors

ListChannelsResponse'
Fields nextToken :: Maybe Text If there are more channels than `maxResults`, use `nextToken` in the request to get the next set. httpStatus :: Int The response's http status code. channels :: [ChannelSummary] List of the matching channels.

Instances

Instances details

Generic ListChannelsResponse Source #
Instance details Defined in Amazonka.IVS.ListChannels Associated Types type Rep ListChannelsResponse :: Type -> Type # Methods from :: ListChannelsResponse -> Rep ListChannelsResponse x # to :: Rep ListChannelsResponse x -> ListChannelsResponse #
Read ListChannelsResponse Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods readsPrec :: Int -> ReadS ListChannelsResponse # readList :: ReadS [ListChannelsResponse] # readPrec :: ReadPrec ListChannelsResponse # readListPrec :: ReadPrec [ListChannelsResponse] #
Show ListChannelsResponse Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods showsPrec :: Int -> ListChannelsResponse -> ShowS # show :: ListChannelsResponse -> String # showList :: [ListChannelsResponse] -> ShowS #
NFData ListChannelsResponse Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods rnf :: ListChannelsResponse -> () #
Eq ListChannelsResponse Source #
Instance details Defined in Amazonka.IVS.ListChannels Methods (==) :: ListChannelsResponse -> ListChannelsResponse -> Bool # (/=) :: ListChannelsResponse -> ListChannelsResponse -> Bool #
type Rep ListChannelsResponse Source #
Instance details Defined in Amazonka.IVS.ListChannels type Rep ListChannelsResponse = D1 ('MetaData "ListChannelsResponse" "Amazonka.IVS.ListChannels" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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 #

Arguments

:: Int	`$sel:httpStatus:ListChannelsResponse'`
-> ListChannelsResponse

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:

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.

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.

listChannelsResponse_httpStatus :: Lens' ListChannelsResponse Int Source #

The response's http status code.

listChannelsResponse_channels :: Lens' ListChannelsResponse [ChannelSummary] Source #

List of the matching channels.