AWS Elemental MediaPackage
VOD API Reference

Assets id

URI

/assets/id

HTTP Methods

GET

Operation ID: DescribeAsset

Provides details about an asset.

Path Parameters

Name Type Required Description
id String True

Identifier for the object that you're working on.

Responses

Status Code Response Model Description
200 Asset

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.

DELETE

Operation ID: DeleteAsset

Permanently deletes an asset.

Path Parameters

Name Type Required Description
id String True

Identifier for the object that you're working on.

Responses

Status Code Response Model Description
202 None

202 Accepted response

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

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

Response Bodies

Example Asset

{ "packagingGroupId": "string", "sourceArn": "string", "resourceId": "string", "sourceRoleArn": "string", "id": "string", "arn": "string", "egressEndpoints": [ { "packagingConfigurationId": "string", "url": "string" } ] }

Properties

Asset

Parameters for an asset.

Property Type Required Description
packagingGroupId

string

False

The ID of the packaging group associated with this asset.

sourceArn

string

False

The ARN for the source content in Amazon S3.

resourceId

string

False

Unique identifier for this asset, as it is configured in the key provider service.

sourceRoleArn

string

False

The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored. Valid format: arn:aws:iam::{accountID}:role/{name}

id

string

False

Unique identifier that you assign to the asset.

arn

string

False

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

egressEndpoints

Array of type EgressEndpoint

False

List of playback endpoints that are available for this asset.

EgressEndpoint

The playback endpoint for a packaging configuration on an asset.

Property Type Required Description
packagingConfigurationId

string

False

The ID of a packaging configuration that's applied to this asset.

url

string

False

The URL that's used to request content from this endpoint.