ConnectHealth / Client / get_domain

get_domain

ConnectHealth.Client.get_domain(**kwargs)

Retrieves information about a Domain.

See also: AWS API Documentation

Request Syntax

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

Parameters:

domainId (string) –

[REQUIRED]

The id of the Domain to get

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'arn': 'string',
    'name': 'string',
    'kmsKeyArn': 'string',
    'encryptionContext': {
        'encryptionType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY',
        'kmsKeyArn': 'string'
    },
    'status': 'ACTIVE'|'DELETING'|'DELETED',
    'webAppUrl': 'string',
    'webAppConfiguration': {
        'ehrRole': 'string',
        'idcApplicationId': 'string',
        'idcRegion': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • domainId (string) –

  • arn (string) –

  • name (string) –

  • kmsKeyArn (string) –

  • encryptionContext (dict) –

    • encryptionType (string) –

      The type of encryption key used.

    • kmsKeyArn (string) –

      The ARN of the KMS key. Only present when encryptionType is CUSTOMER_MANAGED_KEY.

  • status (string) –

  • webAppUrl (string) –

  • webAppConfiguration (dict) –

    • ehrRole (string) –

      ARN of the IAM role used for EHR operations.

    • idcApplicationId (string) –

      The Identity Center application ID associated with this Domain.

    • idcRegion (string) –

      The AWS region where Identity Center is configured.

  • createdAt (datetime) –

  • tags (dict) –

    Tags associated with the Domain

    • (string) –

      • (string) –

Exceptions

• ConnectHealth.Client.exceptions.ResourceNotFoundException