Amazon CodeArtifact Codeartifact Package Group API

The Codeartifact Package Group API from Amazon CodeArtifact — 1 operation(s) for codeartifact package group.

Business capability
Package Registries & Distribution AE-250.10

Operations 4

POST /v1/package-group Create Package Group #
DELETE /v1/package-group Delete Package Group #
GET /v1/package-group Describe Package Group #
PUT /v1/package-group Update Package Group #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-codeartifact:amazon-codeartifact-package-group-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-codeartifact-package-group-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: CodeArtifact Package Group API
  version: '2018-09-22'
  description: Generated from AWS's published Smithy model for CodeArtifact. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://codeartifact.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Package Group
paths:
  /v1/package-group:
    post:
      operationId: CreatePackageGroup
      summary: Create Package Group
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePackageGroupResult'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackageGroupRequest'
      tags:
      - Package Group
    delete:
      operationId: DeletePackageGroup
      summary: Delete Package Group
      description: Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackageGroupResult'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeletePackageGroupRequest'
      tags:
      - Package Group
    get:
      operationId: DescribePackageGroup
      summary: Describe Package Group
      description: Returns a PackageGroupDescription object that contains information about the requested package group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribePackageGroupResult'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribePackageGroupRequest'
      tags:
      - Package Group
    put:
      operationId: UpdatePackageGroup
      summary: Update Package Group
      description: Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePackageGroupResult'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePackageGroupRequest'
      tags:
      - Package Group
components:
  schemas:
    PackageGroupReference:
      type: object
      properties:
        arn:
          type: string
          description: The ARN of the package group.
        pattern:
          type: string
          description: The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.
    DescribePackageGroupResult:
      type: object
      properties:
        packageGroup:
          $ref: '#/components/schemas/PackageGroupDescription'
    UpdatePackageGroupRequest:
      type: object
      properties:
        domain:
          type: string
          description: The name of the domain which contains the package group to be updated.
        domainOwner:
          type: string
          description: The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
        packageGroup:
          type: string
          description: The pattern of the package group to be updated.
        contactInfo:
          type: string
          description: Contact information which you want to update the requested package group with.
        description:
          type: string
          description: The description you want to update the requested package group with.
      required:
      - domain
      - packageGroup
    UpdatePackageGroupResult:
      type: object
      properties:
        packageGroup:
          $ref: '#/components/schemas/PackageGroupDescription'
    DescribePackageGroupRequest:
      type: object
      properties:
        domain:
          type: string
          description: The name of the domain that contains the package group.
        domainOwner:
          type: string
          description: The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
        packageGroup:
          type: string
          description: The pattern of the requested package group.
      required:
      - domain
      - packageGroup
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource.
        resourceType:
          type: string
          enum:
          - domain
          - repository
          - package
          - package-version
          - asset
          description: The type of Amazon Web Services resource.
      required:
      - message
    CreatePackageGroupResult:
      type: object
      properties:
        packageGroup:
          $ref: '#/components/schemas/PackageGroupDescription'
    PackageGroupOriginConfiguration:
      type: object
      properties:
        restrictions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PackageGroupOriginRestriction'
          description: The origin configuration settings that determine how package versions can enter repositories.
    PackageGroupDescription:
      type: object
      properties:
        arn:
          type: string
          description: The ARN of the package group.
        pattern:
          type: string
          description: The pattern of the package group. The pattern determines which packages are associated with the package group.
        domainName:
          type: string
          description: The name of the domain that contains the package group.
        domainOwner:
          type: string
          description: The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
        createdTime:
          type: string
          format: date-time
          description: A timestamp that represents the date and time the package group was created.
        contactInfo:
          type: string
          description: The contact information of the package group.
        description:
          type: string
          description: The description of the package group.
        originConfiguration:
          $ref: '#/components/schemas/PackageGroupOriginConfiguration'
        parent:
          $ref: '#/components/schemas/PackageGroupReference'
    DeletePackageGroupResult:
      type: object
      properties:
        packageGroup:
          $ref: '#/components/schemas/PackageGroupDescription'
    DeletePackageGroupRequest:
      type: object
      properties:
        domain:
          type: string
          description: The domain that contains the package group to be deleted.
        domainOwner:
          type: string
          description: The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
        packageGroup:
          type: string
          description: The pattern of the package group to be deleted.
      required:
      - domain
      - packageGroup
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The time period, in seconds, to wait before retrying the request.
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CANNOT_PARSE
          - ENCRYPTION_KEY_ERROR
          - FIELD_VALIDATION_FAILED
          - UNKNOWN_OPERATION
          - OTHER
      required:
      - message
    Tag:
      type: object
      properties:
        key:
          type: string
          description: The tag key.
        value:
          type: string
          description: The tag value.
      required:
      - key
      - value
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource.
        resourceType:
          type: string
          enum:
          - domain
          - repository
          - package
          - package-version
          - asset
          description: The type of Amazon Web Services resource.
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource.
        resourceType:
          type: string
          enum:
          - domain
          - repository
          - package
          - package-version
          - asset
          description: The type of Amazon Web Services resource.
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreatePackageGroupRequest:
      type: object
      properties:
        domain:
          type: string
          description: The name of the domain in which you want to create a package group.
        domainOwner:
          type: string
          description: The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
        packageGroup:
          type: string
          description: The pattern of the package group to create. The pattern is also the identifier of the package group.
        contactInfo:
          type: string
          description: The contact information for the created package group.
        description:
          type: string
          description: A description of the package group.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more tag key-value pairs for the package group.
      required:
      - domain
      - packageGroup
    PackageGroupOriginRestriction:
      type: object
      properties:
        mode:
          type: string
          enum:
          - ALLOW
          - ALLOW_SPECIFIC_REPOSITORIES
          - BLOCK
          - INHERIT
          description: The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.
        effectiveMode:
          type: string
          enum:
          - ALLOW
          - ALLOW_SPECIFIC_REPOSITORIES
          - BLOCK
          - INHERIT
          description: The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.
        inheritedFrom:
          $ref: '#/components/schemas/PackageGroupReference'
        repositoriesCount:
          type: integer
          description: The number of repositories in the allowed repository list.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: codeartifact
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/codeartifact/service/2018-09-22/codeartifact-2018-09-22.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)