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

CreatePackageGroup

Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.

Request Syntax


POST /v1/package-group?domain=domain&domain-owner=domainOwner HTTP/1.1
Content-type: application/json

{
   "contactInfo": "string",
   "description": "string",
   "packageGroup": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain in which you want to create a package group.

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}

Request Body

The request accepts the following data in JSON format.

contactInfo

The contact information for the created package group.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: \P{C}*

Required: No

description

A description of the package group.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: \P{C}*

Required: No

packageGroup

The pattern of the package group to create. The pattern is also the identifier of the package group.

Type: String

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

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

Required: Yes

tags

One or more tag key-value pairs for the package group.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "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.

packageGroup

Information about the created package group 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

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