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

See also: AWS API Documentation

Request Syntax

response = client.associate_feed(
    id='string',
    associatedResourceName='string',
    outputs=[
        {
            'name': 'string',
            'outputConfig': {
                'cropping': {}
                ,
                'clipping': {
                    'callbackMetadata': 'string'
                }
            },
            '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. 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.

  This field is autopopulated if not provided.

• outputs (list) –

  [REQUIRED]

  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.

  • (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 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.

      Note

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

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • arn (string) –

    The AWS ARN for this association.

  • id (string) –

    An ID for this response. It is unique in Elemental Inference for this AWS account.

Exceptions

• ElementalInference.Client.exceptions.ValidationException

• ElementalInference.Client.exceptions.ResourceNotFoundException

• ElementalInference.Client.exceptions.InternalServerErrorException

• ElementalInference.Client.exceptions.AccessDeniedException

• ElementalInference.Client.exceptions.TooManyRequestException

• ElementalInference.Client.exceptions.ConflictException

• ElementalInference.Client.exceptions.ServiceQuotaExceededException