ElementalInference / Client / associate_feed

associate_feed

ElementalInference.Client.associate_feed(**kwargs)

Associates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed.

AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don’t include will not be affected by the operation.

Specifically:

  • You can add more outputs to the existing outputs. New outputs will be appended.

  • You can’t modify an existing output (for example to change its name). Instead, use UpdateFeed.

  • You can’t delete an existing output. Instead, use UpdateFeed.

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

See also: AWS API Documentation

Request Syntax

response = client.associate_feed(
    id='string',
    associatedResourceName='string',
    outputs=[
        {
            'name': 'string',
            'outputConfig': {
                'cropping': {}
                ,
                'clipping': {
                    'callbackMetadata': 'string'
                },
                'subtitling': {
                    'language': 'eng'|'eng-au'|'eng-gb'|'eng-us'|'fra'|'ita'|'deu'|'spa'|'por',
                    'aspectRatio': {
                        'width': 123,
                        'height': 123
                    },
                    'dictionary': 'string',
                    'profanityFilter': 'DISABLED'|'CENSOR'|'DROP'
                }
            },
            'status': 'ENABLED'|'DISABLED',
            'description': 'string'
        },
    ],
    dryRun=True|False
)
Parameters:

  • id (string) –

    [REQUIRED]

    The ID of the feed.

  • associatedResourceName (string) –

    [REQUIRED]

    An identifier for the resource. This name must not resemble an ARN.

    The resource is the source media that the feed will process. The name you assign should help you to later identify the source media that belongs to the feed. In this way, you will know which source media to push to the feed (using PutMedia).

    This field is autopopulated if not provided.

  • outputs (list) –

    [REQUIRED]

    An array of one or more outputs that you want to add to this feed now, to supplement any outputs that you specified when you created or updated the feed.

    • (dict) –

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

      • name (string) – [REQUIRED]

        A name for the output.

      • outputConfig (dict) – [REQUIRED]

        A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: cropping, clipping, subtitling.

        • cropping (dict) –

          The output config type that applies to the cropping feature.

        • clipping (dict) –

          The output config type that applies to the clipping feature.

          • callbackMetadata (string) –

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

        • subtitling (dict) –

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

          • language (string) – [REQUIRED]

            The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.

          • aspectRatio (dict) –

            The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.

            • width (integer) – [REQUIRED]

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

            • height (integer) – [REQUIRED]

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

          • dictionary (string) –

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

          • profanityFilter (string) –

            Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).

      • status (string) – [REQUIRED]

        The status to assign to the output.

      • description (string) –

        A description for the output.

  • dryRun (boolean) –

    Set to true if you want to do a dry run of the associate action.

    Elemental Inference will validate that the real request would succeed without actually making any changes. A dry run catches errors such as missing IAM permissions, quota limits exceeded, conflicting outputs, and so on. If the dry run fails, the action returns a 4xx error code. After you’ve fixed the errors, resubmit the request.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string'
}

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the feed.

    • id (string) –

      The ID of the feed.

Exceptions