openapi: 3.0.0 info: version: '2018-09-22' x-release: v4 title: CodeArtifact Authorization Token#domain 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. 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.

CodeArtifact Components

Use the information in this guide to help you work with the following CodeArtifact components:

CodeArtifact supports these operations:

' 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 paths: /v1/package/versions/copy#domain&source-repository&destination-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' post: operationId: CopyPackageVersions description:

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CopyPackageVersionsResult' examples: CopyPackageVersions200Example: summary: Default CopyPackageVersions 200 response x-microcks-default: true value: successfulVersions: 1.0.0 failedVersions: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: CopyPackageVersions480Example: summary: Default CopyPackageVersions 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CopyPackageVersions481Example: summary: Default CopyPackageVersions 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CopyPackageVersions482Example: summary: Default CopyPackageVersions 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: CopyPackageVersions483Example: summary: Default CopyPackageVersions 483 response x-microcks-default: true value: example-value '484': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' examples: CopyPackageVersions484Example: summary: Default CopyPackageVersions 484 response x-microcks-default: true value: example-value '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: CopyPackageVersions485Example: summary: Default CopyPackageVersions 485 response x-microcks-default: true value: example-value '486': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: CopyPackageVersions486Example: summary: Default CopyPackageVersions 486 response x-microcks-default: true value: '500123' parameters: - name: domain in: query required: true description: ' The name of the domain that contains the source and destination repositories. ' 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: source-repository in: query required: true description: ' The name of the repository that contains the package versions to be copied. ' schema: type: string pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}' minLength: 2 maxLength: 100 - name: destination-repository in: query required: true description: ' The name of the repository into which package versions are copied. ' 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 package versions to be copied. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package that contains the versions to be copied. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: versions: description:

The versions of the package to be copied.

You must specify versions or versionRevisions. You cannot specify both.

type: array items: $ref: '#/components/schemas/PackageVersion' maxItems: 100 versionRevisions: description:

A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

You must specify versions or versionRevisions. You cannot specify both.

type: object additionalProperties: $ref: '#/components/schemas/PackageVersionRevision' allowOverwrite: description: ' Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code. ' type: boolean includeFromUpstream: description: ' Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories. ' type: boolean examples: CopyPackageVersionsRequestExample: summary: Default CopyPackageVersions request x-microcks-default: true value: versions: - 1.0.0 versionRevisions: {} allowOverwrite: true includeFromUpstream: true summary: Amazon CodeArtifact Copy Package Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/versions/delete#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' post: operationId: DeletePackageVersions description: ' Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don''t show up with list package APIs (for example, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeletePackageVersionsResult' examples: DeletePackageVersions200Example: summary: Default DeletePackageVersions 200 response x-microcks-default: true value: successfulVersions: 1.0.0 failedVersions: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeletePackageVersions480Example: summary: Default DeletePackageVersions 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DeletePackageVersions481Example: summary: Default DeletePackageVersions 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeletePackageVersions482Example: summary: Default DeletePackageVersions 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeletePackageVersions483Example: summary: Default DeletePackageVersions 483 response x-microcks-default: true value: example-value '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DeletePackageVersions484Example: summary: Default DeletePackageVersions 484 response x-microcks-default: true value: example-value '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DeletePackageVersions485Example: summary: Default DeletePackageVersions 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 versions 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 package versions to delete. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package versions to be deleted. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package with the versions to delete. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - versions properties: versions: description: ' An array of strings that specify the versions of the package to delete. ' type: array items: $ref: '#/components/schemas/PackageVersion' maxItems: 100 expectedStatus: description: ' The expected status of the package version to delete. ' type: string enum: - Published - Unfinished - Unlisted - Archived - Disposed - Deleted examples: DeletePackageVersionsRequestExample: summary: Default DeletePackageVersions request x-microcks-default: true value: versions: - 1.0.0 expectedStatus: Published summary: Amazon CodeArtifact Delete Package Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/version#domain&repository&format&package&version: 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' get: operationId: DescribePackageVersion description: ' Returns a PackageVersionDescription object that contains information about the requested package version. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribePackageVersionResult' examples: DescribePackageVersion200Example: summary: Default DescribePackageVersion 200 response x-microcks-default: true value: packageVersion: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DescribePackageVersion480Example: summary: Default DescribePackageVersion 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DescribePackageVersion481Example: summary: Default DescribePackageVersion 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribePackageVersion482Example: summary: Default DescribePackageVersion 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribePackageVersion483Example: summary: Default DescribePackageVersion 483 response x-microcks-default: true value: example-value '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DescribePackageVersion484Example: summary: Default DescribePackageVersion 484 response x-microcks-default: true value: example-value '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DescribePackageVersion485Example: summary: Default DescribePackageVersion 485 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 version. ' 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 version. ' 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 version. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the requested package version. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the requested package version. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: version in: query required: true description: ' A string that contains the package version (for example, 3.5.2). ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 summary: Amazon CodeArtifact Describe Package Version x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/versions/dispose#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' post: operationId: DisposePackageVersions description:

Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.

