ElementalInference / Client / update_feed

update_feed¶

ElementalInference.Client.update_feed(**kwargs)¶

Updates the name and/or outputs in a feed.

Request Syntax

response = client.update_feed(
    name='string',
    id='string',
    outputs=[
        {
            'name': 'string',
            'outputConfig': {
                'cropping': {}
                ,
                'clipping': {
                    'callbackMetadata': 'string'
                }
            },
            'status': 'ENABLED'|'DISABLED',
            'description': 'string',
            'fromAssociation': True|False
        },
    ]
)

Parameters:

name (string) –
[REQUIRED]

Required. You can specify the existing name (to leave it unchanged) or a new name.
id (string) –
[REQUIRED]

The ID of the feed to update.
outputs (list) –
[REQUIRED]

Required. You can specify the existing array of outputs (to leave outputs unchanged) or you can specify a new array.
- (dict) –
  
  Contains configuration information about one output in a feed. It is used in the UpdateFeed action.
  - name (string) – [REQUIRED]
    
    The name start here
  - outputConfig (dict) – [REQUIRED]
    
    A typed property for an output in a feed. It is used in the UpdateFeed 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 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 of the output.
  - description (string) –
    
    A description of the output.
  - fromAssociation (boolean) –
    
    This property is set by the service when you add the output to the feed, and indicates how you added the output. True means that you used the AssociateFeed operation. False means that you used the CreateFeed or UpdateFeed operation. Use GetFeed to obtain the value. If the value is True, include this field here with a value of True. If the value is False, omit the field here.

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 updated or original name of the feed.
- id (string) –
  
  The ID of the feed.
- dataEndpoints (list) –
  
  The data endpoints of the feed.
  - (string) –
- outputs (list) –
  
  The array of outputs in the feed. You might have left this array unchanged, or you might have changed it.
  - (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 output.
- association (dict) –
  
  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.
  - associatedResourceName (string) –
    
    The name of the associated resource.
- tags (dict) –
  
  The name of the resource currently associated with the feed, if any.
  - (string) –
    - (string) –

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