Skip to content

Deletes a Amazon DataZone domain

Description

Deletes a Amazon DataZone domain.

Usage

datazone_delete_domain(identifier, clientToken, skipDeletionCheck,
  cascadeDelete)

Arguments

  • identifier

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

  • clientToken

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

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

  • 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 get_domain response. You can't use this parameter together with skipDeletionCheck. If you don't specify a value, the default is false.

Value

A list with the following syntax:

list(
  status = "CREATING"|"AVAILABLE"|"CREATION_FAILED"|"DELETING"|"DELETED"|"DELETION_FAILED"
)

Request syntax

svc$delete_domain(
  identifier = "string",
  clientToken = "string",
  skipDeletionCheck = TRUE|FALSE,
  cascadeDelete = TRUE|FALSE
)