To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed.

To view information about a disposed package version, use DescribePackageVersion.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisposePackageVersionsResult' examples: DisposePackageVersions200Example: summary: Default DisposePackageVersions 200 response x-microcks-default: true value: successfulVersions: 1.0.0 failedVersions: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DisposePackageVersions480Example: summary: Default DisposePackageVersions 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DisposePackageVersions481Example: summary: Default DisposePackageVersions 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DisposePackageVersions482Example: summary: Default DisposePackageVersions 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DisposePackageVersions483Example: summary: Default DisposePackageVersions 483 response x-microcks-default: true value: example-value '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DisposePackageVersions484Example: summary: Default DisposePackageVersions 484 response x-microcks-default: true value: example-value '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DisposePackageVersions485Example: summary: Default DisposePackageVersions 485 response x-microcks-default: true value: '500123' parameters: - name: domain in: query required: true description: ' The name of the domain that contains the repository you want to dispose. ' 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 versions you want to dispose. ' 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 package versions you want to dispose. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package versions to be disposed. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package with the versions you want to dispose. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - versions properties: versions: description: ' The versions of the package you want to dispose. ' type: array items: $ref: '#/components/schemas/PackageVersion' maxItems: 100 versionRevisions: description: ' The revisions of the package versions you want to dispose. ' type: object additionalProperties: $ref: '#/components/schemas/PackageVersionRevision' expectedStatus: description: ' The expected status of the package version to dispose. ' type: string enum: - Published - Unfinished - Unlisted - Archived - Disposed - Deleted examples: DisposePackageVersionsRequestExample: summary: Default DisposePackageVersions request x-microcks-default: true value: versions: - 1.0.0 versionRevisions: {} expectedStatus: Published summary: Amazon CodeArtifact Dispose Package Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/version/asset#domain&repository&format&package&version&asset: 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' get: operationId: GetPackageVersionAsset description: ' Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPackageVersionAssetResult' examples: GetPackageVersionAsset200Example: summary: Default GetPackageVersionAsset 200 response x-microcks-default: true value: asset: example-value '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetPackageVersionAsset480Example: summary: Default GetPackageVersionAsset 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetPackageVersionAsset481Example: summary: Default GetPackageVersionAsset 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetPackageVersionAsset482Example: summary: Default GetPackageVersionAsset 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetPackageVersionAsset483Example: summary: Default GetPackageVersionAsset 483 response x-microcks-default: true value: example-value '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetPackageVersionAsset484Example: summary: Default GetPackageVersionAsset 484 response x-microcks-default: true value: '500123' '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: GetPackageVersionAsset485Example: summary: Default GetPackageVersionAsset 485 response x-microcks-default: true value: example-value parameters: - name: domain in: query required: true description: ' The name of the domain that contains the repository that contains the package version with the requested asset. ' 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 repository that contains the package version with the requested asset. ' 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 version with the requested asset file. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package version with the requested asset file. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package that contains the requested asset. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: version in: query required: true description: ' A string that contains the package version (for example, 3.5.2). ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: asset in: query required: true description: ' The name of the requested asset. ' schema: type: string pattern: \P{C}+ minLength: 1 maxLength: 255 - name: revision in: query required: false description: ' The name of the package version revision that contains the requested asset. ' schema: type: string pattern: \S+ minLength: 1 maxLength: 50 summary: Amazon CodeArtifact Get Package Version Asset x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/version/readme#domain&repository&format&package&version: 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' get: operationId: GetPackageVersionReadme description:

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPackageVersionReadmeResult' examples: GetPackageVersionReadme200Example: summary: Default GetPackageVersionReadme 200 response x-microcks-default: true value: format: npm namespace: my-package package: lodash version: 1.0.0 versionRevision: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetPackageVersionReadme480Example: summary: Default GetPackageVersionReadme 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetPackageVersionReadme481Example: summary: Default GetPackageVersionReadme 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetPackageVersionReadme482Example: summary: Default GetPackageVersionReadme 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetPackageVersionReadme483Example: summary: Default GetPackageVersionReadme 483 response x-microcks-default: true value: example-value '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetPackageVersionReadme484Example: summary: Default GetPackageVersionReadme 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 version with the requested readme file. ' 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 repository that contains the package with the requested readme file. ' 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 version with the requested readme file. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package version with the requested readme file. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package version that contains the requested readme file. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: version in: query required: true description: ' A string that contains the package version (for example, 3.5.2). ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 summary: Amazon CodeArtifact Get Package Version Readme x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/version/assets#domain&repository&format&package&version: 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' post: operationId: ListPackageVersionAssets description: ' Returns a list of AssetSummary objects for assets in a package version. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPackageVersionAssetsResult' examples: ListPackageVersionAssets200Example: summary: Default ListPackageVersionAssets 200 response x-microcks-default: true value: format: npm namespace: my-package package: lodash version: 1.0.0 versionRevision: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListPackageVersionAssets480Example: summary: Default ListPackageVersionAssets 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListPackageVersionAssets481Example: summary: Default ListPackageVersionAssets 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListPackageVersionAssets482Example: summary: Default ListPackageVersionAssets 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListPackageVersionAssets483Example: summary: Default ListPackageVersionAssets 483 response x-microcks-default: true value: example-value '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListPackageVersionAssets484Example: summary: Default ListPackageVersionAssets 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 associated with the package version assets. ' 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 that contains the requested package version assets. ' 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 package that contains the requested package version assets. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package version that contains the requested package version assets. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package that contains the requested package version assets. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: version in: query required: true description: ' A string that contains the package version (for example, 3.5.2). ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: max-results in: query required: false description: ' The maximum number of results to return per page. ' schema: type: integer minimum: 1 maximum: 1000 - name: next-token in: query required: false description: ' The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. ' schema: type: string pattern: \S+ minLength: 1 maxLength: 2000 - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false summary: Amazon CodeArtifact List Package Version Assets x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/version/dependencies#domain&repository&format&package&version: 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' post: operationId: ListPackageVersionDependencies description: ' Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPackageVersionDependenciesResult' examples: ListPackageVersionDependencies200Example: summary: Default ListPackageVersionDependencies 200 response x-microcks-default: true value: format: npm namespace: my-package package: lodash version: 1.0.0 versionRevision: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListPackageVersionDependencies480Example: summary: Default ListPackageVersionDependencies 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListPackageVersionDependencies481Example: summary: Default ListPackageVersionDependencies 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListPackageVersionDependencies482Example: summary: Default ListPackageVersionDependencies 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListPackageVersionDependencies483Example: summary: Default ListPackageVersionDependencies 483 response x-microcks-default: true value: example-value '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListPackageVersionDependencies484Example: summary: Default ListPackageVersionDependencies 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 requested package version dependencies. ' 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 version. ' 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 package with the requested dependencies. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package version with the requested dependencies. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package versions'' package. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: version in: query required: true description: ' A string that contains the package version (for example, 3.5.2). ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: next-token in: query required: false description: ' The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. ' schema: type: string pattern: \S+ minLength: 1 maxLength: 2000 summary: Amazon CodeArtifact List Package Version Dependencies x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/versions#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' post: operationId: ListPackageVersions description: ' Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPackageVersionsResult' examples: ListPackageVersions200Example: summary: Default ListPackageVersions 200 response x-microcks-default: true value: defaultDisplayVersion: 1.0.0 format: npm namespace: my-package package: lodash versions: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListPackageVersions480Example: summary: Default ListPackageVersions 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListPackageVersions481Example: summary: Default ListPackageVersions 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListPackageVersions482Example: summary: Default ListPackageVersions 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListPackageVersions483Example: summary: Default ListPackageVersions 483 response x-microcks-default: true value: example-value '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListPackageVersions484Example: summary: Default ListPackageVersions 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 requested package versions. ' 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 versions. ' 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 package versions you want to list. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package for which you want to request package versions. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: status in: query required: false description: ' A string that filters the requested package versions by status. ' schema: type: string enum: - Published - Unfinished - Unlisted - Archived - Disposed - Deleted - name: sortBy in: query required: false description: ' How to sort the requested list of package versions. ' schema: type: string enum: - PUBLISHED_TIME - name: max-results in: query required: false description: ' The maximum number of results to return per page. ' schema: type: integer minimum: 1 maximum: 1000 - name: next-token in: query required: false description: ' The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. ' schema: type: string pattern: \S+ minLength: 1 maxLength: 2000 - name: originType in: query required: false description: The originType used to filter package versions. Only package versions with the provided originType will be returned. schema: type: string enum: - INTERNAL - EXTERNAL - UNKNOWN - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false summary: Amazon CodeArtifact List Package Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/version/publish#domain&repository&format&package&version&asset&x-amz-content-sha256: 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' post: operationId: PublishPackageVersion description:

