DataZone / Client / batch_put_attributes_metadata

batch_put_attributes_metadata¶

DataZone.Client.batch_put_attributes_metadata(**kwargs)¶

Writes the attribute metadata.

Request Syntax

response = client.batch_put_attributes_metadata(
    attributes=[
        {
            'attributeIdentifier': 'string',
            'forms': [
                {
                    'content': 'string',
                    'formName': 'string',
                    'typeIdentifier': 'string',
                    'typeRevision': 'string'
                },
            ]
        },
    ],
    clientToken='string',
    domainIdentifier='string',
    entityIdentifier='string',
    entityType='ASSET'|'LISTING'
)

Parameters:

attributes (list) –
[REQUIRED]

The attributes of the metadata.
- (dict) –
  
  The attribute input.
  - attributeIdentifier (string) – [REQUIRED]
    
    The ID of the attribute.
  - forms (list) – [REQUIRED]
    
    The metadata forms as part of the attribute input.
    - (dict) –
      
      The details of a metadata form.
      - content (string) –
        
        The content of the metadata form.
      - formName (string) – [REQUIRED]
        
        The name of the metadata form.
      - typeIdentifier (string) –
        
        The ID of the metadata form type.
      - typeRevision (string) –
        
        The revision of the metadata form type.
clientToken (string) –
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

This field is autopopulated if not provided.
domainIdentifier (string) –
[REQUIRED]

The domain ID where you want to write the attribute metadata.
entityIdentifier (string) –
[REQUIRED]

The entity ID for which you want to write the attribute metadata.
entityType (string) –
[REQUIRED]

The entity type for which you want to write the attribute metadata.

Return type:

dict

Returns:

Response Syntax

{
    'attributes': [
        {
            'attributeIdentifier': 'string'
        },
    ],
    'errors': [
        {
            'attributeIdentifier': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

(dict) –
- attributes (list) –
  
  The results of the BatchPutAttributeMetadata action.
  - (dict) –
    
    The results of the BatchPutAttribute action.
    - attributeIdentifier (string) –
      
      The attribute ID.
- errors (list) –
  
  The errors generated when the BatchPutAttributeMetadata action is invoked.
  - (dict) –
    
    The attribute error.
    - attributeIdentifier (string) –
      
      The attribute ID as part of the attribute error.
    - code (string) –
      
      The code generated as part of the attribute error.
    - message (string) –
      
      The message generated as part of the attribute error.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ConflictException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException