AWS API Changes

2021/02/24 - AWS Elemental MediaPackage VOD - 1 new 4 updated api methods

Changes AWS Elemental MediaPackage provides access logs that capture detailed information about requests sent to a customer's MediaPackage VOD packaging group.

ConfigureLogs (new)

Link ¶

Changes the packaging group's properities to configure log subscription

See also: AWS API Documentation

Request Syntax

client.configure_logs(
    EgressAccessLogs={
        'LogGroupName': 'string'
    },
    Id='string'
)

type EgressAccessLogs

dict

param EgressAccessLogs

Configure egress access logging.

LogGroupName (string) -- Customize the log group name.

type Id

string

param Id

[REQUIRED] The ID of a MediaPackage VOD PackagingGroup resource.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Authorization': {
        'CdnIdentifierSecret': 'string',
        'SecretsRoleArn': 'string'
    },
    'DomainName': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated MediaPackage VOD PackagingGroup resource.
- Arn (string) -- The ARN of the PackagingGroup.
- Authorization (dict) -- CDN Authorization credentials
  - CdnIdentifierSecret (string) -- The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
  - SecretsRoleArn (string) -- The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
- DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Id (string) -- The ID of the PackagingGroup.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

CreatePackagingGroup (updated)

Link ¶
Changes (both)

{'EgressAccessLogs': {'LogGroupName': 'string'}}

Creates a new MediaPackage VOD PackagingGroup resource.

See also: AWS API Documentation

Request Syntax

client.create_packaging_group(
    Authorization={
        'CdnIdentifierSecret': 'string',
        'SecretsRoleArn': 'string'
    },
    EgressAccessLogs={
        'LogGroupName': 'string'
    },
    Id='string',
    Tags={
        'string': 'string'
    }
)

type Authorization

dict

param Authorization

CDN Authorization credentials

CdnIdentifierSecret (string) -- [REQUIRED] The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
SecretsRoleArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.

type EgressAccessLogs

dict

param EgressAccessLogs

Configure egress access logging.

LogGroupName (string) -- Customize the log group name.

type Id

string

param Id

[REQUIRED] The ID of the PackagingGroup.

type Tags

dict

param Tags

A collection of tags associated with a resource

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Authorization': {
        'CdnIdentifierSecret': 'string',
        'SecretsRoleArn': 'string'
    },
    'DomainName': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The new MediaPackage VOD PackagingGroup resource.
- Arn (string) -- The ARN of the PackagingGroup.
- Authorization (dict) -- CDN Authorization credentials
  - CdnIdentifierSecret (string) -- The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
  - SecretsRoleArn (string) -- The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
- DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Id (string) -- The ID of the PackagingGroup.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

DescribePackagingGroup (updated)

Link ¶
Changes (response)

{'EgressAccessLogs': {'LogGroupName': 'string'}}

Returns a description of a MediaPackage VOD PackagingGroup resource.

See also: AWS API Documentation

Request Syntax

client.describe_packaging_group(
    Id='string'
)

type Id

string

param Id

[REQUIRED] The ID of a MediaPackage VOD PackagingGroup resource.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Authorization': {
        'CdnIdentifierSecret': 'string',
        'SecretsRoleArn': 'string'
    },
    'DomainName': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- A MediaPackage VOD PackagingGroup resource.
- Arn (string) -- The ARN of the PackagingGroup.
- Authorization (dict) -- CDN Authorization credentials
  - CdnIdentifierSecret (string) -- The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
  - SecretsRoleArn (string) -- The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
- DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Id (string) -- The ID of the PackagingGroup.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

ListPackagingGroups (updated)

Link ¶
Changes (response)

{'PackagingGroups': {'EgressAccessLogs': {'LogGroupName': 'string'}}}

Returns a collection of MediaPackage VOD PackagingGroup resources.

See also: AWS API Documentation

Request Syntax

client.list_packaging_groups(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

Upper bound on number of records to return.

type NextToken

string

param NextToken

A token used to resume pagination from the end of a previous request.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'PackagingGroups': [
        {
            'Arn': 'string',
            'Authorization': {
                'CdnIdentifierSecret': 'string',
                'SecretsRoleArn': 'string'
            },
            'DomainName': 'string',
            'EgressAccessLogs': {
                'LogGroupName': 'string'
            },
            'Id': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

(dict) -- A collection of MediaPackage VOD PackagingGroup resources.
- NextToken (string) -- A token that can be used to resume pagination from the end of the collection.
- PackagingGroups (list) -- A list of MediaPackage VOD PackagingGroup resources.
  - (dict) -- A MediaPackage VOD PackagingGroup resource.
    - Arn (string) -- The ARN of the PackagingGroup.
    - Authorization (dict) -- CDN Authorization credentials
      - CdnIdentifierSecret (string) -- The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
      - SecretsRoleArn (string) -- The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
    - DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.
    - EgressAccessLogs (dict) -- Configure egress access logging.
      - LogGroupName (string) -- Customize the log group name.
    - Id (string) -- The ID of the PackagingGroup.
    - Tags (dict) -- A collection of tags associated with a resource
      - (string) --
        
        (string) --

UpdatePackagingGroup (updated)

Link ¶
Changes (response)

{'EgressAccessLogs': {'LogGroupName': 'string'}}

Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes.

See also: AWS API Documentation

Request Syntax

client.update_packaging_group(
    Authorization={
        'CdnIdentifierSecret': 'string',
        'SecretsRoleArn': 'string'
    },
    Id='string'
)

type Authorization

dict

param Authorization

CDN Authorization credentials

CdnIdentifierSecret (string) -- [REQUIRED] The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
SecretsRoleArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.

type Id

string

param Id

[REQUIRED] The ID of a MediaPackage VOD PackagingGroup resource.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Authorization': {
        'CdnIdentifierSecret': 'string',
        'SecretsRoleArn': 'string'
    },
    'DomainName': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated MediaPackage VOD PackagingGroup resource.
- Arn (string) -- The ARN of the PackagingGroup.
- Authorization (dict) -- CDN Authorization credentials
  - CdnIdentifierSecret (string) -- The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
  - SecretsRoleArn (string) -- The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
- DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Id (string) -- The ID of the PackagingGroup.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --