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 |
Synopsis
- data KantarWatermarkSettings = KantarWatermarkSettings' {
- metadata7 :: Maybe Text
- kantarServerUrl :: Maybe Text
- kantarLicenseId :: Maybe Natural
- logDestination :: Maybe Text
- fileOffset :: Maybe Double
- metadata6 :: Maybe Text
- metadata3 :: Maybe Text
- credentialsSecretName :: Maybe Text
- channelName :: Maybe Text
- contentReference :: Maybe Text
- metadata8 :: Maybe Text
- metadata5 :: Maybe Text
- metadata4 :: Maybe Text
- newKantarWatermarkSettings :: KantarWatermarkSettings
- kantarWatermarkSettings_metadata7 :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_kantarServerUrl :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_kantarLicenseId :: Lens' KantarWatermarkSettings (Maybe Natural)
- kantarWatermarkSettings_logDestination :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_fileOffset :: Lens' KantarWatermarkSettings (Maybe Double)
- kantarWatermarkSettings_metadata6 :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_metadata3 :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_credentialsSecretName :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_channelName :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_contentReference :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_metadata8 :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_metadata5 :: Lens' KantarWatermarkSettings (Maybe Text)
- kantarWatermarkSettings_metadata4 :: Lens' KantarWatermarkSettings (Maybe Text)
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.
KantarWatermarkSettings' | |
|
Instances
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.