AssociateExternalConnection - CodeArtifact

AssociateExternalConnection

Adds an existing external connection to a repository. One external connection is allowed per repository.

Note

A repository can have one or more upstream repositories, or an external connection.

Request Syntax

POST /v1/repository/external-connection?domain=domain&domain-owner=domainOwner&external-connection=externalConnection&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. It does not include dashes or spaces.

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

externalConnection

The name of the external connection to add to the repository. The following values are supported:

  • public:npmjs - for the npm public repository.

  • public:pypi - for the Python Package Index.

  • public:maven-central - for Maven Central.

  • public:maven-googleandroid - for the Google Android repository.

  • public:maven-gradleplugins - for the Gradle plugins repository.

  • public:maven-commonsware - for the CommonsWare Android repository.

Pattern: [A-Za-z0-9][A-Za-z0-9._\-:]{1,99}

Required: Yes

repository

The name of the repository to which the external connection is added.

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", "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

Information about the connected repository after processing the request.

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

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

ResourceNotFoundException

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

HTTP Status Code: 404

ServiceQuotaExceededException

The operation did not succeed because it would have exceeded a service limit for your account.

HTTP Status Code: 402

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: