openapi: 3.0.0
info:
version: '2018-09-22'
x-release: v4
title: CodeArtifact Authorization Token#domain Repository API
description: '
CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
CodeArtifact Components
Use the information in this guide to help you work with the following CodeArtifact components:
-
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:
-
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.
'
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codeartifact
x-aws-signingName: codeartifact
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeartifact-2018-09-22.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codeartifact.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeArtifact multi-region endpoint
- url: https://codeartifact.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeArtifact multi-region endpoint
- url: http://codeartifact.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeArtifact endpoint for China (Beijing) and China (Ningxia)
- url: https://codeartifact.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeArtifact endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Repository
paths:
/v1/repository/external-connection#domain&repository&external-connection:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AssociateExternalConnection
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateExternalConnectionResult'
examples:
AssociateExternalConnection200Example:
summary: Default AssociateExternalConnection 200 response
x-microcks-default: true
value:
repository: my-repo
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
AssociateExternalConnection480Example:
summary: Default AssociateExternalConnection 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
AssociateExternalConnection481Example:
summary: Default AssociateExternalConnection 481 response
x-microcks-default: true
value: example-value
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
AssociateExternalConnection482Example:
summary: Default AssociateExternalConnection 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
AssociateExternalConnection483Example:
summary: Default AssociateExternalConnection 483 response
x-microcks-default: true
value: example-value
'484':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
AssociateExternalConnection484Example:
summary: Default AssociateExternalConnection 484 response
x-microcks-default: true
value: example-value
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
AssociateExternalConnection485Example:
summary: Default AssociateExternalConnection 485 response
x-microcks-default: true
value: example-value
'486':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
AssociateExternalConnection486Example:
summary: Default AssociateExternalConnection 486 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: The name of the domain that contains the repository.
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 which the external connection is added. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
- name: external-connection
in: query
required: true
description: ' 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.
'
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-:]{1,99}'
minLength: 2
maxLength: 100
summary: Amazon CodeArtifact Associate External Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository
delete:
operationId: DisassociateExternalConnection
description: ' Removes an existing external connection from a repository. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateExternalConnectionResult'
examples:
DisassociateExternalConnection200Example:
summary: Default DisassociateExternalConnection 200 response
x-microcks-default: true
value:
repository: my-repo
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DisassociateExternalConnection480Example:
summary: Default DisassociateExternalConnection 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DisassociateExternalConnection481Example:
summary: Default DisassociateExternalConnection 481 response
x-microcks-default: true
value: example-value
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DisassociateExternalConnection482Example:
summary: Default DisassociateExternalConnection 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DisassociateExternalConnection483Example:
summary: Default DisassociateExternalConnection 483 response
x-microcks-default: true
value: example-value
'484':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
DisassociateExternalConnection484Example:
summary: Default DisassociateExternalConnection 484 response
x-microcks-default: true
value: example-value
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DisassociateExternalConnection485Example:
summary: Default DisassociateExternalConnection 485 response
x-microcks-default: true
value: example-value
'486':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DisassociateExternalConnection486Example:
summary: Default DisassociateExternalConnection 486 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: 'The name of the domain that contains the repository from which to remove the external repository. '
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 from which the external connection will be removed. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
- name: external-connection
in: query
required: true
description: 'The name of the external connection to be removed from the repository. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-:]{1,99}'
minLength: 2
maxLength: 100
summary: Amazon CodeArtifact Disassociate External Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository
/v1/repository/permissions/policies#domain&repository:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteRepositoryPermissionsPolicy
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRepositoryPermissionsPolicyResult'
examples:
DeleteRepositoryPermissionsPolicy200Example:
summary: Default DeleteRepositoryPermissionsPolicy 200 response
x-microcks-default: true
value:
policy: example-value
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DeleteRepositoryPermissionsPolicy480Example:
summary: Default DeleteRepositoryPermissionsPolicy 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeleteRepositoryPermissionsPolicy481Example:
summary: Default DeleteRepositoryPermissionsPolicy 481 response
x-microcks-default: true
value: example-value
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DeleteRepositoryPermissionsPolicy482Example:
summary: Default DeleteRepositoryPermissionsPolicy 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DeleteRepositoryPermissionsPolicy483Example:
summary: Default DeleteRepositoryPermissionsPolicy 483 response
x-microcks-default: true
value: example-value
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DeleteRepositoryPermissionsPolicy484Example:
summary: Default DeleteRepositoryPermissionsPolicy 484 response
x-microcks-default: true
value: example-value
'485':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeleteRepositoryPermissionsPolicy485Example:
summary: Default DeleteRepositoryPermissionsPolicy 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 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: repository
in: query
required: true
description: ' The name of the repository that is associated with the resource policy to be deleted '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
- name: policy-revision
in: query
required: false
description: ' The revision of the repository''s resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository''s resource policy. '
schema:
type: string
pattern: \S+
minLength: 1
maxLength: 100
summary: Amazon CodeArtifact Delete Repository Permissions Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository
/v1/repository/endpoint#domain&repository&format:
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: GetRepositoryEndpoint
description: ' Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRepositoryEndpointResult'
examples:
GetRepositoryEndpoint200Example:
summary: Default GetRepositoryEndpoint 200 response
x-microcks-default: true
value:
repositoryEndpoint: my-repo
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
GetRepositoryEndpoint480Example:
summary: Default GetRepositoryEndpoint 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
GetRepositoryEndpoint481Example:
summary: Default GetRepositoryEndpoint 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
GetRepositoryEndpoint482Example:
summary: Default GetRepositoryEndpoint 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
GetRepositoryEndpoint483Example:
summary: Default GetRepositoryEndpoint 483 response
x-microcks-default: true
value: example-value
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
GetRepositoryEndpoint484Example:
summary: Default GetRepositoryEndpoint 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. '
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 that contains the repository. 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. '
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: ' Returns which endpoint of a repository to return. A repository has one endpoint for each package format. '
schema:
type: string
enum:
- npm
- pypi
- maven
- nuget
- generic
summary: Amazon CodeArtifact Get Repository Endpoint
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository
/v1/repository/permissions/policy#domain&repository:
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: GetRepositoryPermissionsPolicy
description: ' Returns the resource policy that is set on a repository. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRepositoryPermissionsPolicyResult'
examples:
GetRepositoryPermissionsPolicy200Example:
summary: Default GetRepositoryPermissionsPolicy 200 response
x-microcks-default: true
value:
policy: example-value
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
GetRepositoryPermissionsPolicy480Example:
summary: Default GetRepositoryPermissionsPolicy 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
GetRepositoryPermissionsPolicy481Example:
summary: Default GetRepositoryPermissionsPolicy 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
GetRepositoryPermissionsPolicy482Example:
summary: Default GetRepositoryPermissionsPolicy 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
GetRepositoryPermissionsPolicy483Example:
summary: Default GetRepositoryPermissionsPolicy 483 response
x-microcks-default: true
value: example-value
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
GetRepositoryPermissionsPolicy484Example:
summary: Default GetRepositoryPermissionsPolicy 484 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: ' The name of the domain containing the repository whose associated resource policy is to be retrieved. '
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 whose associated resource policy is to be retrieved. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
summary: Amazon CodeArtifact Get Repository Permissions Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository
put:
operationId: PutRepositoryPermissionsPolicy
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutRepositoryPermissionsPolicyResult'
examples:
PutRepositoryPermissionsPolicy200Example:
summary: Default PutRepositoryPermissionsPolicy 200 response
x-microcks-default: true
value:
policy: example-value
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
PutRepositoryPermissionsPolicy480Example:
summary: Default PutRepositoryPermissionsPolicy 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
PutRepositoryPermissionsPolicy481Example:
summary: Default PutRepositoryPermissionsPolicy 481 response
x-microcks-default: true
value: example-value
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
PutRepositoryPermissionsPolicy482Example:
summary: Default PutRepositoryPermissionsPolicy 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
PutRepositoryPermissionsPolicy483Example:
summary: Default PutRepositoryPermissionsPolicy 483 response
x-microcks-default: true
value: example-value
'484':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
PutRepositoryPermissionsPolicy484Example:
summary: Default PutRepositoryPermissionsPolicy 484 response
x-microcks-default: true
value: example-value
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
PutRepositoryPermissionsPolicy485Example:
summary: Default PutRepositoryPermissionsPolicy 485 response
x-microcks-default: true
value: example-value
'486':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
PutRepositoryPermissionsPolicy486Example:
summary: Default PutRepositoryPermissionsPolicy 486 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: ' The name of the domain containing the repository to set the resource policy on. '
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 set the resource policy on. '
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
required:
- policyDocument
properties:
policyRevision:
description: ' Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository''s resource policy. '
type: string
pattern: \S+
minLength: 1
maxLength: 100
policyDocument:
description: ' A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository. '
type: string
pattern: '[\P{C}\s]+'
minLength: 1
maxLength: 7168
examples:
PutRepositoryPermissionsPolicyRequestExample:
summary: Default PutRepositoryPermissionsPolicy request
x-microcks-default: true
value:
policyRevision: example-value
policyDocument: example-value
summary: Amazon CodeArtifact Put Repository Permissions Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository
components:
schemas:
InternalServerException: {}
PackageFormat:
type: string
enum:
- npm
- pypi
- maven
- nuget
- generic
String:
type: string
AccountId:
type: string
pattern: '[0-9]{12}'
minLength: 12
maxLength: 12
ValidationException: {}
GetRepositoryEndpointResult:
type: object
properties:
repositoryEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: ' A string that specifies the URL of the returned endpoint. '
ThrottlingException: {}
UpstreamRepositoryInfoList:
type: array
items:
$ref: '#/components/schemas/UpstreamRepositoryInfo'
ExternalConnectionStatus:
type: string
enum:
- Available
ServiceQuotaExceededException: {}
ResourcePolicy:
type: object
properties:
resourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The ARN of the resource associated with the resource policy '
revision:
allOf:
- $ref: '#/components/schemas/PolicyRevision'
- description: ' The current revision of the resource policy. '
document:
allOf:
- $ref: '#/components/schemas/PolicyDocument'
- description: ' The resource policy formatted in JSON. '
description: ' An CodeArtifact resource policy that contains a resource ARN, document details, and a revision. '
DisassociateExternalConnectionResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' The repository associated with the removed external connection. '
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. '
DeleteRepositoryPermissionsPolicyResult:
type: object
properties:
policy:
allOf:
- $ref: '#/components/schemas/ResourcePolicy'
- description: ' Information about the deleted policy after processing the request. '
AccessDeniedException: {}
PolicyDocument:
type: string
pattern: '[\P{C}\s]+'
minLength: 1
maxLength: 7168
ConflictException: {}
RepositoryExternalConnectionInfo:
type: object
properties:
externalConnectionName:
allOf:
- $ref: '#/components/schemas/ExternalConnectionName'
- description: ' The name of the external connection associated with a repository. '
packageFormat:
allOf:
- $ref: '#/components/schemas/PackageFormat'
- description: ' 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.
'
status:
allOf:
- $ref: '#/components/schemas/ExternalConnectionStatus'
- description: ' The status of the external connection of a repository. There is one valid value, Available. '
description: ' Contains information about the external connection of a repository. '
RepositoryExternalConnectionInfoList:
type: array
items:
$ref: '#/components/schemas/RepositoryExternalConnectionInfo'
GetRepositoryPermissionsPolicyResult:
type: object
properties:
policy:
allOf:
- $ref: '#/components/schemas/ResourcePolicy'
- description: ' The returned resource policy. '
DomainName:
type: string
pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
minLength: 2
maxLength: 50
Timestamp:
type: string
format: date-time
RepositoryName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
ResourceNotFoundException: {}
AssociateExternalConnectionResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' Information about the connected repository after processing the request. '
PutRepositoryPermissionsPolicyResult:
type: object
properties:
policy:
allOf:
- $ref: '#/components/schemas/ResourcePolicy'
- description: ' The resource policy that was set after processing the request. '
UpstreamRepositoryInfo:
type: object
properties:
repositoryName:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: ' The name of an upstream repository. '
description: ' Information about an upstream repository. '
Description:
type: string
pattern: \P{C}*
maxLength: 1000
ExternalConnectionName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-:]{1,99}'
minLength: 2
maxLength: 100
PolicyRevision:
type: string
pattern: \S+
minLength: 1
maxLength: 100
Arn:
type: string
pattern: \S+
minLength: 1
maxLength: 1011
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/codeartifact/
x-hasEquivalentPaths: true