Creates a new package version containing one or more assets (or files).

The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished.

Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PublishPackageVersionResult' examples: PublishPackageVersion200Example: summary: Default PublishPackageVersion 200 response x-microcks-default: true value: format: npm namespace: my-package package: lodash version: 1.0.0 versionRevision: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: PublishPackageVersion480Example: summary: Default PublishPackageVersion 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: PublishPackageVersion481Example: summary: Default PublishPackageVersion 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: PublishPackageVersion482Example: summary: Default PublishPackageVersion 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: PublishPackageVersion483Example: summary: Default PublishPackageVersion 483 response x-microcks-default: true value: example-value '484': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' examples: PublishPackageVersion484Example: summary: Default PublishPackageVersion 484 response x-microcks-default: true value: example-value '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: PublishPackageVersion485Example: summary: Default PublishPackageVersion 485 response x-microcks-default: true value: example-value '486': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: PublishPackageVersion486Example: summary: Default PublishPackageVersion 486 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 version to publish. 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 AWS 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 the package version will be published to. 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 version with the requested asset file.

The only supported value is generic.

schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description: The namespace of the package version to publish. schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: The name of the package version to publish. schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: version in: query required: true description: The package version to publish (for example, 3.5.2). schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: asset in: query required: true description: 'The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . ` ' schema: type: string pattern: \P{C}+ minLength: 1 maxLength: 255 - name: x-amz-content-sha256 in: header required: true description:

