| 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.CreateStreamKey
Description
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
Synopsis
- data CreateStreamKey = CreateStreamKey' {}
- newCreateStreamKey :: Text -> CreateStreamKey
- createStreamKey_tags :: Lens' CreateStreamKey (Maybe (HashMap Text Text))
- createStreamKey_channelArn :: Lens' CreateStreamKey Text
- data CreateStreamKeyResponse = CreateStreamKeyResponse' {
- streamKey :: Maybe StreamKey
- httpStatus :: Int
- newCreateStreamKeyResponse :: Int -> CreateStreamKeyResponse
- createStreamKeyResponse_streamKey :: Lens' CreateStreamKeyResponse (Maybe StreamKey)
- createStreamKeyResponse_httpStatus :: Lens' CreateStreamKeyResponse Int
Creating a Request
data CreateStreamKey Source #
See: newCreateStreamKey smart constructor.
Constructors
| CreateStreamKey' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateStreamKey |
Create a value of CreateStreamKey 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:
CreateStreamKey, createStreamKey_tags - Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
CreateStreamKey, createStreamKey_channelArn - ARN of the channel for which to create the stream key.
Request Lenses
createStreamKey_tags :: Lens' CreateStreamKey (Maybe (HashMap Text Text)) Source #
Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no
service-specific constraints beyond what is documented there.
createStreamKey_channelArn :: Lens' CreateStreamKey Text Source #
ARN of the channel for which to create the stream key.
Destructuring the Response
data CreateStreamKeyResponse Source #
See: newCreateStreamKeyResponse smart constructor.
Constructors
| CreateStreamKeyResponse' | |
Fields
| |
Instances
newCreateStreamKeyResponse Source #
Create a value of CreateStreamKeyResponse 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:streamKey:CreateStreamKeyResponse', createStreamKeyResponse_streamKey - Stream key used to authenticate an RTMPS stream for ingestion.
$sel:httpStatus:CreateStreamKeyResponse', createStreamKeyResponse_httpStatus - The response's http status code.
Response Lenses
createStreamKeyResponse_streamKey :: Lens' CreateStreamKeyResponse (Maybe StreamKey) Source #
Stream key used to authenticate an RTMPS stream for ingestion.
createStreamKeyResponse_httpStatus :: Lens' CreateStreamKeyResponse Int Source #
The response's http status code.