Table of Contents
CodeArtifact.Client¶A low-level client representing CodeArtifact
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:
npm CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine ), and NuGet CLIs ( nuget and dotnet ).webpack is the name of a popular npm package)@types in @types/node )1.0.0 , 1.0.1 , 1.0.2 , etc.)@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..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 domainCreateRepository : 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.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:mavennpmnugetpypiGetRepositoryPermissionsPolicy : 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.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.import boto3
client = boto3.client('codeartifact')
These are the available methods:
associate_external_connection()can_paginate()close()copy_package_versions()create_domain()create_repository()delete_domain()delete_domain_permissions_policy()delete_package()delete_package_versions()delete_repository()delete_repository_permissions_policy()describe_domain()describe_package()describe_package_version()describe_repository()disassociate_external_connection()dispose_package_versions()get_authorization_token()get_domain_permissions_policy()get_package_version_asset()get_package_version_readme()get_paginator()get_repository_endpoint()get_repository_permissions_policy()get_waiter()list_domains()list_package_version_assets()list_package_version_dependencies()list_package_versions()list_packages()list_repositories()list_repositories_in_domain()list_tags_for_resource()put_domain_permissions_policy()put_package_origin_configuration()put_repository_permissions_policy()tag_resource()untag_resource()update_package_versions_status()update_repository()associate_external_connection(**kwargs)¶Adds an existing external connection to a repository. One external connection is allowed per repository.
Note
A repository can have one or more upstream repositories, or an external connection.
See also: AWS API Documentation
Request Syntax
response = client.associate_external_connection(
domain='string',
domainOwner='string',
repository='string',
externalConnection='string'
)
[REQUIRED]
The name of the domain that contains the repository.
[REQUIRED]
The name of the repository to which the external connection is added.
[REQUIRED]
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.dict
Response Syntax
{
'repository': {
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string',
'upstreams': [
{
'repositoryName': 'string'
},
],
'externalConnections': [
{
'externalConnectionName': 'string',
'packageFormat': 'npm'|'pypi'|'maven'|'nuget',
'status': 'Available'
},
]
}
}
Response Structure
(dict) --
repository (dict) --
Information about the connected repository after processing the request.
name (string) --
The name of the repository.
administratorAccount (string) --
The 12-digit account number of the Amazon Web Services account that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
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 (string) --
The Amazon Resource Name (ARN) of the repository.
description (string) --
A text description of the repository.
upstreams (list) --
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.
(dict) --
Information about an upstream repository.
repositoryName (string) --
The name of an upstream repository.
externalConnections (list) --
An array of external connections associated with the repository.
(dict) --
Contains information about the external connection of a repository.
externalConnectionName (string) --
The name of the external connection associated with a repository.
packageFormat (string) --
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 (string) --
The status of the external connection of a repository. There is one valid value, Available .
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
copy_package_versions(**kwargs)¶Copies package versions from one repository to another repository in the same domain.
Note
You must specify versions or versionRevisions . You cannot specify both.
See also: AWS API Documentation
Request Syntax
response = client.copy_package_versions(
domain='string',
domainOwner='string',
sourceRepository='string',
destinationRepository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
versions=[
'string',
],
versionRevisions={
'string': 'string'
},
allowOverwrite=True|False,
includeFromUpstream=True|False
)
[REQUIRED]
The name of the domain that contains the source and destination repositories.
[REQUIRED]
The name of the repository that contains the package versions to be copied.
[REQUIRED]
The name of the repository into which package versions are copied.
[REQUIRED]
The format of the package versions to be copied.
The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example:
groupId . The namespace is required when copying Maven package versions.scope .[REQUIRED]
The name of the package that contains the versions to be copied.
The versions of the package to be copied.
Note
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.
Note
You must specify versions or versionRevisions . You cannot specify both.
failedVersions field of the response with an ALREADY_EXISTS error code.dict
Response Syntax
{
'successfulVersions': {
'string': {
'revision': 'string',
'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted'
}
},
'failedVersions': {
'string': {
'errorCode': 'ALREADY_EXISTS'|'MISMATCHED_REVISION'|'MISMATCHED_STATUS'|'NOT_ALLOWED'|'NOT_FOUND'|'SKIPPED',
'errorMessage': 'string'
}
}
}
Response Structure
(dict) --
successfulVersions (dict) --
A list of the package versions that were successfully copied to your repository.
(string) --
(dict) --
Contains the revision and status of a package version.
revision (string) --
The revision of a package version.
status (string) --
The status of a package version.
failedVersions (dict) --
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_EXISTSMISMATCHED_REVISIONMISMATCHED_STATUSNOT_ALLOWEDNOT_FOUNDSKIPPED(string) --
(dict) --
l An error associated with package.
errorCode (string) --
The error code associated with the error. Valid error codes are:
ALREADY_EXISTSMISMATCHED_REVISIONMISMATCHED_STATUSNOT_ALLOWEDNOT_FOUNDSKIPPEDerrorMessage (string) --
The error message associated with the error.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptioncreate_domain(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_domain(
domain='string',
encryptionKey='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
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.
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 .
Warning
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 .
One or more tag key-value pairs for the domain.
A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
The tag key.
The tag value.
dict
Response Syntax
{
'domain': {
'name': 'string',
'owner': 'string',
'arn': 'string',
'status': 'Active'|'Deleted',
'createdTime': datetime(2015, 1, 1),
'encryptionKey': 'string',
'repositoryCount': 123,
'assetSizeBytes': 123,
's3BucketArn': 'string'
}
}
Response Structure
(dict) --
domain (dict) --
Contains information about the created domain after processing the request.
name (string) --
The name of the domain.
owner (string) --
The Amazon Web Services account ID that owns the domain.
arn (string) --
The Amazon Resource Name (ARN) of the domain.
status (string) --
The current status of a domain.
createdTime (datetime) --
A timestamp that represents the date and time the domain was created.
encryptionKey (string) --
The ARN of an Key Management Service (KMS) key associated with a domain.
repositoryCount (integer) --
The number of repositories in the domain.
assetSizeBytes (integer) --
The total size of all assets in the domain.
s3BucketArn (string) --
The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptioncreate_repository(**kwargs)¶Creates a repository.
See also: AWS API Documentation
Request Syntax
response = client.create_repository(
domain='string',
domainOwner='string',
repository='string',
description='string',
upstreams=[
{
'repositoryName': 'string'
},
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The name of the domain that contains the created repository.
[REQUIRED]
The name of the repository to create.
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.
Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.
The name of an upstream repository.
One or more tag key-value pairs for the repository.
A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
The tag key.
The tag value.
dict
Response Syntax
{
'repository': {
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string',
'upstreams': [
{
'repositoryName': 'string'
},
],
'externalConnections': [
{
'externalConnectionName': 'string',
'packageFormat': 'npm'|'pypi'|'maven'|'nuget',
'status': 'Available'
},
]
}
}
Response Structure
(dict) --
repository (dict) --
Information about the created repository after processing the request.
name (string) --
The name of the repository.
administratorAccount (string) --
The 12-digit account number of the Amazon Web Services account that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
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 (string) --
The Amazon Resource Name (ARN) of the repository.
description (string) --
A text description of the repository.
upstreams (list) --
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.
(dict) --
Information about an upstream repository.
repositoryName (string) --
The name of an upstream repository.
externalConnections (list) --
An array of external connections associated with the repository.
(dict) --
Contains information about the external connection of a repository.
externalConnectionName (string) --
The name of the external connection associated with a repository.
packageFormat (string) --
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 (string) --
The status of the external connection of a repository. There is one valid value, Available .
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondelete_domain(**kwargs)¶Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain(
domain='string',
domainOwner='string'
)
[REQUIRED]
The name of the domain to delete.
dict
Response Syntax
{
'domain': {
'name': 'string',
'owner': 'string',
'arn': 'string',
'status': 'Active'|'Deleted',
'createdTime': datetime(2015, 1, 1),
'encryptionKey': 'string',
'repositoryCount': 123,
'assetSizeBytes': 123,
's3BucketArn': 'string'
}
}
Response Structure
(dict) --
domain (dict) --
Contains information about the deleted domain after processing the request.
name (string) --
The name of the domain.
owner (string) --
The Amazon Web Services account ID that owns the domain.
arn (string) --
The Amazon Resource Name (ARN) of the domain.
status (string) --
The current status of a domain.
createdTime (datetime) --
A timestamp that represents the date and time the domain was created.
encryptionKey (string) --
The ARN of an Key Management Service (KMS) key associated with a domain.
repositoryCount (integer) --
The number of repositories in the domain.
assetSizeBytes (integer) --
The total size of all assets in the domain.
s3BucketArn (string) --
The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondelete_domain_permissions_policy(**kwargs)¶Deletes the resource policy set on a domain.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain_permissions_policy(
domain='string',
domainOwner='string',
policyRevision='string'
)
[REQUIRED]
The name of the domain associated with the resource policy to be deleted.
dict
Response Syntax
{
'policy': {
'resourceArn': 'string',
'revision': 'string',
'document': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
Information about the deleted resource policy after processing the request.
resourceArn (string) --
The ARN of the resource associated with the resource policy
revision (string) --
The current revision of the resource policy.
document (string) --
The resource policy formatted in JSON.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondelete_package(**kwargs)¶Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.
See also: AWS API Documentation
Request Syntax
response = client.delete_package(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string'
)
[REQUIRED]
The name of the domain that contains the package to delete.
[REQUIRED]
The name of the repository that contains the package to delete.
[REQUIRED]
The format of the requested package to delete.
The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
groupId . The namespace is required when deleting Maven package versions.scope .[REQUIRED]
The name of the package to delete.
dict
Response Syntax
{
'deletedPackage': {
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'originConfiguration': {
'restrictions': {
'publish': 'ALLOW'|'BLOCK',
'upstream': 'ALLOW'|'BLOCK'
}
}
}
}
Response Structure
(dict) --
deletedPackage (dict) --
Details about a package, including its format, namespace, and name.
format (string) --
The format of the package.
namespace (string) --
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
groupId .scope .package (string) --
The name of the package.
originConfiguration (dict) --
A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.
restrictions (dict) --
A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.
publish (string) --
The package origin configuration that determines if new versions of the package can be published directly to the repository.
upstream (string) --
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.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondelete_package_versions(**kwargs)¶Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived . Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListackageVersions ), but you can restore them using UpdatePackageVersionsStatus.
See also: AWS API Documentation
Request Syntax
response = client.delete_package_versions(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
versions=[
'string',
],
expectedStatus='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted'
)
[REQUIRED]
The name of the domain that contains the package to delete.
[REQUIRED]
The name of the repository that contains the package versions to delete.
[REQUIRED]
The format of the package versions to delete.
The namespace of the package versions to be deleted. The package version component that specifies its namespace depends on its type. For example:
groupId . The namespace is required when deleting Maven package versions.scope .[REQUIRED]
The name of the package with the versions to delete.
[REQUIRED]
An array of strings that specify the versions of the package to delete.
dict
Response Syntax
{
'successfulVersions': {
'string': {
'revision': 'string',
'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted'
}
},
'failedVersions': {
'string': {
'errorCode': 'ALREADY_EXISTS'|'MISMATCHED_REVISION'|'MISMATCHED_STATUS'|'NOT_ALLOWED'|'NOT_FOUND'|'SKIPPED',
'errorMessage': 'string'
}
}
}
Response Structure
(dict) --
successfulVersions (dict) --
A list of the package versions that were successfully deleted. The status of every successful version will be Deleted .
(string) --
(dict) --
Contains the revision and status of a package version.
revision (string) --
The revision of a package version.
status (string) --
The status of a package version.
failedVersions (dict) --
A PackageVersionError object that contains a map of errors codes for the deleted package that failed. The possible error codes are:
ALREADY_EXISTSMISMATCHED_REVISIONMISMATCHED_STATUSNOT_ALLOWEDNOT_FOUNDSKIPPED(string) --
(dict) --
l An error associated with package.
errorCode (string) --
The error code associated with the error. Valid error codes are:
ALREADY_EXISTSMISMATCHED_REVISIONMISMATCHED_STATUSNOT_ALLOWEDNOT_FOUNDSKIPPEDerrorMessage (string) --
The error message associated with the error.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondelete_repository(**kwargs)¶Deletes a repository.
See also: AWS API Documentation
Request Syntax
response = client.delete_repository(
domain='string',
domainOwner='string',
repository='string'
)
[REQUIRED]
The name of the domain that contains the repository to delete.
[REQUIRED]
The name of the repository to delete.
dict
Response Syntax
{
'repository': {
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string',
'upstreams': [
{
'repositoryName': 'string'
},
],
'externalConnections': [
{
'externalConnectionName': 'string',
'packageFormat': 'npm'|'pypi'|'maven'|'nuget',
'status': 'Available'
},
]
}
}
Response Structure
(dict) --
repository (dict) --
Information about the deleted repository after processing the request.
name (string) --
The name of the repository.
administratorAccount (string) --
The 12-digit account number of the Amazon Web Services account that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
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 (string) --
The Amazon Resource Name (ARN) of the repository.
description (string) --
A text description of the repository.
upstreams (list) --
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.
(dict) --
Information about an upstream repository.
repositoryName (string) --
The name of an upstream repository.
externalConnections (list) --
An array of external connections associated with the repository.
(dict) --
Contains information about the external connection of a repository.
externalConnectionName (string) --
The name of the external connection associated with a repository.
packageFormat (string) --
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 (string) --
The status of the external connection of a repository. There is one valid value, Available .
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondelete_repository_permissions_policy(**kwargs)¶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.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_repository_permissions_policy(
domain='string',
domainOwner='string',
repository='string',
policyRevision='string'
)
[REQUIRED]
The name of the domain that contains the repository associated with the resource policy to be deleted.
[REQUIRED]
The name of the repository that is associated with the resource policy to be deleted
dict
Response Syntax
{
'policy': {
'resourceArn': 'string',
'revision': 'string',
'document': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
Information about the deleted policy after processing the request.
resourceArn (string) --
The ARN of the resource associated with the resource policy
revision (string) --
The current revision of the resource policy.
document (string) --
The resource policy formatted in JSON.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondescribe_domain(**kwargs)¶Returns a DomainDescription object that contains information about the requested domain.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain(
domain='string',
domainOwner='string'
)
[REQUIRED]
A string that specifies the name of the requested domain.
dict
Response Syntax
{
'domain': {
'name': 'string',
'owner': 'string',
'arn': 'string',
'status': 'Active'|'Deleted',
'createdTime': datetime(2015, 1, 1),
'encryptionKey': 'string',
'repositoryCount': 123,
'assetSizeBytes': 123,
's3BucketArn': 'string'
}
}
Response Structure
(dict) --
domain (dict) --
Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.
name (string) --
The name of the domain.
owner (string) --
The Amazon Web Services account ID that owns the domain.
arn (string) --
The Amazon Resource Name (ARN) of the domain.
status (string) --
The current status of a domain.
createdTime (datetime) --
A timestamp that represents the date and time the domain was created.
encryptionKey (string) --
The ARN of an Key Management Service (KMS) key associated with a domain.
repositoryCount (integer) --
The number of repositories in the domain.
assetSizeBytes (integer) --
The total size of all assets in the domain.
s3BucketArn (string) --
The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondescribe_package(**kwargs)¶Returns a PackageDescription object that contains information about the requested package.
See also: AWS API Documentation
Request Syntax
response = client.describe_package(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string'
)
[REQUIRED]
The name of the domain that contains the repository that contains the package.
[REQUIRED]
The name of the repository that contains the requested package.
[REQUIRED]
A format that specifies the type of the requested package.
The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
groupId . The namespace is required when requesting Maven packages.scope .[REQUIRED]
The name of the requested package.
dict
Response Syntax
{
'package': {
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'name': 'string',
'originConfiguration': {
'restrictions': {
'publish': 'ALLOW'|'BLOCK',
'upstream': 'ALLOW'|'BLOCK'
}
}
}
}
Response Structure
(dict) --
package (dict) --
A PackageDescription object that contains information about the requested package.
format (string) --
A format that specifies the type of the package.
namespace (string) --
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
groupId .scope .name (string) --
The name of the package.
originConfiguration (dict) --
The package origin configuration for the package.
restrictions (dict) --
A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.
publish (string) --
The package origin configuration that determines if new versions of the package can be published directly to the repository.
upstream (string) --
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.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondescribe_package_version(**kwargs)¶Returns a PackageVersionDescription object that contains information about the requested package version.
See also: AWS API Documentation
Request Syntax
response = client.describe_package_version(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
packageVersion='string'
)
[REQUIRED]
The name of the domain that contains the repository that contains the package version.
[REQUIRED]
The name of the repository that contains the package version.
[REQUIRED]
A format that specifies the type of the requested package version.
The namespace of the requested package version. The package version component that specifies its namespace depends on its type. For example:
groupId .scope .[REQUIRED]
The name of the requested package version.
[REQUIRED]
A string that contains the package version (for example, 3.5.2 ).
dict
Response Syntax
{
'packageVersion': {
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'packageName': 'string',
'displayName': 'string',
'version': 'string',
'summary': 'string',
'homePage': 'string',
'sourceCodeRepository': 'string',
'publishedTime': datetime(2015, 1, 1),
'licenses': [
{
'name': 'string',
'url': 'string'
},
],
'revision': 'string',
'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
'origin': {
'domainEntryPoint': {
'repositoryName': 'string',
'externalConnectionName': 'string'
},
'originType': 'INTERNAL'|'EXTERNAL'|'UNKNOWN'
}
}
}
Response Structure
(dict) --
packageVersion (dict) --
A PackageVersionDescription object that contains information about the requested package version.
format (string) --
The format of the package version.
namespace (string) --
The namespace of the package version. The package version component that specifies its namespace depends on its type. For example:
groupId .scope .packageName (string) --
The name of the requested package.
displayName (string) --
The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui , is in the namespace vue , and has the format npm , then the displayName is @vue/ui .
version (string) --
The version of the package.
summary (string) --
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 (string) --
The homepage associated with the package.
sourceCodeRepository (string) --
The repository for the source code in the package version, or the source code used to build it.
publishedTime (datetime) --
A timestamp that contains the date and time the package version was published.
licenses (list) --
Information about licenses associated with the package version.
(dict) --
Details of the license data.
name (string) --
Name of the license.
url (string) --
The URL for license data.
revision (string) --
The revision of the package version.
status (string) --
A string that contains the status of the package version.
origin (dict) --
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
domainEntryPoint (dict) --
A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.
repositoryName (string) --
The name of the repository that a package was originally published to.
externalConnectionName (string) --
The name of the external connection that a package was ingested from.
originType (string) --
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.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondescribe_repository(**kwargs)¶Returns a RepositoryDescription object that contains detailed information about the requested repository.
See also: AWS API Documentation
Request Syntax
response = client.describe_repository(
domain='string',
domainOwner='string',
repository='string'
)
[REQUIRED]
The name of the domain that contains the repository to describe.
[REQUIRED]
A string that specifies the name of the requested repository.
dict
Response Syntax
{
'repository': {
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string',
'upstreams': [
{
'repositoryName': 'string'
},
],
'externalConnections': [
{
'externalConnectionName': 'string',
'packageFormat': 'npm'|'pypi'|'maven'|'nuget',
'status': 'Available'
},
]
}
}
Response Structure
(dict) --
repository (dict) --
A RepositoryDescription object that contains the requested repository information.
name (string) --
The name of the repository.
administratorAccount (string) --
The 12-digit account number of the Amazon Web Services account that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
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 (string) --
The Amazon Resource Name (ARN) of the repository.
description (string) --
A text description of the repository.
upstreams (list) --
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.
(dict) --
Information about an upstream repository.
repositoryName (string) --
The name of an upstream repository.
externalConnections (list) --
An array of external connections associated with the repository.
(dict) --
Contains information about the external connection of a repository.
externalConnectionName (string) --
The name of the external connection associated with a repository.
packageFormat (string) --
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 (string) --
The status of the external connection of a repository. There is one valid value, Available .
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondisassociate_external_connection(**kwargs)¶Removes an existing external connection from a repository.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_external_connection(
domain='string',
domainOwner='string',
repository='string',
externalConnection='string'
)
[REQUIRED]
The name of the domain that contains the repository from which to remove the external repository.
[REQUIRED]
The name of the repository from which the external connection will be removed.
[REQUIRED]
The name of the external connection to be removed from the repository.
dict
Response Syntax
{
'repository': {
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string',
'upstreams': [
{
'repositoryName': 'string'
},
],
'externalConnections': [
{
'externalConnectionName': 'string',
'packageFormat': 'npm'|'pypi'|'maven'|'nuget',
'status': 'Available'
},
]
}
}
Response Structure
(dict) --
repository (dict) --
The repository associated with the removed external connection.
name (string) --
The name of the repository.
administratorAccount (string) --
The 12-digit account number of the Amazon Web Services account that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
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 (string) --
The Amazon Resource Name (ARN) of the repository.
description (string) --
A text description of the repository.
upstreams (list) --
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.
(dict) --
Information about an upstream repository.
repositoryName (string) --
The name of an upstream repository.
externalConnections (list) --
An array of external connections associated with the repository.
(dict) --
Contains information about the external connection of a repository.
externalConnectionName (string) --
The name of the external connection associated with a repository.
packageFormat (string) --
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 (string) --
The status of the external connection of a repository. There is one valid value, Available .
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiondispose_package_versions(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.dispose_package_versions(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
versions=[
'string',
],
versionRevisions={
'string': 'string'
},
expectedStatus='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted'
)
[REQUIRED]
The name of the domain that contains the repository you want to dispose.
[REQUIRED]
The name of the repository that contains the package versions you want to dispose.
[REQUIRED]
A format that specifies the type of package versions you want to dispose.
The namespace of the package versions to be disposed. The package version component that specifies its namespace depends on its type. For example:
groupId .scope .[REQUIRED]
The name of the package with the versions you want to dispose.
[REQUIRED]
The versions of the package you want to dispose.
The revisions of the package versions you want to dispose.
dict
Response Syntax
{
'successfulVersions': {
'string': {
'revision': 'string',
'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted'
}
},
'failedVersions': {
'string': {
'errorCode': 'ALREADY_EXISTS'|'MISMATCHED_REVISION'|'MISMATCHED_STATUS'|'NOT_ALLOWED'|'NOT_FOUND'|'SKIPPED',
'errorMessage': 'string'
}
}
}
Response Structure
(dict) --
successfulVersions (dict) --
A list of the package versions that were successfully disposed.
(string) --
(dict) --
Contains the revision and status of a package version.
revision (string) --
The revision of a package version.
status (string) --
The status of a package version.
failedVersions (dict) --
A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:
ALREADY_EXISTSMISMATCHED_REVISIONMISMATCHED_STATUSNOT_ALLOWEDNOT_FOUNDSKIPPED(string) --
(dict) --
l An error associated with package.
errorCode (string) --
The error code associated with the error. Valid error codes are:
ALREADY_EXISTSMISMATCHED_REVISIONMISMATCHED_STATUSNOT_ALLOWEDNOT_FOUNDSKIPPEDerrorMessage (string) --
The error message associated with the error.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionGenerates 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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.get_authorization_token(
domain='string',
domainOwner='string',
durationSeconds=123
)
[REQUIRED]
The name of the domain that is in scope for the generated authorization token.
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.dict
Response Syntax
{
'authorizationToken': 'string',
'expiration': datetime(2015, 1, 1)
}
Response Structure
(dict) --
authorizationToken (string) --
The returned authentication token.
expiration (datetime) --
A timestamp that specifies the date and time the authorization token expires.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionget_domain_permissions_policy(**kwargs)¶Returns the resource policy attached to the specified domain.
Note
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 .
See also: AWS API Documentation
Request Syntax
response = client.get_domain_permissions_policy(
domain='string',
domainOwner='string'
)
[REQUIRED]
The name of the domain to which the resource policy is attached.
dict
Response Syntax
{
'policy': {
'resourceArn': 'string',
'revision': 'string',
'document': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
The returned resource policy.
resourceArn (string) --
The ARN of the resource associated with the resource policy
revision (string) --
The current revision of the resource policy.
document (string) --
The resource policy formatted in JSON.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionget_package_version_asset(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_package_version_asset(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
packageVersion='string',
asset='string',
packageVersionRevision='string'
)
[REQUIRED]
The name of the domain that contains the repository that contains the package version with the requested asset.
[REQUIRED]
The repository that contains the package version with the requested asset.
[REQUIRED]
A format that specifies the type of the package version with the requested asset file.
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:
groupId .scope .[REQUIRED]
The name of the package that contains the requested asset.
[REQUIRED]
A string that contains the package version (for example, 3.5.2 ).
[REQUIRED]
The name of the requested asset.
dict
Response Syntax
{
'asset': StreamingBody(),
'assetName': 'string',
'packageVersion': 'string',
'packageVersionRevision': 'string'
}
Response Structure
(dict) --
asset (StreamingBody) --
The binary file, or asset, that is downloaded.
assetName (string) --
The name of the asset that is downloaded.
packageVersion (string) --
A string that contains the package version (for example, 3.5.2 ).
packageVersionRevision (string) --
The name of the package version revision that contains the downloaded asset.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionCodeArtifact.Client.exceptions.ConflictExceptionget_package_version_readme(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_package_version_readme(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
packageVersion='string'
)
[REQUIRED]
The name of the domain that contains the repository that contains the package version with the requested readme file.
[REQUIRED]
The repository that contains the package with the requested readme file.
[REQUIRED]
A format that specifies the type of the package version with the requested readme file.
Note
Although maven is listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.
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:
groupId .scope .[REQUIRED]
The name of the package version that contains the requested readme file.
[REQUIRED]
A string that contains the package version (for example, 3.5.2 ).
dict
Response Syntax
{
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'version': 'string',
'versionRevision': 'string',
'readme': 'string'
}
Response Structure
(dict) --
format (string) --
The format of the package with the requested readme file.
namespace (string) --
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:
groupId .scope .package (string) --
The name of the package that contains the returned readme file.
version (string) --
The version of the package with the requested readme file.
versionRevision (string) --
The current revision associated with the package version.
readme (string) --
The text of the returned readme file.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_repository_endpoint(**kwargs)¶Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
mavennpmnugetpypiSee also: AWS API Documentation
Request Syntax
response = client.get_repository_endpoint(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget'
)
[REQUIRED]
The name of the domain that contains the repository.
[REQUIRED]
The name of the repository.
[REQUIRED]
Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
dict
Response Syntax
{
'repositoryEndpoint': 'string'
}
Response Structure
(dict) --
repositoryEndpoint (string) --
A string that specifies the URL of the returned endpoint.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionget_repository_permissions_policy(**kwargs)¶Returns the resource policy that is set on a repository.
See also: AWS API Documentation
Request Syntax
response = client.get_repository_permissions_policy(
domain='string',
domainOwner='string',
repository='string'
)
[REQUIRED]
The name of the domain containing the repository whose associated resource policy is to be retrieved.
[REQUIRED]
The name of the repository whose associated resource policy is to be retrieved.
dict
Response Syntax
{
'policy': {
'resourceArn': 'string',
'revision': 'string',
'document': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
The returned resource policy.
resourceArn (string) --
The ARN of the resource associated with the resource policy
revision (string) --
The current revision of the resource policy.
document (string) --
The resource policy formatted in JSON.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_domains(**kwargs)¶Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.
See also: AWS API Documentation
Request Syntax
response = client.list_domains(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'domains': [
{
'name': 'string',
'owner': 'string',
'arn': 'string',
'status': 'Active'|'Deleted',
'createdTime': datetime(2015, 1, 1),
'encryptionKey': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
domains (list) --
The returned list of DomainSummary objects.
(dict) --
Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.
name (string) --
The name of the domain.
owner (string) --
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
arn (string) --
The ARN of the domain.
status (string) --
A string that contains the status of the domain.
createdTime (datetime) --
A timestamp that contains the date and time the domain was created.
encryptionKey (string) --
The key used to encrypt the domain.
nextToken (string) --
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.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionlist_package_version_assets(**kwargs)¶Returns a list of AssetSummary objects for assets in a package version.
See also: AWS API Documentation
Request Syntax
response = client.list_package_version_assets(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
packageVersion='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The name of the domain that contains the repository associated with the package version assets.
[REQUIRED]
The name of the repository that contains the package that contains the requested package version assets.
[REQUIRED]
The format of the package that contains the requested package version assets.
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:
groupId .scope .[REQUIRED]
The name of the package that contains the requested package version assets.
[REQUIRED]
A string that contains the package version (for example, 3.5.2 ).
dict
Response Syntax
{
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'version': 'string',
'versionRevision': 'string',
'nextToken': 'string',
'assets': [
{
'name': 'string',
'size': 123,
'hashes': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
format (string) --
The format of the package that contains the requested package version assets.
namespace (string) --
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:
groupId .scope .package (string) --
The name of the package that contains the requested package version assets.
version (string) --
The version of the package associated with the requested assets.
versionRevision (string) --
The current revision associated with the package version.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
assets (list) --
The returned list of AssetSummary objects.
(dict) --
Contains details about a package version asset.
name (string) --
The name of the asset.
size (integer) --
The size of the asset.
hashes (dict) --
The hashes of the asset.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionlist_package_version_dependencies(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_package_version_dependencies(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
packageVersion='string',
nextToken='string'
)
[REQUIRED]
The name of the domain that contains the repository that contains the requested package version dependencies.
[REQUIRED]
The name of the repository that contains the requested package version.
[REQUIRED]
The format of the package with the requested dependencies.
The namespace of the package version with the requested dependencies. The package version component that specifies its namespace depends on its type. For example:
groupId .scope .[REQUIRED]
The name of the package versions' package.
[REQUIRED]
A string that contains the package version (for example, 3.5.2 ).
dict
Response Syntax
{
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'version': 'string',
'versionRevision': 'string',
'nextToken': 'string',
'dependencies': [
{
'namespace': 'string',
'package': 'string',
'dependencyType': 'string',
'versionRequirement': 'string'
},
]
}
Response Structure
(dict) --
format (string) --
A format that specifies the type of the package that contains the returned dependencies.
namespace (string) --
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:
groupId .scope .package (string) --
The name of the package that contains the returned package versions dependencies.
version (string) --
The version of the package that is specified in the request.
versionRevision (string) --
The current revision associated with the package version.
nextToken (string) --
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
dependencies (list) --
The returned list of PackageDependency objects.
(dict) --
Details about a package dependency.
namespace (string) --
The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:
groupId .scope .package (string) --
The name of the package that this package depends on.
dependencyType (string) --
The type of a package dependency. The possible values depend on the package type. Example types are compile , runtime , and test for Maven packages, and dev , prod , and optional for npm packages.
versionRequirement (string) --
The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3 , ^2.3.4 , or 4.x .
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionlist_package_versions(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_package_versions(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
status='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
sortBy='PUBLISHED_TIME',
maxResults=123,
nextToken='string',
originType='INTERNAL'|'EXTERNAL'|'UNKNOWN'
)
[REQUIRED]
The name of the domain that contains the repository that contains the requested package versions.
[REQUIRED]
The name of the repository that contains the requested package versions.
[REQUIRED]
The format of the returned package versions.
The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:
groupId .scope .[REQUIRED]
The name of the package for which you want to request package versions.
originType used to filter package versions. Only package versions with the provided originType will be returned.dict
Response Syntax
{
'defaultDisplayVersion': 'string',
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'versions': [
{
'version': 'string',
'revision': 'string',
'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
'origin': {
'domainEntryPoint': {
'repositoryName': 'string',
'externalConnectionName': 'string'
},
'originType': 'INTERNAL'|'EXTERNAL'|'UNKNOWN'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
defaultDisplayVersion (string) --
The default package version to display. This depends on the package format:
latest tag. If the latest tag is not set, it's the most recently published package version.format (string) --
A format of the package.
namespace (string) --
The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:
groupId .scope .package (string) --
The name of the package.
versions (list) --
The returned list of PackageVersionSummary objects.
(dict) --
Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects.
version (string) --
Information about a package version.
revision (string) --
The revision associated with a package version.
status (string) --
A string that contains the status of the package version. It can be one of the following:
origin (dict) --
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
domainEntryPoint (dict) --
A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.
repositoryName (string) --
The name of the repository that a package was originally published to.
externalConnectionName (string) --
The name of the external connection that a package was ingested from.
originType (string) --
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.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionlist_packages(**kwargs)¶Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
See also: AWS API Documentation
Request Syntax
response = client.list_packages(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
packagePrefix='string',
maxResults=123,
nextToken='string',
publish='ALLOW'|'BLOCK',
upstream='ALLOW'|'BLOCK'
)
[REQUIRED]
The name of the domain that contains the repository that contains the requested packages.
[REQUIRED]
The name of the repository that contains the requested packages.
The namespace used to filter requested packages. Only packages with the provided namespace will be returned. The package component that specifies its namespace depends on its type. For example:
groupId .scope .packagePrefix are returned.Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.dict
Response Syntax
{
'packages': [
{
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'originConfiguration': {
'restrictions': {
'publish': 'ALLOW'|'BLOCK',
'upstream': 'ALLOW'|'BLOCK'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
packages (list) --
The list of returned PackageSummary objects.
(dict) --
Details about a package, including its format, namespace, and name.
format (string) --
The format of the package.
namespace (string) --
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
groupId .scope .package (string) --
The name of the package.
originConfiguration (dict) --
A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.
restrictions (dict) --
A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.
publish (string) --
The package origin configuration that determines if new versions of the package can be published directly to the repository.
upstream (string) --
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.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionlist_repositories(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_repositories(
repositoryPrefix='string',
maxResults=123,
nextToken='string'
)
repositoryPrefix are returned.dict
Response Syntax
{
'repositories': [
{
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
repositories (list) --
The returned list of RepositorySummary objects.
(dict) --
Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.
name (string) --
The name of the repository.
administratorAccount (string) --
The Amazon Web Services account ID that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
arn (string) --
The ARN of the repository.
description (string) --
The description of the repository.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionlist_repositories_in_domain(**kwargs)¶Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.
See also: AWS API Documentation
Request Syntax
response = client.list_repositories_in_domain(
domain='string',
domainOwner='string',
administratorAccount='string',
repositoryPrefix='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The name of the domain that contains the returned list of repositories.
repositoryPrefix are returned.dict
Response Syntax
{
'repositories': [
{
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
repositories (list) --
The returned list of repositories.
(dict) --
Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.
name (string) --
The name of the repository.
administratorAccount (string) --
The Amazon Web Services account ID that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
arn (string) --
The ARN of the repository.
description (string) --
The description of the repository.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionGets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to get tags for.
{
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
A list of tag key and value pairs associated with the specified resource.
A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
The tag key.
The tag value.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionput_domain_permissions_policy(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.put_domain_permissions_policy(
domain='string',
domainOwner='string',
policyRevision='string',
policyDocument='string'
)
[REQUIRED]
The name of the domain on which to set the resource policy.
[REQUIRED]
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.
dict
Response Syntax
{
'policy': {
'resourceArn': 'string',
'revision': 'string',
'document': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
The resource policy that was set after processing the request.
resourceArn (string) --
The ARN of the resource associated with the resource policy
revision (string) --
The current revision of the resource policy.
document (string) --
The resource policy formatted in JSON.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionput_package_origin_configuration(**kwargs)¶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 .
PutPackageOriginConfigurationcan 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.
See also: AWS API Documentation
Request Syntax
response = client.put_package_origin_configuration(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
restrictions={
'publish': 'ALLOW'|'BLOCK',
'upstream': 'ALLOW'|'BLOCK'
}
)
[REQUIRED]
The name of the domain that contains the repository that contains the package.
[REQUIRED]
The name of the repository that contains the package.
[REQUIRED]
A format that specifies the type of the package to be updated.
The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:
groupId .scope .[REQUIRED]
The name of the package to be updated.
[REQUIRED]
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 origin configuration that determines if new versions of the package can be published directly to the repository.
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.
dict
Response Syntax
{
'originConfiguration': {
'restrictions': {
'publish': 'ALLOW'|'BLOCK',
'upstream': 'ALLOW'|'BLOCK'
}
}
}
Response Structure
(dict) --
originConfiguration (dict) --
A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.
restrictions (dict) --
A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.
publish (string) --
The package origin configuration that determines if new versions of the package can be published directly to the repository.
upstream (string) --
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.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionput_repository_permissions_policy(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.put_repository_permissions_policy(
domain='string',
domainOwner='string',
repository='string',
policyRevision='string',
policyDocument='string'
)
[REQUIRED]
The name of the domain containing the repository to set the resource policy on.
[REQUIRED]
The name of the repository to set the resource policy on.
[REQUIRED]
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
dict
Response Syntax
{
'policy': {
'resourceArn': 'string',
'revision': 'string',
'document': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
The resource policy that was set after processing the request.
resourceArn (string) --
The ARN of the resource associated with the resource policy
revision (string) --
The current revision of the resource policy.
document (string) --
The resource policy formatted in JSON.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptiontag_resource(**kwargs)¶Adds or updates tags for a resource in CodeArtifact.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
[REQUIRED]
The tags you want to modify or add to the resource.
A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
The tag key.
The tag value.
dict
Response Syntax
{}
Response Structure
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionuntag_resource(**kwargs)¶Removes tags from a resource in CodeArtifact.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
[REQUIRED]
The tag key for each tag that you want to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionupdate_package_versions_status(**kwargs)¶Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus , you can update the status of package versions to Archived , Published , or Unlisted . To set the status of a package version to Disposed , use DisposePackageVersions.
See also: AWS API Documentation
Request Syntax
response = client.update_package_versions_status(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
versions=[
'string',
],
versionRevisions={
'string': 'string'
},
expectedStatus='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
targetStatus='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted'
)
[REQUIRED]
The name of the domain that contains the repository that contains the package versions with a status to be updated.
[REQUIRED]
The repository that contains the package versions with the status you want to update.
[REQUIRED]
A format that specifies the type of the package with the statuses to update.
The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:
groupId .scope .[REQUIRED]
The name of the package with the version statuses to update.
[REQUIRED]
An array of strings that specify the versions of the package with the statuses to update.
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 is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus .[REQUIRED]
The status you want to change the package version status to.
dict
Response Syntax
{
'successfulVersions': {
'string': {
'revision': 'string',
'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted'
}
},
'failedVersions': {
'string': {
'errorCode': 'ALREADY_EXISTS'|'MISMATCHED_REVISION'|'MISMATCHED_STATUS'|'NOT_ALLOWED'|'NOT_FOUND'|'SKIPPED',
'errorMessage': 'string'
}
}
}
Response Structure
(dict) --
successfulVersions (dict) --
A list of PackageVersionError objects, one for each package version with a status that failed to update.
(string) --
(dict) --
Contains the revision and status of a package version.
revision (string) --
The revision of a package version.
status (string) --
The status of a package version.
failedVersions (dict) --
A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.
(string) --
(dict) --
l An error associated with package.
errorCode (string) --
The error code associated with the error. Valid error codes are:
ALREADY_EXISTSMISMATCHED_REVISIONMISMATCHED_STATUSNOT_ALLOWEDNOT_FOUNDSKIPPEDerrorMessage (string) --
The error message associated with the error.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionupdate_repository(**kwargs)¶Update the properties of a repository.
See also: AWS API Documentation
Request Syntax
response = client.update_repository(
domain='string',
domainOwner='string',
repository='string',
description='string',
upstreams=[
{
'repositoryName': 'string'
},
]
)
[REQUIRED]
The name of the domain associated with the repository to update.
[REQUIRED]
The name of the repository to update.
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.
Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.
The name of an upstream repository.
dict
Response Syntax
{
'repository': {
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string',
'upstreams': [
{
'repositoryName': 'string'
},
],
'externalConnections': [
{
'externalConnectionName': 'string',
'packageFormat': 'npm'|'pypi'|'maven'|'nuget',
'status': 'Available'
},
]
}
}
Response Structure
(dict) --
repository (dict) --
The updated repository.
name (string) --
The name of the repository.
administratorAccount (string) --
The 12-digit account number of the Amazon Web Services account that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
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 (string) --
The Amazon Resource Name (ARN) of the repository.
description (string) --
A text description of the repository.
upstreams (list) --
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.
(dict) --
Information about an upstream repository.
repositoryName (string) --
The name of an upstream repository.
externalConnections (list) --
An array of external connections associated with the repository.
(dict) --
Contains information about the external connection of a repository.
externalConnectionName (string) --
The name of the external connection associated with a repository.
packageFormat (string) --
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 (string) --
The status of the external connection of a repository. There is one valid value, Available .
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedExceptionCodeArtifact.Client.exceptions.ConflictExceptionCodeArtifact.Client.exceptions.InternalServerExceptionCodeArtifact.Client.exceptions.ResourceNotFoundExceptionCodeArtifact.Client.exceptions.ServiceQuotaExceededExceptionCodeArtifact.Client.exceptions.ThrottlingExceptionCodeArtifact.Client.exceptions.ValidationExceptionThe available paginators are:
CodeArtifact.Paginator.ListDomainsCodeArtifact.Paginator.ListPackageVersionAssetsCodeArtifact.Paginator.ListPackageVersionsCodeArtifact.Paginator.ListPackagesCodeArtifact.Paginator.ListRepositoriesCodeArtifact.Paginator.ListRepositoriesInDomainCodeArtifact.Paginator.ListDomains¶paginator = client.get_paginator('list_domains')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodeArtifact.Client.list_domains().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'domains': [
{
'name': 'string',
'owner': 'string',
'arn': 'string',
'status': 'Active'|'Deleted',
'createdTime': datetime(2015, 1, 1),
'encryptionKey': 'string'
},
],
'NextToken': 'string'
}
Response Structure
The returned list of DomainSummary objects.
Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.
The name of the domain.
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
The ARN of the domain.
A string that contains the status of the domain.
A timestamp that contains the date and time the domain was created.
The key used to encrypt the domain.
A token to resume pagination.
CodeArtifact.Paginator.ListPackageVersionAssets¶paginator = client.get_paginator('list_package_version_assets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodeArtifact.Client.list_package_version_assets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
packageVersion='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the domain that contains the repository associated with the package version assets.
[REQUIRED]
The name of the repository that contains the package that contains the requested package version assets.
[REQUIRED]
The format of the package that contains the requested package version assets.
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:
groupId .scope .[REQUIRED]
The name of the package that contains the requested package version assets.
[REQUIRED]
A string that contains the package version (for example, 3.5.2 ).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'version': 'string',
'versionRevision': 'string',
'assets': [
{
'name': 'string',
'size': 123,
'hashes': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
format (string) --
The format of the package that contains the requested package version assets.
namespace (string) --
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:
groupId .scope .package (string) --
The name of the package that contains the requested package version assets.
version (string) --
The version of the package associated with the requested assets.
versionRevision (string) --
The current revision associated with the package version.
assets (list) --
The returned list of AssetSummary objects.
(dict) --
Contains details about a package version asset.
name (string) --
The name of the asset.
size (integer) --
The size of the asset.
hashes (dict) --
The hashes of the asset.
NextToken (string) --
A token to resume pagination.
CodeArtifact.Paginator.ListPackageVersions¶paginator = client.get_paginator('list_package_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodeArtifact.Client.list_package_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
package='string',
status='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
sortBy='PUBLISHED_TIME',
originType='INTERNAL'|'EXTERNAL'|'UNKNOWN',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the domain that contains the repository that contains the requested package versions.
[REQUIRED]
The name of the repository that contains the requested package versions.
[REQUIRED]
The format of the returned package versions.
The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:
groupId .scope .[REQUIRED]
The name of the package for which you want to request package versions.
originType used to filter package versions. Only package versions with the provided originType will be returned.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'defaultDisplayVersion': 'string',
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'versions': [
{
'version': 'string',
'revision': 'string',
'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
'origin': {
'domainEntryPoint': {
'repositoryName': 'string',
'externalConnectionName': 'string'
},
'originType': 'INTERNAL'|'EXTERNAL'|'UNKNOWN'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
defaultDisplayVersion (string) --
The default package version to display. This depends on the package format:
latest tag. If the latest tag is not set, it's the most recently published package version.format (string) --
A format of the package.
namespace (string) --
The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:
groupId .scope .package (string) --
The name of the package.
versions (list) --
The returned list of PackageVersionSummary objects.
(dict) --
Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects.
version (string) --
Information about a package version.
revision (string) --
The revision associated with a package version.
status (string) --
A string that contains the status of the package version. It can be one of the following:
origin (dict) --
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
domainEntryPoint (dict) --
A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.
repositoryName (string) --
The name of the repository that a package was originally published to.
externalConnectionName (string) --
The name of the external connection that a package was ingested from.
originType (string) --
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.
NextToken (string) --
A token to resume pagination.
CodeArtifact.Paginator.ListPackages¶paginator = client.get_paginator('list_packages')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodeArtifact.Client.list_packages().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
domain='string',
domainOwner='string',
repository='string',
format='npm'|'pypi'|'maven'|'nuget',
namespace='string',
packagePrefix='string',
publish='ALLOW'|'BLOCK',
upstream='ALLOW'|'BLOCK',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the domain that contains the repository that contains the requested packages.
[REQUIRED]
The name of the repository that contains the requested packages.
The namespace used to filter requested packages. Only packages with the provided namespace will be returned. The package component that specifies its namespace depends on its type. For example:
groupId .scope .packagePrefix are returned.Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'packages': [
{
'format': 'npm'|'pypi'|'maven'|'nuget',
'namespace': 'string',
'package': 'string',
'originConfiguration': {
'restrictions': {
'publish': 'ALLOW'|'BLOCK',
'upstream': 'ALLOW'|'BLOCK'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
packages (list) --
The list of returned PackageSummary objects.
(dict) --
Details about a package, including its format, namespace, and name.
format (string) --
The format of the package.
namespace (string) --
The namespace of the package. The package component that specifies its namespace depends on its type. For example:
groupId .scope .package (string) --
The name of the package.
originConfiguration (dict) --
A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.
restrictions (dict) --
A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.
publish (string) --
The package origin configuration that determines if new versions of the package can be published directly to the repository.
upstream (string) --
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.
NextToken (string) --
A token to resume pagination.
CodeArtifact.Paginator.ListRepositories¶paginator = client.get_paginator('list_repositories')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodeArtifact.Client.list_repositories().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
repositoryPrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
repositoryPrefix are returned.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'repositories': [
{
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
repositories (list) --
The returned list of RepositorySummary objects.
(dict) --
Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.
name (string) --
The name of the repository.
administratorAccount (string) --
The Amazon Web Services account ID that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
arn (string) --
The ARN of the repository.
description (string) --
The description of the repository.
NextToken (string) --
A token to resume pagination.
CodeArtifact.Paginator.ListRepositoriesInDomain¶paginator = client.get_paginator('list_repositories_in_domain')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CodeArtifact.Client.list_repositories_in_domain().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
domain='string',
domainOwner='string',
administratorAccount='string',
repositoryPrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the domain that contains the returned list of repositories.
repositoryPrefix are returned.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'repositories': [
{
'name': 'string',
'administratorAccount': 'string',
'domainName': 'string',
'domainOwner': 'string',
'arn': 'string',
'description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
repositories (list) --
The returned list of repositories.
(dict) --
Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.
name (string) --
The name of the repository.
administratorAccount (string) --
The Amazon Web Services account ID that manages the repository.
domainName (string) --
The name of the domain that contains the repository.
domainOwner (string) --
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
arn (string) --
The ARN of the repository.
description (string) --
The description of the repository.
NextToken (string) --
A token to resume pagination.