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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Synopsis

Creating a Request

data CreateRecordingConfiguration Source #

See: newCreateRecordingConfiguration smart constructor.

Constructors

CreateRecordingConfiguration'

Fields

name :: Maybe Text
Recording-configuration name. The value does not need to be unique.
recordingReconnectWindowSeconds :: Maybe Natural
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
tags :: Maybe (HashMap Text Text)
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.
thumbnailConfiguration :: Maybe ThumbnailConfiguration
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
destinationConfiguration :: DestinationConfiguration
A complex type that contains a destination configuration for where recorded video will be stored.

Instances

Instances details

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

newCreateRecordingConfiguration Source #

Arguments

:: DestinationConfiguration	`CreateRecordingConfiguration`
-> CreateRecordingConfiguration

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

CreateRecordingConfiguration, createRecordingConfiguration_name - Recording-configuration name. The value does not need to be unique.

CreateRecordingConfiguration, createRecordingConfiguration_recordingReconnectWindowSeconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

CreateRecordingConfiguration, createRecordingConfiguration_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.

CreateRecordingConfiguration, createRecordingConfiguration_thumbnailConfiguration - A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

CreateRecordingConfiguration, createRecordingConfiguration_destinationConfiguration - A complex type that contains a destination configuration for where recorded video will be stored.

Request Lenses

createRecordingConfiguration_name :: Lens' CreateRecordingConfiguration (Maybe Text) Source #

Recording-configuration name. The value does not need to be unique.

createRecordingConfiguration_recordingReconnectWindowSeconds :: Lens' CreateRecordingConfiguration (Maybe Natural) Source #

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

createRecordingConfiguration_tags :: Lens' CreateRecordingConfiguration (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.

createRecordingConfiguration_thumbnailConfiguration :: Lens' CreateRecordingConfiguration (Maybe ThumbnailConfiguration) Source #

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

createRecordingConfiguration_destinationConfiguration :: Lens' CreateRecordingConfiguration DestinationConfiguration Source #

A complex type that contains a destination configuration for where recorded video will be stored.

Destructuring the Response

data CreateRecordingConfigurationResponse Source #

See: newCreateRecordingConfigurationResponse smart constructor.

Constructors

CreateRecordingConfigurationResponse'
Fields recordingConfiguration :: Maybe RecordingConfiguration httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateRecordingConfigurationResponse Source #

Arguments

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

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

CreateRecordingConfigurationResponse, createRecordingConfigurationResponse_recordingConfiguration -

$sel:httpStatus:CreateRecordingConfigurationResponse', createRecordingConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

createRecordingConfigurationResponse_recordingConfiguration :: Lens' CreateRecordingConfigurationResponse (Maybe RecordingConfiguration) Source #

createRecordingConfigurationResponse_httpStatus :: Lens' CreateRecordingConfigurationResponse Int Source #

The response's http status code.