Packaging_groups id - AWS Elemental MediaPackage

Packaging_groups id

URI

/prod/packaging_groups/id

HTTP methods

GET

Operation ID: DescribePackagingGroup

Provides details about a packaging group.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you're working on.

Responses
Status codeResponse modelDescription
200PackagingGroup

200 OK response

The list of tags is returned successfully.

403None

403 Forbidden response

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

404None

404 Not Found response

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

422None

422 Unprocessable Entity response

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

429None

429 Too Many Requests response

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

500None

500 Internal Server Error response

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

503None

Service unavailable response

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

PUT

Operation ID: UpdatePackagingGroup

Updates a specific packaging group.

You can't change the id attribute or any other system-generated attributes.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you're working on.

Responses
Status codeResponse modelDescription
200PackagingGroup

200 OK response

The packaging group is updated successfully.

403None

403 Forbidden response

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

404None

404 Not Found response

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

422None

422 Unprocessable Entity response

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

429None

429 Too Many Requests response

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

500None

500 Internal Server Error response

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

503None

Service unavailable response

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

DELETE

Operation ID: DeletePackagingGroup

Permanently deletes a packaging group.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you're working on.

Responses
Status codeResponse modelDescription
202None

202 Accepted response

AWS Elemental MediaPackage accepted the request but has not processed it yet.

403None

403 Forbidden response

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

404None

404 Not Found response

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

422None

422 Unprocessable Entity response

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

429None

429 Too Many Requests response

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

500None

500 Internal Server Error response

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

503None

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.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you're working on.

Responses
Status codeResponse modelDescription
200None

200 OK response

The list of tags is returned successfully.

Schemas

Request bodies

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

Response bodies

{ "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "domainName": "string", "egressAccessLogs": { "logGroupName": "string" }, "id": "string", "arn": "string", "approximateAssetCount": integer, "tags": { } }

Properties

Authorization

Parameters for enabling CDN authorization.

PropertyTypeRequiredDescription
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.

EgressAccessLogs

Configures egress access logs.

PropertyTypeRequiredDescription
logGroupName

string

False

Sets a custom Amazon CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/EgressAccessLogs.

PackagingGroup

Parameters for a packaging group.

PropertyTypeRequiredDescription
approximateAssetCount

integer

False

The approximate number of assets in a packaging group. The number is approximate because the count is not updated immediately after adding or removing assets.

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.

authorization

Authorization

False

Parameters for CDN authorization.

domainName

string

False

The fully qualified domain name for Assets in the PackagingGroup.

egressAccessLogs

EgressAccessLogs

False

The configuration parameters for egress access logging.

id

string

False

Unique identifier that you assign to the packaging group.

tags

Tags

False

The tags to assign to the packaging group.

PackagingGroupUpdateParameters

Parameters used to update a MediaPackage packaging group.

PropertyTypeRequiredDescription
authorization

Authorization

False

Parameters for CDN authorization.

Tags

A collection of tags associated with a resource.

PropertyTypeRequiredDescription

*

string

False