The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide).

This value is used as an integrity check to verify that the assetContent has not changed after it was originally sent.

schema: type: string pattern: '[0-9a-f]+' minLength: 64 maxLength: 64 - name: unfinished in: query required: false description: '

Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide).

Valid values: unfinished

' schema: type: boolean requestBody: required: true content: application/json: schema: type: object required: - assetContent properties: assetContent: description: The content of the asset to publish. type: string examples: PublishPackageVersionRequestExample: summary: Default PublishPackageVersion request x-microcks-default: true value: assetContent: example-value summary: Amazon CodeArtifact Publish Package Version x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package /v1/package/versions/update_status#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' post: operationId: UpdatePackageVersionsStatus description: ' Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdatePackageVersionsStatusResult' examples: UpdatePackageVersionsStatus200Example: summary: Default UpdatePackageVersionsStatus 200 response x-microcks-default: true value: successfulVersions: 1.0.0 failedVersions: 1.0.0 '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdatePackageVersionsStatus480Example: summary: Default UpdatePackageVersionsStatus 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdatePackageVersionsStatus481Example: summary: Default UpdatePackageVersionsStatus 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UpdatePackageVersionsStatus482Example: summary: Default UpdatePackageVersionsStatus 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdatePackageVersionsStatus483Example: summary: Default UpdatePackageVersionsStatus 483 response x-microcks-default: true value: example-value '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: UpdatePackageVersionsStatus484Example: summary: Default UpdatePackageVersionsStatus 484 response x-microcks-default: true value: example-value '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdatePackageVersionsStatus485Example: summary: Default UpdatePackageVersionsStatus 485 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 versions with a status to be updated. ' 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 repository that contains the package versions with the status you want to update. ' 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 with the statuses to update. ' schema: type: string enum: - npm - pypi - maven - nuget - generic - name: namespace in: query required: false description:

