Amazonka.KinesisVideo.ListSignalingChannels

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

This operation returns paginated results.

Creating a Request

data ListSignalingChannels

See: newListSignalingChannels smart constructor.

Constructors

ListSignalingChannels'

Fields

• channelNameCondition :: Maybe ChannelNameCondition

  Optional: Returns only the channels that satisfy a specific condition.

• maxResults :: Maybe Natural

  The maximum number of channels to return in the response. The default is 500.

• nextToken :: Maybe Text

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

Instances

ToJSON ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

toJSON :: ListSignalingChannels -> Value

toEncoding :: ListSignalingChannels -> Encoding

toJSONList :: [ListSignalingChannels] -> Value

toEncodingList :: [ListSignalingChannels] -> Encoding

ToHeaders ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

toHeaders :: ListSignalingChannels -> [Header]

ToPath ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

toPath :: ListSignalingChannels -> ByteString

ToQuery ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

toQuery :: ListSignalingChannels -> QueryString

AWSPager ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

page :: ListSignalingChannels -> AWSResponse ListSignalingChannels -> Maybe ListSignalingChannels

AWSRequest ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Associated Types

type AWSResponse ListSignalingChannels

Methods

request :: (Service -> Service) -> ListSignalingChannels -> Request ListSignalingChannels

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSignalingChannels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSignalingChannels)))

Generic ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Associated Types

type Rep ListSignalingChannels :: Type -> Type

Methods

from :: ListSignalingChannels -> Rep ListSignalingChannels x

to :: Rep ListSignalingChannels x -> ListSignalingChannels

Read ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

readsPrec :: Int -> ReadS ListSignalingChannels

readList :: ReadS [ListSignalingChannels]

readPrec :: ReadPrec ListSignalingChannels

readListPrec :: ReadPrec [ListSignalingChannels]

Show ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

showsPrec :: Int -> ListSignalingChannels -> ShowS

show :: ListSignalingChannels -> String

showList :: [ListSignalingChannels] -> ShowS

NFData ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

rnf :: ListSignalingChannels -> ()

Eq ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

(==) :: ListSignalingChannels -> ListSignalingChannels -> Bool

(/=) :: ListSignalingChannels -> ListSignalingChannels -> Bool

Hashable ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

hashWithSalt :: Int -> ListSignalingChannels -> Int

hash :: ListSignalingChannels -> Int

type AWSResponse ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

type AWSResponse ListSignalingChannels = ListSignalingChannelsResponse

type Rep ListSignalingChannels

Defined in Amazonka.KinesisVideo.ListSignalingChannels

type Rep ListSignalingChannels = D1 ('MetaData "ListSignalingChannels" "Amazonka.KinesisVideo.ListSignalingChannels" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ListSignalingChannels'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelNameCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelNameCondition)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListSignalingChannels :: ListSignalingChannels

Create a value of ListSignalingChannels 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:channelNameCondition:ListSignalingChannels', listSignalingChannels_channelNameCondition - Optional: Returns only the channels that satisfy a specific condition.

$sel:maxResults:ListSignalingChannels', listSignalingChannels_maxResults - The maximum number of channels to return in the response. The default is 500.

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

Request Lenses

listSignalingChannels_channelNameCondition :: Lens' ListSignalingChannels (Maybe ChannelNameCondition)

Optional: Returns only the channels that satisfy a specific condition.

listSignalingChannels_maxResults :: Lens' ListSignalingChannels (Maybe Natural)

The maximum number of channels to return in the response. The default is 500.

listSignalingChannels_nextToken :: Lens' ListSignalingChannels (Maybe Text)

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

Destructuring the Response

data ListSignalingChannelsResponse

See: newListSignalingChannelsResponse smart constructor.

Constructors

ListSignalingChannelsResponse'

Fields

• channelInfoList :: Maybe [ChannelInfo]

  An array of ChannelInfo objects.

• nextToken :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListSignalingChannelsResponse

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Associated Types

type Rep ListSignalingChannelsResponse :: Type -> Type

Methods

from :: ListSignalingChannelsResponse -> Rep ListSignalingChannelsResponse x

to :: Rep ListSignalingChannelsResponse x -> ListSignalingChannelsResponse

Read ListSignalingChannelsResponse

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

readsPrec :: Int -> ReadS ListSignalingChannelsResponse

readList :: ReadS [ListSignalingChannelsResponse]

readPrec :: ReadPrec ListSignalingChannelsResponse

readListPrec :: ReadPrec [ListSignalingChannelsResponse]

Show ListSignalingChannelsResponse

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

showsPrec :: Int -> ListSignalingChannelsResponse -> ShowS

show :: ListSignalingChannelsResponse -> String

showList :: [ListSignalingChannelsResponse] -> ShowS

NFData ListSignalingChannelsResponse

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

rnf :: ListSignalingChannelsResponse -> ()

Eq ListSignalingChannelsResponse

Defined in Amazonka.KinesisVideo.ListSignalingChannels

Methods

(==) :: ListSignalingChannelsResponse -> ListSignalingChannelsResponse -> Bool

(/=) :: ListSignalingChannelsResponse -> ListSignalingChannelsResponse -> Bool

type Rep ListSignalingChannelsResponse

Defined in Amazonka.KinesisVideo.ListSignalingChannels

type Rep ListSignalingChannelsResponse = D1 ('MetaData "ListSignalingChannelsResponse" "Amazonka.KinesisVideo.ListSignalingChannels" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ListSignalingChannelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelInfo])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSignalingChannelsResponse

Arguments

:: Int

$sel:httpStatus:ListSignalingChannelsResponse'

-> ListSignalingChannelsResponse

Create a value of ListSignalingChannelsResponse 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:channelInfoList:ListSignalingChannelsResponse', listSignalingChannelsResponse_channelInfoList - An array of ChannelInfo objects.

ListSignalingChannels, listSignalingChannelsResponse_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:ListSignalingChannelsResponse', listSignalingChannelsResponse_httpStatus - The response's http status code.

Response Lenses

listSignalingChannelsResponse_channelInfoList :: Lens' ListSignalingChannelsResponse (Maybe [ChannelInfo])

An array of ChannelInfo objects.

listSignalingChannelsResponse_nextToken :: Lens' ListSignalingChannelsResponse (Maybe Text)

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.

listSignalingChannelsResponse_httpStatus :: Lens' ListSignalingChannelsResponse Int

The response's http status code.