DescribeRepository
Returns a RepositoryDescription object that contains detailed information
about the requested repository.
Request Syntax
GET /v1/repository?domain=domain&domain-owner=domainOwner&repository=repository HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domain
-
The name of the domain that contains the repository to describe.
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} - repository
-
A string that specifies the name of the requested repository.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern:
[A-Za-z0-9][A-Za-z0-9._\-]{1,99}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"repository": {
"administratorAccount": "string",
"arn": "string",
"createdTime": number,
"description": "string",
"domainName": "string",
"domainOwner": "string",
"externalConnections": [
{
"externalConnectionName": "string",
"packageFormat": "string",
"status": "string"
}
],
"name": "string",
"upstreams": [
{
"repositoryName": "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.
- repository
-
A
RepositoryDescriptionobject that contains the requested repository information.Type: RepositoryDescription 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
- InternalServerException
-
The operation did not succeed because of an error that occurred inside AWS CodeArtifact.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation did not succeed because the resource requested is not found in the service.
HTTP Status Code: 404
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