The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:

schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 - name: package in: query required: true description: ' The name of the package with the version statuses to update. ' schema: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - versions - targetStatus properties: versions: description: ' An array of strings that specify the versions of the package with the statuses to update. ' type: array items: $ref: '#/components/schemas/PackageVersion' maxItems: 100 versionRevisions: description: ' A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision. ' type: object additionalProperties: $ref: '#/components/schemas/PackageVersionRevision' expectedStatus: description: ' The package version’s expected status before it is updated. If expectedStatus is provided, the package version''s status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus. ' type: string enum: - Published - Unfinished - Unlisted - Archived - Disposed - Deleted targetStatus: description: ' The status you want to change the package version status to. ' type: string enum: - Published - Unfinished - Unlisted - Archived - Disposed - Deleted examples: UpdatePackageVersionsStatusRequestExample: summary: Default UpdatePackageVersionsStatus request x-microcks-default: true value: versions: - 1.0.0 versionRevisions: {} expectedStatus: Published targetStatus: Published summary: Amazon CodeArtifact Update Package Versions Status x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Package components: schemas: InternalServerException: {} PackageFormat: type: string enum: - npm - pypi - maven - nuget - generic PackageVersionOrigin: type: object properties: domainEntryPoint: allOf: - $ref: '#/components/schemas/DomainEntryPoint' - description: A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain. originType: allOf: - $ref: '#/components/schemas/PackageVersionOriginType' - description: Describes how the package version was originally added to the domain. An INTERNAL origin type means the package version was published directly to a repository in the domain. An EXTERNAL origin type means the package version was ingested from an external connection. description: Information about how a package version was added to a repository. PackageVersionSummaryList: type: array items: $ref: '#/components/schemas/PackageVersionSummary' DescribePackageVersionResult: type: object required: - packageVersion properties: packageVersion: allOf: - $ref: '#/components/schemas/PackageVersionDescription' - description: ' A PackageVersionDescription object that contains information about the requested package version. ' PublishPackageVersionResult: type: object properties: format: allOf: - $ref: '#/components/schemas/PackageFormat' - description: The format of the package version. namespace: allOf: - $ref: '#/components/schemas/PackageNamespace' - description: The namespace of the package version. package: allOf: - $ref: '#/components/schemas/PackageName' - description: The name of the package. version: allOf: - $ref: '#/components/schemas/PackageVersion' - description: The version of the package. versionRevision: allOf: - $ref: '#/components/schemas/PackageVersionRevision' - description: The revision of the package version. status: allOf: - $ref: '#/components/schemas/PackageVersionStatus' - description: A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide. asset: allOf: - $ref: '#/components/schemas/AssetSummary' - description: An AssetSummary for the published asset. PackageVersionDescription: type: object properties: format: allOf: - $ref: '#/components/schemas/PackageFormat' - description: ' The format of the package version. ' namespace: allOf: - $ref: '#/components/schemas/PackageNamespace' - description:

