2026/05/27 - AWS Elemental Inference - 6 new4 updated api methods
Changes Added support for smart subtitles in Elemental Inference, enabling automatic generation of subtitles for media content. Available in English, Spanish, French, German, Italian, and Portuguese.
Lists the dictionaries in your account.
See also: AWS API Documentation
Request Syntax
client.list_dictionaries(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return per API request. Valid range: 1 to 100.
string
The token that identifies the next batch of results to return.
dict
Response Syntax
{
'dictionaries': [
{
'arn': 'string',
'id': 'string',
'name': 'string',
'language': 'eng'|'fra'|'ita'|'deu'|'spa'|'por',
'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dictionaries (list) --
A list of DictionarySummary objects.
(dict) --
Contains summary information about a dictionary. Used in the ListDictionaries response.
arn (string) --
The ARN of the dictionary.
id (string) --
The ID of the dictionary.
name (string) --
The name of the dictionary.
language (string) --
The language of the dictionary.
status (string) --
The status of the dictionary.
nextToken (string) --
The token to use to retrieve the next batch of results.
Retrieves information about the specified dictionary.
See also: AWS API Documentation
Request Syntax
client.get_dictionary(
id='string'
)
string
[REQUIRED]
The ID of the dictionary to retrieve.
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'id': 'string',
'language': 'eng'|'fra'|'ita'|'deu'|'spa'|'por',
'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED',
'references': [
'string',
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
name (string) --
The name of the dictionary.
arn (string) --
The ARN of the dictionary.
id (string) --
The ID of the dictionary.
language (string) --
The language of the dictionary.
status (string) --
The current status of the dictionary.
references (list) --
A list of feed IDs that reference this dictionary.
(string) --
tags (dict) --
The tags associated with the dictionary.
(string) --
(string) --
Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.
See also: AWS API Documentation
Request Syntax
client.create_dictionary(
name='string',
language='eng'|'fra'|'ita'|'deu'|'spa'|'por',
entries='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
A user-friendly name for this dictionary.
string
[REQUIRED]
The language of the dictionary entries. Specify the language using an ISO 639-2/T three-letter code. Supported values: eng, fra, ita, deu, spa, por.
string
The dictionary entries payload. Contains the custom words and phrases for the dictionary. Maximum size is 40,960 characters.
dict
Optional tags to associate with the dictionary.
(string) --
(string) --
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'id': 'string',
'language': 'eng'|'fra'|'ita'|'deu'|'spa'|'por',
'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED',
'references': [
'string',
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
name (string) --
The name that you specified in the request.
arn (string) --
The ARN of the dictionary.
id (string) --
A unique ID that Elemental Inference assigns to the dictionary.
language (string) --
The language of the dictionary.
status (string) --
The current status of the dictionary. After creation succeeds, the status will be AVAILABLE.
references (list) --
A list of feed IDs that reference this dictionary.
(string) --
tags (dict) --
Any tags that you included when you created the dictionary.
(string) --
(string) --
Updates the specified dictionary.
See also: AWS API Documentation
Request Syntax
client.update_dictionary(
id='string',
name='string',
language='eng'|'fra'|'ita'|'deu'|'spa'|'por',
entries='string'
)
string
[REQUIRED]
The ID of the dictionary to update.
string
A new name for the dictionary. If not specified, the name is not changed.
string
A new language for the dictionary. If not specified, the language is not changed.
string
New dictionary entries. If not specified, the entries are not changed.
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'id': 'string',
'language': 'eng'|'fra'|'ita'|'deu'|'spa'|'por',
'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED',
'references': [
'string',
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
name (string) --
The updated or original name of the dictionary.
arn (string) --
The ARN of the dictionary.
id (string) --
The ID of the dictionary.
language (string) --
The updated or original language of the dictionary.
status (string) --
The current status of the dictionary.
references (list) --
A list of feed IDs that reference this dictionary.
(string) --
tags (dict) --
Any tags associated with the dictionary.
(string) --
(string) --
Exports the entries from the specified dictionary.
See also: AWS API Documentation
Request Syntax
client.export_dictionary_entries(
id='string'
)
string
[REQUIRED]
The ID of the dictionary whose entries you want to export.
dict
Response Syntax
{
'entries': 'string'
}
Response Structure
(dict) --
entries (string) --
The dictionary entries payload.
Deletes the specified dictionary. You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's subtitling configuration.
See also: AWS API Documentation
Request Syntax
client.delete_dictionary(
id='string'
)
string
[REQUIRED]
The ID of the dictionary to delete.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED'
}
Response Structure
(dict) --
arn (string) --
The ARN of the deleted dictionary.
id (string) --
The ID of the deleted dictionary.
status (string) --
The status of the dictionary after deletion.
{'outputs': {'outputConfig': {'subtitling': {'aspectRatio': {'height': 'integer',
'width': 'integer'},
'dictionary': 'string',
'language': 'eng | eng-au | '
'eng-gb | eng-us | '
'fra | ita | deu | '
'spa | por',
'profanityFilter': 'DISABLED | '
'CENSOR | '
'DROP'}}}}
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': {}
,
'clipping': {
'callbackMetadata': '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.
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.
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': {'subtitling': {'aspectRatio': {'height': 'integer',
'width': 'integer'},
'dictionary': 'string',
'language': 'eng | eng-au | '
'eng-gb | eng-us | '
'fra | ita | deu | '
'spa | por',
'profanityFilter': 'DISABLED | '
'CENSOR | '
'DROP'}}}}
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',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {}
,
'clipping': {
'callbackMetadata': '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.
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.
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.
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': {},
'clipping': {
'callbackMetadata': '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.
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.
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': {'subtitling': {'aspectRatio': {'height': 'integer',
'width': 'integer'},
'dictionary': 'string',
'language': 'eng | eng-au | '
'eng-gb | eng-us | '
'fra | ita | deu | '
'spa | por',
'profanityFilter': 'DISABLED | '
'CENSOR | '
'DROP'}}}}
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'
},
'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.
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.
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': {'subtitling': {'aspectRatio': {'height': 'integer',
'width': 'integer'},
'dictionary': 'string',
'language': 'eng | eng-au | '
'eng-gb | eng-us | '
'fra | ita | deu | '
'spa | por',
'profanityFilter': 'DISABLED | '
'CENSOR | '
'DROP'}}}}
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',
id='string',
outputs=[
{
'name': 'string',
'outputConfig': {
'cropping': {}
,
'clipping': {
'callbackMetadata': '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
[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.
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.
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': {},
'clipping': {
'callbackMetadata': '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.
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.
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) --