| 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.ListStreamKeys
Description
Gets summary information about stream keys for the specified channel.
This operation returns paginated results.
Synopsis
- data ListStreamKeys = ListStreamKeys' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- channelArn :: Text
- newListStreamKeys :: Text -> ListStreamKeys
- listStreamKeys_maxResults :: Lens' ListStreamKeys (Maybe Natural)
- listStreamKeys_nextToken :: Lens' ListStreamKeys (Maybe Text)
- listStreamKeys_channelArn :: Lens' ListStreamKeys Text
- data ListStreamKeysResponse = ListStreamKeysResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- streamKeys :: [StreamKeySummary]
- newListStreamKeysResponse :: Int -> ListStreamKeysResponse
- listStreamKeysResponse_nextToken :: Lens' ListStreamKeysResponse (Maybe Text)
- listStreamKeysResponse_httpStatus :: Lens' ListStreamKeysResponse Int
- listStreamKeysResponse_streamKeys :: Lens' ListStreamKeysResponse [StreamKeySummary]
Creating a Request
data ListStreamKeys Source #
See: newListStreamKeys smart constructor.
Constructors
| ListStreamKeys' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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) Source #
Maximum number of streamKeys to return. Default: 1.
listStreamKeys_nextToken :: Lens' ListStreamKeys (Maybe Text) Source #
The first stream key to retrieve. This is used for pagination; see the
nextToken response field.
listStreamKeys_channelArn :: Lens' ListStreamKeys Text Source #
Channel ARN used to filter the list.
Destructuring the Response
data ListStreamKeysResponse Source #
See: newListStreamKeysResponse smart constructor.
Constructors
| ListStreamKeysResponse' | |
Fields
| |
Instances
newListStreamKeysResponse Source #
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) Source #
If there are more stream keys than maxResults, use nextToken in the
request to get the next set.
listStreamKeysResponse_httpStatus :: Lens' ListStreamKeysResponse Int Source #
The response's http status code.
listStreamKeysResponse_streamKeys :: Lens' ListStreamKeysResponse [StreamKeySummary] Source #
List of stream keys.