ElementalInference / Client / create_feed

create_feed¶

ElementalInference.Client.create_feed(**kwargs)¶

Creates a feed. The feed is the target for live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed.

Request Syntax

response = client.create_feed(
    name='string',
    outputs=[
        {
            'name': 'string',
            'outputConfig': {
                'cropping': {}
                ,
                'clipping': {
                    'callbackMetadata': 'string'
                }
            },
            'status': 'ENABLED'|'DISABLED',
            'description': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)

Parameters:

name (string) –
[REQUIRED]

A name for this feed.
outputs (list) –
[REQUIRED]

An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, an output might represent the crop feature.
- (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.
tags (dict) –
If you want to include tags, add them now. You won’t be able to add them later.
- (string) –
  - (string) –

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) –
  
  A unique ARN that Elemental Inference assigns to the feed.
- name (string) –
  
  The name that you specified.
- id (string) –
  
  A unique ID that Elemental Inference assigns to the feed.
- dataEndpoints (list) –
  
  A unique ARN that Elemental Inference assigns to the feed.
  - (string) –
- outputs (list) –
  
  Data endpoints that Elemental Inference assigns to the feed.
  - (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 current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE.
- association (dict) –
  
  The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed.
  - associatedResourceName (string) –
    
    The name of the associated resource.
- tags (dict) –
  
  Any tags that you included when you created the feed.
  - (string) –
    - (string) –

Exceptions

ElementalInference.Client.exceptions.ValidationException
ElementalInference.Client.exceptions.InternalServerErrorException
ElementalInference.Client.exceptions.AccessDeniedException
ElementalInference.Client.exceptions.TooManyRequestException
ElementalInference.Client.exceptions.ConflictException
ElementalInference.Client.exceptions.ServiceQuotaExceededException