Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdatePackageGroupOriginConfiguration

Updates the package origin configuration for a package group.

The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.

Request Syntax


PUT /v1/package-group-origin-configuration?domain=domain&domain-owner=domainOwner&package-group=packageGroup HTTP/1.1
Content-type: application/json

{
   "addAllowedRepositories": [ 
      { 
         "originRestrictionType": "string",
         "repositoryName": "string"
      }
   ],
   "removeAllowedRepositories": [ 
      { 
         "originRestrictionType": "string",
         "repositoryName": "string"
      }
   ],
   "restrictions": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain which contains the package group for which to update the origin configuration.

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}

packageGroup

The pattern of the package group for which to update the origin configuration.

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

Pattern: [^\p{C}\p{IsWhitespace}]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

addAllowedRepositories

The repository name and restrictions to add to the allowed repository list of the specified package group.

Type: Array of PackageGroupAllowedRepository objects

Required: No

removeAllowedRepositories

The repository name and restrictions to remove from the allowed repository list of the specified package group.

Type: Array of PackageGroupAllowedRepository objects

Required: No

restrictions

The origin configuration settings that determine how package versions can enter repositories.

Type: String to string map

Valid Keys: EXTERNAL_UPSTREAM | INTERNAL_UPSTREAM | PUBLISH

Valid Values: ALLOW | ALLOW_SPECIFIC_REPOSITORIES | BLOCK | INHERIT

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "allowedRepositoryUpdates": { 
      "string" : { 
         "string" : [ "string" ]
      }
   },
   "packageGroup": { 
      "arn": "string",
      "contactInfo": "string",
      "createdTime": number,
      "description": "string",
      "domainName": "string",
      "domainOwner": "string",
      "originConfiguration": { 
         "restrictions": { 
            "string" : { 
               "effectiveMode": "string",
               "inheritedFrom": { 
                  "arn": "string",
                  "pattern": "string"
               },
               "mode": "string",
               "repositoriesCount": number
            }
         }
      },
      "parent": { 
         "arn": "string",
         "pattern": "string"
      },
      "pattern": "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.

allowedRepositoryUpdates

Information about the updated allowed repositories after processing the request.

Type: String to string to array of strings map map

Valid Keys: EXTERNAL_UPSTREAM | INTERNAL_UPSTREAM | PUBLISH

Valid Keys: ADDED | REMOVED

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

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

packageGroup

The package group and information about it after processing the request.

Type: PackageGroupDescription 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

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