DataZone / Client / delete_domain

delete_domain

DataZone.Client.delete_domain(**kwargs)

Deletes a Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

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

  • identifier (string) –

    [REQUIRED]

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

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • skipDeletionCheck (boolean) – 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.

  • cascadeDelete (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • status (string) –

      The status of the domain.

Exceptions