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

ListAllowedRepositoriesForGroup

Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.

Request Syntax


GET /v1/package-group-allowed-repositories?domain=domain&domain-owner=domainOwner&max-results=maxResults&next-token=nextToken&originRestrictionType=originRestrictionType&package-group=packageGroup HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain that contains the package group from which to list allowed repositories.

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}

maxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: \S+

originRestrictionType

The origin configuration restriction type of which to list allowed repositories.

Valid Values: EXTERNAL_UPSTREAM | INTERNAL_UPSTREAM | PUBLISH

Required: Yes

packageGroup

The pattern of the package group from which to list allowed repositories.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "allowedRepositories": [ "string" ],
   "nextToken": "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.

allowedRepositories

The list of allowed repositories for the package group and origin configuration restriction type.

Type: Array of strings

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

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

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: \S+

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