assets
Creates, updates, deletes, gets or lists an assets resource.
Overview
| Name | assets |
| Type | Resource |
| Id | aws.mediapackage_vod.assets |
Fields
The following fields are returned by SELECT queries:
- describe_asset
- list_assets
| Name | Datatype | Description |
|---|---|---|
arn | string | The ARN of the Asset. |
created_at | string | The time the Asset was initially submitted for Ingest. |
egress_endpoints | array | The list of egress endpoints available for the Asset. |
id | string | The unique identifier for the Asset. |
packaging_group_id | string | The ID of the PackagingGroup for the Asset. |
resource_id | string | The resource ID to include in SPEKE key requests. |
source_arn | string | ARN of the source object in S3. |
source_role_arn | string | The IAM role_arn used to access the source S3 bucket. |
tags | object |
| Name | Datatype | Description |
|---|---|---|
arn | string | The ARN of the Asset. |
created_at | string | The time the Asset was initially submitted for Ingest. |
id | string | The unique identifier for the Asset. |
packaging_group_id | string | The ID of the PackagingGroup for the Asset. |
resource_id | string | The resource ID to include in SPEKE key requests. |
source_arn | string | ARN of the source object in S3. |
source_role_arn | string | The IAM role ARN used to access the source S3 bucket. |
tags | object |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_asset | select | id, region | Returns a description of a MediaPackage VOD Asset resource. | |
list_assets | select | region | maxResults, nextToken, packagingGroupId | Returns a collection of MediaPackage VOD Asset resources. |
create_asset | insert | region, PackagingGroupId, SourceArn, SourceRoleArn | Creates a new MediaPackage VOD Asset resource. | |
delete_asset | delete | id, region | Deletes an existing MediaPackage VOD Asset resource. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | The ID of the MediaPackage VOD Asset resource to delete. |
region | string | AWS region (default: us-east-1) |
maxResults | integer | Upper bound on number of records to return. |
nextToken | string | A token used to resume pagination from the end of a previous request. |
packagingGroupId | string | Returns Assets associated with the specified PackagingGroup. |
SELECT examples
- describe_asset
- list_assets
Returns a description of a MediaPackage VOD Asset resource.
SELECT
arn,
created_at,
egress_endpoints,
id,
packaging_group_id,
resource_id,
source_arn,
source_role_arn,
tags
FROM aws.mediapackage_vod.assets
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;
Returns a collection of MediaPackage VOD Asset resources.
SELECT
arn,
created_at,
id,
packaging_group_id,
resource_id,
source_arn,
source_role_arn,
tags
FROM aws.mediapackage_vod.assets
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND packagingGroupId = '{{ packagingGroupId }}'
;
INSERT examples
- create_asset
- Manifest
Creates a new MediaPackage VOD Asset resource.
INSERT INTO aws.mediapackage_vod.assets (
Id,
PackagingGroupId,
ResourceId,
SourceArn,
SourceRoleArn,
Tags,
region
)
SELECT
'{{ Id }}',
'{{ PackagingGroupId }}' /* required */,
'{{ ResourceId }}',
'{{ SourceArn }}' /* required */,
'{{ SourceRoleArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
created_at,
egress_endpoints,
id,
packaging_group_id,
resource_id,
source_arn,
source_role_arn,
tags
;
# Description fields are for documentation purposes
- name: assets
props:
- name: region
value: "{{ region }}"
description: Required parameter for the assets resource.
- name: Id
value: "{{ Id }}"
- name: PackagingGroupId
value: "{{ PackagingGroupId }}"
- name: ResourceId
value: "{{ ResourceId }}"
- name: SourceArn
value: "{{ SourceArn }}"
- name: SourceRoleArn
value: "{{ SourceRoleArn }}"
- name: Tags
value: "{{ Tags }}"
description: |
A collection of tags associated with a resource
DELETE examples
- delete_asset
Deletes an existing MediaPackage VOD Asset resource.
DELETE FROM aws.mediapackage_vod.assets
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;