Amazon CodeArtifact Package#domain&repository&format&package API

openapi: 3.2.0
info:
  version: '2018-09-22'
  x-release: v4
  title: CodeArtifact Package#domain&repository&format&package API
  description: CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: codeartifact
  x-aws-signingName: codeartifact
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeartifact-2018-09-22.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://codeartifact.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodeArtifact multi-region endpoint
- url: https://codeartifact.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodeArtifact multi-region endpoint
- url: http://codeartifact.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodeArtifact endpoint for China (Beijing) and China (Ningxia)
- url: https://codeartifact.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodeArtifact endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Package#domain&repository&format&package
paths:
  /v1/package#domain&repository&format&package:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: DeletePackage
      description: Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackageResult'
              examples:
                DeletePackage200Example:
                  summary: Default DeletePackage 200 response
                  x-microcks-default: true
                  value:
                    deletedPackage:
                      format: npm
                      namespace: my-package
                      package: lodash
                      originConfiguration: example-value
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                DeletePackage480Example:
                  summary: Default DeletePackage 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                DeletePackage481Example:
                  summary: Default DeletePackage 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DeletePackage482Example:
                  summary: Default DeletePackage 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                DeletePackage483Example:
                  summary: Default DeletePackage 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                DeletePackage484Example:
                  summary: Default DeletePackage 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                DeletePackage485Example:
                  summary: Default DeletePackage 485 response
                  x-microcks-default: true
                  value: '500123'
      parameters:
      - name: domain
        in: query
        required: true
        description: The name of the domain that contains the package to delete.
        schema:
          type: string
          pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
          minLength: 2
          maxLength: 50
      - name: domain-owner
        in: query
        required: false
        description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
        schema:
          type: string
          pattern: '[0-9]{12}'
          minLength: 12
          maxLength: 12
      - name: repository
        in: query
        required: true
        description: The name of the repository that contains the package to delete.
        schema:
          type: string
          pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
          minLength: 2
          maxLength: 100
      - name: format
        in: query
        required: true
        description: The format of the requested package to delete.
        schema:
          type: string
          enum:
          - npm
          - pypi
          - maven
          - nuget
          - generic
      - name: namespace
        in: query
        required: false
        description: <p>The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. The namespace is required when deleting Maven package versions. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>.</p> </li> <li> <p> Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>
        schema:
          type: string
          pattern: '[^#/\s]+'
          minLength: 1
          maxLength: 255
      - name: package
        in: query
        required: true
        description: The name of the package to delete.
        schema:
          type: string
          pattern: '[^#/\s]+'
          minLength: 1
          maxLength: 255
      summary: Amazon CodeArtifact Delete Package
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Package#domain&repository&format&package
    get:
      operationId: DescribePackage
      description: Returns a PackageDescription object that contains information about the requested package.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribePackageResult'
              examples:
                DescribePackage200Example:
                  summary: Default DescribePackage 200 response
                  x-microcks-default: true
                  value:
                    package: lodash
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                DescribePackage480Example:
                  summary: Default DescribePackage 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DescribePackage481Example:
                  summary: Default DescribePackage 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                DescribePackage482Example:
                  summary: Default DescribePackage 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                DescribePackage483Example:
                  summary: Default DescribePackage 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                DescribePackage484Example:
                  summary: Default DescribePackage 484 response
                  x-microcks-default: true
                  value: '500123'
      parameters:
      - name: domain
        in: query
        required: true
        description: The name of the domain that contains the repository that contains the package.
        schema:
          type: string
          pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
          minLength: 2
          maxLength: 50
      - name: domain-owner
        in: query
        required: false
        description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
        schema:
          type: string
          pattern: '[0-9]{12}'
          minLength: 12
          maxLength: 12
      - name: repository
        in: query
        required: true
        description: 'The name of the repository that contains the requested package. '
        schema:
          type: string
          pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
          minLength: 2
          maxLength: 100
      - name: format
        in: query
        required: true
        description: A format that specifies the type of the requested package.
        schema:
          type: string
          enum:
          - npm
          - pypi
          - maven
          - nuget
          - generic
      - name: namespace
        in: query
        required: false
        description: <p>The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. The namespace is required when requesting Maven packages. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>
        schema:
          type: string
          pattern: '[^#/\s]+'
          minLength: 1
          maxLength: 255
      - name: package
        in: query
        required: true
        description: The name of the requested package.
        schema:
          type: string
          pattern: '[^#/\s]+'
          minLength: 1
          maxLength: 255
      summary: Amazon CodeArtifact Describe Package
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Package#domain&repository&format&package
    post:
      operationId: PutPackageOriginConfiguration
      description: 'Sets the package origin configuration for a package.


        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 origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.


        PutPackageOriginConfiguration can be called on a package that doesn''t yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutPackageOriginConfigurationResult'
              examples:
                PutPackageOriginConfiguration200Example:
                  summary: Default PutPackageOriginConfiguration 200 response
                  x-microcks-default: true
                  value:
                    originConfiguration: example-value
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                PutPackageOriginConfiguration480Example:
                  summary: Default PutPackageOriginConfiguration 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                PutPackageOriginConfiguration481Example:
                  summary: Default PutPackageOriginConfiguration 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                PutPackageOriginConfiguration482Example:
                  summary: Default PutPackageOriginConfiguration 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                PutPackageOriginConfiguration483Example:
                  summary: Default PutPackageOriginConfiguration 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                PutPackageOriginConfiguration484Example:
                  summary: Default PutPackageOriginConfiguration 484 response
                  x-microcks-default: true
                  value: '500123'
      parameters:
      - name: domain
        in: query
        required: true
        description: The name of the domain that contains the repository that contains the package.
        schema:
          type: string
          pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
          minLength: 2
          maxLength: 50
      - name: domain-owner
        in: query
        required: false
        description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
        schema:
          type: string
          pattern: '[0-9]{12}'
          minLength: 12
          maxLength: 12
      - name: repository
        in: query
        required: true
        description: The name of the repository that contains the package.
        schema:
          type: string
          pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
          minLength: 2
          maxLength: 100
      - name: format
        in: query
        required: true
        description: A format that specifies the type of the package to be updated.
        schema:
          type: string
          enum:
          - npm
          - pypi
          - maven
          - nuget
          - generic
      - name: namespace
        in: query
        required: false
        description: <p>The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>
        schema:
          type: string
          pattern: '[^#/\s]+'
          minLength: 1
          maxLength: 255
      - name: package
        in: query
        required: true
        description: The name of the package to be updated.
        schema:
          type: string
          pattern: '[^#/\s]+'
          minLength: 1
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - restrictions
              properties:
                restrictions:
                  description: Details about the origin restrictions set on the package. The package origin restrictions determine how new versions of a package can be added to a specific repository.
                  type: object
                  properties:
                    publish:
                      allOf:
                      - $ref: '#/components/schemas/AllowPublish'
                      - description: The package origin configuration that determines if new versions of the package can be published directly to the repository.
                    upstream:
                      allOf:
                      - $ref: '#/components/schemas/AllowUpstream'
                      - description: The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.
            examples:
              PutPackageOriginConfigurationRequestExample:
                summary: Default PutPackageOriginConfiguration request
                x-microcks-default: true
                value:
                  restrictions:
                    publish: example-value
                    upstream: example-value
      summary: Amazon CodeArtifact Put Package Origin Configuration
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Package#domain&repository&format&package
components:
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  schemas:
    ThrottlingException: {}
    ConflictException: {}
    PackageOriginConfiguration:
      type: object
      properties:
        restrictions:
          allOf:
          - $ref: '#/components/schemas/PackageOriginRestrictions'
          - description: A <code>PackageOriginRestrictions</code> object that contains information about the upstream and publish package origin configuration for the package.
      description: Details about the package origin configuration of a package.
    ValidationException: {}
    PackageName:
      type: string
      pattern: '[^#/\s]+'
      minLength: 1
      maxLength: 255
    PackageFormat:
      type: string
      enum:
      - npm
      - pypi
      - maven
      - nuget
      - generic
    AllowUpstream:
      type: string
      enum:
      - ALLOW
      - BLOCK
    ResourceNotFoundException: {}
    PackageSummary:
      type: object
      properties:
        format:
          allOf:
          - $ref: '#/components/schemas/PackageFormat'
          - description: ' The format of the package. '
        namespace:
          allOf:
          - $ref: '#/components/schemas/PackageNamespace'
          - description: <p>The namespace of the package. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>
        package:
          allOf:
          - $ref: '#/components/schemas/PackageName'
          - description: ' The name of the package. '
        originConfiguration:
          allOf:
          - $ref: '#/components/schemas/PackageOriginConfiguration'
          - description: A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html">PackageOriginConfiguration</a> object that contains a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html">PackageOriginRestrictions</a> object that contains information about the upstream and publish package origin restrictions.
      description: ' Details about a package, including its format, namespace, and name. '
    InternalServerException: {}
    PackageOriginRestrictions:
      type: object
      required:
      - publish
      - upstream
      properties:
        publish:
          allOf:
          - $ref: '#/components/schemas/AllowPublish'
          - description: The package origin configuration that determines if new versions of the package can be published directly to the repository.
        upstream:
          allOf:
          - $ref: '#/components/schemas/AllowUpstream'
          - description: The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.
      description: Details about the origin restrictions set on the package. The package origin restrictions determine how new versions of a package can be added to a specific repository.
    AllowPublish:
      type: string
      enum:
      - ALLOW
      - BLOCK
    AccessDeniedException: {}
    PutPackageOriginConfigurationResult:
      type: object
      properties:
        originConfiguration:
          allOf:
          - $ref: '#/components/schemas/PackageOriginConfiguration'
          - description: A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html">PackageOriginConfiguration</a> object that describes the origin configuration set for the package. It contains a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html">PackageOriginRestrictions</a> object that describes how new versions of the package can be introduced to the repository.
    DeletePackageResult:
      type: object
      properties:
        deletedPackage:
          $ref: '#/components/schemas/PackageSummary'
    DescribePackageResult:
      type: object
      required:
      - package
      properties:
        package:
          allOf:
          - $ref: '#/components/schemas/PackageDescription'
          - description: A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a> object that contains information about the requested package.
    PackageDescription:
      type: object
      properties:
        format:
          allOf:
          - $ref: '#/components/schemas/PackageFormat'
          - description: A format that specifies the type of the package.
        namespace:
          allOf:
          - $ref: '#/components/schemas/PackageNamespace'
          - description: <p>The namespace of the package. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>
        name:
          allOf:
          - $ref: '#/components/schemas/PackageName'
          - description: The name of the package.
        originConfiguration:
          allOf:
          - $ref: '#/components/schemas/PackageOriginConfiguration'
          - description: The package origin configuration for the package.
      description: Details about a package.
    PackageNamespace:
      type: string
      pattern: '[^#/\s]+'
      minLength: 1
      maxLength: 255
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/codeartifact/
x-hasEquivalentPaths: true