mediapackagev2 / Client / get_origin_endpoint_policy

get_origin_endpoint_policy

mediapackagev2.Client.get_origin_endpoint_policy(**kwargs)

Retrieves the specified origin endpoint policy that’s configured in AWS Elemental MediaPackage.

See also: AWS API Documentation

Request Syntax

response = client.get_origin_endpoint_policy(
    ChannelGroupName='string',
    ChannelName='string',
    OriginEndpointName='string'
)
Parameters:

  • ChannelGroupName (string) –

    [REQUIRED]

    The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

  • ChannelName (string) –

    [REQUIRED]

    The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

  • OriginEndpointName (string) –

    [REQUIRED]

    The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelGroupName': 'string',
    'ChannelName': 'string',
    'OriginEndpointName': 'string',
    'Policy': 'string',
    'CdnAuthConfiguration': {
        'CdnIdentifierSecretArns': [
            'string',
        ],
        'SecretsRoleArn': 'string'
    }
}

Response Structure

  • (dict) –

    • ChannelGroupName (string) –

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName (string) –

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName (string) –

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

    • Policy (string) –

      The policy assigned to the origin endpoint.

    • CdnAuthConfiguration (dict) –

      The settings for using authorization headers between the MediaPackage endpoint and your CDN.

      For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.

      • CdnIdentifierSecretArns (list) –

        The ARN for the secret in Secrets Manager that your CDN uses for authorization to access the endpoint.

        • (string) –

      • SecretsRoleArn (string) –

        The ARN for the IAM role that gives MediaPackage read access to Secrets Manager and KMS for CDN authorization.

Exceptions