Packaging_groups - AWS Elemental MediaPackage

Packaging_groups

URI

/prod/packaging_groups

HTTP Methods

GET

Operation ID: ListPackagingGroups

Lists packaging groups that match a set of filters that you define.

Query Parameters
Name Type Required Description
nextToken String False

Pagination token. Use this token to request the next page of record results.

maxResults String False

Upper bound on number of records to return.

Responses
Status Code Response Model Description
200 PackagingGroupList

200 OK response

The list of tags is returned successfully.

403 None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

404 None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

422 None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

429 None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

500 None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

503 None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

POST

Operation ID: CreatePackagingGroup

Creates a packaging group.

The packaging group holds one or more packaging configurations. When you create an asset, you specify the packaging group associated with the asset. The asset has playback endpoints for each packaging configuration within the group.

Responses
Status Code Response Model Description
200 PackagingGroup

200 OK response

The list of tags is returned successfully.

403 None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

404 None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

422 None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

429 None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

500 None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

503 None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

OPTIONS

Enable cross-origin resource sharing (CORS) by returning correct headers.

Responses
Status Code Response Model Description
200 None

200 OK response

The list of tags is returned successfully.

Schemas

Request Bodies

Example POST

{ "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "id": "string", "tags": { } }

Response Bodies

Example PackagingGroupList

{ "nextToken": "string", "packagingGroups": [ { "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "domainName": "string", "id": "string", "arn": "string", "tags": { } } ] }

Example PackagingGroup

{ "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "domainName": "string", "id": "string", "arn": "string", "tags": { } }

Properties

Authorization

Parameters for enabling CDN authorization.

Property Type Required Description
cdnIdentifierSecret

string

True

The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.

secretsRoleArn

string

True

The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.

PackagingGroup

Parameters for a packaging group.

Property Type Required Description
authorization

Authorization

False

Parameters for CDN authorization.

domainName

string

False

The fully qualified domain name for Assets in the PackagingGroup.

id

string

False

Unique identifier that you assign to the packaging group.

arn

string

False

The Amazon Resource Name (ARN) for the packaging group. You can get this from the response to any request to the packaging group.

tags

Tags

False

The tags to assign to the packaging group.

PackagingGroupCreateParameters

Parameters for creating a packaging group.

Property Type Required Description
authorization

Authorization

False

Parameters for CDN authorization.

id

string

True

Unique identifier that you assign to the packaging group.

tags

Tags

False

The tags to assign to the packaging group.

PackagingGroupList

A collection of PackagingGroup records.

Property Type Required Description
nextToken

string

False

Pagination token. Use this token to request the next page of packaging groups results.

packagingGroups

Array of type PackagingGroup

False

A list of PackagingGroup records that are configured on this account in this AWS Region.

Tags

A collection of tags associated with a resource.

Property Type Required Description

*

string

False