Assets - AWS Elemental MediaPackage

Assets

URI

/prod/assets

HTTP methods

GET

Operation ID: ListAssets

Lists assets that match a set of filters that you define.

Query parameters
NameTypeRequiredDescription
packagingGroupIdStringFalse

Limits the results to records that are associated with the given packaging group.

nextTokenStringFalse

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

maxResultsStringFalse

Upper bound on number of records to return.

Responses
Status codeResponse modelDescription
200AssetList

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.

POST

Operation ID: CreateAsset

Creates an asset to ingest VOD content.

Once created, the asset starts ingesting content and generates playback URLs for the packaging configurations associated with it. When ingest is complete, downstream devices request VOD content from AWS Elemental MediaPackage using the appropriate URL.

Responses
Status codeResponse modelDescription
200Asset

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.

OPTIONS

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

Responses
Status codeResponse modelDescription
200None

200 OK response

The list of tags is returned successfully.

Schemas

Request bodies

{ "packagingGroupId": "string", "sourceArn": "string", "resourceId": "string", "sourceRoleArn": "string", "id": "string", "tags": { } }

Response bodies

{ "assets": [ { "createdAt": "string", "packagingGroupId": "string", "sourceArn": "string", "resourceId": "string", "sourceRoleArn": "string", "id": "string", "arn": "string", "tags": { } } ], "nextToken": "string" }
{ "createdAt": "string", "packagingGroupId": "string", "sourceArn": "string", "resourceId": "string", "sourceRoleArn": "string", "id": "string", "arn": "string", "egressEndpoints": [ { "packagingConfigurationId": "string", "url": "string", "status": "string" } ], "tags": { } }

Properties

Asset

Parameters for an asset.

PropertyTypeRequiredDescription
arn

string

False

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

createdAt

string

False

The time the Asset was initially submitted for Ingest.

egressEndpoints

Array of type EgressEndpoint

False

List of playback endpoints that are available for this asset.

id

string

False

Unique identifier that you assign to the asset.

packagingGroupId

string

False

The ID of the packaging group associated with this asset.

resourceId

string

False

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

sourceArn

string

False

The ARN for the source content in Amazon S3.

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}

tags

Tags

False

The tags to assign to the asset.

AssetCreateParameters

Parameters for creating an asset.

PropertyTypeRequiredDescription
id

string

True

Unique identifier that you assign to the asset.

packagingGroupId

string

True

The ID of the packaging group associated with this asset.

resourceId

string

False

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

sourceArn

string

True

The ARN for the source content in Amazon S3.

sourceRoleArn

string

True

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}

tags

Tags

False

The tags to assign to the asset.

AssetList

A collection of Asset records.

PropertyTypeRequiredDescription
assets

Array of type AssetShallow

False

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

nextToken

string

False

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

AssetShallow

Parameters on an asset.

PropertyTypeRequiredDescription
arn

string

False

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

createdAt

string

False

The time the Asset was initially submitted for Ingest.

id

string

False

Unique identifier that you assigned to the asset.

packagingGroupId

string

False

The ID of the packaging group associated with this asset.

resourceId

string

False

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

sourceArn

string

False

The ARN for the source content in Amazon S3.

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}

tags

Tags

False

The tags to assign to the asset.

EgressEndpoint

The playback endpoint for a packaging configuration on an asset.

PropertyTypeRequiredDescription
packagingConfigurationId

string

False

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

status

string

False

The current processing status of the asset used for the packaging configuration. The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. Status information isn't available for most assets ingested before September 30th, 2021.

url

string

False

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

Tags

A collection of tags associated with a resource.

PropertyTypeRequiredDescription

*

string

False