CodeArtifactClient#
Index > CodeArtifact > CodeArtifactClient
Auto-generated documentation for CodeArtifact type annotations stubs module mypy-boto3-codeartifact.
CodeArtifactClient#
Type annotations and code completion for boto3.client("codeartifact")
.
boto3 documentation
# CodeArtifactClient usage example
from boto3.session import Session
from mypy_boto3_codeartifact.client import CodeArtifactClient
def get_codeartifact_client() -> CodeArtifactClient:
return Session().client("codeartifact")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("codeartifact").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("codeartifact")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_codeartifact.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
associate_external_connection#
Adds an existing external connection to a repository.
Type annotations and code completion for boto3.client("codeartifact").associate_external_connection
method.
boto3 documentation
# associate_external_connection method definition
def associate_external_connection(
self,
*,
domain: str,
repository: str,
externalConnection: str,
domainOwner: str = ...,
) -> AssociateExternalConnectionResultTypeDef: # (1)
...
# associate_external_connection method usage example with argument unpacking
kwargs: AssociateExternalConnectionRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"externalConnection": ...,
}
parent.associate_external_connection(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("codeartifact").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("codeartifact").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
copy_package_versions#
Copies package versions from one repository to another repository in the same domain.
Type annotations and code completion for boto3.client("codeartifact").copy_package_versions
method.
boto3 documentation
# copy_package_versions method definition
def copy_package_versions(
self,
*,
domain: str,
sourceRepository: str,
destinationRepository: str,
format: PackageFormatType, # (1)
package: str,
domainOwner: str = ...,
namespace: str = ...,
versions: Sequence[str] = ...,
versionRevisions: Mapping[str, str] = ...,
allowOverwrite: bool = ...,
includeFromUpstream: bool = ...,
) -> CopyPackageVersionsResultTypeDef: # (2)
...
# copy_package_versions method usage example with argument unpacking
kwargs: CopyPackageVersionsRequestRequestTypeDef = { # (1)
"domain": ...,
"sourceRepository": ...,
"destinationRepository": ...,
"format": ...,
"package": ...,
}
parent.copy_package_versions(**kwargs)
create_domain#
Creates a domain.
Type annotations and code completion for boto3.client("codeartifact").create_domain
method.
boto3 documentation
# create_domain method definition
def create_domain(
self,
*,
domain: str,
encryptionKey: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDomainResultTypeDef: # (2)
...
- See TagTypeDef
- See CreateDomainResultTypeDef
# create_domain method usage example with argument unpacking
kwargs: CreateDomainRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.create_domain(**kwargs)
create_repository#
Creates a repository.
Type annotations and code completion for boto3.client("codeartifact").create_repository
method.
boto3 documentation
# create_repository method definition
def create_repository(
self,
*,
domain: str,
repository: str,
domainOwner: str = ...,
description: str = ...,
upstreams: Sequence[UpstreamRepositoryTypeDef] = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateRepositoryResultTypeDef: # (3)
...
# create_repository method usage example with argument unpacking
kwargs: CreateRepositoryRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
}
parent.create_repository(**kwargs)
delete_domain#
Deletes a domain.
Type annotations and code completion for boto3.client("codeartifact").delete_domain
method.
boto3 documentation
# delete_domain method definition
def delete_domain(
self,
*,
domain: str,
domainOwner: str = ...,
) -> DeleteDomainResultTypeDef: # (1)
...
# delete_domain method usage example with argument unpacking
kwargs: DeleteDomainRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.delete_domain(**kwargs)
delete_domain_permissions_policy#
Deletes the resource policy set on a domain.
Type annotations and code completion for boto3.client("codeartifact").delete_domain_permissions_policy
method.
boto3 documentation
# delete_domain_permissions_policy method definition
def delete_domain_permissions_policy(
self,
*,
domain: str,
domainOwner: str = ...,
policyRevision: str = ...,
) -> DeleteDomainPermissionsPolicyResultTypeDef: # (1)
...
# delete_domain_permissions_policy method usage example with argument unpacking
kwargs: DeleteDomainPermissionsPolicyRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.delete_domain_permissions_policy(**kwargs)
delete_package#
Deletes a package and all associated package versions.
Type annotations and code completion for boto3.client("codeartifact").delete_package
method.
boto3 documentation
# delete_package method definition
def delete_package(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
domainOwner: str = ...,
namespace: str = ...,
) -> DeletePackageResultTypeDef: # (2)
...
# delete_package method usage example with argument unpacking
kwargs: DeletePackageRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
}
parent.delete_package(**kwargs)
delete_package_versions#
Deletes one or more versions of a package.
Type annotations and code completion for boto3.client("codeartifact").delete_package_versions
method.
boto3 documentation
# delete_package_versions method definition
def delete_package_versions(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
versions: Sequence[str],
domainOwner: str = ...,
namespace: str = ...,
expectedStatus: PackageVersionStatusType = ..., # (2)
) -> DeletePackageVersionsResultTypeDef: # (3)
...
# delete_package_versions method usage example with argument unpacking
kwargs: DeletePackageVersionsRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"versions": ...,
}
parent.delete_package_versions(**kwargs)
delete_repository#
Deletes a repository.
Type annotations and code completion for boto3.client("codeartifact").delete_repository
method.
boto3 documentation
# delete_repository method definition
def delete_repository(
self,
*,
domain: str,
repository: str,
domainOwner: str = ...,
) -> DeleteRepositoryResultTypeDef: # (1)
...
# delete_repository method usage example with argument unpacking
kwargs: DeleteRepositoryRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
}
parent.delete_repository(**kwargs)
delete_repository_permissions_policy#
Deletes the resource policy that is set on a repository.
Type annotations and code completion for boto3.client("codeartifact").delete_repository_permissions_policy
method.
boto3 documentation
# delete_repository_permissions_policy method definition
def delete_repository_permissions_policy(
self,
*,
domain: str,
repository: str,
domainOwner: str = ...,
policyRevision: str = ...,
) -> DeleteRepositoryPermissionsPolicyResultTypeDef: # (1)
...
# delete_repository_permissions_policy method usage example with argument unpacking
kwargs: DeleteRepositoryPermissionsPolicyRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
}
parent.delete_repository_permissions_policy(**kwargs)
describe_domain#
Returns a DomainDescription object that contains information about the requested domain.
Type annotations and code completion for boto3.client("codeartifact").describe_domain
method.
boto3 documentation
# describe_domain method definition
def describe_domain(
self,
*,
domain: str,
domainOwner: str = ...,
) -> DescribeDomainResultTypeDef: # (1)
...
# describe_domain method usage example with argument unpacking
kwargs: DescribeDomainRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.describe_domain(**kwargs)
describe_package#
Returns a PackageDescription object that contains information about the requested package.
Type annotations and code completion for boto3.client("codeartifact").describe_package
method.
boto3 documentation
# describe_package method definition
def describe_package(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
domainOwner: str = ...,
namespace: str = ...,
) -> DescribePackageResultTypeDef: # (2)
...
# describe_package method usage example with argument unpacking
kwargs: DescribePackageRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
}
parent.describe_package(**kwargs)
describe_package_version#
Returns a PackageVersionDescription object that contains information about the requested package version.
Type annotations and code completion for boto3.client("codeartifact").describe_package_version
method.
boto3 documentation
# describe_package_version method definition
def describe_package_version(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
packageVersion: str,
domainOwner: str = ...,
namespace: str = ...,
) -> DescribePackageVersionResultTypeDef: # (2)
...
# describe_package_version method usage example with argument unpacking
kwargs: DescribePackageVersionRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"packageVersion": ...,
}
parent.describe_package_version(**kwargs)
describe_repository#
Returns a RepositoryDescription
object that contains detailed information
about the requested
repository.
Type annotations and code completion for boto3.client("codeartifact").describe_repository
method.