openapi: 3.0.0
info:
  version: '2018-09-22'
  x-release: v4
  title: CodeArtifact Authorization Token#domain Package#domain&repository&format&package API
  description: '<p> CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client. </p> <p> <b>CodeArtifact Components</b> </p> <p>Use the information in this guide to help you work with the following CodeArtifact components:</p> <ul> <li> <p> <b>Repository</b>: A CodeArtifact repository contains a set of <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version">package versions</a>, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the <b> <code>npm</code> </b> CLI, the Maven CLI (<b> <code>mvn</code> </b>), Python CLIs (<b> <code>pip</code> </b> and <code>twine</code>), and NuGet CLIs (<code>nuget</code> and <code>dotnet</code>).</p> </li> <li> <p> <b>Domain</b>: Repositories are aggregated into a higher-level entity known as a <i>domain</i>. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it''s present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).</p> <p>Each repository is a member of a single domain and can''t be moved to a different domain.</p> <p>The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.</p> <p>Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.</p> </li> <li> <p> <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget">NuGet</a> package formats.</p> <p>In CodeArtifact, a package consists of:</p> <ul> <li> <p>A <i>name</i> (for example, <code>webpack</code> is the name of a popular npm package)</p> </li> <li> <p>An optional namespace (for example, <code>@types</code> in <code>@types/node</code>)</p> </li> <li> <p>A set of versions (for example, <code>1.0.0</code>, <code>1.0.1</code>, <code>1.0.2</code>, etc.)</p> </li> <li> <p> Package-level metadata (for example, npm tags)</p> </li> </ul> </li> <li> <p> <b>Package version</b>: A version of a package, such as <code>@types/node 12.6.9</code>. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the <a href="https://semver.org/">Semantic Versioning specification</a>. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.</p> </li> <li> <p> <b>Upstream repository</b>: One repository is <i>upstream</i> of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.</p> </li> <li> <p> <b>Asset</b>: An individual file stored in CodeArtifact associated with a package version, such as an npm <code>.tgz</code> file or Maven POM and JAR files.</p> </li> </ul> <p>CodeArtifact supports these operations:</p> <ul> <li> <p> <code>AssociateExternalConnection</code>: Adds an existing external connection to a repository. </p> </li> <li> <p> <code>CopyPackageVersions</code>: Copies package versions from one repository to another repository in the same domain.</p> </li> <li> <p> <code>CreateDomain</code>: Creates a domain</p> </li> <li> <p> <code>CreateRepository</code>: Creates a CodeArtifact repository in a domain. </p> </li> <li> <p> <code>DeleteDomain</code>: Deletes a domain. You cannot delete a domain that contains repositories. </p> </li> <li> <p> <code>DeleteDomainPermissionsPolicy</code>: Deletes the resource policy that is set on a domain.</p> </li> <li> <p> <code>DeletePackage</code>: Deletes a package and all associated package versions.</p> </li> <li> <p> <code>DeletePackageVersions</code>: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DeleteRepository</code>: Deletes a repository. </p> </li> <li> <p> <code>DeleteRepositoryPermissionsPolicy</code>: Deletes the resource policy that is set on a repository.</p> </li> <li> <p> <code>DescribeDomain</code>: Returns a <code>DomainDescription</code> object that contains information about the requested domain.</p> </li> <li> <p> <code>DescribePackage</code>: Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a> object that contains details about a package. </p> </li> <li> <p> <code>DescribePackageVersion</code>: Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html">PackageVersionDescription</a> object that contains details about a package version. </p> </li> <li> <p> <code>DescribeRepository</code>: Returns a <code>RepositoryDescription</code> object that contains detailed information about the requested repository. </p> </li> <li> <p> <code>DisposePackageVersions</code>: Disposes versions of a package. A package version with the status <code>Disposed</code> cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DisassociateExternalConnection</code>: Removes an existing external connection from a repository. </p> </li> <li> <p> <code>GetAuthorizationToken</code>: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.</p> </li> <li> <p> <code>GetDomainPermissionsPolicy</code>: Returns the policy of a resource that is attached to the specified domain. </p> </li> <li> <p> <code>GetPackageVersionAsset</code>: Returns the contents of an asset that is in a package version. </p> </li> <li> <p> <code>GetPackageVersionReadme</code>: Gets the readme file or descriptive text for a package version.</p> </li> <li> <p> <code>GetRepositoryEndpoint</code>: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: </p> <ul> <li> <p> <code>maven</code> </p> </li> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>nuget</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> </ul> </li> <li> <p> <code>GetRepositoryPermissionsPolicy</code>: Returns the resource policy that is set on a repository. </p> </li> <li> <p> <code>ListDomains</code>: Returns a list of <code>DomainSummary</code> objects. Each returned <code>DomainSummary</code> object contains information about a domain.</p> </li> <li> <p> <code>ListPackages</code>: Lists the packages in a repository.</p> </li> <li> <p> <code>ListPackageVersionAssets</code>: Lists the assets for a given package version.</p> </li> <li> <p> <code>ListPackageVersionDependencies</code>: Returns a list of the direct dependencies for a package version. </p> </li> <li> <p> <code>ListPackageVersions</code>: Returns a list of package versions for a specified package in a repository.</p> </li> <li> <p> <code>ListRepositories</code>: Returns a list of repositories owned by the Amazon Web Services account that called this method.</p> </li> <li> <p> <code>ListRepositoriesInDomain</code>: Returns a list of the repositories in a domain.</p> </li> <li> <p> <code>PublishPackageVersion</code>: Creates a new package version containing one or more assets.</p> </li> <li> <p> <code>PutDomainPermissionsPolicy</code>: Attaches a resource policy to a domain.</p> </li> <li> <p> <code>PutPackageOriginConfiguration</code>: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.</p> </li> <li> <p> <code>PutRepositoryPermissionsPolicy</code>: Sets the resource policy on a repository that specifies permissions to access it. </p> </li> <li> <p> <code>UpdatePackageVersionsStatus</code>: Updates the status of one or more versions of a package.</p> </li> <li> <p> <code>UpdateRepository</code>: Updates the properties of a repository.</p> </li> </ul>'
  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 <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html">DeletePackageVersions</a> 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 <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a> 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: <p>Sets the package origin configuration for a package.</p> <p>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 <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html">Editing package origin controls</a> in the <i>CodeArtifact User Guide</i>.</p> <p> <code>PutPackageOriginConfiguration</code> 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.</p>
      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:
  schemas:
    InternalServerException: {}
    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.
    AllowUpstream:
      type: string
      enum:
      - ALLOW
      - BLOCK
    PackageFormat:
      type: string
      enum:
      - npm
      - pypi
      - maven
      - nuget
      - generic
    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.
    PackageName:
      type: string
      pattern: '[^#/\s]+'
      minLength: 1
      maxLength: 255
    ValidationException: {}
    DeletePackageResult:
      type: object
      properties:
        deletedPackage:
          $ref: '#/components/schemas/PackageSummary'
    ThrottlingException: {}
    PackageNamespace:
      type: string
      pattern: '[^#/\s]+'
      minLength: 1
      maxLength: 255
    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.
    ConflictException: {}
    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.
    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. '
    ResourceNotFoundException: {}
    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.
  parameters:
    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-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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
  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