openapi: 3.0.0 info: version: '2018-09-22' x-release: v4 title: CodeArtifact 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:
Repository: A CodeArtifact repository contains a set of package
versions, 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 npm CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine), and NuGet CLIs
(nuget and dotnet).
Domain: Repositories are aggregated into a higher-level entity known as a domain. 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).
Each repository is a member of a single domain and can''t be moved to a different domain.
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.
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.
Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet package formats.
In CodeArtifact, a package consists of:
A name (for example, webpack
is the name of a popular npm package)
An optional namespace (for example, @types in @types/node)
A set of versions (for example, 1.0.0,
1.0.1, 1.0.2, etc.)
Package-level metadata (for example, npm tags)
Package version: A version of a package, such as
@types/node 12.6.9. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic
Versioning specification. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.
Upstream repository: One repository is upstream 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.
Asset: An individual file stored in CodeArtifact associated
with a package version, such as an npm .tgz file or Maven POM and JAR files.
CodeArtifact supports these operations:
AssociateExternalConnection:
Adds an existing external connection to a repository.
CopyPackageVersions: Copies package versions from one repository to another repository in the same domain.
CreateDomain: Creates a domain
CreateRepository: Creates a CodeArtifact repository in a domain.
DeleteDomain:
Deletes a domain. You cannot delete a domain that contains repositories.
DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
DeletePackage: Deletes a package and all associated package versions.
DeletePackageVersions: 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.
DeleteRepository: Deletes
a repository.
DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
DescribeDomain: Returns a DomainDescription
object that contains information about the requested domain.
DescribePackage: Returns a PackageDescription
object that contains details about a package.
DescribePackageVersion: Returns a PackageVersionDescription
object that contains details about a package version.
DescribeRepository: Returns a RepositoryDescription object that contains detailed information about
the requested repository.
DisposePackageVersions: Disposes versions of a package. A package version with the status Disposed cannot be restored because
they have been permanently removed from storage.
DisassociateExternalConnection: Removes an existing external connection from a repository.
GetAuthorizationToken:
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.
GetDomainPermissionsPolicy: Returns the policy of a resource that is attached to the specified domain.
GetPackageVersionAsset:
Returns the contents of an asset that is in a package version.
GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
maven
npm
nuget
pypi
GetRepositoryPermissionsPolicy: Returns
the resource policy that is set on a repository.
ListDomains: Returns a list of DomainSummary objects. Each returned DomainSummary object contains
information about a domain.
ListPackages: Lists the packages in a repository.
ListPackageVersionAssets: Lists the assets for a given package
version.
ListPackageVersionDependencies: Returns a list of the direct dependencies for a package version.
ListPackageVersions: Returns
a list of package versions for a specified package in a repository.
ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called
this method.
ListRepositoriesInDomain: Returns a list of the repositories in a domain.
PublishPackageVersion: Creates a new package version
containing one or more assets.
PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
PutPackageOriginConfiguration: Sets
the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.
PutRepositoryPermissionsPolicy:
Sets the resource policy on a repository that specifies permissions to access it.
UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
UpdateRepository: Updates the properties of a repository.
Adds an existing external connection to a repository. One external connection is allowed per repository.
A repository can have one or more upstream repositories, or an external connection.
The name of the external connection to add to the repository. The following values are supported:
public:npmjs - for the npm public repository.
public:nuget-org - for the NuGet Gallery.
public:pypi - for the Python Package Index.
public:maven-central
- for Maven Central.
public:maven-googleandroid - for the Google Android repository.
public:maven-gradleplugins - for the Gradle
plugins repository.
public:maven-commonsware - for the CommonsWare Android repository.
public:maven-clojars - for the Clojars
repository.
Copies package versions from one repository to another repository in the same domain.
You must specify versions or versionRevisions.
You cannot specify both.
The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example:
The namespace
of a Maven package version is its groupId. The namespace is required when copying Maven package versions.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of
a generic package is its namespace.
The versions of the package to be copied.
You must specify versions or versionRevisions. You cannot specify both.
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.
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
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'
/v1/domain#domain:
post:
operationId: CreateDomain
description: 'Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it''s in multiple repositories.
Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDomainResult' examples: CreateDomain200Example: summary: Default CreateDomain 200 response x-microcks-default: true value: domain: my-domain '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: CreateDomain480Example: summary: Default CreateDomain 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateDomain481Example: summary: Default CreateDomain 481 response x-microcks-default: true value: example-value '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateDomain482Example: summary: Default CreateDomain 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: CreateDomain483Example: summary: Default CreateDomain 483 response x-microcks-default: true value: example-value '484': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' examples: CreateDomain484Example: summary: Default CreateDomain 484 response x-microcks-default: true value: example-value '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: CreateDomain485Example: summary: Default CreateDomain 485 response x-microcks-default: true value: example-value '486': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: CreateDomain486Example: summary: Default CreateDomain 486 response x-microcks-default: true value: '500123' parameters: - name: domain in: query required: true description: ' The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable. ' schema: type: string pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]' minLength: 2 maxLength: 50 requestBody: required: true content: application/json: schema: type: object properties: encryptionKey: description: ' The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias,
or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key
that is used. For more information, see DescribeKey in the Key
Management Service API Reference and Key Management Service API Permissions Reference
in the Key Management Service Developer Guide.
CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
RepositoryDescription object that contains detailed information about the requested repository. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRepositoryResult'
examples:
DescribeRepository200Example:
summary: Default DescribeRepository 200 response
x-microcks-default: true
value:
repository: my-repo
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DescribeRepository480Example:
summary: Default DescribeRepository 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DescribeRepository481Example:
summary: Default DescribeRepository 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DescribeRepository482Example:
summary: Default DescribeRepository 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DescribeRepository483Example:
summary: Default DescribeRepository 483 response
x-microcks-default: true
value: example-value
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DescribeRepository484Example:
summary: Default DescribeRepository 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 to describe. '
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: ' A string that specifies the name of the requested repository. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
summary: Amazon CodeArtifact Describe Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: UpdateRepository
description: ' Update the properties of a repository. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRepositoryResult'
examples:
UpdateRepository200Example:
summary: Default UpdateRepository 200 response
x-microcks-default: true
value:
repository: my-repo
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
UpdateRepository480Example:
summary: Default UpdateRepository 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
UpdateRepository481Example:
summary: Default UpdateRepository 481 response
x-microcks-default: true
value: example-value
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
UpdateRepository482Example:
summary: Default UpdateRepository 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UpdateRepository483Example:
summary: Default UpdateRepository 483 response
x-microcks-default: true
value: example-value
'484':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
UpdateRepository484Example:
summary: Default UpdateRepository 484 response
x-microcks-default: true
value: example-value
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
UpdateRepository485Example:
summary: Default UpdateRepository 485 response
x-microcks-default: true
value: example-value
'486':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateRepository486Example:
summary: Default UpdateRepository 486 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: ' The name of the domain associated with the repository to update. '
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 to update. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
description: ' An updated repository description. '
type: string
pattern: '\P{C}*'
maxLength: 1000
upstreams:
description: ' A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks
for a requested package version. For more information, see Working with upstream repositories. '
type: array
items:
$ref: '#/components/schemas/UpstreamRepository'
examples:
UpdateRepositoryRequestExample:
summary: Default UpdateRepository request
x-microcks-default: true
value:
description: Example description for CodeArtifact resource
upstreams:
- repositoryName: my-repo
summary: Amazon CodeArtifact Update Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/domain/permissions/policy#domain:
delete:
operationId: DeleteDomainPermissionsPolicy
description: ' Deletes the resource policy set on a domain. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDomainPermissionsPolicyResult'
examples:
DeleteDomainPermissionsPolicy200Example:
summary: Default DeleteDomainPermissionsPolicy 200 response
x-microcks-default: true
value:
policy: example-value
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DeleteDomainPermissionsPolicy480Example:
summary: Default DeleteDomainPermissionsPolicy 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeleteDomainPermissionsPolicy481Example:
summary: Default DeleteDomainPermissionsPolicy 481 response
x-microcks-default: true
value: example-value
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DeleteDomainPermissionsPolicy482Example:
summary: Default DeleteDomainPermissionsPolicy 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DeleteDomainPermissionsPolicy483Example:
summary: Default DeleteDomainPermissionsPolicy 483 response
x-microcks-default: true
value: example-value
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DeleteDomainPermissionsPolicy484Example:
summary: Default DeleteDomainPermissionsPolicy 484 response
x-microcks-default: true
value: example-value
'485':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeleteDomainPermissionsPolicy485Example:
summary: Default DeleteDomainPermissionsPolicy 485 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: ' The name of the domain associated with the resource policy to be deleted. '
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: policy-revision
in: query
required: false
description: ' The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain''s resource
policy. '
schema:
type: string
pattern: \S+
minLength: 1
maxLength: 100
summary: Amazon CodeArtifact Delete Domain Permissions Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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: GetDomainPermissionsPolicy
description: 'Returns the resource policy attached to the specified domain.
The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.
The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
The namespace of a Maven package is
its groupId. The namespace is required when deleting Maven package versions.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
The namespace of a Maven package is
its groupId. The namespace is required when requesting Maven packages.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
Sets the package origin configuration for a package.
The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.
PutPackageOriginConfiguration can be called on a package that doesn''t yet exist in the repository. When called on a package that does not exist, a package is created in the repository
with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories,
or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.
The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:
The namespace of a Maven package
is its groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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:
The namespace
of a Maven package version is its groupId. The namespace is required when deleting Maven package versions.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of
a generic package is its namespace.
Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.
Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts
lose permissions to perform the repository actions granted by the deleted policy.
The namespace of the requested package version. The package version component that specifies its namespace depends on its type. For example:
The namespace of a
Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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
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'
/v1/package/versions/dispose#domain&repository&format&package:
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:
The namespace
of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken
permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.
CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the
token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds
parameter.
The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called
while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes,
then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.
See Using IAM Roles for more information on controlling session duration.
0 and any number between 900 (15 minutes) and 43200 (12
hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user''s role''s temporary credentials.'
schema:
type: integer
minimum: 0
maximum: 43200
summary: Amazon CodeArtifact Get Authorization Token
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/v1/package/version/asset#domain&repository&format&package&version&asset:
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:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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
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'
/v1/package/version/readme#domain&repository&format&package&version:
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:
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
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
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'
/v1/repository/endpoint#domain&repository&format:
get:
operationId: GetRepositoryEndpoint
description: 'Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
maven
npm
nuget
pypi
Sets the resource policy on a repository that specifies permissions to access it.
When you call PutRepositoryPermissionsPolicy, the resource policy on the repository
is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.
DomainSummary object contains information about a domain. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDomainsResult'
examples:
ListDomains200Example:
summary: Default ListDomains 200 response
x-microcks-default: true
value:
domains: my-domain
nextToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListDomains480Example:
summary: Default ListDomains 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListDomains481Example:
summary: Default ListDomains 481 response
x-microcks-default: true
value: example-value
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListDomains482Example:
summary: Default ListDomains 482 response
x-microcks-default: true
value: example-value
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListDomains483Example:
summary: Default ListDomains 483 response
x-microcks-default: true
value: '500123'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
maxResults:
description: ' The maximum number of results to return per page. '
type: integer
minimum: 1
maximum: 1000
nextToken:
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. '
type: string
pattern: \S+
minLength: 1
maxLength: 2000
examples:
ListDomainsRequestExample:
summary: Default ListDomains request
x-microcks-default: true
value:
maxResults: 1
nextToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example
summary: Amazon CodeArtifact List Domains
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/v1/package/version/assets#domain&repository&format&package&version:
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:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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
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'
/v1/package/version/dependencies#domain&repository&format&package&version:
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:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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
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'
/v1/package/versions#domain&repository&format&package:
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:
The namespace of a Maven package is its groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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
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'
/v1/packages#domain&repository:
post:
operationId: ListPackages
description: ' Returns a list of PackageSummary objects for packages in a repository that match the
request parameters. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPackagesResult'
examples:
ListPackages200Example:
summary: Default ListPackages 200 response
x-microcks-default: true
value:
packages: lodash
nextToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListPackages480Example:
summary: Default ListPackages 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListPackages481Example:
summary: Default ListPackages 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListPackages482Example:
summary: Default ListPackages 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListPackages483Example:
summary: Default ListPackages 483 response
x-microcks-default: true
value: example-value
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListPackages484Example:
summary: Default ListPackages 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 packages. '
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 packages. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
- name: format
in: query
required: false
description: The format used to filter requested packages. Only packages from the provided format will be returned.
schema:
type: string
enum:
- npm
- pypi
- maven
- nuget
- generic
- name: namespace
in: query
required: false
description: 'The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is
called --namespace and not --namespace-prefix, it has prefix-matching behavior.
Each package format uses namespace as follows:
The namespace
of a Maven package is its groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
packagePrefix are returned. '
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: publish
in: query
required: false
description: 'The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information,
see PackageOriginRestrictions.'
schema:
type: string
enum:
- ALLOW
- BLOCK
- name: upstream
in: query
required: false
description: 'The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information,
see PackageOriginRestrictions.'
schema:
type: string
enum:
- ALLOW
- BLOCK
- 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 Packages
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/v1/repositories:
post:
operationId: ListRepositories
description: ' Returns a list of RepositorySummary objects. Each RepositorySummary
contains information about a repository in the specified Amazon Web Services account and that matches the input parameters. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositoriesResult'
examples:
ListRepositories200Example:
summary: Default ListRepositories 200 response
x-microcks-default: true
value:
repositories: my-repo
nextToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListRepositories480Example:
summary: Default ListRepositories 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListRepositories481Example:
summary: Default ListRepositories 481 response
x-microcks-default: true
value: example-value
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListRepositories482Example:
summary: Default ListRepositories 482 response
x-microcks-default: true
value: example-value
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListRepositories483Example:
summary: Default ListRepositories 483 response
x-microcks-default: true
value: '500123'
parameters:
- name: repository-prefix
in: query
required: false
description: ' A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.'
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
- 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 Repositories
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/v1/domain/repositories#domain:
post:
operationId: ListRepositoriesInDomain
description: ' Returns a list of RepositorySummary objects. Each RepositorySummary
contains information about a repository in the specified domain and that matches the input parameters. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositoriesInDomainResult'
examples:
ListRepositoriesInDomain200Example:
summary: Default ListRepositoriesInDomain 200 response
x-microcks-default: true
value:
repositories: my-repo
nextToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListRepositoriesInDomain480Example:
summary: Default ListRepositoriesInDomain 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListRepositoriesInDomain481Example:
summary: Default ListRepositoriesInDomain 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListRepositoriesInDomain482Example:
summary: Default ListRepositoriesInDomain 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListRepositoriesInDomain483Example:
summary: Default ListRepositoriesInDomain 483 response
x-microcks-default: true
value: example-value
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListRepositoriesInDomain484Example:
summary: Default ListRepositoriesInDomain 484 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: ' The name of the domain that contains the returned list of 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: administrator-account
in: query
required: false
description: ' Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID. '
schema:
type: string
pattern: '[0-9]{12}'
minLength: 12
maxLength: 12
- name: repository-prefix
in: query
required: false
description: ' A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
- 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 Repositories in Domain
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/v1/tags#resourceArn:
post:
operationId: ListTagsForResource
description: Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResult'
examples:
ListTagsForResource200Example:
summary: Default ListTagsForResource 200 response
x-microcks-default: true
value:
tags: example-value
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListTagsForResource480Example:
summary: Default ListTagsForResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListTagsForResource481Example:
summary: Default ListTagsForResource 481 response
x-microcks-default: true
value: example-value
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListTagsForResource482Example:
summary: Default ListTagsForResource 482 response
x-microcks-default: true
value: example-value
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListTagsForResource483Example:
summary: Default ListTagsForResource 483 response
x-microcks-default: true
value: '500123'
parameters:
- name: resourceArn
in: query
required: true
description: The Amazon Resource Name (ARN) of the resource to get tags for.
schema:
type: string
pattern: \S+
minLength: 1
maxLength: 1011
summary: Amazon CodeArtifact List Tags for Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/v1/package/version/publish#domain&repository&format&package&version&asset&x-amz-content-sha256:
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.
A format that specifies the type of the package version with the requested asset file.
The only supported value is generic.
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.
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
Sets a resource policy on a domain that specifies permissions to access it.
When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored
when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.
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:
The namespace
of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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
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'
components:
parameters:
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-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
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-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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
schemas:
AssociateExternalConnectionResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' Information about the connected repository after processing the request. '
AccessDeniedException: {}
ConflictException: {}
InternalServerException: {}
ResourceNotFoundException: {}
ServiceQuotaExceededException: {}
ThrottlingException: {}
ValidationException: {}
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:
ALREADY_EXISTS
MISMATCHED_REVISION
MISMATCHED_STATUS
NOT_ALLOWED
NOT_FOUND
SKIPPED
UpstreamRepository objects is an input parameter to CreateRepository
and UpdateRepository. '
DeleteDomainResult:
type: object
properties:
domain:
allOf:
- $ref: '#/components/schemas/DomainDescription'
- description: ' Contains information about the deleted domain after processing the request. '
DeleteDomainPermissionsPolicyResult:
type: object
properties:
policy:
allOf:
- $ref: '#/components/schemas/ResourcePolicy'
- description: ' Information about the deleted resource policy after processing the request. '
DeletePackageResult:
type: object
properties:
deletedPackage:
$ref: '#/components/schemas/PackageSummary'
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:
ALREADY_EXISTS
MISMATCHED_REVISION
MISMATCHED_STATUS
NOT_ALLOWED
NOT_FOUND
SKIPPED
RepositoryDescription object that contains the requested repository information. '
DisassociateExternalConnectionResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' The repository associated with the removed external connection. '
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:
ALREADY_EXISTS
MISMATCHED_REVISION
MISMATCHED_STATUS
NOT_ALLOWED
NOT_FOUND
SKIPPED
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:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
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:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
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:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The default package version to display. This depends on the package format:
For Maven and PyPI packages, it''s the most recently published package version.
For npm packages, it''s the version referenced by the latest tag. If the latest tag is not set, it''s the most recently published package version.
The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:
The namespace of a Maven package is its groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
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. '
UpdateRepositoryResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' The updated repository. '
AccountId:
type: string
pattern: '[0-9]{12}'
minLength: 12
maxLength: 12
Arn:
type: string
pattern: \S+
minLength: 1
maxLength: 1011
Asset:
type: string
HashValue:
type: string
pattern: '[0-9a-f]+'
minLength: 32
maxLength: 512
AssetHashes:
type: object
additionalProperties:
$ref: '#/components/schemas/HashValue'
AssetName:
type: string
pattern: '\P{C}+'
minLength: 1
maxLength: 255
LongOptional:
type: integer
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. '
AssetSummaryList:
type: array
items:
$ref: '#/components/schemas/AssetSummary'
DomainName:
type: string
pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
minLength: 2
maxLength: 50
RepositoryName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
ExternalConnectionName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-:]{1,99}'
minLength: 2
maxLength: 100
AssociateExternalConnectionRequest:
type: object
title: AssociateExternalConnectionRequest
properties: {}
RepositoryDescription:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: ' The name of the repository. '
administratorAccount:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The 12-digit account number of the Amazon Web Services account that manages the repository. '
domainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: ' The name of the domain that contains the repository. '
domainOwner:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces. '
arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The Amazon Resource Name (ARN) of the repository. '
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: ' A text description of the repository. '
upstreams:
allOf:
- $ref: '#/components/schemas/UpstreamRepositoryInfoList'
- description: ' A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for
a requested package version. For more information, see Working with upstream repositories. '
externalConnections:
allOf:
- $ref: '#/components/schemas/RepositoryExternalConnectionInfoList'
- description: ' An array of external connections associated with the repository. '
createdTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that represents the date and time the repository was created.
description: ' The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglot—a
single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI (mvn),
and pip. You can create up to 100 repositories per Amazon Web Services account. '
AuthorizationTokenDurationSeconds:
type: integer
minimum: 0
maximum: 43200
BooleanOptional:
type: boolean
PackageFormat:
type: string
enum:
- npm
- pypi
- maven
- nuget
- generic
PackageNamespace:
type: string
pattern: '[^#/\s]+'
minLength: 1
maxLength: 255
PackageName:
type: string
pattern: '[^#/\s]+'
minLength: 1
maxLength: 255
PackageVersionList:
type: array
items:
$ref: '#/components/schemas/PackageVersion'
maxItems: 100
PackageVersionRevisionMap:
type: object
additionalProperties:
$ref: '#/components/schemas/PackageVersionRevision'
CopyPackageVersionsRequest:
type: object
title: CopyPackageVersionsRequest
properties:
versions:
allOf:
- $ref: '#/components/schemas/PackageVersionList'
- description: The versions of the package to be copied.
You must specify versions or versionRevisions. You cannot specify both.
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.
failedVersions field of the response with an ALREADY_EXISTS error code. '
includeFromUpstream:
allOf:
- $ref: '#/components/schemas/BooleanOptional'
- 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. '
SuccessfulPackageVersionInfoMap:
type: object
additionalProperties:
$ref: '#/components/schemas/SuccessfulPackageVersionInfo'
PackageVersionErrorMap:
type: object
additionalProperties:
$ref: '#/components/schemas/PackageVersionError'
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 0
maxItems: 200
CreateDomainRequest:
type: object
title: CreateDomainRequest
properties:
encryptionKey:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or
a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used.
For more information, see DescribeKey in the Key Management Service
API Reference and Key Management Service API Permissions Reference in the Key
Management Service Developer Guide.
CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
The namespace of a Maven package is its
groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
The namespace of a Maven package is its
groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
The namespace of the package version. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven
package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
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. '
DescribeRepositoryRequest:
type: object
title: DescribeRepositoryRequest
properties: {}
DisassociateExternalConnectionRequest:
type: object
title: DisassociateExternalConnectionRequest
properties: {}
DisposePackageVersionsRequest:
type: object
required:
- versions
title: DisposePackageVersionsRequest
properties:
versions:
allOf:
- $ref: '#/components/schemas/PackageVersionList'
- description: ' The versions of the package you want to dispose. '
versionRevisions:
allOf:
- $ref: '#/components/schemas/PackageVersionRevisionMap'
- description: ' The revisions of the package versions you want to dispose. '
expectedStatus:
allOf:
- $ref: '#/components/schemas/PackageVersionStatus'
- description: ' The expected status of the package version to dispose. '
DomainStatus:
type: string
enum:
- Active
- Deleted
Timestamp:
type: string
format: date-time
Integer:
type: integer
Long:
type: integer
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.'
DomainSummary:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: ' The name of the domain. '
owner:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The ARN of the domain. '
status:
allOf:
- $ref: '#/components/schemas/DomainStatus'
- description: ' A string that contains the status of the domain. '
createdTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' A timestamp that contains the date and time the domain was created. '
encryptionKey:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The key used to encrypt the domain. '
description: ' Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains
operation returns a list of DomainSummary objects. '
DomainSummaryList:
type: array
items:
$ref: '#/components/schemas/DomainSummary'
ErrorMessage:
type: string
ExternalConnectionStatus:
type: string
enum:
- Available
GetAuthorizationTokenRequest:
type: object
title: GetAuthorizationTokenRequest
properties: {}
String:
type: string
GetDomainPermissionsPolicyRequest:
type: object
title: GetDomainPermissionsPolicyRequest
properties: {}
GetPackageVersionAssetRequest:
type: object
title: GetPackageVersionAssetRequest
properties: {}
GetPackageVersionReadmeRequest:
type: object
title: GetPackageVersionReadmeRequest
properties: {}
GetRepositoryEndpointRequest:
type: object
title: GetRepositoryEndpointRequest
properties: {}
GetRepositoryPermissionsPolicyRequest:
type: object
title: GetRepositoryPermissionsPolicyRequest
properties: {}
HashAlgorithm:
type: string
enum:
- MD5
- SHA-1
- SHA-256
- SHA-512
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. '
LicenseInfoList:
type: array
items:
$ref: '#/components/schemas/LicenseInfo'
ListDomainsMaxResults:
type: integer
minimum: 1
maximum: 1000
PaginationToken:
type: string
pattern: \S+
minLength: 1
maxLength: 2000
ListDomainsRequest:
type: object
title: ListDomainsRequest
properties:
maxResults:
allOf:
- $ref: '#/components/schemas/ListDomainsMaxResults'
- description: ' The maximum number of results to return per page. '
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. '
ListPackageVersionAssetsMaxResults:
type: integer
minimum: 1
maximum: 1000
ListPackageVersionAssetsRequest:
type: object
title: ListPackageVersionAssetsRequest
properties: {}
ListPackageVersionDependenciesRequest:
type: object
title: ListPackageVersionDependenciesRequest
properties: {}
PackageDependencyList:
type: array
items:
$ref: '#/components/schemas/PackageDependency'
ListPackageVersionsMaxResults:
type: integer
minimum: 1
maximum: 1000
PackageVersionSortType:
type: string
enum:
- PUBLISHED_TIME
PackageVersionOriginType:
type: string
enum:
- INTERNAL
- EXTERNAL
- UNKNOWN
ListPackageVersionsRequest:
type: object
title: ListPackageVersionsRequest
properties: {}
PackageVersionSummaryList:
type: array
items:
$ref: '#/components/schemas/PackageVersionSummary'
ListPackagesMaxResults:
type: integer
minimum: 1
maximum: 1000
ListPackagesRequest:
type: object
title: ListPackagesRequest
properties: {}
PackageSummaryList:
type: array
items:
$ref: '#/components/schemas/PackageSummary'
ListRepositoriesInDomainMaxResults:
type: integer
minimum: 1
maximum: 1000
ListRepositoriesInDomainRequest:
type: object
title: ListRepositoriesInDomainRequest
properties: {}
RepositorySummaryList:
type: array
items:
$ref: '#/components/schemas/RepositorySummary'
ListRepositoriesMaxResults:
type: integer
minimum: 1
maximum: 1000
ListRepositoriesRequest:
type: object
title: ListRepositoriesRequest
properties: {}
ListTagsForResourceRequest:
type: object
title: ListTagsForResourceRequest
properties: {}
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:
The namespace
of a Maven package is its groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The type of a package dependency. The possible values depend on the package type.
npm: regular, dev, peer, optional
maven: optional, parent, compile, runtime, test, system, provided.
Note that parent is not a regular Maven dependency type; instead this is extracted from the <parent> element if one is defined in the package version''s
POM file.
nuget: The dependencyType field is never set for NuGet packages.
pypi: Requires-Dist
1.2.3, ^2.3.4, or 4.x. '
description: ' Details about a package dependency. '
PackageOriginConfiguration:
type: object
properties:
restrictions:
allOf:
- $ref: '#/components/schemas/PackageOriginRestrictions'
- description: A PackageOriginRestrictions 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.
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.
String255:
type: string
minLength: 1
maxLength: 255
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.
PackageVersionErrorCode:
type: string
enum:
- ALREADY_EXISTS
- MISMATCHED_REVISION
- MISMATCHED_STATUS
- NOT_ALLOWED
- NOT_FOUND
- SKIPPED
PackageVersionError:
type: object
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/PackageVersionErrorCode'
- description: 'The error code associated with the error. Valid error codes are:
ALREADY_EXISTS
MISMATCHED_REVISION
MISMATCHED_STATUS
NOT_ALLOWED
NOT_FOUND
SKIPPED
PackageVersionSummary objects. '
PolicyDocument:
type: string
pattern: '[\P{C}\s]+'
minLength: 1
maxLength: 7168
SHA256:
type: string
pattern: '[0-9a-f]+'
minLength: 64
maxLength: 64
PublishPackageVersionRequest:
type: object
required:
- assetContent
title: PublishPackageVersionRequest
properties:
assetContent:
allOf:
- $ref: '#/components/schemas/Asset'
- description: The content of the asset to publish.
PutDomainPermissionsPolicyRequest:
type: object
required:
- domain
- policyDocument
title: PutDomainPermissionsPolicyRequest
properties:
domain:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: ' The name of the domain on which to set the resource policy. '
domainOwner:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
policyRevision:
allOf:
- $ref: '#/components/schemas/PolicyRevision'
- description: ' The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain''s resource
policy. '
policyDocument:
allOf:
- $ref: '#/components/schemas/PolicyDocument'
- description: ' A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain. '
PutPackageOriginConfigurationRequest:
type: object
required:
- restrictions
title: PutPackageOriginConfigurationRequest
properties:
restrictions:
allOf:
- $ref: '#/components/schemas/PackageOriginRestrictions'
- description: 'A PackageOriginRestrictions object that contains information about
the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external
connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.
You must include both the
desired upstream and publish restrictions.
The package format associated with a repository''s external connection. The valid package formats are:
npm: A Node Package Manager (npm) package.
pypi: A Python Package Index (PyPI) package.
maven: A Maven package that contains compiled code in a distributable format,
such as a JAR file.
nuget: A NuGet package.
Available. '
description: ' Contains information about the external connection of a repository. '
RepositorySummary:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: ' The name of the repository. '
administratorAccount:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The Amazon Web Services account ID that manages the repository. '
domainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: ' The name of the domain that contains the repository. '
domainOwner:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The ARN of the repository. '
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: ' The description of the repository. '
createdTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that represents the date and time the repository was created.
description: ' Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories
operation returns a list of RepositorySummary objects. '
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. '
TagValue:
type: string
pattern: '\P{C}*'
minLength: 0
maxLength: 256
TagKeyList:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 0
maxItems: 200
TagResourceRequest:
type: object
required:
- tags
title: TagResourceRequest
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags you want to modify or add to the resource.
UntagResourceRequest:
type: object
required:
- tagKeys
title: UntagResourceRequest
properties:
tagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: The tag key for each tag that you want to remove from the resource.
UpdatePackageVersionsStatusRequest:
type: object
required:
- versions
- targetStatus
title: UpdatePackageVersionsStatusRequest
properties:
versions:
allOf:
- $ref: '#/components/schemas/PackageVersionList'
- description: ' An array of strings that specify the versions of the package with the statuses to update. '
versionRevisions:
allOf:
- $ref: '#/components/schemas/PackageVersionRevisionMap'
- 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. '
expectedStatus:
allOf:
- $ref: '#/components/schemas/PackageVersionStatus'
- 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. '
targetStatus:
allOf:
- $ref: '#/components/schemas/PackageVersionStatus'
- description: ' The status you want to change the package version status to. '
UpdateRepositoryRequest:
type: object
title: UpdateRepositoryRequest
properties:
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: ' An updated repository description. '
upstreams:
allOf:
- $ref: '#/components/schemas/UpstreamRepositoryList'
- description: ' A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for
a requested package version. For more information, see Working with upstream repositories. '
UpstreamRepositoryInfo:
type: object
properties:
repositoryName:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: ' The name of an upstream repository. '
description: ' Information about an upstream repository. '
security:
- hmac: []