get_domain

ConnectCases.Client.get_domain(**kwargs)

Returns information about a specific domain if it exists.

See also: AWS API Documentation

Request Syntax

response = client.get_domain(
    domainId='string'
)

Parameters

domainId (string) --

[REQUIRED]

The unique identifier of the Cases domain.

Return type

dict

Returns

Response Syntax

{
    'createdTime': datetime(2015, 1, 1),
    'domainArn': 'string',
    'domainId': 'string',
    'domainStatus': 'Active'|'CreationInProgress'|'CreationFailed',
    'name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • createdTime (datetime) --

    The timestamp when the Cases domain was created.

  • domainArn (string) --

    The Amazon Resource Name (ARN) for the Cases domain.

  • domainId (string) --

    The unique identifier of the Cases domain.

  • domainStatus (string) --

    The status of the Cases domain.

  • name (string) --

    The name of the Cases domain.

  • 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) --

Exceptions

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