ConnectCases / Client / batch_get_field

batch_get_field#

ConnectCases.Client.batch_get_field(**kwargs)#

Returns the description for the list of fields in the request parameters.

Request Syntax

response = client.batch_get_field(
    domainId='string',
    fields=[
        {
            'id': 'string'
        },
    ]
)

Parameters:

domainId (string) –
[REQUIRED]

The unique identifier of the Cases domain.
fields (list) –
[REQUIRED]

A list of unique field identifiers.
- (dict) –
  
  Object for unique identifier of a field.
  - id (string) – [REQUIRED]
    
    Unique identifier of a field.

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'errorCode': 'string',
            'id': 'string',
            'message': 'string'
        },
    ],
    'fields': [
        {
            'description': 'string',
            'fieldArn': 'string',
            'fieldId': 'string',
            'name': 'string',
            'namespace': 'System'|'Custom',
            'tags': {
                'string': 'string'
            },
            'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User'
        },
    ]
}

Response Structure

(dict) –
- errors (list) –
  
  A list of field errors.
  - (dict) –
    
    Object for errors on fields.
    - errorCode (string) –
      
      The error code from getting a field.
    - id (string) –
      
      The field identifier that caused the error.
    - message (string) –
      
      The error message from getting a field.
- fields (list) –
  
  A list of detailed field information.
  - (dict) –
    
    Object to store detailed field information.
    - description (string) –
      
      Description of the field.
    - fieldArn (string) –
      
      The Amazon Resource Name (ARN) of the field.
    - fieldId (string) –
      
      Unique identifier of the field.
    - name (string) –
      
      Name of the field.
    - namespace (string) –
      
      Namespace of the field.
    - tags (dict) –
      
      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
      - (string) –
        
        (string) –
    - type (string) –
      
      Type of the field.

Exceptions

ConnectCases.Client.exceptions.InternalServerException
ConnectCases.Client.exceptions.ResourceNotFoundException
ConnectCases.Client.exceptions.ValidationException
ConnectCases.Client.exceptions.ThrottlingException
ConnectCases.Client.exceptions.AccessDeniedException