2026/02/24 - AWS Elemental Inference - 10 new api methods
Changes Initial GA launch for AWS Elemental Inference including capabilities of Smart Crop and Live Event Clipping
Displays a list of feeds that belong to this AWS account.
See also: AWS API Documentation
Request Syntax
client.list_feeds(
maxResults=123,
nextToken='string'
)
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.
string
The token that identifies the batch of results that you want to see.
For example, you submit a ListBridges 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 ListBridges request a second time and specify the NextToken value.
dict
Response Syntax
{
'feeds': [
{
'arn': 'string',
'id': 'string',
'name': 'string',
'association': {
'associatedResourceName': 'string'
},
'status': 'CREATING'|'AVAILABLE'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'ARCHIVED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
feeds (list) --
A list of feed summaries.
(dict) --
Contains configuration information about a feed. It is used in the ListFeeds action.
arn (string) --
The ARN of the feed.
id (string) --
The ID of the feed.
name (string) --
The name of the feed
association (dict) --
The resource, if any, associated with the feed.
associatedResourceName (string) --
The name of the associated resource.
status (string) --
The status of the feed.
nextToken (string) --
The token that identifies the batch of results that you want to see. For example, you submit a list 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 list request a second time and specify the NextToken value.
Releases the resource (for example, an MediaLive channel) that is associated with this feed. The outputs in the feed become disabled.
See also: AWS API Documentation
Request Syntax
client.disassociate_feed(
id='string',
associatedResourceName='string',
dryRun=True|False
)
string
[REQUIRED]
The ID of the feed where you want to release the resource.
string
[REQUIRED]
The name of the resource currently associated with the feed'.
This field is autopopulated if not provided.
boolean
Set to true if you want to do a dry run of the disassociate action.
dict
Response Syntax
{
'arn': 'string',
'id': 'string'
}
Response Structure
(dict) --
arn (string) --
The ID of the feed where you deleted the associated resource.
id (string) --
The ARN of the resource that you deleted.
List all tags that are on an Elemental Inference resource in the current region.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource whose tags you want to query.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
A list of the tags that belong to this resource.
(string) --
(string) --
Deletes specified tags from the specified resource in the current region.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource where you want to delete one or more tags.
list
[REQUIRED]
The keys of the tags to delete.
(string) --
None
Deletes the specified feed. The feed can be deleted at any time.
See also: AWS API Documentation
Request Syntax
client.delete_feed(
id='string'
)
string
[REQUIRED]
The ID of the feed.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'status': 'CREATING'|'AVAILABLE'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'ARCHIVED'
}
Response Structure
(dict) --
arn (string) --
The ARN of the deleted feed.
id (string) --
The ID of the deleted feed.
status (string) --
The current status of the feed. When deletion of the feed has succeeded, the status will be DELETED.
Updates the name and/or outputs in a feed.
See also: AWS API Documentation
Request Syntax
client.update_feed(
name='string',
id='string',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {}
,
'clipping': {
'callbackMetadata': 'string'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string',
'fromAssociation': True|False
},
]
)
string
[REQUIRED]
Required. You can specify the existing name (to leave it unchanged) or a new name.
string
[REQUIRED]
The ID of the feed to update.
list
[REQUIRED]
Required. You can specify the existing array of outputs (to leave outputs unchanged) or you can specify a new array.
(dict) --
Contains configuration information about one output in a feed. It is used in the UpdateFeed action.
name (string) -- [REQUIRED]
The name start here
outputConfig (dict) -- [REQUIRED]
A typed property for an output in a feed. It is used in the UpdateFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
cropping (dict) --
The output config type that applies to the cropping feature.
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
The metadata that is the result of the clip request to Elemental Inference.
status (string) -- [REQUIRED]
The status of the output.
description (string) --
A description of the output.
fromAssociation (boolean) --
This property is set by the service when you add the output to the feed, and indicates how you added the output. True means that you used the AssociateFeed operation. False means that you used the CreateFeed or UpdateFeed operation. Use GetFeed to obtain the value. If the value is True, include this field here with a value of True. If the value is False, omit the field here.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'id': 'string',
'dataEndpoints': [
'string',
],
'outputs': [
{
'name': 'string',
'outputConfig': {
'cropping': {},
'clipping': {
'callbackMetadata': 'string'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string',
'fromAssociation': True|False
},
],
'status': 'CREATING'|'AVAILABLE'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'ARCHIVED',
'association': {
'associatedResourceName': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the feed.
name (string) --
The updated or original name of the feed.
id (string) --
The ID of the feed.
dataEndpoints (list) --
The data endpoints of the feed.
(string) --
outputs (list) --
The array of outputs in the feed. You might have left this array unchanged, or you might have changed it.
(dict) --
Contains configuration information about one output in a feed. It is used in the GetFeed action.
name (string) --
The ARN of the output.
outputConfig (dict) --
A typed property for an output in a feed. It is used in the GetFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
cropping (dict) --
The output config type that applies to the cropping feature.
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
The metadata that is the result of the clip request to Elemental Inference.
status (string) --
The status of the output.
description (string) --
The description of the output.
fromAssociation (boolean) --
True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.
status (string) --
The status of the output.
association (dict) --
True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.
associatedResourceName (string) --
The name of the associated resource.
tags (dict) --
The name of the resource currently associated with the feed, if any.
(string) --
(string) --
Associates the specified tags to the resource identified by the specified resourceArn in the current region. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource where you want to add tags.
dict
[REQUIRED]
A list of tags to add to the resource.
(string) --
(string) --
None
Creates a feed. The feed is the target for live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed.
See also: AWS API Documentation
Request Syntax
client.create_feed(
name='string',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {}
,
'clipping': {
'callbackMetadata': 'string'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string'
},
],
tags={
'string': 'string'
}
)
string
[REQUIRED]
A name for this feed.
list
[REQUIRED]
An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, an output might represent the crop feature.
(dict) --
Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions.
name (string) -- [REQUIRED]
A name for the output.
outputConfig (dict) -- [REQUIRED]
A typed property for an output in a feed. It is used in the CreateFeed and AssociateFeed actions. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
cropping (dict) --
The output config type that applies to the cropping feature.
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
The metadata that is the result of the clip request to Elemental Inference.
status (string) -- [REQUIRED]
The status to assign to the output.
description (string) --
A description for the output.
dict
If you want to include tags, add them now. You won't be able to add them later.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'id': 'string',
'dataEndpoints': [
'string',
],
'outputs': [
{
'name': 'string',
'outputConfig': {
'cropping': {},
'clipping': {
'callbackMetadata': 'string'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string',
'fromAssociation': True|False
},
],
'status': 'CREATING'|'AVAILABLE'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'ARCHIVED',
'association': {
'associatedResourceName': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
A unique ARN that Elemental Inference assigns to the feed.
name (string) --
The name that you specified.
id (string) --
A unique ID that Elemental Inference assigns to the feed.
dataEndpoints (list) --
A unique ARN that Elemental Inference assigns to the feed.
(string) --
outputs (list) --
Data endpoints that Elemental Inference assigns to the feed.
(dict) --
Contains configuration information about one output in a feed. It is used in the GetFeed action.
name (string) --
The ARN of the output.
outputConfig (dict) --
A typed property for an output in a feed. It is used in the GetFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
cropping (dict) --
The output config type that applies to the cropping feature.
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
The metadata that is the result of the clip request to Elemental Inference.
status (string) --
The status of the output.
description (string) --
The description of the output.
fromAssociation (boolean) --
True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.
status (string) --
The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE.
association (dict) --
The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed.
associatedResourceName (string) --
The name of the associated resource.
tags (dict) --
Any tags that you included when you created the feed.
(string) --
(string) --
Associates a resource with the feed. The resource provides the input that Elemental Inference needs 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.
See also: AWS API Documentation
Request Syntax
client.associate_feed(
id='string',
associatedResourceName='string',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {}
,
'clipping': {
'callbackMetadata': 'string'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string'
},
],
dryRun=True|False
)
string
[REQUIRED]
The ID of the feed.
string
[REQUIRED]
An identifier for the resource. If the resource is from an AWS service, this identifier must be the full ARN of that resource. Otherwise, the identifier is a name that you assign and that is appropriate for the application that owns the resource. This name must not resemble an ARN.
This field is autopopulated if not provided.
list
[REQUIRED]
The outputs to add to this feed. You must specify at least one output. You can later use the UpdateFeed action to change the list of outputs.
(dict) --
Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions.
name (string) -- [REQUIRED]
A name for the output.
outputConfig (dict) -- [REQUIRED]
A typed property for an output in a feed. It is used in the CreateFeed and AssociateFeed actions. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
cropping (dict) --
The output config type that applies to the cropping feature.
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
The metadata that is the result of the clip request to Elemental Inference.
status (string) -- [REQUIRED]
The status to assign to the output.
description (string) --
A description for the output.
boolean
Set to true if you want to do a dry run of the associate action.
dict
Response Syntax
{
'arn': 'string',
'id': 'string'
}
Response Structure
(dict) --
arn (string) --
The AWS ARN for this association.
id (string) --
An ID for this response. It is unique in Elemental Inference for this AWS account.
Retrieves information about the specified feed.
See also: AWS API Documentation
Request Syntax
client.get_feed(
id='string'
)
string
[REQUIRED]
The ID of the feed to query.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'id': 'string',
'dataEndpoints': [
'string',
],
'outputs': [
{
'name': 'string',
'outputConfig': {
'cropping': {},
'clipping': {
'callbackMetadata': 'string'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string',
'fromAssociation': True|False
},
],
'status': 'CREATING'|'AVAILABLE'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'ARCHIVED',
'association': {
'associatedResourceName': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the feed.
name (string) --
The name of the feed being queried.
id (string) --
The ID of the feed being queried.
dataEndpoints (list) --
The dataEndpoints of the feed being queried.
(string) --
outputs (list) --
An array of the outputs in the feed being queried.
(dict) --
Contains configuration information about one output in a feed. It is used in the GetFeed action.
name (string) --
The ARN of the output.
outputConfig (dict) --
A typed property for an output in a feed. It is used in the GetFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
cropping (dict) --
The output config type that applies to the cropping feature.
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
The metadata that is the result of the clip request to Elemental Inference.
status (string) --
The status of the output.
description (string) --
The description of the output.
fromAssociation (boolean) --
True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.
status (string) --
The status of the feed being queried.
association (dict) --
Information about the resource, if any, associated with the feed being queried.
associatedResourceName (string) --
The name of the associated resource.
tags (dict) --
A list of the tags, if any, for the feed being queried.
(string) --
(string) --