2026/08/10 - AWS Elemental Inference - 1 new 4 updated api methods
Changes Added support for the SearchFixtures API and DataSourceConfiguration, enabling customers to map fixture event data onto clipping outputs for improved feature accuracy.
Searches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window. Each fixture in the response includes a fixtureId that you specify in the clipping output of a feed, so that Elemental Inference maps the event data for that fixture onto the clipping metadata. This operation is paginated: if there are more fixtures than fit in one page, the response includes a nextToken that you pass in a subsequent request.
See also: AWS API Documentation
Request Syntax
client.search_fixtures(
sport='basketball'|'american-football',
startDate='string',
endDate='string',
filters=[
{
'name': 'COMPETITOR',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).
string
[REQUIRED]
The first day of the search window, in UTC. The search includes fixtures that are scheduled on this day.
Specify the date in ISO 8601 format, as YYYY-MM-DD. For example, 2026-03-14.
string
The last day of the search window, in UTC. The search includes fixtures that are scheduled on this day. Specify the date in ISO 8601 format, as YYYY-MM-DD.
If you omit this parameter, Elemental Inference searches only the day that you specified in startDate. The window from startDate through endDate must not exceed seven days.
list
An array of filters that narrow the results. Each filter applies to one dimension of a fixture, such as the competitor. You can specify up to 10 filters.
A fixture must satisfy every filter in the array in order to appear in the results. Within one filter, a fixture must match at least one of the values.
(dict) --
A filter for a fixture search. It is used in the filters array of a SearchFixtures request.
name (string) -- [REQUIRED]
The dimension of the fixture to filter on. Valid values: COMPETITOR.
values (list) -- [REQUIRED]
An array of values to match in the dimension that you specified in name. You can specify up to 10 values. A fixture appears in the results if it matches at least one of these values.
(string) --
integer
The maximum number of fixtures to return for each API request.
The service might return fewer fixtures than the maxResults value. When more fixtures match the search, the response also includes a nextToken value that you can use to fetch the next batch of results.
string
The token that identifies the batch of results that you want to see.
For example, you submit a SearchFixtures 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 submit the SearchFixtures request a second time, with the same search criteria, and specify the nextToken value.
dict
Response Syntax
{
'fixtures': [
{
'fixtureId': 'string',
'name': 'string',
'fixtureGroup': 'string',
'scheduledStart': datetime(2015, 1, 1),
'status': 'string',
'competitors': [
{
'name': 'string',
'isHome': True|False
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
fixtures (list) --
An array of FixtureSummary objects, one for each fixture that matches the search. The array is empty if no fixtures match.
(dict) --
Contains information about one fixture. It is used in the SearchFixtures response.
Elemental Inference relays the information in this structure from the data source, so that you can identify the fixture that matches your source media.
fixtureId (string) --
The ID of the fixture. Specify this ID in the clipping output of a feed, to identify the fixture whose event data you want Elemental Inference to map onto the clipping metadata.
name (string) --
The name of the fixture, as provided by the data source. For example, the names of the two competing teams.
fixtureGroup (string) --
The group that the fixture belongs to, such as the competition, league, or tournament. The data source doesn't provide this information for every fixture.
scheduledStart (datetime) --
The scheduled start time of the fixture, as provided by the data source. The actual start time might differ.
status (string) --
The status of the fixture in its lifecycle, as provided by the data source. For example, Scheduled or Completed.
competitors (list) --
An array of the competitors (the teams or individuals) in the fixture.
(dict) --
Contains information about one competitor in a fixture. It is used in the FixtureSummary that is in the SearchFixtures response.
name (string) --
The name of the competitor, as provided by the data source.
isHome (boolean) --
Specifies whether this competitor is the home side in the fixture. If true, this competitor is the home side. If false, this competitor is the away side.
nextToken (string) --
The token that identifies the next batch of results. To see the next batch, submit the SearchFixtures request again, with the same search criteria, and specify this value in nextToken.
This parameter is absent when there are no more results to return.
{'outputs': {'outputConfig': {'clipping': {'dataSourceConfiguration': {'fixtureId': 'string'}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.associate_feed(
id='string',
associatedResourceName='string',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {
'templateGroups': [
{
'name': 'string',
'templateUris': [
'string',
]
},
]
},
'clipping': {
'callbackMetadata': 'string',
'dataSourceConfiguration': {
'fixtureId': 'string'
}
},
'subtitling': {
'language': 'eng'|'eng-au'|'eng-gb'|'eng-us'|'fra'|'ita'|'deu'|'spa'|'por',
'aspectRatio': {
'width': 123,
'height': 123
},
'dictionary': 'string',
'profanityFilter': 'DISABLED'|'CENSOR'|'DROP'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string'
},
],
dryRun=True|False
)
string
[REQUIRED]
The ID of the feed.
string
[REQUIRED]
An identifier for the resource. This name must not resemble an ARN.
The resource is the source media that the feed will process. The name you assign should help you to later identify the source media that belongs to the feed. In this way, you will know which source media to push to the feed (using PutMedia).
This field is autopopulated if not provided.
list
[REQUIRED]
An array of one or more outputs that you want to add to this feed now, to supplement any outputs that you specified when you created or updated the feed.
(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 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.
templateGroups (list) --
An array of template groups for the crop output. Each template group provides the graphics-compositing templates that Elemental Inference applies to the cropped video. You can specify from 1 to 4 template groups.
(dict) --
A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.
name (string) -- [REQUIRED]
A name for the template group.
templateUris (list) -- [REQUIRED]
An array of Amazon S3 URIs that point to the graphics-compositing templates for this group. You can specify 1 or 2 URIs. Each URI must be in the form s3://bucket-name/key. Elemental Inference reads these templates using the IAM role that you specify in accessRoleArn.
(string) --
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.
dataSourceConfiguration (dict) --
The data source to map onto this clipping output. This parameter is optional. When you include this parameter, Elemental Inference reads the event data for the fixture that you specify, and includes that data in the event clipping metadata for this output.
If you omit this parameter, Elemental Inference doesn't map a data source onto this output.
fixtureId (string) -- [REQUIRED]
The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing.
To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary.
subtitling (dict) --
The output config type that applies to the smart subtitling feature.
language (string) -- [REQUIRED]
The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.
aspectRatio (dict) --
The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.
width (integer) -- [REQUIRED]
The width component of the aspect ratio (for example, 16 in a 16:9 ratio).
height (integer) -- [REQUIRED]
The height component of the aspect ratio (for example, 9 in a 16:9 ratio).
dictionary (string) --
The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.
profanityFilter (string) --
Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).
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.
Elemental Inference will validate that the real request would succeed without actually making any changes. A dry run catches errors such as missing IAM permissions, quota limits exceeded, conflicting outputs, and so on. If the dry run fails, the action returns a 4xx error code. After you've fixed the errors, resubmit the request.
dict
Response Syntax
{
'arn': 'string',
'id': 'string'
}
Response Structure
(dict) --
arn (string) --
The ARN of the feed.
id (string) --
The ID of the feed.
{'outputs': {'outputConfig': {'clipping': {'dataSourceConfiguration': {'fixtureId': 'string'}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_feed(
name='string',
accessRoleArn='string',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {
'templateGroups': [
{
'name': 'string',
'templateUris': [
'string',
]
},
]
},
'clipping': {
'callbackMetadata': 'string',
'dataSourceConfiguration': {
'fixtureId': 'string'
}
},
'subtitling': {
'language': 'eng'|'eng-au'|'eng-gb'|'eng-us'|'fra'|'ita'|'deu'|'spa'|'por',
'aspectRatio': {
'width': 123,
'height': 123
},
'dictionary': 'string',
'profanityFilter': 'DISABLED'|'CENSOR'|'DROP'
}
},
'status': 'ENABLED'|'DISABLED',
'description': 'string'
},
],
tags={
'string': 'string'
}
)
string
[REQUIRED]
A user-friendly name for this feed.
string
The ARN of an IAM role that Elemental Inference assumes to access resources in your account on your behalf. For example, the smart crop feature uses this role to read graphics-compositing templates from your Amazon S3 bucket. You specify one access role for each feed.
list
[REQUIRED]
An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, there is one output type for the smart crop feature. You must specify at least one output, but you can later add outputs using AssociateFeed, or add, modify, and delete outputs using UpdateFeed.
(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 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.
templateGroups (list) --
An array of template groups for the crop output. Each template group provides the graphics-compositing templates that Elemental Inference applies to the cropped video. You can specify from 1 to 4 template groups.
(dict) --
A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.
name (string) -- [REQUIRED]
A name for the template group.
templateUris (list) -- [REQUIRED]
An array of Amazon S3 URIs that point to the graphics-compositing templates for this group. You can specify 1 or 2 URIs. Each URI must be in the form s3://bucket-name/key. Elemental Inference reads these templates using the IAM role that you specify in accessRoleArn.
(string) --
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.
dataSourceConfiguration (dict) --
The data source to map onto this clipping output. This parameter is optional. When you include this parameter, Elemental Inference reads the event data for the fixture that you specify, and includes that data in the event clipping metadata for this output.
If you omit this parameter, Elemental Inference doesn't map a data source onto this output.
fixtureId (string) -- [REQUIRED]
The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing.
To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary.
subtitling (dict) --
The output config type that applies to the smart subtitling feature.
language (string) -- [REQUIRED]
The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.
aspectRatio (dict) --
The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.
width (integer) -- [REQUIRED]
The width component of the aspect ratio (for example, 16 in a 16:9 ratio).
height (integer) -- [REQUIRED]
The height component of the aspect ratio (for example, 9 in a 16:9 ratio).
dictionary (string) --
The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.
profanityFilter (string) --
Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).
status (string) -- [REQUIRED]
The status to assign to the output.
description (string) --
A description for the output.
dict
Optional tags. You can also add tags later, using TagResource.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'id': 'string',
'dataEndpoints': [
'string',
],
'outputs': [
{
'name': 'string',
'outputConfig': {
'cropping': {
'templateGroups': [
{
'name': 'string',
'templateUris': [
'string',
]
},
]
},
'clipping': {
'callbackMetadata': 'string',
'dataSourceConfiguration': {
'fixtureId': 'string'
}
},
'subtitling': {
'language': 'eng'|'eng-au'|'eng-gb'|'eng-us'|'fra'|'ita'|'deu'|'spa'|'por',
'aspectRatio': {
'width': 123,
'height': 123
},
'dictionary': 'string',
'profanityFilter': 'DISABLED'|'CENSOR'|'DROP'
}
},
'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 in the request.
id (string) --
A unique ID that Elemental Inference assigns to the feed.
dataEndpoints (list) --
An array of endpoints for the feed. Typically, there is only one endpoint. The feed receives source media at this endpoint (when the calling application calls PutMedia) and returns the resulting metadata to this endpoint (when the calling application calls GetMetadata).
(string) --
outputs (list) --
Repeats the outputs that you specified in the request.
(dict) --
Contains configuration information about one output in a feed. It is used in the GetFeed response.
name (string) --
The name of the output.
outputConfig (dict) --
A typed property for an output in a feed. 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.
templateGroups (list) --
An array of template groups for the crop output. Each template group provides the graphics-compositing templates that Elemental Inference applies to the cropped video. You can specify from 1 to 4 template groups.
(dict) --
A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.
name (string) --
A name for the template group.
templateUris (list) --
An array of Amazon S3 URIs that point to the graphics-compositing templates for this group. You can specify 1 or 2 URIs. Each URI must be in the form s3://bucket-name/key. Elemental Inference reads these templates using the IAM role that you specify in accessRoleArn.
(string) --
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.
dataSourceConfiguration (dict) --
The data source to map onto this clipping output. This parameter is optional. When you include this parameter, Elemental Inference reads the event data for the fixture that you specify, and includes that data in the event clipping metadata for this output.
If you omit this parameter, Elemental Inference doesn't map a data source onto this output.
fixtureId (string) --
The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing.
To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary.
subtitling (dict) --
The output config type that applies to the smart subtitling feature.
language (string) --
The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.
aspectRatio (dict) --
The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.
width (integer) --
The width component of the aspect ratio (for example, 16 in a 16:9 ratio).
height (integer) --
The height component of the aspect ratio (for example, 9 in a 16:9 ratio).
dictionary (string) --
The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.
profanityFilter (string) --
Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).
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 using AssociateFeed. False means it was created using CreateFeed or UpdateFeed.
You will need this value if you use UpdateFeed 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 or UpdateFeed.
associatedResourceName (string) --
The name of the associated resource.
tags (dict) --
Any tags that you included when you created the feed.
(string) --
(string) --
{'outputs': {'outputConfig': {'clipping': {'dataSourceConfiguration': {'fixtureId': 'string'}}}}}
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': {
'templateGroups': [
{
'name': 'string',
'templateUris': [
'string',
]
},
]
},
'clipping': {
'callbackMetadata': 'string',
'dataSourceConfiguration': {
'fixtureId': 'string'
}
},
'subtitling': {
'language': 'eng'|'eng-au'|'eng-gb'|'eng-us'|'fra'|'ita'|'deu'|'spa'|'por',
'aspectRatio': {
'width': 123,
'height': 123
},
'dictionary': 'string',
'profanityFilter': 'DISABLED'|'CENSOR'|'DROP'
}
},
'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.
id (string) --
The ID of the feed.
dataEndpoints (list) --
The dataEndpoints of the feed.
(string) --
outputs (list) --
An array of the outputs in the feed.
(dict) --
Contains configuration information about one output in a feed. It is used in the GetFeed response.
name (string) --
The name of the output.
outputConfig (dict) --
A typed property for an output in a feed. 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.
templateGroups (list) --
An array of template groups for the crop output. Each template group provides the graphics-compositing templates that Elemental Inference applies to the cropped video. You can specify from 1 to 4 template groups.
(dict) --
A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.
name (string) --
A name for the template group.
templateUris (list) --
An array of Amazon S3 URIs that point to the graphics-compositing templates for this group. You can specify 1 or 2 URIs. Each URI must be in the form s3://bucket-name/key. Elemental Inference reads these templates using the IAM role that you specify in accessRoleArn.
(string) --
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.
dataSourceConfiguration (dict) --
The data source to map onto this clipping output. This parameter is optional. When you include this parameter, Elemental Inference reads the event data for the fixture that you specify, and includes that data in the event clipping metadata for this output.
If you omit this parameter, Elemental Inference doesn't map a data source onto this output.
fixtureId (string) --
The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing.
To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary.
subtitling (dict) --
The output config type that applies to the smart subtitling feature.
language (string) --
The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.
aspectRatio (dict) --
The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.
width (integer) --
The width component of the aspect ratio (for example, 16 in a 16:9 ratio).
height (integer) --
The height component of the aspect ratio (for example, 9 in a 16:9 ratio).
dictionary (string) --
The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.
profanityFilter (string) --
Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).
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 using AssociateFeed. False means it was created using CreateFeed or UpdateFeed.
You will need this value if you use UpdateFeed to modify the list of outputs in the feed.
status (string) --
The status of the feed.
association (dict) --
Information about the resource that is associated with the feed. It's possible that there is no associated resource. This is not an error.
associatedResourceName (string) --
The name of the associated resource.
tags (dict) --
A list of the tags, if any, for the feed.
(string) --
(string) --
{'outputs': {'outputConfig': {'clipping': {'dataSourceConfiguration': {'fixtureId': 'string'}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.update_feed(
name='string',
accessRoleArn='string',
id='string',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {
'templateGroups': [
{
'name': 'string',
'templateUris': [
'string',
]
},
]
},
'clipping': {
'callbackMetadata': 'string',
'dataSourceConfiguration': {
'fixtureId': 'string'
}
},
'subtitling': {
'language': 'eng'|'eng-au'|'eng-gb'|'eng-us'|'fra'|'ita'|'deu'|'spa'|'por',
'aspectRatio': {
'width': 123,
'height': 123
},
'dictionary': 'string',
'profanityFilter': 'DISABLED'|'CENSOR'|'DROP'
}
},
'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
The ARN of an IAM role that Elemental Inference assumes to access resources in your account on your behalf. You can specify the existing role (to leave it unchanged) or a new role. You specify one access role for each feed.
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 of the output.
outputConfig (dict) -- [REQUIRED]
A typed property for an output in a feed. 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.
templateGroups (list) --
An array of template groups for the crop output. Each template group provides the graphics-compositing templates that Elemental Inference applies to the cropped video. You can specify from 1 to 4 template groups.
(dict) --
A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.
name (string) -- [REQUIRED]
A name for the template group.
templateUris (list) -- [REQUIRED]
An array of Amazon S3 URIs that point to the graphics-compositing templates for this group. You can specify 1 or 2 URIs. Each URI must be in the form s3://bucket-name/key. Elemental Inference reads these templates using the IAM role that you specify in accessRoleArn.
(string) --
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.
dataSourceConfiguration (dict) --
The data source to map onto this clipping output. This parameter is optional. When you include this parameter, Elemental Inference reads the event data for the fixture that you specify, and includes that data in the event clipping metadata for this output.
If you omit this parameter, Elemental Inference doesn't map a data source onto this output.
fixtureId (string) -- [REQUIRED]
The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing.
To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary.
subtitling (dict) --
The output config type that applies to the smart subtitling feature.
language (string) -- [REQUIRED]
The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.
aspectRatio (dict) --
The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.
width (integer) -- [REQUIRED]
The width component of the aspect ratio (for example, 16 in a 16:9 ratio).
height (integer) -- [REQUIRED]
The height component of the aspect ratio (for example, 9 in a 16:9 ratio).
dictionary (string) --
The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.
profanityFilter (string) --
Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).
status (string) -- [REQUIRED]
The status of the output.
description (string) --
A description of the output.
fromAssociation (boolean) --
Elemental Inference originally sets this parameter to True if this output was created by AssociateFeed or to False if this output was created by CreateFeed or UpdateFeed.
You must not change this value. Therefore, use GetFeed to determine the current value. Then in the UpdateFeed request, if the current value is True, include this parameter with a value of True. If it's False, omit the parameter.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'id': 'string',
'dataEndpoints': [
'string',
],
'outputs': [
{
'name': 'string',
'outputConfig': {
'cropping': {
'templateGroups': [
{
'name': 'string',
'templateUris': [
'string',
]
},
]
},
'clipping': {
'callbackMetadata': 'string',
'dataSourceConfiguration': {
'fixtureId': 'string'
}
},
'subtitling': {
'language': 'eng'|'eng-au'|'eng-gb'|'eng-us'|'fra'|'ita'|'deu'|'spa'|'por',
'aspectRatio': {
'width': 123,
'height': 123
},
'dictionary': 'string',
'profanityFilter': 'DISABLED'|'CENSOR'|'DROP'
}
},
'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 response.
name (string) --
The name of the output.
outputConfig (dict) --
A typed property for an output in a feed. 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.
templateGroups (list) --
An array of template groups for the crop output. Each template group provides the graphics-compositing templates that Elemental Inference applies to the cropped video. You can specify from 1 to 4 template groups.
(dict) --
A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.
name (string) --
A name for the template group.
templateUris (list) --
An array of Amazon S3 URIs that point to the graphics-compositing templates for this group. You can specify 1 or 2 URIs. Each URI must be in the form s3://bucket-name/key. Elemental Inference reads these templates using the IAM role that you specify in accessRoleArn.
(string) --
clipping (dict) --
The output config type that applies to the clipping feature.
callbackMetadata (string) --
A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.
dataSourceConfiguration (dict) --
The data source to map onto this clipping output. This parameter is optional. When you include this parameter, Elemental Inference reads the event data for the fixture that you specify, and includes that data in the event clipping metadata for this output.
If you omit this parameter, Elemental Inference doesn't map a data source onto this output.
fixtureId (string) --
The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing.
To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary.
subtitling (dict) --
The output config type that applies to the smart subtitling feature.
language (string) --
The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.
aspectRatio (dict) --
The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.
width (integer) --
The width component of the aspect ratio (for example, 16 in a 16:9 ratio).
height (integer) --
The height component of the aspect ratio (for example, 9 in a 16:9 ratio).
dictionary (string) --
The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.
profanityFilter (string) --
Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).
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 using AssociateFeed. False means it was created using CreateFeed or UpdateFeed.
You will need this value if you use UpdateFeed to modify the list of outputs in the feed.
status (string) --
The status of the feed.
association (dict) --
Information about the resource that is associated with the feed, if any.
associatedResourceName (string) --
The name of the associated resource.
tags (dict) --
The tags associated with the feed.
(string) --
(string) --