ElementalInference / Client / get_feed

get_feed

ElementalInference.Client.get_feed(**kwargs)

Retrieves information about the specified feed.

See also: AWS API Documentation

Request Syntax

response = client.get_feed(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The ID of the feed to query.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'id': 'string',
    'dataEndpoints': [
        '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',
            'fromAssociation': True|False
        },
    ],
    'status': 'CREATING'|'AVAILABLE'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'ARCHIVED',
    'association': {
        'associatedResourceName': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the feed.

    • name (string) –

      The name of the feed.

    • id (string) –

      The ID of the feed.

    • dataEndpoints (list) –

      The dataEndpoints of the feed.

      • (string) –

    • outputs (list) –

      An array of the outputs in the feed.

      • (dict) –

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

        • name (string) –

          The name of the output.

        • outputConfig (dict) –

          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 will be set: cropping, clipping, subtitling. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • 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) –

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

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

              • height (integer) –

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

          The status of the output.

        • description (string) –

          The description of the output.

        • fromAssociation (boolean) –

          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.

    • status (string) –

      The status of the feed.

    • association (dict) –

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

      • associatedResourceName (string) –

        The name of the associated resource.

    • tags (dict) –

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

      • (string) –

        • (string) –

Exceptions