The namespace of the package version. The package version component that specifies its namespace depends on its type. For example:

packageName: allOf: - $ref: '#/components/schemas/PackageName' - description: ' The name of the requested package. ' displayName: allOf: - $ref: '#/components/schemas/String255' - description: ' The name of the package that is displayed. The displayName varies depending on the package version''s format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui. ' version: allOf: - $ref: '#/components/schemas/PackageVersion' - description: ' The version of the package. ' summary: allOf: - $ref: '#/components/schemas/String' - description: ' A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version''s format. ' homePage: allOf: - $ref: '#/components/schemas/String' - description: ' The homepage associated with the package. ' sourceCodeRepository: allOf: - $ref: '#/components/schemas/String' - description: ' The repository for the source code in the package version, or the source code used to build it. ' publishedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' A timestamp that contains the date and time the package version was published. ' licenses: allOf: - $ref: '#/components/schemas/LicenseInfoList' - description: ' Information about licenses associated with the package version. ' revision: allOf: - $ref: '#/components/schemas/PackageVersionRevision' - description: ' The revision of the package version. ' status: allOf: - $ref: '#/components/schemas/PackageVersionStatus' - description: ' A string that contains the status of the package version. ' origin: allOf: - $ref: '#/components/schemas/PackageVersionOrigin' - description: A PackageVersionOrigin object that contains information about how the package version was added to the repository. description: ' Details about a package version. ' String: type: string DeletePackageVersionsResult: type: object properties: successfulVersions: allOf: - $ref: '#/components/schemas/SuccessfulPackageVersionInfoMap' - description: ' A list of the package versions that were successfully deleted. The status of every successful version will be Deleted. ' failedVersions: allOf: - $ref: '#/components/schemas/PackageVersionErrorMap' - description: '

A PackageVersionError object that contains a map of errors codes for the deleted package that failed. The possible error codes are:

' AssetHashes: type: object additionalProperties: $ref: '#/components/schemas/HashValue' LicenseInfoList: type: array items: $ref: '#/components/schemas/LicenseInfo' PackageName: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 AssetSummaryList: type: array items: $ref: '#/components/schemas/AssetSummary' PackageVersionStatus: type: string enum: - Published - Unfinished - Unlisted - Archived - Disposed - Deleted PackageVersionErrorCode: type: string enum: - ALREADY_EXISTS - MISMATCHED_REVISION - MISMATCHED_STATUS - NOT_ALLOWED - NOT_FOUND - SKIPPED ErrorMessage: type: string PackageVersionOriginType: type: string enum: - INTERNAL - EXTERNAL - UNKNOWN PaginationToken: type: string pattern: \S+ minLength: 1 maxLength: 2000 DomainEntryPoint: type: object properties: repositoryName: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The name of the repository that a package was originally published to. externalConnectionName: allOf: - $ref: '#/components/schemas/ExternalConnectionName' - description: The name of the external connection that a package was ingested from. description: Information about how a package originally entered the CodeArtifact domain. For packages published directly to CodeArtifact, the entry point is the repository it was published to. For packages ingested from an external repository, the entry point is the external connection that it was ingested from. An external connection is a CodeArtifact repository that is connected to an external repository such as the npm registry or NuGet gallery. PackageVersionSummary: type: object required: - version - status properties: version: allOf: - $ref: '#/components/schemas/PackageVersion' - description: ' Information about a package version. ' revision: allOf: - $ref: '#/components/schemas/PackageVersionRevision' - description: ' The revision associated with a package version. ' status: allOf: - $ref: '#/components/schemas/PackageVersionStatus' - description: ' A string that contains the status of the package version. It can be one of the following: ' origin: allOf: - $ref: '#/components/schemas/PackageVersionOrigin' - description: A PackageVersionOrigin object that contains information about how the package version was added to the repository. description: ' Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects. ' ValidationException: {} GetPackageVersionAssetResult: type: object properties: asset: allOf: - $ref: '#/components/schemas/Asset' - description: ' The binary file, or asset, that is downloaded.' ThrottlingException: {} AssetName: type: string pattern: \P{C}+ minLength: 1 maxLength: 255 ServiceQuotaExceededException: {} ListPackageVersionAssetsResult: type: object properties: format: allOf: - $ref: '#/components/schemas/PackageFormat' - description: ' The format of the package that contains the requested package version assets. ' namespace: allOf: - $ref: '#/components/schemas/PackageNamespace' - description:

