Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteDomain

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

Request Syntax


DELETE /v1/domain?domain=domain&domain-owner=domainOwner HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain to delete.

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Required: Yes

domainOwner

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "domain": { 
      "arn": "string",
      "assetSizeBytes": number,
      "createdTime": number,
      "encryptionKey": "string",
      "name": "string",
      "owner": "string",
      "repositoryCount": number,
      "s3BucketArn": "string",
      "status": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

domain

Contains information about the deleted domain after processing the request.

Type: DomainDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The operation did not succeed because of an unauthorized access attempt.

HTTP Status Code: 403

ConflictException

The operation did not succeed because prerequisites are not met.

HTTP Status Code: 409

InternalServerException

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

HTTP Status Code: 500

ThrottlingException

The operation did not succeed because too many requests are sent to the service.

HTTP Status Code: 429

ValidationException

The operation did not succeed because a parameter in the request was sent with an invalid value.

HTTP Status Code: 400