describe-asset¶

Description¶

Returns a description of a MediaPackage VOD Asset resource.

Synopsis¶

  describe-asset
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--id (string) The ID of an MediaPackage VOD Asset resource.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe an asset

The following describe-asset example displays all of the details of the asset named 30sec_chicken.

aws mediapackage-vod describe-asset \
    --id 30sec_chicken

Output:

{
    "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:assets/30sec_chicken",
    "Id":"30sec_chicken",
    "PackagingGroupId":"Packaging_group_1",
    "SourceArn":"arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil",
    "SourceRoleArn":"arn:aws:iam::111122223333:role/EMP_Vod",
    "EgressEndpoints":[
        {
            "PackagingConfigurationId":"DASH",
            "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/66c25aff456d463aae0855172b3beb27/4ddfda6da17c4c279a1b8401cba31892/index.mpd"
        },
        {
            "PackagingConfigurationId":"HLS",
            "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/6e5bf286a3414254a2bf0d22ae148d7e/06b5875b4d004c3cbdc4da2dc4d14638/index.m3u8"
        },
        {
            "PackagingConfigurationId":"CMAF",
            "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/628fb5d8d89e4702958b020af27fde0e/05eb062214064238ad6330a443aff7f7/index.m3u8"
        }
    ]
}

For more information, see Viewing Asset Details in the AWS Elemental MediaPackage User Guide.

Output¶

Arn -> (string)

The ARN of the Asset.

CreatedAt -> (string)

The time the Asset was initially submitted for Ingest.

EgressEndpoints -> (list)

The list of egress endpoints available for the Asset.

(structure)

The endpoint URL used to access an Asset using one PackagingConfiguration.

PackagingConfigurationId -> (string)

The ID of the PackagingConfiguration being applied to the Asset.

Status -> (string)

The current processing status of the asset used for the packaging configuration. The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. Status information won’t be available for most assets ingested before 2021-09-30.

Url -> (string)

The URL of the parent manifest for the repackaged Asset.

Id -> (string)

The unique identifier for the Asset.

PackagingGroupId -> (string)

The ID of the PackagingGroup for the Asset.

ResourceId -> (string)

The resource ID to include in SPEKE key requests.

SourceArn -> (string)

ARN of the source object in S3.

SourceRoleArn -> (string)

The IAM role_arn used to access the source S3 bucket.

Tags -> (map)

A collection of tags associated with a resource

key -> (string)

value -> (string)

Table of Contents

Feedback

User Guide