The namespace of the package version that contains the requested package version assets. The package version component that specifies its namespace depends on its type. For example:

package: allOf: - $ref: '#/components/schemas/PackageName' - description: ' The name of the package that contains the requested package version assets. ' version: allOf: - $ref: '#/components/schemas/PackageVersion' - description: ' The version of the package associated with the requested assets. ' versionRevision: allOf: - $ref: '#/components/schemas/PackageVersionRevision' - description: ' The current revision associated with the package version. ' nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: ' If there are additional results, this is the token for the next set of results. ' assets: allOf: - $ref: '#/components/schemas/AssetSummaryList' - description: ' The returned list of AssetSummary objects. ' ListPackageVersionDependenciesResult: type: object properties: format: allOf: - $ref: '#/components/schemas/PackageFormat' - description: ' A format that specifies the type of the package that contains the returned dependencies. ' namespace: allOf: - $ref: '#/components/schemas/PackageNamespace' - description:

The namespace of the package version that contains the returned dependencies. The package version component that specifies its namespace depends on its type. For example:

package: allOf: - $ref: '#/components/schemas/PackageName' - description: ' The name of the package that contains the returned package versions dependencies. ' version: allOf: - $ref: '#/components/schemas/PackageVersion' - description: ' The version of the package that is specified in the request. ' versionRevision: allOf: - $ref: '#/components/schemas/PackageVersionRevision' - description: ' The current revision associated with the package version. ' nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: ' The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. ' dependencies: allOf: - $ref: '#/components/schemas/PackageDependencyList' - description: ' The returned list of PackageDependency objects. ' PackageDependencyList: type: array items: $ref: '#/components/schemas/PackageDependency' DisposePackageVersionsResult: type: object properties: successfulVersions: allOf: - $ref: '#/components/schemas/SuccessfulPackageVersionInfoMap' - description: ' A list of the package versions that were successfully disposed. ' failedVersions: allOf: - $ref: '#/components/schemas/PackageVersionErrorMap' - description: '

A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:

' SuccessfulPackageVersionInfoMap: type: object additionalProperties: $ref: '#/components/schemas/SuccessfulPackageVersionInfo' ListPackageVersionsResult: type: object properties: defaultDisplayVersion: allOf: - $ref: '#/components/schemas/PackageVersion' - description: '

The default package version to display. This depends on the package format:

' format: allOf: - $ref: '#/components/schemas/PackageFormat' - description: ' A format of the package. ' namespace: allOf: - $ref: '#/components/schemas/PackageNamespace' - description:

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

package: allOf: - $ref: '#/components/schemas/PackageName' - description: ' The name of the package. ' versions: allOf: - $ref: '#/components/schemas/PackageVersionSummaryList' - description: ' The returned list of PackageVersionSummary objects. ' nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: ' If there are additional results, this is the token for the next set of results. ' SuccessfulPackageVersionInfo: type: object properties: revision: allOf: - $ref: '#/components/schemas/String' - description: ' The revision of a package version. ' status: allOf: - $ref: '#/components/schemas/PackageVersionStatus' - description: ' The status of a package version. ' description: ' Contains the revision and status of a package version. ' PackageNamespace: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 PackageVersion: type: string pattern: '[^#/\s]+' minLength: 1 maxLength: 255 CopyPackageVersionsResult: type: object properties: successfulVersions: allOf: - $ref: '#/components/schemas/SuccessfulPackageVersionInfoMap' - description: ' A list of the package versions that were successfully copied to your repository. ' failedVersions: allOf: - $ref: '#/components/schemas/PackageVersionErrorMap' - description: '

