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 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.
", "CreateFeed": "Creates a feed. The feed is the target for live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed.
", "DeleteFeed": "Deletes the specified feed. The feed can be deleted at any time.
", "DisassociateFeed": "Releases the resource (for example, an MediaLive channel) that is associated with this feed. The outputs in the feed become disabled.
", "GetFeed": "Retrieves information about the specified feed.
", "ListFeeds": "Displays a list of feeds that belong to this AWS account.
", "ListTagsForResource": "List all tags that are on an Elemental Inference resource in the current region.
", "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.
", "UpdateFeed": "Updates the name and/or outputs in a feed.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": {} }, "AssociateFeedRequest": { "base": null, "refs": {} }, "AssociateFeedResponse": { "base": null, "refs": {} }, "AssociatedResourceName": { "base": null, "refs": { "AssociateFeedRequest$associatedResourceName": "An identifier for the resource. If the resource is from an AWS service, this identifier must be the full ARN of that resource. Otherwise, the identifier is a name that you assign and that is appropriate for the application that owns the resource. This name must not resemble an ARN.
", "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.
", "DisassociateFeedRequest$dryRun": "Set to true if you want to do a dry run of the disassociate action.
", "GetOutput$fromAssociation": "True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.
", "UpdateOutput$fromAssociation": "This property is set by the service when you add the output to the feed, and indicates how you added the output. True means that you used the AssociateFeed operation. False means that you used the CreateFeed or UpdateFeed operation. Use GetFeed to obtain the value. If the value is True, include this field here with a value of True. If the value is False, omit the field here.
" } }, "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.
" } }, "ConflictException": { "base": "The request could not be completed due to a conflict.
", "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": "The outputs to add to this feed. You must specify at least one output. You can later use the UpdateFeed action to change the list of outputs.
", "CreateFeedRequest$outputs": "An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, an output might represent the crop feature.
" } }, "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.
" } }, "DeleteFeedRequest": { "base": null, "refs": {} }, "DeleteFeedResponse": { "base": null, "refs": {} }, "DisassociateFeedRequest": { "base": null, "refs": {} }, "DisassociateFeedResponse": { "base": null, "refs": {} }, "FeedArn": { "base": null, "refs": { "AssociateFeedResponse$arn": "The AWS ARN for this association.
", "CreateFeedResponse$arn": "A unique ARN that Elemental Inference assigns to the feed.
", "DeleteFeedResponse$arn": "The ARN of the deleted feed.
", "DisassociateFeedResponse$arn": "The ID of the feed where you deleted the associated resource.
", "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.
", "FeedSummary$association": "The resource, if any, associated with the feed.
", "GetFeedResponse$association": "Information about the resource, if any, associated with the feed being queried.
", "UpdateFeedResponse$association": "True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.
" } }, "FeedId": { "base": null, "refs": { "AssociateFeedRequest$id": "The ID of the feed.
", "AssociateFeedResponse$id": "An ID for this response. It is unique in Elemental Inference for this AWS account.
", "CreateFeedResponse$id": "A unique ID that Elemental Inference assigns to the feed.
", "DeleteFeedRequest$id": "The ID of the feed.
", "DeleteFeedResponse$id": "The ID of the deleted feed.
", "DisassociateFeedRequest$id": "The ID of the feed where you want to release the resource.
", "DisassociateFeedResponse$id": "The ARN of the resource that you deleted.
", "FeedSummary$id": "The ID of the feed.
", "GetFeedRequest$id": "The ID of the feed to query.
", "GetFeedResponse$id": "The ID of the feed being queried.
", "UpdateFeedRequest$id": "The ID of the feed to update.
", "UpdateFeedResponse$id": "The ID of the feed.
" } }, "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 being queried.
", "UpdateFeedResponse$status": "The status of the output.
" } }, "FeedSummary": { "base": "Contains configuration information about a feed. It is used in the ListFeeds action.
", "refs": { "FeedSummaryList$member": null } }, "FeedSummaryList": { "base": null, "refs": { "ListFeedsResponse$feeds": "A list of feed summaries.
" } }, "GetFeedRequest": { "base": null, "refs": {} }, "GetFeedResponse": { "base": null, "refs": {} }, "GetOutput": { "base": "Contains configuration information about one output in a feed. It is used in the GetFeed action.
", "refs": { "GetOutputList$member": null } }, "GetOutputList": { "base": null, "refs": { "CreateFeedResponse$outputs": "Data endpoints that Elemental Inference assigns to the feed.
", "GetFeedResponse$outputs": "An array of the outputs in the feed being queried.
", "UpdateFeedResponse$outputs": "The array of outputs in the feed. You might have left this array unchanged, or you might have changed it.
" } }, "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": {} }, "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": {} }, "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 is used in the CreateFeed and AssociateFeed actions. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
", "GetOutput$outputConfig": "A typed property for an output in a feed. It is used in the GetFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
", "UpdateOutput$outputConfig": "A typed property for an output in a feed. It is used in the UpdateFeed action. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.
" } }, "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.
" } }, "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": "The metadata that is the result of the clip request to Elemental Inference.
", "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": { "CreateFeedRequest$name": "A name for this feed.
", "CreateFeedResponse$name": "The name that you specified.
", "CreateOutput$name": "A name for the output.
", "FeedSummary$name": "The name of the feed
", "GetFeedResponse$name": "The name of the feed being queried.
", "GetOutput$name": "The ARN of the output.
", "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 start here
" } }, "ResourceNotFoundException": { "base": "The resource specified in the action doesn't exist.
", "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": {} }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "InternalServerErrorException$message": null, "ListFeedsRequest$nextToken": "The token that identifies the batch of results that you want to see.
For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.
", "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.
", "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "StringList$member": null, "TooManyRequestException$message": null, "ValidationException$message": null } }, "StringList": { "base": null, "refs": { "CreateFeedResponse$dataEndpoints": "A unique ARN that Elemental Inference assigns to the feed.
", "GetFeedResponse$dataEndpoints": "The dataEndpoints of the feed being queried.
", "UpdateFeedResponse$dataEndpoints": "The data endpoints of the feed.
" } }, "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": { "CreateFeedRequest$tags": "If you want to include tags, add them now. You won't be able to add them later.
", "CreateFeedResponse$tags": "Any tags that you included when you created the feed.
", "GetFeedResponse$tags": "A list of the tags, if any, for the feed being queried.
", "ListTagsForResourceResponse$tags": "A list of the tags that belong to this resource.
", "TagResourceRequest$tags": "A list of tags to add to the resource.
", "UpdateFeedResponse$tags": "The name of the resource currently associated with the feed, if any.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "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": {} }, "UntagResourceRequest": { "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.
" } }, "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": {} } } }