Amazon Connect Cases

{'fields': {'type': {'Url'}}}

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

See also: AWS API Documentation

Request Syntax

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

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the Cases domain.

type fields:

list

param fields:

[REQUIRED]

A list of unique field identifiers.

• (dict) --

  Object for unique identifier of a field.

  • id (string) -- [REQUIRED]

    Unique identifier of a field.

rtype:

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'
        },
    ]
}

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.

{'type': {'Url'}}

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

See also: AWS API Documentation

Request Syntax

client.create_field(
    description='string',
    domainId='string',
    name='string',
    type='Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'
)

type description:

string

param description:

The description of the field.

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the Cases domain.

type name:

string

param name:

[REQUIRED]

The name of the field.

type type:

string

param type:

[REQUIRED]

Defines the data type, some system constraints, and default display of the field.

rtype:

dict

returns:

Response Syntax

{
    'fieldArn': 'string',
    'fieldId': 'string'
}

Response Structure

• (dict) --

  • fieldArn (string) --

    The Amazon Resource Name (ARN) of the field.

  • fieldId (string) --

    The unique identifier of a field.

{'fields': {'type': {'Url'}}}

Lists all fields in a Cases domain.

See also: AWS API Documentation

Request Syntax

client.list_fields(
    domainId='string',
    maxResults=123,
    nextToken='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the Cases domain.

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'fields': [
        {
            'fieldArn': 'string',
            'fieldId': 'string',
            'name': 'string',
            'namespace': 'System'|'Custom',
            'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • fields (list) --

    List of detailed field information.

    • (dict) --

      Object for the summarized details of the field.

      • fieldArn (string) --

        The Amazon Resource Name (ARN) of the field.

      • fieldId (string) --

        The unique identifier of a field.

      • name (string) --

        Name of the field.

      • namespace (string) --

        The namespace of a field.

      • type (string) --

        The type of a field.

  • nextToken (string) --

    The token for the next set of results. This is null if there are no more results to return.