A map of package versions that failed to copy and their error codes. The possible error codes are in the PackageVersionError data type. They are:

' HashValue: type: string pattern: '[0-9a-f]+' minLength: 32 maxLength: 512 PackageVersionRevision: type: string pattern: \S+ minLength: 1 maxLength: 50 AccessDeniedException: {} Asset: type: string ConflictException: {} PackageVersionError: type: object properties: errorCode: allOf: - $ref: '#/components/schemas/PackageVersionErrorCode' - description: '

The error code associated with the error. Valid error codes are:

' errorMessage: allOf: - $ref: '#/components/schemas/ErrorMessage' - description: ' The error message associated with the error. ' description: 'l An error associated with package. ' GetPackageVersionReadmeResult: type: object properties: format: allOf: - $ref: '#/components/schemas/PackageFormat' - description: ' The format of the package with the requested readme file. ' namespace: allOf: - $ref: '#/components/schemas/PackageNamespace' - description:

The namespace of the package version with the requested readme file. The package version component that specifies its namespace depends on its type. For example:

package: allOf: - $ref: '#/components/schemas/PackageName' - description: ' The name of the package that contains the returned readme file. ' version: allOf: - $ref: '#/components/schemas/PackageVersion' - description: ' The version of the package with the requested readme file. ' versionRevision: allOf: - $ref: '#/components/schemas/PackageVersionRevision' - description: ' The current revision associated with the package version. ' readme: allOf: - $ref: '#/components/schemas/String' - description: ' The text of the returned readme file. ' AssetSummary: type: object required: - name properties: name: allOf: - $ref: '#/components/schemas/AssetName' - description: ' The name of the asset. ' size: allOf: - $ref: '#/components/schemas/LongOptional' - description: ' The size of the asset. ' hashes: allOf: - $ref: '#/components/schemas/AssetHashes' - description: ' The hashes of the asset. ' description: ' Contains details about a package version asset. ' Timestamp: type: string format: date-time ResourceNotFoundException: {} RepositoryName: type: string pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}' minLength: 2 maxLength: 100 LicenseInfo: type: object properties: name: allOf: - $ref: '#/components/schemas/String' - description: ' Name of the license. ' url: allOf: - $ref: '#/components/schemas/String' - description: ' The URL for license data. ' description: ' Details of the license data. ' PackageVersionErrorMap: type: object additionalProperties: $ref: '#/components/schemas/PackageVersionError' UpdatePackageVersionsStatusResult: type: object properties: successfulVersions: allOf: - $ref: '#/components/schemas/SuccessfulPackageVersionInfoMap' - description: ' A list of PackageVersionError objects, one for each package version with a status that failed to update. ' failedVersions: allOf: - $ref: '#/components/schemas/PackageVersionErrorMap' - description: ' A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated. ' PackageDependency: type: object properties: namespace: allOf: - $ref: '#/components/schemas/PackageNamespace' - description:

The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:

package: allOf: - $ref: '#/components/schemas/PackageName' - description: ' The name of the package that this package depends on. ' dependencyType: allOf: - $ref: '#/components/schemas/String' - description: '

The type of a package dependency. The possible values depend on the package type.

' versionRequirement: allOf: - $ref: '#/components/schemas/String' - description: ' The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x. ' description: ' Details about a package dependency. ' ExternalConnectionName: type: string pattern: '[A-Za-z0-9][A-Za-z0-9._\-:]{1,99}' minLength: 2 maxLength: 100 String255: type: string minLength: 1 maxLength: 255 LongOptional: type: integer parameters: X-Amz-Security-Token: name: X-Amz-Security-Token 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-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-Content-Sha256: name: X-Amz-Content-Sha256 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