GetRepositoryEndpoint
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
-
cargo
-
generic
-
maven
-
npm
-
nuget
-
pypi
-
ruby
-
swift
Request Syntax
GET /v1/repository/endpoint?domain=domain
&domain-owner=domainOwner
&endpointType=endpointType
&format=format
&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.
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 that contains the repository. It does not include dashes or spaces.
Length Constraints: Fixed length of 12.
Pattern:
[0-9]{12}
- endpointType
-
A string that specifies the type of endpoint.
Valid Values:
dualstack | ipv4
- format
-
Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
Valid Values:
npm | pypi | maven | nuget | generic | ruby | swift | cargo
Required: Yes
- repository
-
The name of the 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
{
"repositoryEndpoint": "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.
- repositoryEndpoint
-
A string that specifies the URL of the returned endpoint.
Type: String
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: