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'
                }
            },
            '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 being queried.

    • id (string) –

      The ID of the feed being queried.

    • dataEndpoints (list) –

      The dataEndpoints of the feed being queried.

      • (string) –

    • outputs (list) –

      An array of the outputs in the feed being queried.

      • (dict) –

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

        • name (string) –

          The ARN of the output.

        • outputConfig (dict) –

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

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: cropping, clipping. 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) –

              The metadata that is the result of the clip request to Elemental Inference.

        • 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 by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.

    • status (string) –

      The status of the feed being queried.

    • association (dict) –

      Information about the resource, if any, associated with the feed being queried.

      • associatedResourceName (string) –

        The name of the associated resource.

    • tags (dict) –

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

      • (string) –

        • (string) –

Exceptions