This is the AWS Elemental Inference REST API Reference. It provides information on the URL, request contents, and response contents of each AWS Elemental Inference REST operation.
We assume that you have the IAM permissions that you need to use AWS Elemental Inference via the REST API. We also assume that you are familiar with the features and operations of AWS Elemental Inference as described in AWS Elemental Inference User Guide.
", "operations": { "AssociateFeed": "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.
", "CreateDictionary": "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.
", "CreateFeed": "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.
", "CreateScheduleAction": "Creates a schedule action on a feed. A schedule action applies configuration changes to the feed at a time that you specify, in the same way as an UpdateFeed request.
Elemental Inference validates the targets of the action when you create it.
", "DeleteDictionary": "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.
", "DeleteFeed": "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.
", "DeleteFeedPolicy": "Deletes the resource-based policy attached to the specified feed. After you delete the policy, the operation revokes the cross-account access that the policy granted.
", "DeleteScheduleAction": "Deletes a schedule action from a feed. A deleted action never runs.
You can delete only an action whose status is PENDING. Deleting an action doesn't reverse changes that the action already made to the feed. When you delete or archive a feed, Elemental Inference deletes all the schedule actions on that feed.
", "DisassociateFeed": "Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.
", "ExportDictionaryEntries": "Exports the entries from the specified dictionary.
", "GetDictionary": "Retrieves information about the specified dictionary.
", "GetFeed": "Retrieves information about the specified feed.
", "GetFeedPolicy": "Retrieves the resource-based policy attached to the specified feed.
", "GetFixture": "Retrieves information about the specified fixture (a sports event, such as a specific basketball game). You obtain a fixtureId from SearchFixtures, or from the clipping output of a feed.
", "ListDictionaries": "Lists the dictionaries in your account.
", "ListFeeds": "Displays a list of feeds that belong to this AWS account.
", "ListScheduleActions": "Displays a list of the schedule actions on a feed, including the status of each action and, for a failed action, information about why it failed.
Elemental Inference keeps an action whose status is COMPLETED or FAILED for about 48 hours after its scheduled time, and then deletes it automatically.
", "ListTagsForResource": "List all tags that are on an Elemental Inference resource in the current region.
", "PutFeedPolicy": "Attaches or replaces a resource-based policy on the specified feed. A resource-based policy grants cross-account access to the feed.
", "SearchFixtures": "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.
", "TagResource": "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.
", "UntagResource": "Deletes specified tags from the specified resource in the current region.
", "UpdateDictionary": "Updates the specified dictionary.
", "UpdateFeed": "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.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": {} }, "AspectRatio": { "base": "The width and height of the output video. Used in SubtitlingConfig to determine subtitle layout.
", "refs": { "SubtitlingConfig$aspectRatio": "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.
" } }, "AssociateFeedRequest": { "base": null, "refs": {} }, "AssociateFeedResponse": { "base": null, "refs": {} }, "AssociatedResourceName": { "base": null, "refs": { "AssociateFeedRequest$associatedResourceName": "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).
", "DisassociateFeedRequest$associatedResourceName": "The name of the resource currently associated with the feed.
", "FeedAssociation$associatedResourceName": "The name of the associated resource.
" } }, "Boolean": { "base": null, "refs": { "AssociateFeedRequest$dryRun": "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.
", "Competitor$isHome": "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.
", "DisassociateFeedRequest$dryRun": "Set to true if you want to do a dry run of the disassociate 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. If the dry run fails, the action returns a 4xx error code.
", "GetOutput$fromAssociation": "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.
", "UpdateOutput$fromAssociation": "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.
" } }, "ClippingConfig": { "base": "A type of OutputConfig, used when the output in a feed is for the clip feature.
", "refs": { "OutputConfig$clipping": "The output config type that applies to the clipping feature.
" } }, "Competitor": { "base": "Contains information about one competitor in a fixture. It is used in the FixtureSummary that is in the SearchFixtures response.
", "refs": { "CompetitorList$member": null } }, "CompetitorList": { "base": null, "refs": { "FixtureSummary$competitors": "An array of the competitors (the teams or individuals) in the fixture.
", "GetFixtureResponse$competitors": "An array of the competitors (the teams or individuals) in the fixture.
" } }, "ConflictException": { "base": "The request could not be completed due to a conflict.
", "refs": {} }, "ContextualMetadataConfig": { "base": "The output configuration settings for the contextual metadata feature. Use this structure when the feed output generates metadata that describes the media content.
", "refs": { "OutputConfig$contextualMetadata": "The output config type that applies to the contextual metadata feature.
" } }, "CreateDictionaryRequest": { "base": null, "refs": {} }, "CreateDictionaryResponse": { "base": null, "refs": {} }, "CreateFeedRequest": { "base": null, "refs": {} }, "CreateFeedResponse": { "base": null, "refs": {} }, "CreateOutput": { "base": "Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions.
", "refs": { "CreateOutputList$member": null } }, "CreateOutputList": { "base": null, "refs": { "AssociateFeedRequest$outputs": "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.
", "CreateFeedRequest$outputs": "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.
" } }, "CreateScheduleActionRequest": { "base": null, "refs": {} }, "CreateScheduleActionResponse": { "base": null, "refs": {} }, "CroppingConfig": { "base": "A type of OutputConfig, used when the output in a feed is for the crop feature.
", "refs": { "OutputConfig$cropping": "The output config type that applies to the cropping feature.
" } }, "DataSourceConfiguration": { "base": "Contains the data source configuration for a clipping output. It identifies the fixture whose event data Elemental Inference maps onto the clipping metadata. It is used in the dataSourceConfiguration property of a ClippingConfig.
", "refs": { "ClippingConfig$dataSourceConfiguration": "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.
", "UpdateClippingDataSourceConfiguration$dataSourceConfiguration": "The game that you want to attach to the output.
" } }, "DataSourceSport": { "base": null, "refs": { "SearchFixturesRequest$sport": "The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).
" } }, "DeleteDictionaryRequest": { "base": null, "refs": {} }, "DeleteDictionaryResponse": { "base": null, "refs": {} }, "DeleteFeedPolicyRequest": { "base": null, "refs": {} }, "DeleteFeedRequest": { "base": null, "refs": {} }, "DeleteFeedResponse": { "base": null, "refs": {} }, "DeleteScheduleActionRequest": { "base": null, "refs": {} }, "DeleteScheduleActionResponse": { "base": null, "refs": {} }, "DictionaryArn": { "base": null, "refs": { "CreateDictionaryResponse$arn": "The ARN of the dictionary.
", "DeleteDictionaryResponse$arn": "The ARN of the deleted dictionary.
", "DictionarySummary$arn": "The ARN of the dictionary.
", "GetDictionaryResponse$arn": "The ARN of the dictionary.
", "UpdateDictionaryResponse$arn": "The ARN of the dictionary.
" } }, "DictionaryEntriesPayload": { "base": null, "refs": { "CreateDictionaryRequest$entries": "The dictionary entries payload. Contains the custom words and phrases for the dictionary. Maximum size is 40,960 characters.
", "ExportDictionaryEntriesResponse$entries": "The dictionary entries payload.
", "UpdateDictionaryRequest$entries": "New dictionary entries. If not specified, the entries are not changed.
" } }, "DictionaryId": { "base": null, "refs": { "CreateDictionaryResponse$id": "A unique ID that Elemental Inference assigns to the dictionary.
", "DeleteDictionaryRequest$id": "The ID of the dictionary to delete.
", "DeleteDictionaryResponse$id": "The ID of the deleted dictionary.
", "DictionarySummary$id": "The ID of the dictionary.
", "ExportDictionaryEntriesRequest$id": "The ID of the dictionary whose entries you want to export.
", "GetDictionaryRequest$id": "The ID of the dictionary to retrieve.
", "GetDictionaryResponse$id": "The ID of the dictionary.
", "SubtitlingConfig$dictionary": "The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.
", "UpdateDictionaryRequest$id": "The ID of the dictionary to update.
", "UpdateDictionaryResponse$id": "The ID of the dictionary.
" } }, "DictionaryLanguage": { "base": null, "refs": { "CreateDictionaryRequest$language": "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.
", "CreateDictionaryResponse$language": "The language of the dictionary.
", "DictionarySummary$language": "The language of the dictionary.
", "GetDictionaryResponse$language": "The language of the dictionary.
", "UpdateDictionaryRequest$language": "A new language for the dictionary. If not specified, the language is not changed.
", "UpdateDictionaryResponse$language": "The updated or original language of the dictionary.
" } }, "DictionaryStatus": { "base": null, "refs": { "CreateDictionaryResponse$status": "The current status of the dictionary. After creation succeeds, the status will be AVAILABLE.
", "DeleteDictionaryResponse$status": "The status of the dictionary after deletion.
", "DictionarySummary$status": "The status of the dictionary.
", "GetDictionaryResponse$status": "The current status of the dictionary.
", "UpdateDictionaryResponse$status": "The current status of the dictionary.
" } }, "DictionarySummary": { "base": "Contains summary information about a dictionary. Used in the ListDictionaries response.
", "refs": { "DictionarySummaryList$member": null } }, "DictionarySummaryList": { "base": null, "refs": { "ListDictionariesResponse$dictionaries": "A list of DictionarySummary objects.
" } }, "DisassociateFeedRequest": { "base": null, "refs": {} }, "DisassociateFeedResponse": { "base": null, "refs": {} }, "ExportDictionaryEntriesRequest": { "base": null, "refs": {} }, "ExportDictionaryEntriesResponse": { "base": null, "refs": {} }, "ExtendedAnalysisMode": { "base": null, "refs": { "ContextualMetadataConfig$extendedAnalysis": "Specifies whether Elemental Inference generates extended analysis of the media content for this output. Extended analysis identifies the people, environments, brands, and on-screen text in the media content. This setting is independent of summaryGeneration.
Valid values:
ENABLED (default) – Elemental Inference populates the people, environments, brands, and on-screen text fields.
DISABLED – Elemental Inference doesn't populate the people, environments, brands, and on-screen text fields.
The ARN of the feed.
", "CreateFeedResponse$arn": "A unique ARN that Elemental Inference assigns to the feed.
", "DeleteFeedResponse$arn": "The ARN of the deleted feed.
", "DisassociateFeedResponse$arn": "The ARN of the feed.
", "FeedSummary$arn": "The ARN of the feed.
", "GetFeedResponse$arn": "The ARN of the feed.
", "UpdateFeedResponse$arn": "The ARN of the feed.
" } }, "FeedAssociation": { "base": "Contains information about the resource that is associated with a feed. It is used in the FeedSummary that is used in the response of a ListFeeds action.
", "refs": { "CreateFeedResponse$association": "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.
", "FeedSummary$association": "The resource, if any, associated with the feed.
", "GetFeedResponse$association": "Information about the resource that is associated with the feed. It's possible that there is no associated resource. This is not an error.
", "UpdateFeedResponse$association": "Information about the resource that is associated with the feed, if any.
" } }, "FeedId": { "base": null, "refs": { "AssociateFeedRequest$id": "The ID of the feed.
", "AssociateFeedResponse$id": "The ID of the feed.
", "CreateFeedResponse$id": "A unique ID that Elemental Inference assigns to the feed.
", "CreateScheduleActionRequest$id": "Specifies the ID of the feed that you want to add the schedule action to.
", "DeleteFeedPolicyRequest$id": "The ID of the feed whose policy you want to delete.
", "DeleteFeedRequest$id": "The ID of the feed.
", "DeleteFeedResponse$id": "The ID of the deleted feed.
", "DeleteScheduleActionRequest$id": "The ID of the feed that holds the schedule action.
", "DisassociateFeedRequest$id": "The ID of the feed where you want to release the resource.
", "DisassociateFeedResponse$id": "The ID of the feed.
", "FeedReferences$member": null, "FeedSummary$id": "The ID of the feed.
", "GetFeedPolicyRequest$id": "The ID of the feed whose policy you want to retrieve.
", "GetFeedRequest$id": "The ID of the feed to query.
", "GetFeedResponse$id": "The ID of the feed.
", "ListScheduleActionsRequest$id": "The ID of the feed that you want to query.
", "PutFeedPolicyRequest$id": "The ID of the feed to attach the policy to.
", "UpdateFeedRequest$id": "The ID of the feed to update.
", "UpdateFeedResponse$id": "The ID of the feed.
" } }, "FeedReferences": { "base": null, "refs": { "CreateDictionaryResponse$references": "A list of feed IDs that reference this dictionary.
", "GetDictionaryResponse$references": "A list of feed IDs that reference this dictionary.
", "UpdateDictionaryResponse$references": "A list of feed IDs that reference this dictionary.
" } }, "FeedStatus": { "base": null, "refs": { "CreateFeedResponse$status": "The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE.
", "DeleteFeedResponse$status": "The current status of the feed. When deletion of the feed has succeeded, the status will be DELETED.
", "FeedSummary$status": "The status of the feed.
", "GetFeedResponse$status": "The status of the feed.
", "UpdateFeedResponse$status": "The status of the feed.
" } }, "FeedSummary": { "base": "Contains configuration information about a feed. It is used in the ListFeeds response.
", "refs": { "FeedSummaryList$member": null } }, "FeedSummaryList": { "base": null, "refs": { "ListFeedsResponse$feeds": "A list of FeedSummary objects.
" } }, "FilterName": { "base": null, "refs": { "SearchFilter$name": "The dimension of the fixture to filter on. Valid values: COMPETITOR.
" } }, "FilterValue": { "base": null, "refs": { "FilterValueList$member": null } }, "FilterValueList": { "base": null, "refs": { "SearchFilter$values": "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.
" } }, "FixedModeScheduleActionStartSettings": { "base": "Sets the time at which a schedule action runs once. This is a type of ScheduleActionStartConfiguration.
", "refs": { "ScheduleActionStartConfiguration$fixedModeScheduleActionStartSettings": "The start settings type for an action that runs once, at a fixed time.
" } }, "FixtureDate": { "base": null, "refs": { "SearchFixturesRequest$startDate": "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.
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.
" } }, "FixtureId": { "base": null, "refs": { "DataSourceConfiguration$fixtureId": "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.
", "FixtureSummary$fixtureId": "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.
", "GetFixtureRequest$fixtureId": "The ID of the fixture to retrieve, as returned by SearchFixtures.
", "GetFixtureResponse$fixtureId": "The ID that you specified in the request.
" } }, "FixtureSummary": { "base": "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.
", "refs": { "FixtureSummaryList$member": null } }, "FixtureSummaryList": { "base": null, "refs": { "SearchFixturesResponse$fixtures": "An array of FixtureSummary objects, one for each fixture that matches the search. The array is empty if no fixtures match.
" } }, "GatewayTimedOutException": { "base": "The request timed out before the service returned a response. This is a temporary condition. Retry the request. If the problem persists, contact AWS Support.
", "refs": {} }, "GetDictionaryRequest": { "base": null, "refs": {} }, "GetDictionaryResponse": { "base": null, "refs": {} }, "GetFeedPolicyRequest": { "base": null, "refs": {} }, "GetFeedPolicyResponse": { "base": null, "refs": {} }, "GetFeedRequest": { "base": null, "refs": {} }, "GetFeedResponse": { "base": null, "refs": {} }, "GetFixtureRequest": { "base": null, "refs": {} }, "GetFixtureResponse": { "base": null, "refs": {} }, "GetOutput": { "base": "Contains configuration information about one output in a feed. It is used in the GetFeed response.
", "refs": { "GetOutputList$member": null } }, "GetOutputList": { "base": null, "refs": { "CreateFeedResponse$outputs": "Repeats the outputs that you specified in the request.
", "GetFeedResponse$outputs": "An array of the outputs in the feed.
", "UpdateFeedResponse$outputs": "The array of outputs in the feed. You might have left this array unchanged, or you might have changed it.
" } }, "IamRoleArn": { "base": null, "refs": { "CreateFeedRequest$accessRoleArn": "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.
", "CreateFeedResponse$accessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that you specified in the request. This property is absent if you didn't specify an IAM role.
", "GetFeedResponse$accessRoleArn": "The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that Elemental Inference assumes. Elemental Inference uses this role to access resources in your account on your behalf. This property is absent if the feed doesn't have an IAM role.
", "UpdateFeedRequest$accessRoleArn": "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.
", "UpdateFeedResponse$accessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role for the feed, after the update. This property is absent if the feed doesn't have an IAM role.
" } }, "Integer": { "base": null, "refs": { "AspectRatio$width": "The width component of the aspect ratio (for example, 16 in a 16:9 ratio).
", "AspectRatio$height": "The height component of the aspect ratio (for example, 9 in a 16:9 ratio).
" } }, "InternalServerErrorException": { "base": "An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.
", "refs": {} }, "ListDictionariesRequest": { "base": null, "refs": {} }, "ListDictionariesRequestMaxResultsInteger": { "base": null, "refs": { "ListDictionariesRequest$maxResults": "The maximum number of results to return per API request. Valid range: 1 to 100.
" } }, "ListDictionariesResponse": { "base": null, "refs": {} }, "ListFeedsRequest": { "base": null, "refs": {} }, "ListFeedsRequestMaxResultsInteger": { "base": null, "refs": { "ListFeedsRequest$maxResults": "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.
" } }, "ListFeedsResponse": { "base": null, "refs": {} }, "ListScheduleActionsRequest": { "base": null, "refs": {} }, "ListScheduleActionsRequestMaxResultsInteger": { "base": null, "refs": { "ListScheduleActionsRequest$maxResults": "The maximum number of results to return for each API request. If you don't specify MaxResults, Elemental Inference returns a maximum of 10 results for each page.
" } }, "ListScheduleActionsResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "OutputConfig": { "base": "Contains one typed output. It is used in the CreateOutput, GetOutput, and Update Output structures.
", "refs": { "CreateOutput$outputConfig": "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.
", "GetOutput$outputConfig": "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.
", "UpdateOutput$outputConfig": "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.
" } }, "OutputStatus": { "base": null, "refs": { "CreateOutput$status": "The status to assign to the output.
", "GetOutput$status": "The status of the output.
", "UpdateOutput$status": "The status of the output.
", "UpdateOutputStatus$status": "Specifies whether the output is enabled or disabled after the action runs.
" } }, "PolicyDocument": { "base": null, "refs": { "GetFeedPolicyResponse$policy": "The resource-based policy document attached to the feed.
", "PutFeedPolicyRequest$policy": "The resource-based policy document to attach to the feed.
" } }, "ProfanityFilterMode": { "base": null, "refs": { "SubtitlingConfig$profanityFilter": "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).
" } }, "PutFeedPolicyRequest": { "base": null, "refs": {} }, "PutFeedPolicyResponse": { "base": null, "refs": {} }, "RemoveClippingDataSourceConfiguration": { "base": "Removes the game from an event clipping output at the action's scheduled time. This is a type of ScheduleActionOperation, and the output must be an event clipping output.
", "refs": { "ScheduleActionOperation$removeClippingDataSourceConfiguration": "The operation type that removes the game from an event clipping output.
" } }, "ResourceArn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The ARN of the resource whose tags you want to query.
", "TagResourceRequest$resourceArn": "The ARN of the resource where you want to add tags.
", "UntagResourceRequest$resourceArn": "The ARN of the resource where you want to delete one or more tags.
" } }, "ResourceDescription": { "base": null, "refs": { "ClippingConfig$callbackMetadata": "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.
", "CreateOutput$description": "A description for the output.
", "GetOutput$description": "The description of the output.
", "UpdateOutput$description": "A description of the output.
" } }, "ResourceName": { "base": null, "refs": { "CreateDictionaryRequest$name": "A user-friendly name for this dictionary.
", "CreateDictionaryResponse$name": "The name that you specified in the request.
", "CreateFeedRequest$name": "A user-friendly name for this feed.
", "CreateFeedResponse$name": "The name that you specified in the request.
", "CreateOutput$name": "A name for the output.
", "CreateScheduleActionRequest$actionName": "A name for the schedule action. The name must be unique within the feed. You can reuse the name of an action that you deleted.
", "CreateScheduleActionResponse$actionName": "The name that you specified.
", "DeleteScheduleActionRequest$actionName": "The name of the schedule action that you want to delete.
", "DeleteScheduleActionResponse$actionName": "The name of the schedule action that Elemental Inference deleted.
", "DictionarySummary$name": "The name of the dictionary.
", "FeedSummary$name": "The name of the feed
", "GetDictionaryResponse$name": "The name of the dictionary.
", "GetFeedResponse$name": "The name of the feed.
", "GetOutput$name": "The name of the output.
", "RemoveClippingDataSourceConfiguration$outputName": "The name of the output that you want to remove the game from.
", "ScheduleAction$actionName": "The name of the schedule action. The name is unique within the feed.
", "TemplateGroup$name": "A name for the template group.
", "UpdateClippingDataSourceConfiguration$outputName": "The name of the output that you want to attach the game to.
", "UpdateDictionaryRequest$name": "A new name for the dictionary. If not specified, the name is not changed.
", "UpdateDictionaryResponse$name": "The updated or original name of the dictionary.
", "UpdateFeedRequest$name": "Required. You can specify the existing name (to leave it unchanged) or a new name.
", "UpdateFeedResponse$name": "The updated or original name of the feed.
", "UpdateOutput$name": "The name of the output.
", "UpdateOutputStatus$outputName": "The name of the output that you want to enable or disable. The output must exist in the feed when you create the action.
" } }, "ResourceNotFoundException": { "base": "The resource specified in the action doesn't exist.
", "refs": {} }, "S3Uri": { "base": null, "refs": { "TemplateUriList$member": null } }, "ScheduleAction": { "base": "Describes one schedule action on a feed, including the changes it makes and whether it has run yet. Elemental Inference returns this structure in the ListScheduleActions operation.
", "refs": { "ScheduleActionList$member": null } }, "ScheduleActionError": { "base": "Describes the cause of a schedule action failure, including the failure type and a description of what went wrong.
", "refs": { "CreateScheduleActionResponse$error": "A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.
", "ScheduleAction$error": "A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.
" } }, "ScheduleActionErrorCode": { "base": null, "refs": { "ScheduleActionError$errorCode": "The type of failure. Valid values are the following:
The action referred to something that didn't exist or wasn't valid at the scheduled time, for example an output that you deleted.
An unexpected error prevented the action from completing.
A list of the schedule actions on the feed.
" } }, "ScheduleActionOperation": { "base": "Holds one typed configuration change that a schedule action makes to a feed. Each operation must contain exactly one property.
", "refs": { "ScheduleActionOperations$member": null } }, "ScheduleActionOperations": { "base": null, "refs": { "CreateScheduleActionRequest$operations": "Specifies the list of configuration changes that you want to make to the feed. Elemental Inference applies all the operations in an action together, in the order that you specify them. If any operation fails, Elemental Inference doesn't apply any of them.
", "CreateScheduleActionResponse$operations": "The configuration changes that the action makes to the feed.
", "ScheduleAction$operations": "The configuration changes that the action makes to the feed.
" } }, "ScheduleActionStartConfiguration": { "base": "Holds the typed start settings that determine when a schedule action runs. Currently, only fixed mode is supported.
", "refs": { "CreateScheduleActionRequest$startConfiguration": "Specifies when the action runs.
", "CreateScheduleActionResponse$startConfiguration": "Specifies when the action runs.
", "ScheduleAction$startConfiguration": "Specifies when the action runs.
" } }, "ScheduleActionStatus": { "base": null, "refs": { "CreateScheduleActionResponse$status": "The status of the action. After you create the action successfully, Elemental Inference sets the status to PENDING.
", "ScheduleAction$status": "The status of the action. Valid values are the following:
The action is waiting for its scheduled time.
Elemental Inference applied all the action's operations to the feed.
Elemental Inference couldn't apply the action.
A filter for a fixture search. It is used in the filters array of a SearchFixtures request.
", "refs": { "SearchFilterList$member": null } }, "SearchFilterList": { "base": null, "refs": { "SearchFixturesRequest$filters": "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.
" } }, "SearchFixturesRequest": { "base": null, "refs": {} }, "SearchFixturesRequestMaxResultsInteger": { "base": null, "refs": { "SearchFixturesRequest$maxResults": "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.
" } }, "SearchFixturesResponse": { "base": null, "refs": {} }, "ServiceQuotaExceededException": { "base": "The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.
", "refs": {} }, "ServiceUnavailableException": { "base": "The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.
", "refs": {} }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "Competitor$name": "The name of the competitor, as provided by the data source.
", "ConflictException$message": null, "FixtureSummary$name": "The name of the fixture, as provided by the data source. For example, the names of the two competing teams.
", "FixtureSummary$fixtureGroup": "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.
", "FixtureSummary$status": "The status of the fixture in its lifecycle, as provided by the data source. For example, Scheduled or Completed.
", "GatewayTimedOutException$message": null, "GetFixtureResponse$name": "The name of the fixture, as provided by the data source. For example, the names of the two competing teams.
", "GetFixtureResponse$fixtureGroup": "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.
", "GetFixtureResponse$status": "The status of the fixture in its lifecycle, as provided by the data source. For example, Scheduled or Completed.
", "InternalServerErrorException$message": null, "ListDictionariesRequest$nextToken": "The token that identifies the next batch of results to return.
", "ListDictionariesResponse$nextToken": "The token to use to retrieve the next batch of results.
", "ListFeedsRequest$nextToken": "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.
", "ListFeedsResponse$nextToken": "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.
", "ListScheduleActionsRequest$nextToken": "The token that identifies the batch of results that you want to see. To see the next batch, submit the request a second time and specify the NextToken value that Elemental Inference returned.
", "ListScheduleActionsResponse$nextToken": "The token that identifies the next batch of results. Elemental Inference returns it only when more results are available.
", "ResourceNotFoundException$message": null, "ScheduleActionError$errorMessage": "A description of the failure.
", "SearchFixturesRequest$nextToken": "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.
", "SearchFixturesResponse$nextToken": "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.
", "ServiceQuotaExceededException$message": null, "ServiceUnavailableException$message": null, "StringList$member": null, "TooManyRequestException$message": null, "ValidationException$message": null } }, "StringList": { "base": null, "refs": { "CreateFeedResponse$dataEndpoints": "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).
", "GetFeedResponse$dataEndpoints": "The dataEndpoints of the feed.
", "UpdateFeedResponse$dataEndpoints": "The data endpoints of the feed.
" } }, "SubtitlingConfig": { "base": "A type of OutputConfig, used when the output in a feed is for the smart subtitling feature. Smart subtitling uses automatic speech recognition (ASR) to generate live TTML subtitles from the audio in your source media.
", "refs": { "OutputConfig$subtitling": "The output config type that applies to the smart subtitling feature.
" } }, "SummaryGenerationMode": { "base": null, "refs": { "ContextualMetadataConfig$summaryGeneration": "Specifies whether Elemental Inference generates a descriptive summary of the media content for this output, along with the objects and actions that it detects. This setting is independent of extendedAnalysis.
Valid values:
ENABLED (default) – Elemental Inference populates the summary, objects, and actions fields, along with the IAB taxonomy and GARM suitability classifications.
DISABLED – Elemental Inference doesn't populate the summary, objects, and actions fields.
The scheduled start time of the fixture, as provided by the data source. The actual start time might differ.
", "GetFixtureResponse$scheduledStart": "The scheduled start time of the fixture, as provided by the data source. The actual start time might differ.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The keys of the tags to delete.
" } }, "TagMap": { "base": null, "refs": { "CreateDictionaryRequest$tags": "Optional tags to associate with the dictionary.
", "CreateDictionaryResponse$tags": "Any tags that you included when you created the dictionary.
", "CreateFeedRequest$tags": "Optional tags. You can also add tags later, using TagResource.
", "CreateFeedResponse$tags": "Any tags that you included when you created the feed.
", "GetDictionaryResponse$tags": "The tags associated with the dictionary.
", "GetFeedResponse$tags": "A list of the tags, if any, for the feed.
", "ListTagsForResourceResponse$tags": "A list of the tags that belong to this resource.
", "TagResourceRequest$tags": "A list of tags to add to the resource.
", "UpdateDictionaryResponse$tags": "Any tags associated with the dictionary.
", "UpdateFeedResponse$tags": "The tags associated with the feed.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "TemplateGroup": { "base": "A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.
", "refs": { "TemplateGroupList$member": null } }, "TemplateGroupList": { "base": null, "refs": { "CroppingConfig$templateGroups": "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.
" } }, "TemplateUriList": { "base": null, "refs": { "TemplateGroup$templateUris": "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.
The UTC time at which the action runs. Specify the time in whole seconds. For the range of times that you can specify, see the AWS Elemental Inference User Guide.
This time is approximate. The change can take a few minutes to take effect on the media that the feed is processing.
" } }, "TooManyRequestException": { "base": "The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.
", "refs": {} }, "TranscriptionLanguage": { "base": null, "refs": { "SubtitlingConfig$language": "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.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UpdateClippingDataSourceConfiguration": { "base": "Attaches a game to an event clipping output at the action's scheduled time. This is a type of ScheduleActionOperation, and the output must be an event clipping output.
", "refs": { "ScheduleActionOperation$updateClippingDataSourceConfiguration": "The operation type that attaches a game to an event clipping output.
" } }, "UpdateDictionaryRequest": { "base": null, "refs": {} }, "UpdateDictionaryResponse": { "base": null, "refs": {} }, "UpdateFeedRequest": { "base": null, "refs": {} }, "UpdateFeedResponse": { "base": null, "refs": {} }, "UpdateOutput": { "base": "Contains configuration information about one output in a feed. It is used in the UpdateFeed action.
", "refs": { "UpdateOutputList$member": null } }, "UpdateOutputList": { "base": null, "refs": { "UpdateFeedRequest$outputs": "Required. You can specify the existing array of outputs (to leave outputs unchanged) or you can specify a new array.
" } }, "UpdateOutputStatus": { "base": "Enables or disables an output at the action's scheduled time. This is a type of ScheduleActionOperation.
", "refs": { "ScheduleActionOperation$updateOutputStatus": "The operation type that enables or disables an output.
" } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.
", "refs": {} } } }