DataZone / Client / create_domain

create_domain#

DataZone.Client.create_domain(**kwargs)#

Creates an Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    clientToken='string',
    description='string',
    domainExecutionRole='string',
    domainVersion='V1'|'V2',
    kmsKeyIdentifier='string',
    name='string',
    serviceRole='string',
    singleSignOn={
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL'
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • description (string) – The description of the Amazon DataZone domain.

  • domainExecutionRole (string) –

    [REQUIRED]

    The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

  • domainVersion (string) – The version of the domain that is created.

  • kmsKeyIdentifier (string) – The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

  • name (string) –

    [REQUIRED]

    The name of the Amazon DataZone domain.

  • serviceRole (string) – The service role of the domain that is created.

  • singleSignOn (dict) –

    The single-sign on configuration of the Amazon DataZone domain.

    • type (string) –

      The type of single sign-on in Amazon DataZone.

    • userAssignment (string) –

      The single sign-on user assignment in Amazon DataZone.

  • tags (dict) –

    The tags specified for the Amazon DataZone domain.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'description': 'string',
    'domainExecutionRole': 'string',
    'domainVersion': 'V1'|'V2',
    'id': 'string',
    'kmsKeyIdentifier': 'string',
    'name': 'string',
    'portalUrl': 'string',
    'rootDomainUnitId': 'string',
    'serviceRole': 'string',
    'singleSignOn': {
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL'
    },
    'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the Amazon DataZone domain.

    • description (string) –

      The description of the Amazon DataZone domain.

    • domainExecutionRole (string) –

      The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

    • domainVersion (string) –

      The version of the domain that is created.

    • id (string) –

      The identifier of the Amazon DataZone domain.

    • kmsKeyIdentifier (string) –

      The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

    • name (string) –

      The name of the Amazon DataZone domain.

    • portalUrl (string) –

      The URL of the data portal for this Amazon DataZone domain.

    • rootDomainUnitId (string) –

      The ID of the root domain unit.

    • serviceRole (string) –

      Te service role of the domain that is created.

    • singleSignOn (dict) –

      The single-sign on configuration of the Amazon DataZone domain.

      • type (string) –

        The type of single sign-on in Amazon DataZone.

      • userAssignment (string) –

        The single sign-on user assignment in Amazon DataZone.

    • status (string) –

      The status of the Amazon DataZone domain.

    • tags (dict) –

      The tags specified for the Amazon DataZone domain.

      • (string) –

        • (string) –

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.ResourceNotFoundException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ServiceQuotaExceededException

  • DataZone.Client.exceptions.ConflictException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException