ConnectHealth / Client / create_domain

create_domain

ConnectHealth.Client.create_domain(**kwargs)

Creates a new Domain for managing HealthAgent resources.

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    name='string',
    kmsKeyArn='string',
    webAppSetupConfiguration={
        'ehrRole': 'string',
        'idcInstanceId': 'string',
        'idcRegion': 'string'
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name for the new Domain.

  • kmsKeyArn (string) – The ARN of the KMS key to use for encrypting data in this Domain.

  • webAppSetupConfiguration (dict) –

    Configuration for the Domain web application. Optional, but if provided all fields are required.

    • ehrRole (string) – [REQUIRED]

      ARN of the IAM role used for EHR operations.

    • idcInstanceId (string) – [REQUIRED]

      The Identity Center instance ID to use for creating the application.

    • idcRegion (string) – [REQUIRED]

      The AWS region where Identity Center is configured.

  • tags (dict) –

    Tags to associate with the Domain.

    • (string) –

      • (string) –

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

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

Exceptions