libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaConvert.Types.KantarWatermarkSettings

Description

 
Synopsis

Documentation

data KantarWatermarkSettings Source #

Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.

See: newKantarWatermarkSettings smart constructor.

Constructors

KantarWatermarkSettings' 

Fields

  • metadata7 :: Maybe Text

    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

  • kantarServerUrl :: Maybe Text

    Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.

  • kantarLicenseId :: Maybe Natural

    Provide your Kantar license ID number. You should get this number from Kantar.

  • logDestination :: Maybe Text

    Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

  • fileOffset :: Maybe Double

    Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.

  • metadata6 :: Maybe Text

    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

  • metadata3 :: Maybe Text

    You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.

  • credentialsSecretName :: Maybe Text

    Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.

  • channelName :: Maybe Text

    Provide an audio channel name from your Kantar audio license.

  • contentReference :: Maybe Text

    Specify a unique identifier for Kantar to use for this piece of content.

  • metadata8 :: Maybe Text

    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

  • metadata5 :: Maybe Text

    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

  • metadata4 :: Maybe Text

    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

Instances

Instances details
Eq KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

Read KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

Show KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

Generic KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

Associated Types

type Rep KantarWatermarkSettings :: Type -> Type #

NFData KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

Methods

rnf :: KantarWatermarkSettings -> () #

Hashable KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

ToJSON KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

FromJSON KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

type Rep KantarWatermarkSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.KantarWatermarkSettings

type Rep KantarWatermarkSettings = D1 ('MetaData "KantarWatermarkSettings" "Amazonka.MediaConvert.Types.KantarWatermarkSettings" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "KantarWatermarkSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "metadata7") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kantarServerUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kantarLicenseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "logDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fileOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "metadata6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "metadata3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "credentialsSecretName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "contentReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metadata8") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "metadata5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metadata4") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newKantarWatermarkSettings :: KantarWatermarkSettings Source #

Create a value of KantarWatermarkSettings 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:metadata7:KantarWatermarkSettings', kantarWatermarkSettings_metadata7 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

$sel:kantarServerUrl:KantarWatermarkSettings', kantarWatermarkSettings_kantarServerUrl - Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.

$sel:kantarLicenseId:KantarWatermarkSettings', kantarWatermarkSettings_kantarLicenseId - Provide your Kantar license ID number. You should get this number from Kantar.

$sel:logDestination:KantarWatermarkSettings', kantarWatermarkSettings_logDestination - Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

$sel:fileOffset:KantarWatermarkSettings', kantarWatermarkSettings_fileOffset - Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.

$sel:metadata6:KantarWatermarkSettings', kantarWatermarkSettings_metadata6 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

$sel:metadata3:KantarWatermarkSettings', kantarWatermarkSettings_metadata3 - You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.

$sel:credentialsSecretName:KantarWatermarkSettings', kantarWatermarkSettings_credentialsSecretName - Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.

$sel:channelName:KantarWatermarkSettings', kantarWatermarkSettings_channelName - Provide an audio channel name from your Kantar audio license.

$sel:contentReference:KantarWatermarkSettings', kantarWatermarkSettings_contentReference - Specify a unique identifier for Kantar to use for this piece of content.

$sel:metadata8:KantarWatermarkSettings', kantarWatermarkSettings_metadata8 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

$sel:metadata5:KantarWatermarkSettings', kantarWatermarkSettings_metadata5 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

$sel:metadata4:KantarWatermarkSettings', kantarWatermarkSettings_metadata4 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

kantarWatermarkSettings_metadata7 :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

kantarWatermarkSettings_kantarServerUrl :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.

kantarWatermarkSettings_kantarLicenseId :: Lens' KantarWatermarkSettings (Maybe Natural) Source #

Provide your Kantar license ID number. You should get this number from Kantar.

kantarWatermarkSettings_logDestination :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

kantarWatermarkSettings_fileOffset :: Lens' KantarWatermarkSettings (Maybe Double) Source #

Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.

kantarWatermarkSettings_metadata6 :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

kantarWatermarkSettings_metadata3 :: Lens' KantarWatermarkSettings (Maybe Text) Source #

You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.

kantarWatermarkSettings_credentialsSecretName :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.

kantarWatermarkSettings_channelName :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Provide an audio channel name from your Kantar audio license.

kantarWatermarkSettings_contentReference :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Specify a unique identifier for Kantar to use for this piece of content.

kantarWatermarkSettings_metadata8 :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

kantarWatermarkSettings_metadata5 :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

kantarWatermarkSettings_metadata4 :: Lens' KantarWatermarkSettings (Maybe Text) Source #

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.