DataZone / Client / get_domain

get_domain

DataZone.Client.get_domain(**kwargs)

Gets an Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

response = client.get_domain(
    identifier='string'
)
Parameters:

identifier (string) –

[REQUIRED]

The identifier of the specified Amazon DataZone domain.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'rootDomainUnitId': 'string',
    'name': 'string',
    'description': 'string',
    'singleSignOn': {
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL',
        'idcInstanceArn': 'string'
    },
    'domainExecutionRole': 'string',
    'arn': 'string',
    'kmsKeyIdentifier': 'string',
    'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
    'portalUrl': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'domainVersion': 'V1'|'V2',
    'serviceRole': 'string',
    'failureReasons': [
        {
            'id': 'string',
            'message': 'string'
        },
    ],
    'deleteProgress': {
        'successfullyDeletedProjectCount': 123
    }
}

Response Structure

  • (dict) –

    • id (string) –

      The identifier of the specified Amazon DataZone domain.

    • rootDomainUnitId (string) –

      The ID of the root domain in Amazon Datazone.

    • name (string) –

      The name of the Amazon DataZone domain.

    • description (string) –

      The description of the Amazon DataZone domain.

    • singleSignOn (dict) –

      The single sing-on option of the specified 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.

      • idcInstanceArn (string) –

        The ARN of the IDC instance.

    • domainExecutionRole (string) –

      The domain execution role with which the Amazon DataZone domain is created.

    • arn (string) –

      The ARN of the specified 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.

    • status (string) –

      The status of the specified Amazon DataZone domain.

    • portalUrl (string) –

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

    • createdAt (datetime) –

      The timestamp of when the Amazon DataZone domain was created.

    • lastUpdatedAt (datetime) –

      The timestamp of when the Amazon DataZone domain was last updated.

    • tags (dict) –

      The tags specified for the Amazon DataZone domain.

      • (string) –

        • (string) –

    • domainVersion (string) –

      The version of the domain.

    • serviceRole (string) –

      The service role of the domain.

    • failureReasons (list) –

      The list of failure reasons for resources that Amazon DataZone could not delete during a cascade deletion of the domain.

      • (dict) –

        The details of a resource deletion failure during a cascade deletion of the domain.

        • id (string) –

          The identifier of the resource that failed to delete.

        • message (string) –

          The error message associated with the resource that failed to delete.

    • deleteProgress (dict) –

      The progress of the current domain deletion, including the number of projects that Amazon DataZone successfully deleted.

      • successfullyDeletedProjectCount (integer) –

        The number of projects that Amazon DataZone successfully deleted during the domain deletion.

Exceptions