[ aws . mediapackage-vod ]

list-assets

Description

Returns a collection of MediaPackage VOD Asset resources.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-assets is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Assets

Synopsis

  list-assets
[--packaging-group-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--packaging-group-id (string) Returns Assets associated with the specified PackagingGroup.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 list all assets

The following list-assets example ists all of the assets that are configured in the current AWS account.

aws mediapackage-vod list-assets

Output:

{
    "Assets": [
        "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"
    ]
}

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

Output

Assets -> (list)

A list of MediaPackage VOD Asset resources.

(structure)

A MediaPackage VOD Asset resource.

Arn -> (string)

The ARN of the Asset.

CreatedAt -> (string)

The time the Asset was initially submitted for Ingest.

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)

NextToken -> (string)

A token that can be used to resume pagination from the end of the collection.