{ "smithy": "2.0", "shapes": { "com.amazonaws.elementalinference#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.elementalinference#AspectRatio": { "type": "structure", "members": { "width": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The width component of the aspect ratio (for example, 16 in a 16:9 ratio).

", "smithy.api#required": {} } }, "height": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The height component of the aspect ratio (for example, 9 in a 16:9 ratio).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The width and height of the output video. Used in SubtitlingConfig to determine subtitle layout.

" } }, "com.amazonaws.elementalinference#AssociateFeed": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#AssociateFeedRequest" }, "output": { "target": "com.amazonaws.elementalinference#AssociateFeedResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to associate a feed with an AWS resource" }, "smithy.api#documentation": "

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:

Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.

", "smithy.api#http": { "method": "POST", "uri": "/v1/feed/{id}/associate", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#AssociateFeedRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "associatedResourceName": { "target": "com.amazonaws.elementalinference#AssociatedResourceName", "traits": { "smithy.api#documentation": "

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).

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "outputs": { "target": "com.amazonaws.elementalinference#CreateOutputList", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "dryRun": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#AssociateFeedResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FeedArn", "traits": { "smithy.api#documentation": "

The ARN of the feed.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#AssociatedResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\w \\-\\.',@:;/]*$" } }, "com.amazonaws.elementalinference#BedrockApi": { "type": "enum", "members": { "INVOKE_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVOKE_MODEL" } } } }, "com.amazonaws.elementalinference#BedrockFunctionTarget": { "type": "structure", "members": { "api": { "target": "com.amazonaws.elementalinference#BedrockApi", "traits": { "smithy.api#documentation": "

The Amazon Bedrock API to call. The only valid value is INVOKE_MODEL.

", "smithy.api#required": {} } }, "model": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The model to invoke. Specify one of the following:

Elemental Inference invokes the model in the Region of the feed. To use a model in other Regions, specify a cross-Region inference profile ID. A custom or provisioned model must be in the Region of the feed.

The request expression must produce a request body that this model accepts, and the model must accept the kind of media that the request expression references. For example, a text-only model can't accept a request that references media.frames.

", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^([a-z0-9-]{1,63}[.][a-z0-9-.:]{1,76}|arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:(custom-model|provisioned-model)/.+)$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An Amazon Bedrock model to invoke. Elemental Inference invokes the model in your account by assuming the feed's access role, so a feed that runs this function must specify an accessRoleArn. The invocation is subject to your Amazon Bedrock quotas and appears on your bill.

" } }, "com.amazonaws.elementalinference#ChooseOneOptionList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#QuestionOption" }, "traits": { "smithy.api#documentation": "

An array of the options of a chooseOne question.

", "smithy.api#length": { "min": 2, "max": 26 } } }, "com.amazonaws.elementalinference#ChooseOneQuestion": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#QuestionName", "traits": { "smithy.api#documentation": "

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

", "smithy.api#required": {} } }, "question": { "target": "com.amazonaws.elementalinference#QuestionText", "traits": { "smithy.api#documentation": "

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' \" ( ) - : ; / & %, plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

", "smithy.api#required": {} } }, "options": { "target": "com.amazonaws.elementalinference#ChooseOneOptionList", "traits": { "smithy.api#documentation": "

The options that Elemental Inference chooses from. You can specify from 2 to 26 options. The question counts as one item toward the limit of 100 scored items in a version, regardless of how many options it has.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A question that you ask Elemental Inference, which answers by choosing one of its options. You specify it in the chooseOne array of a question set.

" } }, "com.amazonaws.elementalinference#ChooseOneQuestionList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#ChooseOneQuestion" }, "traits": { "smithy.api#documentation": "

An array of ChooseOneQuestion objects.

", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.elementalinference#ClipTrigger": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The perClip trigger, which runs the function each time an event clipping output reports events. Events that the output reports together share one run, and media.clip.events contains all of them. To choose this trigger, set perClip to an empty object.

Specify clippingSettings to name the event clipping output that reports the events. You can't use this trigger with a function that references media.transcript or media.contextual.

" } }, "com.amazonaws.elementalinference#ClippingConfig": { "type": "structure", "members": { "callbackMetadata": { "target": "com.amazonaws.elementalinference#ResourceDescription", "traits": { "smithy.api#documentation": "

A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.

" } }, "dataSourceConfiguration": { "target": "com.amazonaws.elementalinference#DataSourceConfiguration", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

A type of OutputConfig, used when the output in a feed is for the clip feature.

" } }, "com.amazonaws.elementalinference#ClippingSettings": { "type": "structure", "members": { "outputName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of an ENABLED event clipping output on this feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The event clipping output on this feed that provides events for a perClip trigger and media.clip for a function. Specify this structure for a perClip trigger, and for a function that references media.clip on a fixedInterval trigger.

If the function output is ENABLED, the output that you name must also be ENABLED.

" } }, "com.amazonaws.elementalinference#Competitor": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the competitor, as provided by the data source.

" } }, "isHome": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about one competitor in a fixture. It is used in the FixtureSummary that is in the SearchFixtures response.

" } }, "com.amazonaws.elementalinference#CompetitorList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#Competitor" }, "traits": { "smithy.api#length": { "max": 30 } } }, "com.amazonaws.elementalinference#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request could not be completed due to a conflict.

", "smithy.api#error": "client", "smithy.api#httpError": 409, "smithy.api#retryable": {} } }, "com.amazonaws.elementalinference#ContextType": { "type": "enum", "members": { "FRAMES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FRAMES" } }, "SUBTITLES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBTITLES" } }, "CONTEXTUAL_METADATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTEXTUAL_METADATA" } }, "CLIP_METADATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLIP_METADATA" } } }, "traits": { "smithy.api#documentation": "

One kind of media context that a function reads. Elemental Inference derives this value from the media paths that the request expression references:

A request expression can reference at most one of SUBTITLES, CONTEXTUAL_METADATA, and CLIP_METADATA, in addition to FRAMES.

" } }, "com.amazonaws.elementalinference#ContextTypeList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#ContextType" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.elementalinference#ContextualMetadataConfig": { "type": "structure", "members": { "summaryGeneration": { "target": "com.amazonaws.elementalinference#SummaryGenerationMode", "traits": { "smithy.api#documentation": "

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:

" } }, "extendedAnalysis": { "target": "com.amazonaws.elementalinference#ExtendedAnalysisMode", "traits": { "smithy.api#documentation": "

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:

If you specify customQuestions, you must set this property to DISABLED.

" } }, "customQuestions": { "target": "com.amazonaws.elementalinference#CustomQuestionsConfig", "traits": { "smithy.api#documentation": "

The question sets that you ask Elemental Inference about each shot, each scene, or both, in this output.

If you specify customQuestions, you must also set extendedAnalysis to DISABLED. If you omit extendedAnalysis, it defaults to ENABLED, and the request fails.

While a feed references a version of a question set, you can't delete that version or the question set.

" } } }, "traits": { "smithy.api#documentation": "

The output configuration settings for the contextual metadata feature. Use this structure when the feed output generates metadata that describes the media content.

" } }, "com.amazonaws.elementalinference#ContextualMetadataSettings": { "type": "structure", "members": { "outputName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of an ENABLED contextual metadata output on this feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The contextual metadata output on this feed that provides scenes for a perScene trigger and media.contextual for a function. Specify this structure for a perScene trigger, and for a function that references media.contextual on a perShot trigger.

If the function output is ENABLED, the output that you name must also be ENABLED.

" } }, "com.amazonaws.elementalinference#CreateDictionary": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#CreateDictionaryRequest" }, "output": { "target": "com.amazonaws.elementalinference#CreateDictionaryResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new dictionary", "createsResources": [ "dictionary" ], "resources": { "required": {} } }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "POST", "uri": "/v1/dictionary", "code": 202 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#CreateDictionaryRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A user-friendly name for this dictionary.

", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.elementalinference#DictionaryLanguage", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "entries": { "target": "com.amazonaws.elementalinference#DictionaryEntriesPayload", "traits": { "smithy.api#documentation": "

The dictionary entries payload. Contains the custom words and phrases for the dictionary. Maximum size is 40,960 characters.

" } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Optional tags to associate with the dictionary.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#CreateDictionaryResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name that you specified in the request.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.elementalinference#DictionaryArn", "traits": { "smithy.api#documentation": "

The ARN of the dictionary.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

A unique ID that Elemental Inference assigns to the dictionary.

", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.elementalinference#DictionaryLanguage", "traits": { "smithy.api#documentation": "

The language of the dictionary.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#DictionaryStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The current status of the dictionary. After creation succeeds, the status will be AVAILABLE.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A list of feed IDs that reference this dictionary.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Any tags that you included when you created the dictionary.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#CreateFeed": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#CreateFeedRequest" }, "output": { "target": "com.amazonaws.elementalinference#CreateFeedResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new feed", "createsResources": [ "feed" ], "resources": { "required": {} } }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "POST", "uri": "/v1/feed", "code": 202 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#CreateFeedRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A user-friendly name for this feed.

", "smithy.api#required": {} } }, "accessRoleArn": { "target": "com.amazonaws.elementalinference#IamRoleArn", "traits": { "smithy.api#documentation": "

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.

" } }, "outputs": { "target": "com.amazonaws.elementalinference#CreateOutputList", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

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.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Optional tags. You can also add tags later, using TagResource.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#CreateFeedResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FeedArn", "traits": { "smithy.api#documentation": "

A unique ARN that Elemental Inference assigns to the feed.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name that you specified in the request.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

A unique ID that Elemental Inference assigns to the feed.

", "smithy.api#required": {} } }, "dataEndpoints": { "target": "com.amazonaws.elementalinference#StringList", "traits": { "smithy.api#documentation": "

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).

", "smithy.api#required": {} } }, "outputs": { "target": "com.amazonaws.elementalinference#GetOutputList", "traits": { "smithy.api#documentation": "

Repeats the outputs that you specified in the request.

", "smithy.api#required": {} } }, "accessRoleArn": { "target": "com.amazonaws.elementalinference#IamRoleArn", "traits": { "smithy.api#documentation": "

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.

" } }, "status": { "target": "com.amazonaws.elementalinference#FeedStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "association": { "target": "com.amazonaws.elementalinference#FeedAssociation", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

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.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Any tags that you included when you created the feed.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#CreateFunction": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#CreateFunctionRequest" }, "output": { "target": "com.amazonaws.elementalinference#CreateFunctionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new inference function", "createsResources": [ "function" ], "resources": { "required": {} } }, "smithy.api#documentation": "

Creates a function. A function analyzes a feed by building a request from the feed's media and metadata, optionally sending that request to an Amazon Bedrock model in your account, and publishing the result to the feed's metadata timeline.

A function runs only after you attach it to a feed as a function output. For more information, see Using functions in the AWS Elemental Inference User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/v1/function", "code": 202 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#CreateFunctionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A name for this function.

", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.elementalinference#FunctionTarget", "traits": { "smithy.api#documentation": "

The destination for the request that the function builds.

", "smithy.api#required": {} } }, "requestExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that builds the request. Elemental Inference evaluates it against the media object of the feed, which holds the media and metadata that the function asked for. Maximum length: 5,120 characters.

When you save the function, Elemental Inference evaluates the expression against sample media and rejects it if the evaluation fails. For a Bedrock target, the result must be a JSON object; Elemental Inference doesn't check that the object is a valid request body for the model. The expression can reference at most one of media.transcript, media.contextual, and media.clip. For a passthrough target, it can't reference media.frames.

", "smithy.api#length": { "min": 1, "max": 5120 }, "smithy.api#required": {} } }, "responseExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as its root: the model response for a Bedrock target, or the output of the request expression for a passthrough target. If a function has no response expression, Elemental Inference stores the entire result. Maximum length: 5,120 characters.

When you save the function, Elemental Inference checks that the expression is valid JSONata. For a passthrough target, it also evaluates the request and response expressions together against sample media, and rejects them if they produce no value.

" } }, "description": { "target": "com.amazonaws.elementalinference#FunctionDescription", "traits": { "smithy.api#documentation": "

The description of the function. Maximum length: 1,024 characters.

" } }, "eventBridgeDelivery": { "target": "com.amazonaws.elementalinference#EventBridgeDeliveryMode", "traits": { "smithy.api#default": "DISABLED", "smithy.api#documentation": "

Specifies whether Elemental Inference also sends this function's results to Amazon EventBridge. Elemental Inference sends a result only when the result is a JSON object with a top-level eventBridge field set to true. It sends the result, unchanged, as a Function Metadata Generated event to the default event bus in your account, after the result is available from GetMetadata. If the result is larger than 64 KB, the event has resultOmitted set to true in place of the result.

Valid values:

For a Bedrock target, ENABLED requires a response expression, because the model response itself never has a top-level eventBridge field. A feed output that runs a function with ENABLED can't use a fixedInterval trigger shorter than 4 seconds.

" } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

The tags to associate with this function.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#CreateFunctionResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the function.

", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.elementalinference#FunctionTarget", "traits": { "smithy.api#documentation": "

The destination for the request that the function builds.

", "smithy.api#required": {} } }, "requestExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that builds the request. Elemental Inference evaluates it against the media object of the feed, which holds the media and metadata that the function asked for.

", "smithy.api#length": { "min": 1, "max": 5120 }, "smithy.api#required": {} } }, "responseExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as its root: the model response for a Bedrock target, or the output of the request expression for a passthrough target. If a function has no response expression, Elemental Inference stores the entire result.

" } }, "description": { "target": "com.amazonaws.elementalinference#FunctionDescription", "traits": { "smithy.api#documentation": "

The description of the function.

" } }, "eventBridgeDelivery": { "target": "com.amazonaws.elementalinference#EventBridgeDeliveryMode", "traits": { "smithy.api#default": "DISABLED", "smithy.api#documentation": "

Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With ENABLED, each result that is a JSON object with a top-level eventBridge field set to true is also sent as a Function Metadata Generated event to the default event bus in your account.

" } }, "arn": { "target": "com.amazonaws.elementalinference#FunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the function.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#FunctionStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The status of the function. A successful request returns CREATING. The function is ready to use as soon as the request succeeds.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The IDs of the feeds that have a function output, enabled or disabled, that references this function. While this list isn't empty, the function can't be deleted, and its name and target can't be changed.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "contextTypes": { "target": "com.amazonaws.elementalinference#ContextTypeList", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the function.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#CreateOutput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A name for the output.

", "smithy.api#required": {} } }, "outputConfig": { "target": "com.amazonaws.elementalinference#OutputConfig", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#OutputStatus", "traits": { "smithy.api#documentation": "

The status to assign to the output.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#ResourceDescription", "traits": { "smithy.api#documentation": "

A description for the output.

" } } }, "traits": { "smithy.api#documentation": "

Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions.

" } }, "com.amazonaws.elementalinference#CreateOutputList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#CreateOutput" } }, "com.amazonaws.elementalinference#CreateQuestionSet": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#CreateQuestionSetRequest" }, "output": { "target": "com.amazonaws.elementalinference#CreateQuestionSetResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new question set", "createsResources": [ "question-set" ], "resources": { "required": {} } }, "smithy.api#documentation": "

Creates a question set. Use a question set to get answers about content that's specific to your business, in addition to the built-in contextual metadata classifications. A question set contains your own questions. You ask Elemental Inference these questions about each shot or scene of the media in a contextual metadata output, and Elemental Inference answers each question with scores. To use a question set, reference it in the customQuestions property of the contextual metadata configuration of a feed output.

CreateQuestionSet creates the question set with a DRAFT version that contains the questions in the request. To change DRAFT, use UpdateQuestionSet. To publish DRAFT as a numbered version, use CreateQuestionSetVersion. You can't change a published version.

A question set can contain the following types of questions. You must specify at least one question.

A version can contain up to 100 scored items, where each yesNo question, each option of a yesNoPerOption question, and each chooseOne question counts as one item. The name of each question must be unique across all three types.

", "smithy.api#http": { "method": "POST", "uri": "/v1/question-set", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#CreateQuestionSetRequest": { "type": "structure", "members": { "yesNo": { "target": "com.amazonaws.elementalinference#YesNoQuestionList", "traits": { "smithy.api#documentation": "

An array of questions that Elemental Inference answers with yes or no. You can specify up to 50 yesNo questions. An empty array is the same as omitting this property.

" } }, "yesNoPerOption": { "target": "com.amazonaws.elementalinference#YesNoPerOptionQuestionList", "traits": { "smithy.api#documentation": "

An array of questions that you ask about each of their options. Elemental Inference answers yes or no for each option. You can specify up to 10 yesNoPerOption questions. An empty array is the same as omitting this property.

" } }, "chooseOne": { "target": "com.amazonaws.elementalinference#ChooseOneQuestionList", "traits": { "smithy.api#documentation": "

An array of questions that Elemental Inference answers by choosing one of their options. You can specify up to 10 chooseOne questions. An empty array is the same as omitting this property.

" } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A user-friendly name for this question set.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Optional tags to associate with the question set. You can also add tags later, using TagResource.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#CreateQuestionSetResponse": { "type": "structure", "members": { "yesNo": { "target": "com.amazonaws.elementalinference#YesNoQuestionList", "traits": { "smithy.api#documentation": "

The yesNo questions that you specified in the request, in the order that you specified them. Elemental Inference doesn't return this property if the request didn't include any yesNo questions.

" } }, "yesNoPerOption": { "target": "com.amazonaws.elementalinference#YesNoPerOptionQuestionList", "traits": { "smithy.api#documentation": "

The yesNoPerOption questions that you specified in the request, in the order that you specified them. Elemental Inference doesn't return this property if the request didn't include any yesNoPerOption questions.

" } }, "chooseOne": { "target": "com.amazonaws.elementalinference#ChooseOneQuestionList", "traits": { "smithy.api#documentation": "

The chooseOne questions that you specified in the request, in the order that you specified them. Elemental Inference doesn't return this property if the request didn't include any chooseOne questions.

" } }, "arn": { "target": "com.amazonaws.elementalinference#QuestionSetArn", "traits": { "smithy.api#documentation": "

The ARN of the question set.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

A unique ID that Elemental Inference assigns to the question set.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name that you specified in the request.

", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The version that this response describes. For CreateQuestionSet, the version is always DRAFT.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#QuestionSetVersionDescription", "traits": { "smithy.api#documentation": "

The description of the version. Elemental Inference doesn't return this property for CreateQuestionSet, because the DRAFT version has no description.

" } }, "latestVersion": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The number of the highest version that you have published for this question set. Elemental Inference doesn't return this property for CreateQuestionSet, because a new question set has no published versions.

" } }, "sha256": { "target": "com.amazonaws.elementalinference#QuestionSetSha256", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The SHA-256 hash of the DRAFT version, as 64 lowercase hexadecimal characters. The hash covers the name of the question set and its questions. You can specify this value in a CreateQuestionSetVersion request, so that Elemental Inference publishes DRAFT only if it hasn't changed.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A list of feed IDs that reference this version of the question set. For a new question set, the list is empty.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Any tags that you included when you created the question set.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#CreateQuestionSetVersion": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#CreateQuestionSetVersionRequest" }, "output": { "target": "com.amazonaws.elementalinference#CreateQuestionSetVersionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a version of a question set" }, "smithy.api#documentation": "

Publishes the DRAFT version of the specified question set as a new version. The new version has the same name and questions as DRAFT, and you can't change it. DRAFT doesn't change, so you can continue to update it.

Version numbers start at 1, and each new version has the next number. Elemental Inference never reuses a version number, even after you delete that version.

If DRAFT hasn't changed since the latest published version, Elemental Inference doesn't create a version. Instead, it returns the latest version. A change to the name of the question set counts as a change to DRAFT.

A question set can have a limited number of versions. If the question set already has the maximum number of versions, Elemental Inference returns ServiceQuotaExceededException. To free space for a new version, delete a version that you no longer need, or create a new question set.

", "smithy.api#http": { "method": "POST", "uri": "/v1/question-set/{id}/versions", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#CreateQuestionSetVersionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set whose DRAFT version you want to publish.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "sha256": { "target": "com.amazonaws.elementalinference#QuestionSetSha256", "traits": { "smithy.api#documentation": "

The SHA-256 hash of the DRAFT version that you want to publish, as returned by GetQuestionSet or UpdateQuestionSet. If you specify this value, Elemental Inference publishes DRAFT only if its current hash matches. If it doesn't match, because DRAFT changed after you retrieved it, the request fails with ConflictException.

If you don't specify this value, Elemental Inference publishes DRAFT as it is when it receives the request.

" } }, "description": { "target": "com.amazonaws.elementalinference#QuestionSetVersionDescription", "traits": { "smithy.api#documentation": "

A description of the new version. You can't change the description after Elemental Inference publishes the version. If DRAFT hasn't changed since the latest version, Elemental Inference ignores this value and returns the latest version with its existing description.

The description can be up to 256 characters. It can contain the letters A-Z and a-z, the digits 0-9, underscores, spaces, and the following characters: - . ' , @ : ;.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#CreateQuestionSetVersionResponse": { "type": "structure", "members": { "yesNo": { "target": "com.amazonaws.elementalinference#YesNoQuestionList", "traits": { "smithy.api#documentation": "

The yesNo questions in this version. Elemental Inference doesn't return this property if the version has no yesNo questions.

" } }, "yesNoPerOption": { "target": "com.amazonaws.elementalinference#YesNoPerOptionQuestionList", "traits": { "smithy.api#documentation": "

The yesNoPerOption questions in this version. Elemental Inference doesn't return this property if the version has no yesNoPerOption questions.

" } }, "chooseOne": { "target": "com.amazonaws.elementalinference#ChooseOneQuestionList", "traits": { "smithy.api#documentation": "

The chooseOne questions in this version. Elemental Inference doesn't return this property if the version has no chooseOne questions.

" } }, "arn": { "target": "com.amazonaws.elementalinference#QuestionSetArn", "traits": { "smithy.api#documentation": "

The ARN of the question set.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the question set at this version.

", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The number of the version that Elemental Inference published. If DRAFT hadn't changed since the latest version, this is the number of that existing version.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#QuestionSetVersionDescription", "traits": { "smithy.api#documentation": "

The description of the version. For a new version, this is the description that you specified in the request. If DRAFT hadn't changed since the latest version, this is the description of that existing version. Elemental Inference doesn't return this property if the version has no description.

" } }, "latestVersion": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The number of the highest version that you have published for this question set. It's the same as version.

" } }, "sha256": { "target": "com.amazonaws.elementalinference#QuestionSetSha256", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The SHA-256 hash of the version, as 64 lowercase hexadecimal characters. It's the same as the hash of the DRAFT version that Elemental Inference published.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A list of feed IDs that reference this version of the question set. For a new version, the list is empty.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Any tags associated with the question set.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#CreateScheduleAction": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#CreateScheduleActionRequest" }, "output": { "target": "com.amazonaws.elementalinference#CreateScheduleActionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a schedule action for a feed", "resources": { "required": { "feed": {} } } }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "POST", "uri": "/v1/feed/{id}/schedule-actions", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#CreateScheduleActionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

Specifies the ID of the feed that you want to add the schedule action to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "actionName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "startConfiguration": { "target": "com.amazonaws.elementalinference#ScheduleActionStartConfiguration", "traits": { "smithy.api#documentation": "

Specifies when the action runs.

", "smithy.api#required": {} } }, "operations": { "target": "com.amazonaws.elementalinference#ScheduleActionOperations", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#CreateScheduleActionResponse": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name that you specified.

", "smithy.api#required": {} } }, "startConfiguration": { "target": "com.amazonaws.elementalinference#ScheduleActionStartConfiguration", "traits": { "smithy.api#documentation": "

Specifies when the action runs.

", "smithy.api#required": {} } }, "operations": { "target": "com.amazonaws.elementalinference#ScheduleActionOperations", "traits": { "smithy.api#documentation": "

The configuration changes that the action makes to the feed.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#ScheduleActionStatus", "traits": { "smithy.api#documentation": "

The status of the action. After you create the action successfully, Elemental Inference sets the status to PENDING.

", "smithy.api#required": {} } }, "error": { "target": "com.amazonaws.elementalinference#ScheduleActionError", "traits": { "smithy.api#documentation": "

A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#CroppingConfig": { "type": "structure", "members": { "templateGroups": { "target": "com.amazonaws.elementalinference#TemplateGroupList", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

A type of OutputConfig, used when the output in a feed is for the crop feature.

" } }, "com.amazonaws.elementalinference#CustomQuestionsConfig": { "type": "structure", "members": { "shot": { "target": "com.amazonaws.elementalinference#QuestionSetReference", "traits": { "smithy.api#documentation": "

The version of a question set to ask Elemental Inference about each shot.

" } }, "scene": { "target": "com.amazonaws.elementalinference#QuestionSetReference", "traits": { "smithy.api#documentation": "

The version of a question set to ask Elemental Inference about each scene.

" } } }, "traits": { "smithy.api#documentation": "

The question sets that you ask Elemental Inference about the media in a contextual metadata output. You must specify at least one of shot or scene. They can reference the same version of the same question set.

" } }, "com.amazonaws.elementalinference#DataSourceConfiguration": { "type": "structure", "members": { "fixtureId": { "target": "com.amazonaws.elementalinference#FixtureId", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elementalinference#DataSourceSport": { "type": "enum", "members": { "BASKETBALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "basketball" } }, "AMERICAN_FOOTBALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "american-football" } } } }, "com.amazonaws.elementalinference#DeleteDictionary": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DeleteDictionaryRequest" }, "output": { "target": "com.amazonaws.elementalinference#DeleteDictionaryResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a dictionary" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/dictionary/{id}", "code": 202 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DeleteDictionaryRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the dictionary to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DeleteDictionaryResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#DictionaryArn", "traits": { "smithy.api#documentation": "

The ARN of the deleted dictionary.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the deleted dictionary.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#DictionaryStatus", "traits": { "smithy.api#documentation": "

The status of the dictionary after deletion.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#DeleteFeed": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DeleteFeedRequest" }, "output": { "target": "com.amazonaws.elementalinference#DeleteFeedResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a feed" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/feed/{id}", "code": 202 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DeleteFeedPolicy": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DeleteFeedPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the resource-based policy of a feed", "resources": { "required": { "feed": {} } } }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/feed/{id}/policy", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DeleteFeedPolicyRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed whose policy you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DeleteFeedRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DeleteFeedResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FeedArn", "traits": { "smithy.api#documentation": "

The ARN of the deleted feed.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the deleted feed.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#FeedStatus", "traits": { "smithy.api#documentation": "

The current status of the feed. When deletion of the feed has succeeded, the status will be DELETED.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#DeleteFunction": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DeleteFunctionRequest" }, "output": { "target": "com.amazonaws.elementalinference#DeleteFunctionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete an inference function" }, "smithy.api#documentation": "

Deletes a function. If any feed still references the function, the operation returns a ConflictException. A disabled function output still references the function. Use GetFunction to find those feeds, then remove the function output from each one with UpdateFeed, or delete the feed, before retrying.

Deleting a function doesn't delete the metadata that it has already produced.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/function/{id}", "code": 202 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DeleteFunctionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DeleteFunctionResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the function.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#FunctionStatus", "traits": { "smithy.api#documentation": "

The status of the function. A successful request returns DELETING. Elemental Inference removes the function before it returns the response.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#DeleteQuestionSet": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DeleteQuestionSetRequest" }, "output": { "target": "com.amazonaws.elementalinference#DeleteQuestionSetResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a question set" }, "smithy.api#documentation": "

Deletes the specified question set, including its DRAFT version and all its published versions. You can't delete a question set while any feed references any of its versions, including an archived feed. You must first remove the question set from the customQuestions configuration of each feed output that references it, or delete those feeds.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/question-set/{id}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DeleteQuestionSetRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DeleteQuestionSetResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#QuestionSetArn", "traits": { "smithy.api#documentation": "

The ARN of the deleted question set.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the deleted question set.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#DeleteQuestionSetVersion": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DeleteQuestionSetVersionRequest" }, "output": { "target": "com.amazonaws.elementalinference#DeleteQuestionSetVersionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a version of a question set" }, "smithy.api#documentation": "

Deletes a published version of the specified question set. You can't delete a version while a feed references it, including an archived feed. You can't restore a deleted version, and Elemental Inference doesn't reuse its number.

You can't delete the DRAFT version on its own. To delete DRAFT, delete the question set by using DeleteQuestionSet.

Deleting a version doesn't change the latestVersion of the question set, even if you delete the highest version.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/question-set/{id}/versions/{questionSetVersion}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DeleteQuestionSetVersionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set that contains the version.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "questionSetVersion": { "target": "com.amazonaws.elementalinference#PublishedQuestionSetVersion", "traits": { "smithy.api#documentation": "

The number of the published version to delete. You can't specify DRAFT.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DeleteQuestionSetVersionResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#DeleteScheduleAction": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DeleteScheduleActionRequest" }, "output": { "target": "com.amazonaws.elementalinference#DeleteScheduleActionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a schedule action for a feed", "resources": { "required": { "feed": {} } } }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/feed/{id}/schedule-actions", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DeleteScheduleActionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed that holds the schedule action.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "actionName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the schedule action that you want to delete.

", "smithy.api#httpQuery": "actionName", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DeleteScheduleActionResponse": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the schedule action that Elemental Inference deleted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#DictionaryArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::Elemental-Inference::Dictionary", "service": "com.amazonaws.elementalinference#ElementalInference", "resource": "com.amazonaws.elementalinference#DictionaryResource" } } }, "com.amazonaws.elementalinference#DictionaryEntriesPayload": { "type": "string", "traits": { "smithy.api#length": { "max": 40960 } } }, "com.amazonaws.elementalinference#DictionaryId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 19 }, "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.elementalinference#DictionaryLanguage": { "type": "enum", "members": { "ENG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eng" } }, "FRA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fra" } }, "ITA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ita" } }, "DEU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "deu" } }, "SPA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "spa" } }, "POR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "por" } } } }, "com.amazonaws.elementalinference#DictionaryResource": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.elementalinference#DictionaryId" } }, "create": { "target": "com.amazonaws.elementalinference#CreateDictionary" }, "read": { "target": "com.amazonaws.elementalinference#GetDictionary" }, "update": { "target": "com.amazonaws.elementalinference#UpdateDictionary" }, "delete": { "target": "com.amazonaws.elementalinference#DeleteDictionary" }, "list": { "target": "com.amazonaws.elementalinference#ListDictionaries" }, "operations": [ { "target": "com.amazonaws.elementalinference#ExportDictionaryEntries" } ], "traits": { "aws.api#arn": { "template": "dictionary/{id}" }, "aws.api#taggable": { "property": "tags" }, "aws.cloudformation#cfnResource": { "name": "Dictionary" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "dictionary", "relativeDocumentation": "elemental-inference-configuration.html" }, "smithy.api#documentation": "Represents a custom dictionary for improving transcription accuracy", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnResource", "UnstableTrait.aws.api#taggable" ] } }, "com.amazonaws.elementalinference#DictionaryStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "REFERENCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REFERENCED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.elementalinference#DictionarySummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#DictionaryArn", "traits": { "smithy.api#documentation": "

The ARN of the dictionary.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the dictionary.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the dictionary.

", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.elementalinference#DictionaryLanguage", "traits": { "smithy.api#documentation": "

The language of the dictionary.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#DictionaryStatus", "traits": { "smithy.api#documentation": "

The status of the dictionary.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains summary information about a dictionary. Used in the ListDictionaries response.

" } }, "com.amazonaws.elementalinference#DictionarySummaryList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#DictionarySummary" } }, "com.amazonaws.elementalinference#DisassociateFeed": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#DisassociateFeedRequest" }, "output": { "target": "com.amazonaws.elementalinference#DisassociateFeedResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to disassociate a feed from an AWS resource" }, "smithy.api#documentation": "

Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.

", "smithy.api#http": { "method": "POST", "uri": "/v1/feed/{id}/disassociate", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#DisassociateFeedRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed where you want to release the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "associatedResourceName": { "target": "com.amazonaws.elementalinference#AssociatedResourceName", "traits": { "smithy.api#documentation": "

The name of the resource currently associated with the feed.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "dryRun": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#DisassociateFeedResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FeedArn", "traits": { "smithy.api#documentation": "

The ARN of the feed.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ElementalInference": { "type": "service", "version": "2018-11-14", "operations": [ { "target": "com.amazonaws.elementalinference#GetFixture" }, { "target": "com.amazonaws.elementalinference#ListTagsForResource" }, { "target": "com.amazonaws.elementalinference#SearchFixtures" }, { "target": "com.amazonaws.elementalinference#TagResource" }, { "target": "com.amazonaws.elementalinference#UntagResource" } ], "resources": [ { "target": "com.amazonaws.elementalinference#DictionaryResource" }, { "target": "com.amazonaws.elementalinference#FeedResource" }, { "target": "com.amazonaws.elementalinference#FunctionResource" }, { "target": "com.amazonaws.elementalinference#QuestionSetResource" } ], "traits": { "aws.api#service": { "sdkId": "ElementalInference", "arnNamespace": "elemental-inference", "cloudFormationName": "ElementalInference", "cloudTrailEventSource": "elemental-inference.amazonaws.com" }, "aws.api#tagEnabled": {}, "aws.auth#sigv4": { "name": "elemental-inference" }, "aws.iam#defineConditionKeys": { "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by tags associated with the resource", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by tags that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by tag keys that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#cors": { "maxAge": 86400 }, "smithy.api#documentation": "

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.

", "smithy.api#suppress": [ "UnstableTrait.aws.api#tagEnabled" ], "smithy.api#title": "AWS Elemental Inference", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://elemental-inference-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elemental-inference-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elemental-inference.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elemental-inference.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://elemental-inference-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://elemental-inference-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://elemental-inference.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://elemental-inference.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elemental-inference.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elemental-inference.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elemental-inference.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elemental-inference.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.elementalinference#EventBridgeDeliveryMode": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } }, "traits": { "smithy.api#documentation": "

Whether Elemental Inference sends a function's marked results to Amazon EventBridge.

" } }, "com.amazonaws.elementalinference#ExportDictionaryEntries": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ExportDictionaryEntriesRequest" }, "output": { "target": "com.amazonaws.elementalinference#ExportDictionaryEntriesResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to export dictionary entries" }, "smithy.api#documentation": "

Exports the entries from the specified dictionary.

", "smithy.api#http": { "method": "GET", "uri": "/v1/dictionary/{id}/entries/export", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#ExportDictionaryEntriesRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the dictionary whose entries you want to export.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ExportDictionaryEntriesResponse": { "type": "structure", "members": { "entries": { "target": "com.amazonaws.elementalinference#DictionaryEntriesPayload", "traits": { "smithy.api#documentation": "

The dictionary entries payload.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ExtendedAnalysisMode": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.elementalinference#FeedArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::Elemental-Inference::Feed", "service": "com.amazonaws.elementalinference#ElementalInference", "resource": "com.amazonaws.elementalinference#FeedResource" } } }, "com.amazonaws.elementalinference#FeedAssociation": { "type": "structure", "members": { "associatedResourceName": { "target": "com.amazonaws.elementalinference#AssociatedResourceName", "traits": { "smithy.api#documentation": "

The name of the associated resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elementalinference#FeedId": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9]{19}$" } }, "com.amazonaws.elementalinference#FeedReferences": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#FeedId" } }, "com.amazonaws.elementalinference#FeedResource": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.elementalinference#FeedId" } }, "create": { "target": "com.amazonaws.elementalinference#CreateFeed" }, "read": { "target": "com.amazonaws.elementalinference#GetFeed" }, "update": { "target": "com.amazonaws.elementalinference#UpdateFeed" }, "delete": { "target": "com.amazonaws.elementalinference#DeleteFeed" }, "list": { "target": "com.amazonaws.elementalinference#ListFeeds" }, "operations": [ { "target": "com.amazonaws.elementalinference#AssociateFeed" }, { "target": "com.amazonaws.elementalinference#CreateScheduleAction" }, { "target": "com.amazonaws.elementalinference#DeleteFeedPolicy" }, { "target": "com.amazonaws.elementalinference#DeleteScheduleAction" }, { "target": "com.amazonaws.elementalinference#DisassociateFeed" }, { "target": "com.amazonaws.elementalinference#GetFeedPolicy" }, { "target": "com.amazonaws.elementalinference#ListScheduleActions" }, { "target": "com.amazonaws.elementalinference#PutFeedPolicy" } ], "traits": { "aws.api#arn": { "template": "feed/{id}" }, "aws.api#taggable": { "property": "tags" }, "aws.cloudformation#cfnResource": { "name": "Feed" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "feed", "relativeDocumentation": "elemental-inference-configuration.html" }, "smithy.api#documentation": "Represents a feed that receives media for inference processing", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnResource", "UnstableTrait.aws.api#taggable" ] } }, "com.amazonaws.elementalinference#FeedStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } } } }, "com.amazonaws.elementalinference#FeedSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FeedArn", "traits": { "smithy.api#documentation": "

The ARN of the feed.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the feed

", "smithy.api#required": {} } }, "association": { "target": "com.amazonaws.elementalinference#FeedAssociation", "traits": { "smithy.api#documentation": "

The resource, if any, associated with the feed.

" } }, "status": { "target": "com.amazonaws.elementalinference#FeedStatus", "traits": { "smithy.api#documentation": "

The status of the feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains configuration information about a feed. It is used in the ListFeeds response.

" } }, "com.amazonaws.elementalinference#FeedSummaryList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#FeedSummary" } }, "com.amazonaws.elementalinference#FilterName": { "type": "enum", "members": { "COMPETITOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPETITOR" } } } }, "com.amazonaws.elementalinference#FilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.elementalinference#FilterValueList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#FilterValue" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.elementalinference#FixedIntervalTrigger": { "type": "structure", "members": { "intervalSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The amount of content, in seconds, between runs of the function. Valid range: 1 to 60. For a function with eventBridgeDelivery set to ENABLED, the minimum is 4.

", "smithy.api#range": { "min": 1, "max": 60 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The settings of the fixedInterval trigger, which runs the function once for every intervalSeconds of content. A function that references media.transcript must use this trigger. You can't use this trigger with a function that references media.contextual.

If the function references media.transcript, specify subtitlingSettings. If the function references media.clip, specify clippingSettings. Each run then receives the events that the event clipping output reported during the interval, in media.clip.events.

" } }, "com.amazonaws.elementalinference#FixedModeScheduleActionStartSettings": { "type": "structure", "members": { "scheduledAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Sets the time at which a schedule action runs once. This is a type of ScheduleActionStartConfiguration.

" } }, "com.amazonaws.elementalinference#FixtureDate": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "com.amazonaws.elementalinference#FixtureId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.elementalinference#FixtureSummary": { "type": "structure", "members": { "fixtureId": { "target": "com.amazonaws.elementalinference#FixtureId", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the fixture, as provided by the data source. For example, the names of the two competing teams.

", "smithy.api#required": {} } }, "fixtureGroup": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The group that the fixture belongs to, such as the competition, league, or tournament. The data source doesn't provide this information for every fixture.

" } }, "scheduledStart": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The scheduled start time of the fixture, as provided by the data source. The actual start time might differ.

", "smithy.api#timestampFormat": "date-time" } }, "status": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The status of the fixture in its lifecycle, as provided by the data source. For example, Scheduled or Completed.

", "smithy.api#required": {} } }, "competitors": { "target": "com.amazonaws.elementalinference#CompetitorList", "traits": { "smithy.api#documentation": "

An array of the competitors (the teams or individuals) in the fixture.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elementalinference#FixtureSummaryList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#FixtureSummary" } }, "com.amazonaws.elementalinference#FrameSamplingMode": { "type": "enum", "members": { "FIRST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIRST" } }, "UNIFORM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNIFORM" } }, "LAST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAST" } } } }, "com.amazonaws.elementalinference#FrameSamplingStrategy": { "type": "structure", "members": { "mode": { "target": "com.amazonaws.elementalinference#FrameSamplingMode", "traits": { "smithy.api#documentation": "

Which frames of the window to send: FIRST (the first frames), UNIFORM (frames spread evenly across the window), or LAST (the last frames).

", "smithy.api#required": {} } }, "count": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of frames to send on each run. Valid range: 1 to 64. The default is 1. Each frame adds to the size of the model request and to what the model charges for it.

", "smithy.api#range": { "min": 1, "max": 64 } } } }, "traits": { "smithy.api#documentation": "

Specifies how Elemental Inference chooses frames from the media of each run, and how many frames it chooses. The media of a run is the interval, shot, scene, or clips that the run covers.

" } }, "com.amazonaws.elementalinference#FrameSettings": { "type": "structure", "members": { "frameSampling": { "target": "com.amazonaws.elementalinference#FrameSamplingStrategy", "traits": { "smithy.api#documentation": "

The method for choosing which frames to send.

", "smithy.api#required": {} } }, "frameSize": { "target": "com.amazonaws.elementalinference#FrameSize", "traits": { "smithy.api#documentation": "

The size to resize each frame to. If you omit this structure, frames keep their source size. Smaller frames reduce the size of the model request.

" } } }, "traits": { "smithy.api#documentation": "

The frames that a function receives in media.frames on each run: which frames, how many, and at what size. Elemental Inference applies these settings only to a function that references media.frames.

When you add or change the function output, Elemental Inference estimates the size of the frames and rejects settings whose frames won't fit in one model request. To send more frames in each request, specify a smaller frameSize.

" } }, "com.amazonaws.elementalinference#FrameSize": { "type": "structure", "members": { "widthPixels": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The width of each frame, in pixels. Valid range: 1 to 1280.

", "smithy.api#range": { "min": 1, "max": 1280 }, "smithy.api#required": {} } }, "heightPixels": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The height of each frame, in pixels. Valid range: 1 to 720.

", "smithy.api#range": { "min": 1, "max": 720 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The dimensions, in pixels, of each frame that a function sends. Elemental Inference resizes each frame to exactly this width and height.

" } }, "com.amazonaws.elementalinference#FunctionArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::ElementalInference::Function", "service": "com.amazonaws.elementalinference#ElementalInference", "resource": "com.amazonaws.elementalinference#FunctionResource" } } }, "com.amazonaws.elementalinference#FunctionConfig": { "type": "structure", "members": { "functionArn": { "target": "com.amazonaws.elementalinference#FunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the function to run. The function must exist in the same account and the same Region as the feed.

", "smithy.api#required": {} } }, "trigger": { "target": "com.amazonaws.elementalinference#Trigger", "traits": { "smithy.api#documentation": "

Determines when the function runs.

", "smithy.api#required": {} } }, "frameSettings": { "target": "com.amazonaws.elementalinference#FrameSettings", "traits": { "smithy.api#documentation": "

The frames to send on each run: how many, which ones, and at what size. Applies to a function that references media.frames. If you omit this structure, Elemental Inference sends the first frame of the window, at its source size.

" } }, "subtitlingSettings": { "target": "com.amazonaws.elementalinference#SubtitlingSettings", "traits": { "smithy.api#documentation": "

The smart subtitles output on this feed to read the transcript from. Required for a function that references media.transcript.

" } }, "contextualMetadataSettings": { "target": "com.amazonaws.elementalinference#ContextualMetadataSettings", "traits": { "smithy.api#documentation": "

The contextual metadata output on this feed to read scenes and classifications from. Required for a perScene trigger, and for a function that references media.contextual on a perShot trigger.

" } }, "clippingSettings": { "target": "com.amazonaws.elementalinference#ClippingSettings", "traits": { "smithy.api#documentation": "

The event clipping output on this feed to read clips from. Required for a perClip trigger, and for a function that references media.clip.

" } } }, "traits": { "smithy.api#documentation": "

The output configuration settings for a function. Use this structure to run a function on this feed. The name of the output is the name that you pass to GetMetadata to read the results.

Include the settings that the function's media context and trigger require. Elemental Inference ignores settings that neither uses. It also rejects settings whose frames are estimated to exceed the size of a single model request.

A feed that has an enabled function output must also have an enabled cropping, clipping, subtitling, or contextual metadata output. A feed that runs a function with a Bedrock target must specify an accessRoleArn.

" } }, "com.amazonaws.elementalinference#FunctionDescription": { "type": "string", "traits": { "smithy.api#length": { "max": 1024 }, "smithy.api#pattern": "^[\\w \\-\\.',@:;]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.elementalinference#FunctionId": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9]{19}$" } }, "com.amazonaws.elementalinference#FunctionResource": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.elementalinference#FunctionId" } }, "create": { "target": "com.amazonaws.elementalinference#CreateFunction" }, "read": { "target": "com.amazonaws.elementalinference#GetFunction" }, "update": { "target": "com.amazonaws.elementalinference#UpdateFunction" }, "delete": { "target": "com.amazonaws.elementalinference#DeleteFunction" }, "list": { "target": "com.amazonaws.elementalinference#ListFunctions" }, "traits": { "aws.api#arn": { "template": "function/{id}" }, "aws.api#taggable": { "property": "tags" }, "aws.cloudformation#cfnResource": { "name": "Function" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "function", "relativeDocumentation": "elemental-inference-configuration.html" }, "smithy.api#documentation": "A customer-authored inference function attachable to a feed as an output", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnResource", "UnstableTrait.aws.api#taggable" ] } }, "com.amazonaws.elementalinference#FunctionStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "REFERENCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REFERENCED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } }, "traits": { "smithy.api#documentation": "

The status of a function.

" } }, "com.amazonaws.elementalinference#FunctionSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the function.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the function.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#FunctionDescription", "traits": { "smithy.api#documentation": "

The description of the function.

" } }, "status": { "target": "com.amazonaws.elementalinference#FunctionStatus", "traits": { "smithy.api#documentation": "

The status of the function.

", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.elementalinference#FunctionTarget", "traits": { "smithy.api#documentation": "

The destination for the request that the function builds.

" } }, "contextTypes": { "target": "com.amazonaws.elementalinference#ContextTypeList", "traits": { "smithy.api#documentation": "

The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.

" } } }, "traits": { "smithy.api#documentation": "

Contains identifying and configuration details for a function, including its name, target, status, and derived media context.

" } }, "com.amazonaws.elementalinference#FunctionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#FunctionSummary" } }, "com.amazonaws.elementalinference#FunctionTarget": { "type": "union", "members": { "bedrock": { "target": "com.amazonaws.elementalinference#BedrockFunctionTarget", "traits": { "smithy.api#documentation": "

Send the request to an Amazon Bedrock model.

" } }, "passthrough": { "target": "com.amazonaws.elementalinference#PassthroughFunctionTarget", "traits": { "smithy.api#documentation": "

Send the request nowhere. Use this target to reshape the metadata that Elemental Inference already produces, with no model invocation and no model charges.

" } } }, "traits": { "smithy.api#documentation": "

The destination for the request that a function builds. Specify exactly one member.

" } }, "com.amazonaws.elementalinference#GatewayTimedOutException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

", "smithy.api#error": "server", "smithy.api#httpError": 504, "smithy.api#retryable": {} } }, "com.amazonaws.elementalinference#GetDictionary": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#GetDictionaryRequest" }, "output": { "target": "com.amazonaws.elementalinference#GetDictionaryResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get dictionary details" }, "smithy.api#documentation": "

Retrieves information about the specified dictionary.

", "smithy.api#http": { "method": "GET", "uri": "/v1/dictionary/{id}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#GetDictionaryRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the dictionary to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#GetDictionaryResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the dictionary.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.elementalinference#DictionaryArn", "traits": { "smithy.api#documentation": "

The ARN of the dictionary.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the dictionary.

", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.elementalinference#DictionaryLanguage", "traits": { "smithy.api#documentation": "

The language of the dictionary.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#DictionaryStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The current status of the dictionary.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A list of feed IDs that reference this dictionary.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the dictionary.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#GetFeed": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#GetFeedRequest" }, "output": { "target": "com.amazonaws.elementalinference#GetFeedResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get feed details" }, "smithy.api#documentation": "

Retrieves information about the specified feed.

", "smithy.api#http": { "method": "GET", "uri": "/v1/feed/{id}", "code": 200 }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "FeedDeleted": { "documentation": "Wait until a Feed is deleted", "minDelay": 3, "acceptors": [ { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "status", "expected": "DELETING", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "errorType": "InternalServerErrorException" } }, { "state": "retry", "matcher": { "errorType": "TooManyRequestException" } } ] } } } }, "com.amazonaws.elementalinference#GetFeedPolicy": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#GetFeedPolicyRequest" }, "output": { "target": "com.amazonaws.elementalinference#GetFeedPolicyResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get the resource-based policy of a feed", "resources": { "required": { "feed": {} } } }, "smithy.api#documentation": "

Retrieves the resource-based policy attached to the specified feed.

", "smithy.api#http": { "method": "GET", "uri": "/v1/feed/{id}/policy", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#GetFeedPolicyRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed whose policy you want to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#GetFeedPolicyResponse": { "type": "structure", "members": { "policy": { "target": "com.amazonaws.elementalinference#PolicyDocument", "traits": { "smithy.api#documentation": "

The resource-based policy document attached to the feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#GetFeedRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed to query.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#GetFeedResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FeedArn", "traits": { "smithy.api#documentation": "

The ARN of the feed.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the feed.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed.

", "smithy.api#required": {} } }, "dataEndpoints": { "target": "com.amazonaws.elementalinference#StringList", "traits": { "smithy.api#documentation": "

The dataEndpoints of the feed.

", "smithy.api#required": {} } }, "outputs": { "target": "com.amazonaws.elementalinference#GetOutputList", "traits": { "smithy.api#documentation": "

An array of the outputs in the feed.

", "smithy.api#required": {} } }, "accessRoleArn": { "target": "com.amazonaws.elementalinference#IamRoleArn", "traits": { "smithy.api#documentation": "

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.

" } }, "status": { "target": "com.amazonaws.elementalinference#FeedStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The status of the feed.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "association": { "target": "com.amazonaws.elementalinference#FeedAssociation", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

Information about the resource that is associated with the feed. It's possible that there is no associated resource. This is not an error.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

A list of the tags, if any, for the feed.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#GetFixture": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#GetFixtureRequest" }, "output": { "target": "com.amazonaws.elementalinference#GetFixtureResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#GatewayTimedOutException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#ServiceUnavailableException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get a fixture" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "GET", "uri": "/v1/fixtures/{fixtureId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#GetFixtureRequest": { "type": "structure", "members": { "fixtureId": { "target": "com.amazonaws.elementalinference#FixtureId", "traits": { "smithy.api#documentation": "

The ID of the fixture to retrieve, as returned by SearchFixtures.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#GetFixtureResponse": { "type": "structure", "members": { "fixtureId": { "target": "com.amazonaws.elementalinference#FixtureId", "traits": { "smithy.api#documentation": "

The ID that you specified in the request.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the fixture, as provided by the data source. For example, the names of the two competing teams.

", "smithy.api#required": {} } }, "fixtureGroup": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The group that the fixture belongs to, such as the competition, league, or tournament. The data source doesn't provide this information for every fixture.

" } }, "scheduledStart": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The scheduled start time of the fixture, as provided by the data source. The actual start time might differ.

", "smithy.api#timestampFormat": "date-time" } }, "status": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The status of the fixture in its lifecycle, as provided by the data source. For example, Scheduled or Completed.

", "smithy.api#required": {} } }, "competitors": { "target": "com.amazonaws.elementalinference#CompetitorList", "traits": { "smithy.api#documentation": "

An array of the competitors (the teams or individuals) in the fixture.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#GetFunction": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#GetFunctionRequest" }, "output": { "target": "com.amazonaws.elementalinference#GetFunctionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get inference function details" }, "smithy.api#documentation": "

Retrieves the details of a function, including its expressions, the media context that Elemental Inference derived from the request expression, and the feeds that currently reference it.

", "smithy.api#http": { "method": "GET", "uri": "/v1/function/{id}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#GetFunctionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#GetFunctionResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the function.

", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.elementalinference#FunctionTarget", "traits": { "smithy.api#documentation": "

The destination for the request that the function builds.

", "smithy.api#required": {} } }, "requestExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that builds the request. Elemental Inference evaluates it against the media object of the feed, which holds the media and metadata that the function asked for.

", "smithy.api#length": { "min": 1, "max": 5120 }, "smithy.api#required": {} } }, "responseExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as its root: the model response for a Bedrock target, or the output of the request expression for a passthrough target. If a function has no response expression, Elemental Inference stores the entire result.

" } }, "description": { "target": "com.amazonaws.elementalinference#FunctionDescription", "traits": { "smithy.api#documentation": "

The description of the function.

" } }, "eventBridgeDelivery": { "target": "com.amazonaws.elementalinference#EventBridgeDeliveryMode", "traits": { "smithy.api#default": "DISABLED", "smithy.api#documentation": "

Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With ENABLED, each result that is a JSON object with a top-level eventBridge field set to true is also sent as a Function Metadata Generated event to the default event bus in your account.

" } }, "arn": { "target": "com.amazonaws.elementalinference#FunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the function.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#FunctionStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The status of the function.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The IDs of the feeds that have a function output, enabled or disabled, that references this function. While this list isn't empty, the function can't be deleted, and its name and target can't be changed.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "contextTypes": { "target": "com.amazonaws.elementalinference#ContextTypeList", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the function.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#GetOutput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the output.

", "smithy.api#required": {} } }, "outputConfig": { "target": "com.amazonaws.elementalinference#OutputConfig", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#OutputStatus", "traits": { "smithy.api#documentation": "

The status of the output.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#ResourceDescription", "traits": { "smithy.api#documentation": "

The description of the output.

" } }, "fromAssociation": { "target": "smithy.api#Boolean", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

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.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } } }, "traits": { "smithy.api#documentation": "

Contains configuration information about one output in a feed. It is used in the GetFeed response.

" } }, "com.amazonaws.elementalinference#GetOutputList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#GetOutput" } }, "com.amazonaws.elementalinference#GetQuestionSet": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#GetQuestionSetRequest" }, "output": { "target": "com.amazonaws.elementalinference#GetQuestionSetResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get question set details" }, "smithy.api#documentation": "

Retrieves information about the specified question set at one version. By default, GetQuestionSet returns the DRAFT version. To retrieve a published version, specify questionSetVersion.

", "smithy.api#http": { "method": "GET", "uri": "/v1/question-set/{id}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#GetQuestionSetRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "questionSetVersion": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The version of the question set to retrieve: DRAFT or the number of a published version. If you don't specify a version, Elemental Inference returns DRAFT.

", "smithy.api#httpQuery": "questionSetVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#GetQuestionSetResponse": { "type": "structure", "members": { "yesNo": { "target": "com.amazonaws.elementalinference#YesNoQuestionList", "traits": { "smithy.api#documentation": "

The yesNo questions in this version. Elemental Inference doesn't return this property if the version has no yesNo questions.

" } }, "yesNoPerOption": { "target": "com.amazonaws.elementalinference#YesNoPerOptionQuestionList", "traits": { "smithy.api#documentation": "

The yesNoPerOption questions in this version. Elemental Inference doesn't return this property if the version has no yesNoPerOption questions.

" } }, "chooseOne": { "target": "com.amazonaws.elementalinference#ChooseOneQuestionList", "traits": { "smithy.api#documentation": "

The chooseOne questions in this version. Elemental Inference doesn't return this property if the version has no chooseOne questions.

" } }, "arn": { "target": "com.amazonaws.elementalinference#QuestionSetArn", "traits": { "smithy.api#documentation": "

The ARN of the question set.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the question set at this version. For a published version, this is the name that the question set had when the version was published.

", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The version that this response describes: DRAFT or the number of a published version.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#QuestionSetVersionDescription", "traits": { "smithy.api#documentation": "

The description that you specified when you published this version. Elemental Inference doesn't return this property for DRAFT, or for a version that you published without a description.

" } }, "latestVersion": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The number of the highest version that you have published for this question set, even if you have since deleted that version. Elemental Inference doesn't return this property if you haven't published a version.

" } }, "sha256": { "target": "com.amazonaws.elementalinference#QuestionSetSha256", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The SHA-256 hash of this version, as 64 lowercase hexadecimal characters. The hash covers the name of the question set and its questions at this version. For DRAFT, you can specify this value in a CreateQuestionSetVersion request, so that Elemental Inference publishes DRAFT only if it hasn't changed.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A list of feed IDs that reference this version of the question set. The list doesn't include feeds that reference other versions.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the question set.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#IamRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 255 }, "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.elementalinference#InternalServerErrorException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.elementalinference#JsonataExpression": { "type": "string", "traits": { "smithy.api#length": { "max": 5120 }, "smithy.api#sensitive": {} } }, "com.amazonaws.elementalinference#ListDictionaries": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ListDictionariesRequest" }, "output": { "target": "com.amazonaws.elementalinference#ListDictionariesResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list dictionaries in the account" }, "smithy.api#documentation": "

Lists the dictionaries in your account.

", "smithy.api#http": { "method": "GET", "uri": "/v1/dictionaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "dictionaries", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#ListDictionariesRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return per API request. Valid range: 1 to 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token that identifies the next batch of results to return.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ListDictionariesResponse": { "type": "structure", "members": { "dictionaries": { "target": "com.amazonaws.elementalinference#DictionarySummaryList", "traits": { "smithy.api#documentation": "

A list of DictionarySummary objects.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next batch of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ListFeeds": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ListFeedsRequest" }, "output": { "target": "com.amazonaws.elementalinference#ListFeedsResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list feeds in the account" }, "smithy.api#documentation": "

Displays a list of feeds that belong to this AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/v1/feeds", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "feeds", "pageSize": "maxResults" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListFeedsSuccess", "params": { "maxResults": 10 }, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.elementalinference#ListFeedsRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ListFeedsResponse": { "type": "structure", "members": { "feeds": { "target": "com.amazonaws.elementalinference#FeedSummaryList", "traits": { "smithy.api#documentation": "

A list of FeedSummary objects.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ListFunctions": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ListFunctionsRequest" }, "output": { "target": "com.amazonaws.elementalinference#ListFunctionsResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list inference functions in the account" }, "smithy.api#documentation": "

Lists the functions in this account, in this Region. Each entry is a summary. To get the expressions of a function, use GetFunction.

", "smithy.api#http": { "method": "GET", "uri": "/v1/functions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "functions", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#ListFunctionsRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum number of functions to return in one response. Valid range: 1 to 100. The default is 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token that identifies the page of results to return. Use the nextToken value from a previous response.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ListFunctionsResponse": { "type": "structure", "members": { "functions": { "target": "com.amazonaws.elementalinference#FunctionSummaryList", "traits": { "smithy.api#documentation": "

An array of function summaries.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token to use in a subsequent request to get the next page of results. This field is absent when there are no more results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ListQuestionSetVersions": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ListQuestionSetVersionsRequest" }, "output": { "target": "com.amazonaws.elementalinference#ListQuestionSetVersionsResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the versions of a question set" }, "smithy.api#documentation": "

Lists the versions of the specified question set. The list starts with the DRAFT version, followed by the published versions from the highest version number to the lowest. The list doesn't include deleted versions.

The response doesn't include the questions in each version. To retrieve them, use GetQuestionSet and specify questionSetVersion.

", "smithy.api#http": { "method": "GET", "uri": "/v1/question-set/{id}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "versions", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#ListQuestionSetVersionsRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set whose versions you want to list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return per API request. Valid range: 1 to 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token that identifies the next batch of results to return.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ListQuestionSetVersionsResponse": { "type": "structure", "members": { "versions": { "target": "com.amazonaws.elementalinference#QuestionSetVersionSummaryList", "traits": { "smithy.api#documentation": "

A list of QuestionSetVersionSummary objects.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next batch of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ListQuestionSets": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ListQuestionSetsRequest" }, "output": { "target": "com.amazonaws.elementalinference#ListQuestionSetsResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list question sets in the account" }, "smithy.api#documentation": "

Lists the question sets in your account. The response doesn't include the questions in each question set. To retrieve them, use GetQuestionSet.

", "smithy.api#http": { "method": "GET", "uri": "/v1/question-sets", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "questionSets", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#ListQuestionSetsRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return per API request. Valid range: 1 to 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token that identifies the next batch of results to return.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ListQuestionSetsResponse": { "type": "structure", "members": { "questionSets": { "target": "com.amazonaws.elementalinference#QuestionSetSummaryList", "traits": { "smithy.api#documentation": "

A list of QuestionSetSummary objects.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next batch of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ListScheduleActions": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ListScheduleActionsRequest" }, "output": { "target": "com.amazonaws.elementalinference#ListScheduleActionsResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list schedule actions for a feed", "resources": { "required": { "feed": {} } } }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "GET", "uri": "/v1/feed/{id}/schedule-actions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "scheduleActions", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#ListScheduleActionsRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed that you want to query.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ListScheduleActionsResponse": { "type": "structure", "members": { "scheduleActions": { "target": "com.amazonaws.elementalinference#ScheduleActionList", "traits": { "smithy.api#documentation": "

A list of the schedule actions on the feed.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token that identifies the next batch of results. Elemental Inference returns it only when more results are available.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.elementalinference#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list tags on a resource" }, "smithy.api#documentation": "

List all tags that are on an Elemental Inference resource in the current region.

", "smithy.api#http": { "method": "GET", "uri": "/v1/tags/{resourceArn}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.elementalinference#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource whose tags you want to query.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

A list of the tags that belong to this resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#OptionName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of an option. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

", "smithy.api#pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "com.amazonaws.elementalinference#OptionText": { "type": "string", "traits": { "smithy.api#documentation": "

The text of an option. The text can be up to 16 bytes, encoded in UTF-8.

", "smithy.api#length": { "min": 1, "max": 16 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{N} .,?!'\"\u2019\u201c\u201d()\\-:;/&%]*$" } }, "com.amazonaws.elementalinference#OutputConfig": { "type": "union", "members": { "cropping": { "target": "com.amazonaws.elementalinference#CroppingConfig", "traits": { "smithy.api#documentation": "

The output config type that applies to the cropping feature.

" } }, "clipping": { "target": "com.amazonaws.elementalinference#ClippingConfig", "traits": { "smithy.api#documentation": "

The output config type that applies to the clipping feature.

" } }, "subtitling": { "target": "com.amazonaws.elementalinference#SubtitlingConfig", "traits": { "smithy.api#documentation": "

The output config type that applies to the smart subtitling feature.

" } }, "contextualMetadata": { "target": "com.amazonaws.elementalinference#ContextualMetadataConfig", "traits": { "smithy.api#documentation": "

The output config type that applies to the contextual metadata feature.

" } }, "function": { "target": "com.amazonaws.elementalinference#FunctionConfig", "traits": { "smithy.api#documentation": "

The output config type that applies to a function.

" } } }, "traits": { "smithy.api#documentation": "

Contains one typed output. It is used in the CreateOutput, GetOutput, and Update Output structures.

" } }, "com.amazonaws.elementalinference#OutputStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.elementalinference#PassthroughFunctionTarget": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

A target that invokes nothing. Elemental Inference evaluates your request expression, then evaluates your response expression against that result. If the function has no response expression, Elemental Inference stores the result of the request expression.

A passthrough function can't reference media.frames. It also needs no access role on the feed.

" } }, "com.amazonaws.elementalinference#PolicyDocument": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.elementalinference#ProfanityFilterMode": { "type": "enum", "members": { "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "CENSOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CENSOR" } }, "DROP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DROP" } } } }, "com.amazonaws.elementalinference#PublishedQuestionSetVersion": { "type": "string", "traits": { "smithy.api#documentation": "

The number of a published version of a question set.

", "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#pattern": "^[1-9][0-9]*$" } }, "com.amazonaws.elementalinference#PutFeedPolicy": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#PutFeedPolicyRequest" }, "output": { "target": "com.amazonaws.elementalinference#PutFeedPolicyResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to put a resource-based policy on a feed", "resources": { "required": { "feed": {} } } }, "smithy.api#documentation": "

Attaches or replaces a resource-based policy on the specified feed. A resource-based policy grants cross-account access to the feed.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/feed/{id}/policy", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#PutFeedPolicyRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed to attach the policy to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.elementalinference#PolicyDocument", "traits": { "smithy.api#documentation": "

The resource-based policy document to attach to the feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#PutFeedPolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#QuestionName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of a question. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

", "smithy.api#pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "com.amazonaws.elementalinference#QuestionOption": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#OptionName", "traits": { "smithy.api#documentation": "

A name for the option. The name must be unique among the options of the question. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

", "smithy.api#required": {} } }, "text": { "target": "com.amazonaws.elementalinference#OptionText", "traits": { "smithy.api#documentation": "

The text of the option. The text must be unique among the options of the question, ignoring case. The text can be up to 16 bytes, encoded in UTF-8. It can contain the same characters as the text of a question.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An option in a yesNoPerOption question or a chooseOne question.

" } }, "com.amazonaws.elementalinference#QuestionSetArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::ElementalInference::QuestionSet", "service": "com.amazonaws.elementalinference#ElementalInference", "resource": "com.amazonaws.elementalinference#QuestionSetResource" }, "smithy.api#documentation": "

The ARN of a question set.

" } }, "com.amazonaws.elementalinference#QuestionSetId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID of a question set.

", "smithy.api#pattern": "^[a-z0-9]{19}$" } }, "com.amazonaws.elementalinference#QuestionSetReference": { "type": "structure", "members": { "questionSetId": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set. The question set must be in your account.

", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The version of the question set: DRAFT or the number of a published version. The version must exist.

If you specify DRAFT, the output uses the current DRAFT questions and picks up changes that you make later by using UpdateQuestionSet. To keep the questions for the output fixed, specify a published version.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifies one version of a question set. You specify it in CustomQuestionsConfig.

" } }, "com.amazonaws.elementalinference#QuestionSetResource": { "type": "resource", "identifiers": { "id": { "target": "com.amazonaws.elementalinference#QuestionSetId" } }, "create": { "target": "com.amazonaws.elementalinference#CreateQuestionSet" }, "read": { "target": "com.amazonaws.elementalinference#GetQuestionSet" }, "update": { "target": "com.amazonaws.elementalinference#UpdateQuestionSet" }, "delete": { "target": "com.amazonaws.elementalinference#DeleteQuestionSet" }, "list": { "target": "com.amazonaws.elementalinference#ListQuestionSets" }, "operations": [ { "target": "com.amazonaws.elementalinference#CreateQuestionSetVersion" }, { "target": "com.amazonaws.elementalinference#DeleteQuestionSetVersion" }, { "target": "com.amazonaws.elementalinference#ListQuestionSetVersions" } ], "traits": { "aws.api#arn": { "template": "question-set/{id}" }, "aws.api#taggable": { "property": "tags" }, "aws.cloudformation#cfnResource": { "name": "QuestionSet" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "question-set", "relativeDocumentation": "elemental-inference-configuration.html" }, "smithy.api#documentation": "A versioned set of customer-defined questions asked about video shots or scenes", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnResource", "UnstableTrait.aws.api#taggable" ] } }, "com.amazonaws.elementalinference#QuestionSetSha256": { "type": "string", "traits": { "smithy.api#documentation": "

The SHA-256 hash of a version of a question set, as 64 lowercase hexadecimal characters.

", "smithy.api#pattern": "^[a-f0-9]{64}$" } }, "com.amazonaws.elementalinference#QuestionSetSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#QuestionSetArn", "traits": { "smithy.api#documentation": "

The ARN of the question set.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the question set.

", "smithy.api#required": {} } }, "latestVersion": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The number of the highest version that you have published for this question set, even if you have since deleted that version. Elemental Inference doesn't return this property if you haven't published a version.

" } } }, "traits": { "smithy.api#documentation": "

Contains summary information about a question set. Used in the ListQuestionSets response.

" } }, "com.amazonaws.elementalinference#QuestionSetSummaryList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#QuestionSetSummary" }, "traits": { "smithy.api#documentation": "

An array of QuestionSetSummary objects.

" } }, "com.amazonaws.elementalinference#QuestionSetVersion": { "type": "string", "traits": { "smithy.api#documentation": "

A version of a question set: DRAFT or the number of a published version.

", "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#pattern": "^(DRAFT|[1-9][0-9]*)$" } }, "com.amazonaws.elementalinference#QuestionSetVersionDescription": { "type": "string", "traits": { "smithy.api#documentation": "

A description of a published version of a question set.

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\w \\-\\.',@:;]*$" } }, "com.amazonaws.elementalinference#QuestionSetVersionSummary": { "type": "structure", "members": { "version": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The version: DRAFT or the number of a published version.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#QuestionSetVersionDescription", "traits": { "smithy.api#documentation": "

The description that you specified when you published this version. Elemental Inference doesn't return this property for DRAFT, or for a version that you published without a description.

" } }, "sha256": { "target": "com.amazonaws.elementalinference#QuestionSetSha256", "traits": { "smithy.api#documentation": "

The SHA-256 hash of this version, as 64 lowercase hexadecimal characters. The hash covers the name of the question set and its questions at this version.

", "smithy.api#required": {} } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

For DRAFT, the time when you created the question set or last updated DRAFT. For a published version, the time when you published it.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains summary information about one version of a question set. Used in the ListQuestionSetVersions response.

" } }, "com.amazonaws.elementalinference#QuestionSetVersionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#QuestionSetVersionSummary" }, "traits": { "smithy.api#documentation": "

An array of QuestionSetVersionSummary objects.

" } }, "com.amazonaws.elementalinference#QuestionText": { "type": "string", "traits": { "smithy.api#documentation": "

The text of a question. The text can be up to 256 bytes, encoded in UTF-8.

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{N} .,?!'\"\u2019\u201c\u201d()\\-:;/&%]*$" } }, "com.amazonaws.elementalinference#RemoveClippingDataSourceConfiguration": { "type": "structure", "members": { "outputName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the output that you want to remove the game from.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elementalinference#ResourceArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::Elemental-Inference::Resource" }, "smithy.api#pattern": "^arn:aws[a-z\\-]*:elemental-inference[a-z\\-]*:[a-z0-9\\-]+:[0-9]{12}:[a-z\\-]+/[a-zA-Z0-9]{1,19}$" } }, "com.amazonaws.elementalinference#ResourceDescription": { "type": "string", "traits": { "smithy.api#length": { "max": 1024 }, "smithy.api#pattern": "^[\\w \\-\\.',@:;]*$" } }, "com.amazonaws.elementalinference#ResourceName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?$" } }, "com.amazonaws.elementalinference#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The resource specified in the action doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elementalinference#S3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 255 }, "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+$" } }, "com.amazonaws.elementalinference#SceneTrigger": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The perScene trigger, which runs the function once for each scene that a contextual metadata output reports. The function runs after the scene ends, with the media of that scene. To choose this trigger, set perScene to an empty object.

Specify contextualMetadataSettings to name the contextual metadata output that reports the scenes. You can't use this trigger with a function that references media.transcript or media.clip.

" } }, "com.amazonaws.elementalinference#ScheduleAction": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the schedule action. The name is unique within the feed.

", "smithy.api#required": {} } }, "startConfiguration": { "target": "com.amazonaws.elementalinference#ScheduleActionStartConfiguration", "traits": { "smithy.api#documentation": "

Specifies when the action runs.

", "smithy.api#required": {} } }, "operations": { "target": "com.amazonaws.elementalinference#ScheduleActionOperations", "traits": { "smithy.api#documentation": "

The configuration changes that the action makes to the feed.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#ScheduleActionStatus", "traits": { "smithy.api#documentation": "

The status of the action. Valid values are the following:

PENDING

The action is waiting for its scheduled time.

COMPLETED

Elemental Inference applied all the action's operations to the feed.

FAILED

Elemental Inference couldn't apply the action.

", "smithy.api#required": {} } }, "error": { "target": "com.amazonaws.elementalinference#ScheduleActionError", "traits": { "smithy.api#documentation": "

A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elementalinference#ScheduleActionError": { "type": "structure", "members": { "errorCode": { "target": "com.amazonaws.elementalinference#ScheduleActionErrorCode", "traits": { "smithy.api#documentation": "

The type of failure. Valid values are the following:

INVALID_ACTION_TARGET

The action referred to something that didn't exist or wasn't valid at the scheduled time, for example an output that you deleted.

INTERNAL_ERROR

An unexpected error prevented the action from completing.

", "smithy.api#required": {} } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of the failure.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes the cause of a schedule action failure, including the failure type and a description of what went wrong.

" } }, "com.amazonaws.elementalinference#ScheduleActionErrorCode": { "type": "enum", "members": { "INVALID_ACTION_TARGET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ACTION_TARGET" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_ERROR" } } } }, "com.amazonaws.elementalinference#ScheduleActionList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#ScheduleAction" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.elementalinference#ScheduleActionOperation": { "type": "union", "members": { "updateOutputStatus": { "target": "com.amazonaws.elementalinference#UpdateOutputStatus", "traits": { "smithy.api#documentation": "

The operation type that enables or disables an output.

" } }, "updateClippingDataSourceConfiguration": { "target": "com.amazonaws.elementalinference#UpdateClippingDataSourceConfiguration", "traits": { "smithy.api#documentation": "

The operation type that attaches a game to an event clipping output.

" } }, "removeClippingDataSourceConfiguration": { "target": "com.amazonaws.elementalinference#RemoveClippingDataSourceConfiguration", "traits": { "smithy.api#documentation": "

The operation type that removes the game from an event clipping output.

" } } }, "traits": { "smithy.api#documentation": "

Holds one typed configuration change that a schedule action makes to a feed. Each operation must contain exactly one property.

" } }, "com.amazonaws.elementalinference#ScheduleActionOperations": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#ScheduleActionOperation" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.elementalinference#ScheduleActionStartConfiguration": { "type": "union", "members": { "fixedModeScheduleActionStartSettings": { "target": "com.amazonaws.elementalinference#FixedModeScheduleActionStartSettings", "traits": { "smithy.api#documentation": "

The start settings type for an action that runs once, at a fixed time.

" } } }, "traits": { "smithy.api#documentation": "

Holds the typed start settings that determine when a schedule action runs. Currently, only fixed mode is supported.

" } }, "com.amazonaws.elementalinference#ScheduleActionStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.elementalinference#SearchFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#FilterName", "traits": { "smithy.api#documentation": "

The dimension of the fixture to filter on. Valid values: COMPETITOR.

", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.elementalinference#FilterValueList", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A filter for a fixture search. It is used in the filters array of a SearchFixtures request.

" } }, "com.amazonaws.elementalinference#SearchFilterList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#SearchFilter" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.elementalinference#SearchFixtures": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#SearchFixturesRequest" }, "output": { "target": "com.amazonaws.elementalinference#SearchFixturesResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#GatewayTimedOutException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ServiceUnavailableException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to search fixtures" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "POST", "uri": "/v1/fixtures", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "fixtures", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.elementalinference#SearchFixturesRequest": { "type": "structure", "members": { "sport": { "target": "com.amazonaws.elementalinference#DataSourceSport", "traits": { "smithy.api#documentation": "

The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).

", "smithy.api#required": {} } }, "startDate": { "target": "com.amazonaws.elementalinference#FixtureDate", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "endDate": { "target": "com.amazonaws.elementalinference#FixtureDate", "traits": { "smithy.api#documentation": "

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.

" } }, "filters": { "target": "com.amazonaws.elementalinference#SearchFilterList", "traits": { "smithy.api#documentation": "

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.

" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#SearchFixturesResponse": { "type": "structure", "members": { "fixtures": { "target": "com.amazonaws.elementalinference#FixtureSummaryList", "traits": { "smithy.api#documentation": "

An array of FixtureSummary objects, one for each fixture that matches the search. The array is empty if no fixtures match.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.elementalinference#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The service is temporarily unable to handle the request. Retry the request. If the problem persists, contact AWS Support.

", "smithy.api#error": "server", "smithy.api#httpError": 503, "smithy.api#retryable": {} } }, "com.amazonaws.elementalinference#ShotTrigger": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The perShot trigger, which runs the function once for each shot that Elemental Inference detects in the video. The function runs after the shot ends, with the media of that shot. To choose this trigger, set perShot to an empty object. The feed must have a video input.

You can't use this trigger with a function that references media.transcript or media.clip. If the function references media.contextual, specify contextualMetadataSettings.

" } }, "com.amazonaws.elementalinference#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.elementalinference#SubtitlingConfig": { "type": "structure", "members": { "language": { "target": "com.amazonaws.elementalinference#TranscriptionLanguage", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "aspectRatio": { "target": "com.amazonaws.elementalinference#AspectRatio", "traits": { "smithy.api#documentation": "

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.

" } }, "dictionary": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.

" } }, "profanityFilter": { "target": "com.amazonaws.elementalinference#ProfanityFilterMode", "traits": { "smithy.api#documentation": "

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).

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elementalinference#SubtitlingSettings": { "type": "structure", "members": { "outputName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of an ENABLED smart subtitles output on this feed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The smart subtitles output on this feed that a function reads media.transcript from. Specify this structure for a function that references media.transcript. That function must use a fixedInterval trigger.

If the function output is ENABLED, the output that you name must also be ENABLED.

" } }, "com.amazonaws.elementalinference#SummaryGenerationMode": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.elementalinference#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.elementalinference#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#TagKey" } }, "com.amazonaws.elementalinference#TagMap": { "type": "map", "key": { "target": "com.amazonaws.elementalinference#TagKey" }, "value": { "target": "com.amazonaws.elementalinference#TagValue" } }, "com.amazonaws.elementalinference#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to add tags to a resource", "resources": { "optional": { "dictionary": {}, "feed": {}, "function": {}, "question-set": {} } } }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "POST", "uri": "/v1/tags/{resourceArn}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.elementalinference#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource where you want to add tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

A list of tags to add to the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#TagValue": { "type": "string", "traits": { "smithy.api#length": { "max": 256 } } }, "com.amazonaws.elementalinference#TemplateGroup": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A name for the template group.

", "smithy.api#required": {} } }, "templateUris": { "target": "com.amazonaws.elementalinference#TemplateUriList", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A named set of graphics-compositing templates used by the crop feature, specified in the templateGroups array of a CroppingConfig.

" } }, "com.amazonaws.elementalinference#TemplateGroupList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#TemplateGroup" }, "traits": { "smithy.api#length": { "min": 1, "max": 4 } } }, "com.amazonaws.elementalinference#TemplateUriList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#S3Uri" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.elementalinference#TooManyRequestException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} } }, "com.amazonaws.elementalinference#TranscriptionLanguage": { "type": "enum", "members": { "ENG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eng" } }, "ENG_AU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eng-au" } }, "ENG_GB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eng-gb" } }, "ENG_US": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eng-us" } }, "FRA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fra" } }, "ITA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ita" } }, "DEU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "deu" } }, "SPA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "spa" } }, "POR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "por" } } } }, "com.amazonaws.elementalinference#Trigger": { "type": "union", "members": { "fixedInterval": { "target": "com.amazonaws.elementalinference#FixedIntervalTrigger", "traits": { "smithy.api#documentation": "

Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.

" } }, "perShot": { "target": "com.amazonaws.elementalinference#ShotTrigger", "traits": { "smithy.api#documentation": "

Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.

" } }, "perScene": { "target": "com.amazonaws.elementalinference#SceneTrigger", "traits": { "smithy.api#documentation": "

Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.

" } }, "perClip": { "target": "com.amazonaws.elementalinference#ClipTrigger", "traits": { "smithy.api#documentation": "

Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.

" } } }, "traits": { "smithy.api#documentation": "

Determines when a function runs. Specify exactly one member.

" } }, "com.amazonaws.elementalinference#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from a resource", "resources": { "optional": { "dictionary": {}, "feed": {}, "function": {}, "question-set": {} } } }, "smithy.api#documentation": "

Deletes specified tags from the specified resource in the current region.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/tags/{resourceArn}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.elementalinference#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource where you want to delete one or more tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.elementalinference#TagKeyList", "traits": { "smithy.api#documentation": "

The keys of the tags to delete.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#UpdateClippingDataSourceConfiguration": { "type": "structure", "members": { "outputName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the output that you want to attach the game to.

", "smithy.api#required": {} } }, "dataSourceConfiguration": { "target": "com.amazonaws.elementalinference#DataSourceConfiguration", "traits": { "smithy.api#documentation": "

The game that you want to attach to the output.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elementalinference#UpdateDictionary": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#UpdateDictionaryRequest" }, "output": { "target": "com.amazonaws.elementalinference#UpdateDictionaryResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update dictionary configuration" }, "smithy.api#documentation": "

Updates the specified dictionary.

", "smithy.api#http": { "method": "PATCH", "uri": "/v1/dictionary/{id}", "code": 200 } } }, "com.amazonaws.elementalinference#UpdateDictionaryRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the dictionary to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A new name for the dictionary. If not specified, the name is not changed.

" } }, "language": { "target": "com.amazonaws.elementalinference#DictionaryLanguage", "traits": { "smithy.api#documentation": "

A new language for the dictionary. If not specified, the language is not changed.

" } }, "entries": { "target": "com.amazonaws.elementalinference#DictionaryEntriesPayload", "traits": { "smithy.api#documentation": "

New dictionary entries. If not specified, the entries are not changed.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#UpdateDictionaryResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The updated or original name of the dictionary.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.elementalinference#DictionaryArn", "traits": { "smithy.api#documentation": "

The ARN of the dictionary.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#DictionaryId", "traits": { "smithy.api#documentation": "

The ID of the dictionary.

", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.elementalinference#DictionaryLanguage", "traits": { "smithy.api#documentation": "

The updated or original language of the dictionary.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#DictionaryStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The current status of the dictionary.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A list of feed IDs that reference this dictionary.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Any tags associated with the dictionary.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#UpdateFeed": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#UpdateFeedRequest" }, "output": { "target": "com.amazonaws.elementalinference#UpdateFeedResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#ServiceQuotaExceededException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update feed configuration" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/feed/{id}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#UpdateFeedRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

Required. You can specify the existing name (to leave it unchanged) or a new name.

", "smithy.api#required": {} } }, "accessRoleArn": { "target": "com.amazonaws.elementalinference#IamRoleArn", "traits": { "smithy.api#documentation": "

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.

" } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "outputs": { "target": "com.amazonaws.elementalinference#UpdateOutputList", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

Required. You can specify the existing array of outputs (to leave outputs unchanged) or you can specify a new array.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#UpdateFeedResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.elementalinference#FeedArn", "traits": { "smithy.api#documentation": "

The ARN of the feed.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The updated or original name of the feed.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FeedId", "traits": { "smithy.api#documentation": "

The ID of the feed.

", "smithy.api#required": {} } }, "dataEndpoints": { "target": "com.amazonaws.elementalinference#StringList", "traits": { "smithy.api#documentation": "

The data endpoints of the feed.

", "smithy.api#required": {} } }, "outputs": { "target": "com.amazonaws.elementalinference#GetOutputList", "traits": { "smithy.api#documentation": "

The array of outputs in the feed. You might have left this array unchanged, or you might have changed it.

", "smithy.api#required": {} } }, "accessRoleArn": { "target": "com.amazonaws.elementalinference#IamRoleArn", "traits": { "smithy.api#documentation": "

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.

" } }, "status": { "target": "com.amazonaws.elementalinference#FeedStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The status of the feed.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "association": { "target": "com.amazonaws.elementalinference#FeedAssociation", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

Information about the resource that is associated with the feed, if any.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the feed.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#UpdateFunction": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#UpdateFunctionRequest" }, "output": { "target": "com.amazonaws.elementalinference#UpdateFunctionResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update inference function configuration" }, "smithy.api#documentation": "

Updates a function. Include only the parameters that you want to change; parameters that you don't include aren't affected. Elemental Inference validates the updated expressions in the same way as CreateFunction.

While a feed references the function, you can change only its expressions and its description, and you can set eventBridgeDelivery to DISABLED but not to ENABLED. The request expression must keep referencing the same media context, as reported in contextTypes. Changing an expression changes the behavior of every feed that references the function.

", "smithy.api#http": { "method": "PATCH", "uri": "/v1/function/{id}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#UpdateFunctionRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A new name for the function. You can't change the name while the function is referenced by a feed.

" } }, "target": { "target": "com.amazonaws.elementalinference#FunctionTarget", "traits": { "smithy.api#documentation": "

A new target for the function. You can't change the target while the function is referenced by a feed.

" } }, "requestExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

A new request expression for the function. Elemental Inference derives contextTypes again from the new expression. While a feed references the function, the new expression must reference the same media context as the current one.

", "smithy.api#length": { "min": 1, "max": 5120 } } }, "responseExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

A new response expression for the function. To remove the response expression, specify an empty string. A function with a Bedrock target and eventBridgeDelivery set to ENABLED must keep a response expression.

" } }, "description": { "target": "com.amazonaws.elementalinference#FunctionDescription", "traits": { "smithy.api#documentation": "

A new description for the function.

" } }, "eventBridgeDelivery": { "target": "com.amazonaws.elementalinference#EventBridgeDeliveryMode", "traits": { "smithy.api#documentation": "

Specifies whether Elemental Inference also sends this function's marked results to Amazon EventBridge, as described for CreateFunction. If you omit this parameter, the current value is kept. While a feed references the function, you can change this value to DISABLED, but not to ENABLED.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#UpdateFunctionResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the function.

", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.elementalinference#FunctionTarget", "traits": { "smithy.api#documentation": "

The destination for the request that the function builds.

", "smithy.api#required": {} } }, "requestExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that builds the request. Elemental Inference evaluates it against the media object of the feed, which holds the media and metadata that the function asked for.

", "smithy.api#length": { "min": 1, "max": 5120 }, "smithy.api#required": {} } }, "responseExpression": { "target": "com.amazonaws.elementalinference#JsonataExpression", "traits": { "smithy.api#documentation": "

The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as its root: the model response for a Bedrock target, or the output of the request expression for a passthrough target. If a function has no response expression, Elemental Inference stores the entire result.

" } }, "description": { "target": "com.amazonaws.elementalinference#FunctionDescription", "traits": { "smithy.api#documentation": "

The description of the function.

" } }, "eventBridgeDelivery": { "target": "com.amazonaws.elementalinference#EventBridgeDeliveryMode", "traits": { "smithy.api#default": "DISABLED", "smithy.api#documentation": "

Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With ENABLED, each result that is a JSON object with a top-level eventBridge field set to true is also sent as a Function Metadata Generated event to the default event bus in your account.

" } }, "arn": { "target": "com.amazonaws.elementalinference#FunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the function.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#FunctionId", "traits": { "smithy.api#documentation": "

The ID of the function.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#FunctionStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The status of the function.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The IDs of the feeds that have a function output, enabled or disabled, that references this function. While this list isn't empty, the function can't be deleted, and its name and target can't be changed.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "contextTypes": { "target": "com.amazonaws.elementalinference#ContextTypeList", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the function.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#UpdateOutput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the output.

", "smithy.api#required": {} } }, "outputConfig": { "target": "com.amazonaws.elementalinference#OutputConfig", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#OutputStatus", "traits": { "smithy.api#documentation": "

The status of the output.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#ResourceDescription", "traits": { "smithy.api#documentation": "

A description of the output.

" } }, "fromAssociation": { "target": "smithy.api#Boolean", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

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.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } } }, "traits": { "smithy.api#documentation": "

Contains configuration information about one output in a feed. It is used in the UpdateFeed action.

" } }, "com.amazonaws.elementalinference#UpdateOutputList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#UpdateOutput" } }, "com.amazonaws.elementalinference#UpdateOutputStatus": { "type": "structure", "members": { "outputName": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The name of the output that you want to enable or disable. The output must exist in the feed when you create the action.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.elementalinference#OutputStatus", "traits": { "smithy.api#documentation": "

Specifies whether the output is enabled or disabled after the action runs.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Enables or disables an output at the action's scheduled time. This is a type of ScheduleActionOperation.

" } }, "com.amazonaws.elementalinference#UpdateQuestionSet": { "type": "operation", "input": { "target": "com.amazonaws.elementalinference#UpdateQuestionSetRequest" }, "output": { "target": "com.amazonaws.elementalinference#UpdateQuestionSetResponse" }, "errors": [ { "target": "com.amazonaws.elementalinference#AccessDeniedException" }, { "target": "com.amazonaws.elementalinference#ConflictException" }, { "target": "com.amazonaws.elementalinference#InternalServerErrorException" }, { "target": "com.amazonaws.elementalinference#ResourceNotFoundException" }, { "target": "com.amazonaws.elementalinference#TooManyRequestException" }, { "target": "com.amazonaws.elementalinference#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a question set" }, "smithy.api#documentation": "

Updates the DRAFT version of the specified question set. UpdateQuestionSet doesn't create a version and doesn't change published versions. To publish the updated DRAFT as a new version, use CreateQuestionSetVersion.

UpdateQuestionSet replaces questions one type at a time. For each of yesNo, yesNoPerOption, and chooseOne: if you omit the array, DRAFT keeps its questions of that type. If you include the array, it replaces all the questions of that type in DRAFT. If you include an empty array, DRAFT no longer has questions of that type. The updated DRAFT must follow the same rules as in CreateQuestionSet, and Elemental Inference applies those rules to the questions that DRAFT keeps as well as to the questions in the request.

Feeds that reference the DRAFT version use the updated questions. To make sure that the questions for a feed don't change, reference a published version instead.

", "smithy.api#http": { "method": "PATCH", "uri": "/v1/question-set/{id}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.elementalinference#UpdateQuestionSetRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "yesNo": { "target": "com.amazonaws.elementalinference#YesNoQuestionList", "traits": { "smithy.api#documentation": "

An array of questions that Elemental Inference answers with yes or no, to replace all the yesNo questions in DRAFT. You can specify up to 50 yesNo questions. If not specified, the yesNo questions are not changed. To remove all the yesNo questions, specify an empty array.

" } }, "yesNoPerOption": { "target": "com.amazonaws.elementalinference#YesNoPerOptionQuestionList", "traits": { "smithy.api#documentation": "

An array of questions that you ask about each of their options, to replace all the yesNoPerOption questions in DRAFT. You can specify up to 10 yesNoPerOption questions. If not specified, the yesNoPerOption questions are not changed. To remove all the yesNoPerOption questions, specify an empty array.

" } }, "chooseOne": { "target": "com.amazonaws.elementalinference#ChooseOneQuestionList", "traits": { "smithy.api#documentation": "

An array of questions that Elemental Inference answers by choosing one of their options, to replace all the chooseOne questions in DRAFT. You can specify up to 10 chooseOne questions. If not specified, the chooseOne questions are not changed. To remove all the chooseOne questions, specify an empty array.

" } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

A new name for the question set. If not specified, the name is not changed.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elementalinference#UpdateQuestionSetResponse": { "type": "structure", "members": { "yesNo": { "target": "com.amazonaws.elementalinference#YesNoQuestionList", "traits": { "smithy.api#documentation": "

The yesNo questions in this version. Elemental Inference doesn't return this property if the version has no yesNo questions.

" } }, "yesNoPerOption": { "target": "com.amazonaws.elementalinference#YesNoPerOptionQuestionList", "traits": { "smithy.api#documentation": "

The yesNoPerOption questions in this version. Elemental Inference doesn't return this property if the version has no yesNoPerOption questions.

" } }, "chooseOne": { "target": "com.amazonaws.elementalinference#ChooseOneQuestionList", "traits": { "smithy.api#documentation": "

The chooseOne questions in this version. Elemental Inference doesn't return this property if the version has no chooseOne questions.

" } }, "arn": { "target": "com.amazonaws.elementalinference#QuestionSetArn", "traits": { "smithy.api#documentation": "

The ARN of the question set.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.elementalinference#QuestionSetId", "traits": { "smithy.api#documentation": "

The ID of the question set.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.elementalinference#ResourceName", "traits": { "smithy.api#documentation": "

The updated or original name of the question set.

", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The version that this response describes. For UpdateQuestionSet, the version is always DRAFT.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.elementalinference#QuestionSetVersionDescription", "traits": { "smithy.api#documentation": "

The description of the version. Elemental Inference doesn't return this property for UpdateQuestionSet, because the DRAFT version has no description.

" } }, "latestVersion": { "target": "com.amazonaws.elementalinference#QuestionSetVersion", "traits": { "smithy.api#documentation": "

The number of the highest version that you have published for this question set, even if you have since deleted that version. Elemental Inference doesn't return this property if you haven't published a version.

" } }, "sha256": { "target": "com.amazonaws.elementalinference#QuestionSetSha256", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The SHA-256 hash of the DRAFT version after the update, as 64 lowercase hexadecimal characters. The hash covers the name of the question set and its questions, so it changes when you rename the question set. You can specify this value in a CreateQuestionSetVersion request, so that Elemental Inference publishes DRAFT only if it hasn't changed since this update.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "references": { "target": "com.amazonaws.elementalinference#FeedReferences", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A list of feed IDs that reference the DRAFT version of the question set.

", "smithy.api#suppress": [ "UnstableTrait.aws.cloudformation#cfnExcludeProperty" ] } }, "tags": { "target": "com.amazonaws.elementalinference#TagMap", "traits": { "smithy.api#documentation": "

Any tags associated with the question set.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elementalinference#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elementalinference#YesNoPerOptionOptionList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#QuestionOption" }, "traits": { "smithy.api#documentation": "

An array of the options of a yesNoPerOption question.

", "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.elementalinference#YesNoPerOptionQuestion": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#QuestionName", "traits": { "smithy.api#documentation": "

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

", "smithy.api#required": {} } }, "question": { "target": "com.amazonaws.elementalinference#QuestionText", "traits": { "smithy.api#documentation": "

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' \" ( ) - : ; / & %, plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

", "smithy.api#required": {} } }, "options": { "target": "com.amazonaws.elementalinference#YesNoPerOptionOptionList", "traits": { "smithy.api#documentation": "

The options that you ask the question about. You can specify from 1 to 50 options. Each option counts as one item toward the limit of 100 scored items in a version.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A question that you ask Elemental Inference separately about each of its options. Elemental Inference answers yes or no for each option. Word the question so that it fits any of the options. For example, ask Is this overlay visible? with one option for each overlay. You specify it in the yesNoPerOption array of a question set.

" } }, "com.amazonaws.elementalinference#YesNoPerOptionQuestionList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#YesNoPerOptionQuestion" }, "traits": { "smithy.api#documentation": "

An array of YesNoPerOptionQuestion objects.

", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.elementalinference#YesNoQuestion": { "type": "structure", "members": { "name": { "target": "com.amazonaws.elementalinference#QuestionName", "traits": { "smithy.api#documentation": "

A name for the question. The name must be unique among all the questions in the version, across all question types. The name can be up to 64 characters. It must start with a letter or an underscore, and can contain only the letters A-Z and a-z, the digits 0-9, and underscores.

", "smithy.api#required": {} } }, "question": { "target": "com.amazonaws.elementalinference#QuestionText", "traits": { "smithy.api#documentation": "

The text of the question. The text can be up to 256 bytes, encoded in UTF-8. It can contain letters in any language, combining marks, digits, spaces, and the following characters: . , ? ! ' \" ( ) - : ; / & %, plus the curly apostrophe and quotation marks (U+2019, U+201C, and U+201D).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A question that you ask Elemental Inference, which answers with yes or no. You specify it in the yesNo array of a question set.

" } }, "com.amazonaws.elementalinference#YesNoQuestionList": { "type": "list", "member": { "target": "com.amazonaws.elementalinference#YesNoQuestion" }, "traits": { "smithy.api#documentation": "

An array of YesNoQuestion objects.

", "smithy.api#length": { "max": 50 } } } } }