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

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'domainExecutionRole': 'string',
    'id': 'string',
    'kmsKeyIdentifier': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'portalUrl': 'string',
    'rootDomainUnitId': '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 specified Amazon DataZone domain.

  • createdAt (datetime) –

    The timestamp of when the Amazon DataZone domain was created.

  • description (string) –

    The description of the Amazon DataZone domain.

  • domainExecutionRole (string) –

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

  • id (string) –

    The identifier 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.

  • lastUpdatedAt (datetime) –

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

  • 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 in Amazon Datazone.

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

  • status (string) –

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

• DataZone.Client.exceptions.UnauthorizedException