Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IVS.CreateStreamKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data CreateStreamKey Source #

See: newCreateStreamKey smart constructor.

Constructors

CreateStreamKey'
Fields tags :: Maybe (HashMap Text Text) Array of 1-50 maps, each of the form `string:string (key:value)`. channelArn :: Text ARN of the channel for which to create the stream key.

Instances

Instances details

Eq CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods (==) :: CreateStreamKey -> CreateStreamKey -> Bool # (/=) :: CreateStreamKey -> CreateStreamKey -> Bool #
Read CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods readsPrec :: Int -> ReadS CreateStreamKey # readList :: ReadS [CreateStreamKey] # readPrec :: ReadPrec CreateStreamKey # readListPrec :: ReadPrec [CreateStreamKey] #
Show CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods showsPrec :: Int -> CreateStreamKey -> ShowS # show :: CreateStreamKey -> String # showList :: [CreateStreamKey] -> ShowS #
Generic CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Associated Types type Rep CreateStreamKey :: Type -> Type # Methods from :: CreateStreamKey -> Rep CreateStreamKey x # to :: Rep CreateStreamKey x -> CreateStreamKey #
NFData CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods rnf :: CreateStreamKey -> () #
Hashable CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods hashWithSalt :: Int -> CreateStreamKey -> Int # hash :: CreateStreamKey -> Int #
ToJSON CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods toJSON :: CreateStreamKey -> Value # toEncoding :: CreateStreamKey -> Encoding # toJSONList :: [CreateStreamKey] -> Value # toEncodingList :: [CreateStreamKey] -> Encoding #
AWSRequest CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Associated Types type AWSResponse CreateStreamKey # Methods request :: CreateStreamKey -> Request CreateStreamKey # response :: MonadResource m => Logger -> Service -> Proxy CreateStreamKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStreamKey))) #
ToHeaders CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods toHeaders :: CreateStreamKey -> [Header] #
ToPath CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods toPath :: CreateStreamKey -> ByteString #
ToQuery CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods toQuery :: CreateStreamKey -> QueryString #
type Rep CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey type Rep CreateStreamKey = D1 ('MetaData "CreateStreamKey" "Amazonka.IVS.CreateStreamKey" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "CreateStreamKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateStreamKey Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey type AWSResponse CreateStreamKey = CreateStreamKeyResponse

newCreateStreamKey Source #

Arguments

:: Text	`$sel:channelArn:CreateStreamKey'`
-> 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:

$sel:tags:CreateStreamKey', createStreamKey_tags - Array of 1-50 maps, each of the form string:string (key:value).

$sel:channelArn: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).

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 streamKey :: Maybe StreamKey Stream key used to authenticate an RTMPS stream for ingestion. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateStreamKeyResponse Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods (==) :: CreateStreamKeyResponse -> CreateStreamKeyResponse -> Bool # (/=) :: CreateStreamKeyResponse -> CreateStreamKeyResponse -> Bool #
Show CreateStreamKeyResponse Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods showsPrec :: Int -> CreateStreamKeyResponse -> ShowS # show :: CreateStreamKeyResponse -> String # showList :: [CreateStreamKeyResponse] -> ShowS #
Generic CreateStreamKeyResponse Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Associated Types type Rep CreateStreamKeyResponse :: Type -> Type # Methods from :: CreateStreamKeyResponse -> Rep CreateStreamKeyResponse x # to :: Rep CreateStreamKeyResponse x -> CreateStreamKeyResponse #
NFData CreateStreamKeyResponse Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey Methods rnf :: CreateStreamKeyResponse -> () #
type Rep CreateStreamKeyResponse Source #
Instance details Defined in Amazonka.IVS.CreateStreamKey type Rep CreateStreamKeyResponse = D1 ('MetaData "CreateStreamKeyResponse" "Amazonka.IVS.CreateStreamKey" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "CreateStreamKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamKey)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateStreamKeyResponse Source #

Arguments

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

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.