feeds

Creates, updates, deletes, gets or lists a feeds resource.

Overview

Name	feeds
Type	Resource
Id	aws.elementalinference.feeds

Fields

The following fields are returned by SELECT queries:

get_feed

Name	Datatype	Description
id	string	The ID of the feed. (pattern: <code>[a-z0-9]{19}</code>)
name	string	The name of the feed. (pattern: <code>[a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?</code>)
arn	string	The ARN of the feed.
association	object	Information about the resource that is associated with the feed. It's possible that there is no associated resource. This is not an error.
data_endpoints	array	The dataEndpoints of the feed.
outputs	array	An array of the outputs in the feed.
status	string	The status of the feed. (CREATING, AVAILABLE, ACTIVE, UPDATING, DELETING, DELETED, ARCHIVED)
tags	object	A list of the tags, if any, for the feed.

list_feeds

Name	Datatype	Description
id	string	The ID of the feed. (pattern: <code>[a-z0-9]{19}</code>)
name	string	The name of the feed (pattern: <code>[a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?</code>)
arn	string	The ARN of the feed.
association	object	The resource, if any, associated with the feed.
status	string	The status of the feed. (CREATING, AVAILABLE, ACTIVE, UPDATING, DELETING, DELETED, ARCHIVED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_feed	select	id, region		Retrieves information about the specified feed.
list_feeds	select	region	maxResults, nextToken	Displays a list of feeds that belong to this AWS account.
create_feed	insert	region, name, outputs		Creates a feed. The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs.
associate_feed	update	id, region, associatedResourceName, outputs		Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed. AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation. Specifically: You can add more outputs to the existing outputs. New outputs will be appended. You can't modify an existing output (for example to change its name). Instead, use UpdateFeed. You can't delete an existing output. Instead, use UpdateFeed. Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.
update_feed	update	id, region, name, outputs		Updates the name and/or outputs in a feed. UpdateFeed is a PUT operation, which means that the payload that you specify completely overwrites the existing payload. This means that if you want to touch the array of outputs, you must pass in the full new list. So you must omit outputs you want to delete, and include outputs you want to add or modify. If you want to patch the array of outputs to make selective additions, use AssociateFeed.
disassociate_feed	update	id, region, associatedResourceName		Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.
delete_feed	delete	id, region		Deletes the specified feed. You can delete the feed at any time. Elemental Inference doesn't block you from deleting a feed when the calling application is calling PutMedia or GetMetadata on that feed, although both these calls will start to fail. For more information about managing inactive feeds, see the Elemental Inference User Guide.

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 feed.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per API request. For example, you submit a list request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. Valid Range: Minimum value of 1. Maximum value of 1000.
nextToken	string	The token that identifies the batch of results that you want to see. For example, you submit a ListFeeds request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFeeds request a second time and specify the NextToken value.

SELECT examples

get_feed

Retrieves information about the specified feed.

SELECT
id,
name,
arn,
association,
data_endpoints,
outputs,
status,
tags
FROM aws.elementalinference.feeds
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_feeds

Displays a list of feeds that belong to this AWS account.

SELECT
id,
name,
arn,
association,
status
FROM aws.elementalinference.feeds
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_feed

Creates a feed. The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs.

INSERT INTO aws.elementalinference.feeds (
name,
accessRoleArn,
outputs,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ accessRoleArn }}',
'{{ outputs }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
association,
data_endpoints,
outputs,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: feeds
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the feeds resource.
  - name: name
    value: "{{ name }}"
  - name: accessRoleArn
    value: "{{ accessRoleArn }}"
  - name: outputs
    value:
      - name: "{{ name }}"
        outputConfig:
          cropping:
            templateGroups:
              - name: "{{ name }}"
                templateUris: "{{ templateUris }}"
          clipping:
            callbackMetadata: "{{ callbackMetadata }}"
            dataSourceConfiguration:
              fixtureId: "{{ fixtureId }}"
          subtitling:
            language: "{{ language }}"
            aspectRatio:
              width: {{ width }}
              height: {{ height }}
            dictionary: "{{ dictionary }}"
            profanityFilter: "{{ profanityFilter }}"
        status: "{{ status }}"
        description: "{{ description }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

associate_feed

Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed. AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation. Specifically: You can add more outputs to the existing outputs. New outputs will be appended. You can't modify an existing output (for example to change its name). Instead, use UpdateFeed. You can't delete an existing output. Instead, use UpdateFeed. Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.

UPDATE aws.elementalinference.feeds
SET 
associatedResourceName = '{{ associatedResourceName }}',
outputs = '{{ outputs }}',
dryRun = {{ dryRun }}
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND associatedResourceName = '{{ associatedResourceName }}' --required
AND outputs = '{{ outputs }}' --required
RETURNING
id,
arn;

update_feed

Updates the name and/or outputs in a feed. UpdateFeed is a PUT operation, which means that the payload that you specify completely overwrites the existing payload. This means that if you want to touch the array of outputs, you must pass in the full new list. So you must omit outputs you want to delete, and include outputs you want to add or modify. If you want to patch the array of outputs to make selective additions, use AssociateFeed.

UPDATE aws.elementalinference.feeds
SET 
name = '{{ name }}',
accessRoleArn = '{{ accessRoleArn }}',
outputs = '{{ outputs }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND name = '{{ name }}' --required
AND outputs = '{{ outputs }}' --required
RETURNING
id,
name,
arn,
association,
data_endpoints,
outputs,
status,
tags;

disassociate_feed

Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.

UPDATE aws.elementalinference.feeds
SET 
associatedResourceName = '{{ associatedResourceName }}',
dryRun = {{ dryRun }}
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND associatedResourceName = '{{ associatedResourceName }}' --required
RETURNING
id,
arn;

DELETE examples

delete_feed

Deletes the specified feed. You can delete the feed at any time. Elemental Inference doesn't block you from deleting a feed when the calling application is calling PutMedia or GetMetadata on that feed, although both these calls will start to fail. For more information about managing inactive feeds, see the Elemental Inference User Guide.

DELETE FROM aws.elementalinference.feeds
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;