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.ImportPlaybackKeyPair

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Creating a Request

data ImportPlaybackKeyPair Source #

See: newImportPlaybackKeyPair smart constructor.

Constructors

ImportPlaybackKeyPair'

Fields

name :: Maybe Text
Playback-key-pair name. The value does not need to be unique.
tags :: Maybe (HashMap Text Text)
Any tags provided with the request are added to the playback key pair tags. 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.
publicKeyMaterial :: Text
The public portion of a customer-generated key pair.

Instances

Instances details

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

newImportPlaybackKeyPair Source #

Arguments

:: Text	`$sel:publicKeyMaterial:ImportPlaybackKeyPair'`
-> ImportPlaybackKeyPair

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

ImportPlaybackKeyPair, importPlaybackKeyPair_name - Playback-key-pair name. The value does not need to be unique.

ImportPlaybackKeyPair, importPlaybackKeyPair_tags - Any tags provided with the request are added to the playback key pair tags. 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.

$sel:publicKeyMaterial:ImportPlaybackKeyPair', importPlaybackKeyPair_publicKeyMaterial - The public portion of a customer-generated key pair.

Request Lenses

importPlaybackKeyPair_name :: Lens' ImportPlaybackKeyPair (Maybe Text) Source #

Playback-key-pair name. The value does not need to be unique.

importPlaybackKeyPair_tags :: Lens' ImportPlaybackKeyPair (Maybe (HashMap Text Text)) Source #

Any tags provided with the request are added to the playback key pair tags. 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.

importPlaybackKeyPair_publicKeyMaterial :: Lens' ImportPlaybackKeyPair Text Source #

The public portion of a customer-generated key pair.

Destructuring the Response

data ImportPlaybackKeyPairResponse Source #

See: newImportPlaybackKeyPairResponse smart constructor.

Constructors

ImportPlaybackKeyPairResponse'
Fields keyPair :: Maybe PlaybackKeyPair httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ImportPlaybackKeyPairResponse Source #
Instance details Defined in Amazonka.IVS.ImportPlaybackKeyPair Associated Types type Rep ImportPlaybackKeyPairResponse :: Type -> Type # Methods from :: ImportPlaybackKeyPairResponse -> Rep ImportPlaybackKeyPairResponse x # to :: Rep ImportPlaybackKeyPairResponse x -> ImportPlaybackKeyPairResponse #
Read ImportPlaybackKeyPairResponse Source #
Instance details Defined in Amazonka.IVS.ImportPlaybackKeyPair Methods readsPrec :: Int -> ReadS ImportPlaybackKeyPairResponse # readList :: ReadS [ImportPlaybackKeyPairResponse] # readPrec :: ReadPrec ImportPlaybackKeyPairResponse # readListPrec :: ReadPrec [ImportPlaybackKeyPairResponse] #
Show ImportPlaybackKeyPairResponse Source #
Instance details Defined in Amazonka.IVS.ImportPlaybackKeyPair Methods showsPrec :: Int -> ImportPlaybackKeyPairResponse -> ShowS # show :: ImportPlaybackKeyPairResponse -> String # showList :: [ImportPlaybackKeyPairResponse] -> ShowS #
NFData ImportPlaybackKeyPairResponse Source #
Instance details Defined in Amazonka.IVS.ImportPlaybackKeyPair Methods rnf :: ImportPlaybackKeyPairResponse -> () #
Eq ImportPlaybackKeyPairResponse Source #
Instance details Defined in Amazonka.IVS.ImportPlaybackKeyPair Methods (==) :: ImportPlaybackKeyPairResponse -> ImportPlaybackKeyPairResponse -> Bool # (/=) :: ImportPlaybackKeyPairResponse -> ImportPlaybackKeyPairResponse -> Bool #
type Rep ImportPlaybackKeyPairResponse Source #
Instance details Defined in Amazonka.IVS.ImportPlaybackKeyPair type Rep ImportPlaybackKeyPairResponse = D1 ('MetaData "ImportPlaybackKeyPairResponse" "Amazonka.IVS.ImportPlaybackKeyPair" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "ImportPlaybackKeyPairResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlaybackKeyPair)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newImportPlaybackKeyPairResponse Source #

Arguments

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

Create a value of ImportPlaybackKeyPairResponse 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:keyPair:ImportPlaybackKeyPairResponse', importPlaybackKeyPairResponse_keyPair -

$sel:httpStatus:ImportPlaybackKeyPairResponse', importPlaybackKeyPairResponse_httpStatus - The response's http status code.

Response Lenses

importPlaybackKeyPairResponse_keyPair :: Lens' ImportPlaybackKeyPairResponse (Maybe PlaybackKeyPair) Source #

importPlaybackKeyPairResponse_httpStatus :: Lens' ImportPlaybackKeyPairResponse Int Source #

The response's http status code.