Skip to content

KantarWatermarkSettings

Source code in docs_src/capo_mediaconvert/types/kantar_watermark_settings.py
class KantarWatermarkSettings(TypedDict, closed=True):
    channel_name: NotRequired[
        "capo_mediaconvert.types.__string_min1_max20.__stringMin1Max20"
    ]
    """Provide an audio channel name from your Kantar audio license."""
    content_reference: NotRequired[
        "capo_mediaconvert.types.__string_min1_max50_pattern_azaz09.__stringMin1Max50PatternAZAZ09"
    ]
    """Specify a unique identifier for Kantar to use for this piece of content."""
    credentials_secret_name: NotRequired[
        "capo_mediaconvert.types.__string_min1_max2048_pattern_arn_az_secretsmanager_wd12_secret_azaz09.__stringMin1Max2048PatternArnAZSecretsmanagerWD12SecretAZAZ09"
    ]
    """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."""
    file_offset: NotRequired["capo_mediaconvert.types.__double_min0.__doubleMin0"]
    """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."""
    kantar_license_id: NotRequired[
        "capo_mediaconvert.types.__integer_min0_max2147483647.__integerMin0Max2147483647"
    ]
    """Provide your Kantar license ID number. You should get this number from Kantar."""
    kantar_server_url: NotRequired[
        "capo_mediaconvert.types.__string_pattern_https_kantarmedia55_prod.__stringPatternHttpsKantarmedia55Prod"
    ]
    """Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar."""
    log_destination: NotRequired[
        "capo_mediaconvert.types.__string_pattern_s3.__stringPatternS3"
    ]
    """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"""
    metadata3: NotRequired[
        "capo_mediaconvert.types.__string_min1_max50.__stringMin1Max50"
    ]
    """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."""
    metadata4: NotRequired[
        "capo_mediaconvert.types.__string_min1_max50.__stringMin1Max50"
    ]
    """Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."""
    metadata5: NotRequired[
        "capo_mediaconvert.types.__string_min1_max50.__stringMin1Max50"
    ]
    """Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."""
    metadata6: NotRequired[
        "capo_mediaconvert.types.__string_min1_max50.__stringMin1Max50"
    ]
    """Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."""
    metadata7: NotRequired[
        "capo_mediaconvert.types.__string_min1_max50.__stringMin1Max50"
    ]
    """Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."""
    metadata8: NotRequired[
        "capo_mediaconvert.types.__string_min1_max50.__stringMin1Max50"
    ]
    """Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."""

channel_name instance-attribute

channel_name: NotRequired[__stringMin1Max20]

Provide an audio channel name from your Kantar audio license.

content_reference instance-attribute

content_reference: NotRequired[__stringMin1Max50PatternAZAZ09]

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

credentials_secret_name instance-attribute

credentials_secret_name: NotRequired[
    __stringMin1Max2048PatternArnAZSecretsmanagerWD12SecretAZAZ09
]

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.

file_offset instance-attribute

file_offset: NotRequired[__doubleMin0]

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.

kantar_license_id instance-attribute

kantar_license_id: NotRequired[__integerMin0Max2147483647]

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

kantar_server_url instance-attribute

kantar_server_url: NotRequired[__stringPatternHttpsKantarmedia55Prod]

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

log_destination instance-attribute

log_destination: NotRequired[__stringPatternS3]

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

metadata3 instance-attribute

metadata3: NotRequired[__stringMin1Max50]

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.

metadata4 instance-attribute

metadata4: NotRequired[__stringMin1Max50]

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

metadata5 instance-attribute

metadata5: NotRequired[__stringMin1Max50]

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

metadata6 instance-attribute

metadata6: NotRequired[__stringMin1Max50]

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

metadata7 instance-attribute

metadata7: NotRequired[__stringMin1Max50]

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

metadata8 instance-attribute

metadata8: NotRequired[__stringMin1Max50]

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