UpdateRepository - AWS CodeArtifact

Update the properties of a repository.

Request Syntax

PUT /v1/repository?domain=domain&domain-owner=domainOwner&repository=repository HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "upstreams": [ 
      { 
         "repositoryName": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain associated with the repository to update.

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

The name of the repository to update.

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 accepts the following data in JSON format.

description

An updated repository description.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: \P{C}*

Required: No

upstreams

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

Type: Array of UpstreamRepository objects

Required: No

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.

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.

resourceId: The ID of the resource.
resourceType: The type of AWS resource.

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.

resourceId: The ID of the resource.
resourceType: The type of AWS resource.

HTTP Status Code: 404

ServiceQuotaExceededException

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

resourceId: The ID of the resource.
resourceType: The type of AWS resource.

HTTP Status Code: 402

ThrottlingException

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

retryAfterSeconds: The time period, in seconds, to wait before retrying the request.

HTTP Status Code: 429

ValidationException

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