Amazon DataZone

{'cascadeDelete': 'boolean'}

Deletes a Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

client.delete_domain(
    identifier='string',
    clientToken='string',
    skipDeletionCheck=True|False,
    cascadeDelete=True|False
)

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the Amazon Web Services domain that is to be deleted.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type skipDeletionCheck:

boolean

param skipDeletionCheck:

Specifies whether to skip the check that prevents deletion of a domain that still contains resources. When you use this parameter, Amazon DataZone deletes the domain but might not remove its associated resources, which can leave orphaned resources behind. To delete a domain and fully clean up its associated resources, use cascadeDelete instead. You can't use this parameter together with cascadeDelete.

type cascadeDelete:

boolean

param cascadeDelete:

Specifies whether to delete the domain along with all of its associated resources. When you use this parameter, Amazon DataZone deletes the domain and cleanly removes its associated resources without leaving orphaned resources behind. Amazon DataZone reports deletion progress in the deleteProgress field. Amazon DataZone reports any resources that it can't delete in the failureReasons field of the GetDomain response. You can't use this parameter together with skipDeletionCheck. If you don't specify a value, the default is false.

rtype:

dict

returns:

Response Syntax

{
    'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'
}

Response Structure

• (dict) --

  • status (string) --

    The status of the domain.

{'deleteProgress': {'successfullyDeletedProjectCount': 'integer'},
 'failureReasons': [{'id': 'string', 'message': 'string'}]}

Gets an Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

client.get_domain(
    identifier='string'
)

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the specified Amazon DataZone domain.

rtype:

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.