AWS cli documentation change
Summary
Updated AssociateFeed command documentation to add new subtitling feature, clarify operation behavior, and update navigation links. Added detailed parameters for subtitling including language support, aspect ratio, custom dictionaries, and profanity filtering options.
Security assessment
The change introduces a profanity filter option (DISABLED/CENSOR/DROP) for subtitling, which is a security control for content moderation. However, there's no evidence of a specific security vulnerability being fixed. The change primarily documents new features and operational clarifications.
Diff
diff --git a/cli/latest/reference/elementalinference/associate-feed.md b/cli/latest/reference/elementalinference/associate-feed.md index 4764a566f..e5eaa1e1f 100644 --- a//cli/latest/reference/elementalinference/associate-feed.md +++ b//cli/latest/reference/elementalinference/associate-feed.md @@ -13 +13 @@ - * [next](create-feed.html "create-feed") | + * [next](create-dictionary.html "create-dictionary") | @@ -15 +15 @@ - * [AWS CLI 2.34.53 Command Reference](../../index.html) » + * [AWS CLI 2.34.55 Command Reference](../../index.html) » @@ -23 +23 @@ - * [create-feed →](create-feed.html "next chapter \(use the right arrow\)") + * [create-dictionary →](create-dictionary.html "next chapter \(use the right arrow\)") @@ -59 +59,13 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Associates a resource with the feed. The resource provides the input that Elemental Inference needs needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. +Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed. + +AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don’t include will not be affected by the operation. + +Specifically: + + * You can add more outputs to the existing outputs. New outputs will be appended. + * You can’t modify an existing output (for example to change its name). Instead, use UpdateFeed. + * You can’t delete an existing output. Instead, use UpdateFeed. + + + +Also note that you can’t change the feed name with AssociateFeed. Instead, use UpdateFeed. @@ -108 +120,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elemen -> An identifier for the resource. If the resource is from an AWS service, this identifier must be the full ARN of that resource. Otherwise, the identifier is a name that you assign and that is appropriate for the application that owns the resource. This name must not resemble an ARN. +> 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). @@ -120 +134 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elemen -> The outputs to add to this feed. You must specify at least one output. You can later use the UpdateFeed action to change the list of outputs. +> 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. @@ -138 +152 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elemen ->>> A typed property for an output in a feed. It is used in the CreateFeed and AssociateFeed actions. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. +>>> 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. @@ -142 +156 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elemen ->>> This is a Tagged Union structure. Only one of the following top level keys can be set: `cropping`, `clipping`. +>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `cropping`, `clipping`, `subtitling`. @@ -154 +168 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elemen ->>>>> The metadata that is the result of the clip request to Elemental Inference. +>>>>> 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. @@ -162,0 +177,58 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elemen +>>> +>>> subtitling -> (structure) +>>> +>>>> The output config type that applies to the smart subtitling feature. +>>>> +>>>> language -> (string) [required] +>>>> +>>>>> The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por. +>>>>> +>>>>> Possible values: +>>>>> +>>>>> * `eng` +>>>>> * `eng-au` +>>>>> * `eng-gb` +>>>>> * `eng-us` +>>>>> * `fra` +>>>>> * `ita` +>>>>> * `deu` +>>>>> * `spa` +>>>>> * `por` +>>>>> + +>>>> +>>>> aspectRatio -> (structure) +>>>> +>>>>> The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths. +>>>>> +>>>>> width -> (integer) [required] +>>>>> +>>>>>> The width component of the aspect ratio (for example, 16 in a 16:9 ratio). +>>>>> +>>>>> height -> (integer) [required] +>>>>> +>>>>>> The height component of the aspect ratio (for example, 9 in a 16:9 ratio). +>>>> +>>>> dictionary -> (string) +>>>> +>>>>> The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary. +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `19` +>>>>> * pattern: `[a-zA-Z0-9]+` +>>>>> + +>>>> +>>>> profanityFilter -> (string) +>>>> +>>>>> Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript). +>>>>> +>>>>> Possible values: +>>>>> +>>>>> * `DISABLED` +>>>>> * `CENSOR` +>>>>> * `DROP` +>>>>> + @@ -187,6 +258,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elemen -Shorthand Syntax: - - - name=string,outputConfig={cropping={},clipping={callbackMetadata=string}},status=string,description=string ... - - @@ -204,0 +271,9 @@ JSON Syntax: + }, + "subtitling": { + "language": "eng"|"eng-au"|"eng-gb"|"eng-us"|"fra"|"ita"|"deu"|"spa"|"por", + "aspectRatio": { + "width": integer, + "height": integer + }, + "dictionary": "string", + "profanityFilter": "DISABLED"|"CENSOR"|"DROP" @@ -216,0 +292,2 @@ JSON Syntax: +> +> 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. @@ -333 +410 @@ arn -> (string) -> The AWS ARN for this association. +> The ARN of the feed. @@ -337 +414 @@ id -> (string) -> An ID for this response. It is unique in Elemental Inference for this AWS account. +> The ID of the feed. @@ -346 +423 @@ id -> (string) - * [create-feed →](create-feed.html "next chapter \(use the right arrow\)") + * [create-dictionary →](create-dictionary.html "next chapter \(use the right arrow\)") @@ -353 +430 @@ id -> (string) - * [next](create-feed.html "create-feed") | + * [next](create-dictionary.html "create-dictionary") | @@ -355 +432 @@ id -> (string) - * [AWS CLI 2.34.53 Command Reference](../../index.html) » + * [AWS CLI 2.34.55 Command Reference](../../index.html) »