DescribeDomain - AWS CodeArtifact


Returns a DomainDescription object that contains information about the requested domain.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.


A string that specifies the name of the requested domain.

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

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

Required: Yes


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.


Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.

Type: DomainDescription object


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


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

HTTP Status Code: 403


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

HTTP Status Code: 500


The operation did not succeed because the resource requested is not found in the service.

HTTP Status Code: 404


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

HTTP Status Code: 429


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: