Amazonka.IVS.ListStreamKeys

Gets summary information about stream keys for the specified channel.

This operation returns paginated results.

Creating a Request

data ListStreamKeys

See: newListStreamKeys smart constructor.

Constructors

ListStreamKeys'

Fields

• maxResults :: Maybe Natural

  Maximum number of streamKeys to return. Default: 1.

• nextToken :: Maybe Text

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

• channelArn :: Text

  Channel ARN used to filter the list.

Instances

ToJSON ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

toJSON :: ListStreamKeys -> Value

toEncoding :: ListStreamKeys -> Encoding

toJSONList :: [ListStreamKeys] -> Value

toEncodingList :: [ListStreamKeys] -> Encoding

ToHeaders ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

toHeaders :: ListStreamKeys -> [Header]

ToPath ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

toPath :: ListStreamKeys -> ByteString

ToQuery ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

toQuery :: ListStreamKeys -> QueryString

AWSPager ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

page :: ListStreamKeys -> AWSResponse ListStreamKeys -> Maybe ListStreamKeys

AWSRequest ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Associated Types

type AWSResponse ListStreamKeys

Methods

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

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

Generic ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Associated Types

type Rep ListStreamKeys :: Type -> Type

Methods

from :: ListStreamKeys -> Rep ListStreamKeys x

to :: Rep ListStreamKeys x -> ListStreamKeys

Read ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

readsPrec :: Int -> ReadS ListStreamKeys

readList :: ReadS [ListStreamKeys]

readPrec :: ReadPrec ListStreamKeys

readListPrec :: ReadPrec [ListStreamKeys]

Show ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

showsPrec :: Int -> ListStreamKeys -> ShowS

show :: ListStreamKeys -> String

showList :: [ListStreamKeys] -> ShowS

NFData ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

rnf :: ListStreamKeys -> ()

Eq ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

(==) :: ListStreamKeys -> ListStreamKeys -> Bool

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

Hashable ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

Methods

hashWithSalt :: Int -> ListStreamKeys -> Int

hash :: ListStreamKeys -> Int

type AWSResponse ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

type AWSResponse ListStreamKeys = ListStreamKeysResponse

type Rep ListStreamKeys

Defined in Amazonka.IVS.ListStreamKeys

type Rep ListStreamKeys = D1 ('MetaData "ListStreamKeys" "Amazonka.IVS.ListStreamKeys" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "ListStreamKeys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListStreamKeys

Arguments

:: Text

ListStreamKeys

-> ListStreamKeys

Create a value of ListStreamKeys 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:maxResults:ListStreamKeys', listStreamKeys_maxResults - Maximum number of streamKeys to return. Default: 1.

ListStreamKeys, listStreamKeys_nextToken - The first stream key to retrieve. This is used for pagination; see the nextToken response field.

ListStreamKeys, listStreamKeys_channelArn - Channel ARN used to filter the list.

Request Lenses

listStreamKeys_maxResults :: Lens' ListStreamKeys (Maybe Natural)

Maximum number of streamKeys to return. Default: 1.

listStreamKeys_nextToken :: Lens' ListStreamKeys (Maybe Text)

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

listStreamKeys_channelArn :: Lens' ListStreamKeys Text

Channel ARN used to filter the list.

Destructuring the Response

data ListStreamKeysResponse

See: newListStreamKeysResponse smart constructor.

Constructors

ListStreamKeysResponse'

Fields

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• streamKeys :: [StreamKeySummary]

  List of stream keys.

Instances

Generic ListStreamKeysResponse

Defined in Amazonka.IVS.ListStreamKeys

Associated Types

type Rep ListStreamKeysResponse :: Type -> Type

Methods

from :: ListStreamKeysResponse -> Rep ListStreamKeysResponse x

to :: Rep ListStreamKeysResponse x -> ListStreamKeysResponse

Read ListStreamKeysResponse

Defined in Amazonka.IVS.ListStreamKeys

Methods

readsPrec :: Int -> ReadS ListStreamKeysResponse

readList :: ReadS [ListStreamKeysResponse]

readPrec :: ReadPrec ListStreamKeysResponse

readListPrec :: ReadPrec [ListStreamKeysResponse]

Show ListStreamKeysResponse

Defined in Amazonka.IVS.ListStreamKeys

Methods

showsPrec :: Int -> ListStreamKeysResponse -> ShowS

show :: ListStreamKeysResponse -> String

showList :: [ListStreamKeysResponse] -> ShowS

NFData ListStreamKeysResponse

Defined in Amazonka.IVS.ListStreamKeys

Methods

rnf :: ListStreamKeysResponse -> ()

Eq ListStreamKeysResponse

Defined in Amazonka.IVS.ListStreamKeys

Methods

(==) :: ListStreamKeysResponse -> ListStreamKeysResponse -> Bool

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

type Rep ListStreamKeysResponse

Defined in Amazonka.IVS.ListStreamKeys

type Rep ListStreamKeysResponse = D1 ('MetaData "ListStreamKeysResponse" "Amazonka.IVS.ListStreamKeys" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "ListStreamKeysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "streamKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [StreamKeySummary]))))

newListStreamKeysResponse

Arguments

:: Int

$sel:httpStatus:ListStreamKeysResponse'

-> ListStreamKeysResponse

Create a value of ListStreamKeysResponse 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:

ListStreamKeys, listStreamKeysResponse_nextToken - If there are more stream keys than maxResults, use nextToken in the request to get the next set.

$sel:httpStatus:ListStreamKeysResponse', listStreamKeysResponse_httpStatus - The response's http status code.

$sel:streamKeys:ListStreamKeysResponse', listStreamKeysResponse_streamKeys - List of stream keys.

Response Lenses

listStreamKeysResponse_nextToken :: Lens' ListStreamKeysResponse (Maybe Text)

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

listStreamKeysResponse_httpStatus :: Lens' ListStreamKeysResponse Int

The response's http status code.

listStreamKeysResponse_streamKeys :: Lens' ListStreamKeysResponse [StreamKeySummary]

List of stream keys.