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_package_group#
Creates a package group.
Type annotations and code completion for boto3.client("codeartifact").create_package_group
method.
boto3 documentation
# create_package_group method definition
def create_package_group(
self,
*,
domain: str,
packageGroup: str,
domainOwner: str = ...,
contactInfo: str = ...,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreatePackageGroupResultTypeDef: # (2)
...
# create_package_group method usage example with argument unpacking
kwargs: CreatePackageGroupRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
}
parent.create_package_group(**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_group#
Deletes a package group.
Type annotations and code completion for boto3.client("codeartifact").delete_package_group
method.
boto3 documentation
# delete_package_group method definition
def delete_package_group(
self,
*,
domain: str,
packageGroup: str,
domainOwner: str = ...,
) -> DeletePackageGroupResultTypeDef: # (1)
...
# delete_package_group method usage example with argument unpacking
kwargs: DeletePackageGroupRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
}
parent.delete_package_group(**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_group#
Returns a PackageGroupDescription object that contains information about the requested package group.
Type annotations and code completion for boto3.client("codeartifact").describe_package_group
method.
boto3 documentation
# describe_package_group method definition
def describe_package_group(
self,
*,
domain: str,
packageGroup: str,
domainOwner: str = ...,
) -> DescribePackageGroupResultTypeDef: # (1)
...
# describe_package_group method usage example with argument unpacking
kwargs: DescribePackageGroupRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
}
parent.describe_package_group(**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.
boto3 documentation
# describe_repository method definition
def describe_repository(
self,
*,
domain: str,
repository: str,
domainOwner: str = ...,
) -> DescribeRepositoryResultTypeDef: # (1)
...
# describe_repository method usage example with argument unpacking
kwargs: DescribeRepositoryRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
}
parent.describe_repository(**kwargs)
disassociate_external_connection#
Removes an existing external connection from a repository.
Type annotations and code completion for boto3.client("codeartifact").disassociate_external_connection
method.
boto3 documentation
# disassociate_external_connection method definition
def disassociate_external_connection(
self,
*,
domain: str,
repository: str,
externalConnection: str,
domainOwner: str = ...,
) -> DisassociateExternalConnectionResultTypeDef: # (1)
...
# disassociate_external_connection method usage example with argument unpacking
kwargs: DisassociateExternalConnectionRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"externalConnection": ...,
}
parent.disassociate_external_connection(**kwargs)
dispose_package_versions#
Deletes the assets in package versions and sets the package versions' status to
Disposed
.
Type annotations and code completion for boto3.client("codeartifact").dispose_package_versions
method.
boto3 documentation
# dispose_package_versions method definition
def dispose_package_versions(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
versions: Sequence[str],
domainOwner: str = ...,
namespace: str = ...,
versionRevisions: Mapping[str, str] = ...,
expectedStatus: PackageVersionStatusType = ..., # (2)
) -> DisposePackageVersionsResultTypeDef: # (3)
...
# dispose_package_versions method usage example with argument unpacking
kwargs: DisposePackageVersionsRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"versions": ...,
}
parent.dispose_package_versions(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("codeartifact").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_associated_package_group#
Returns the most closely associated package group to the specified package.
Type annotations and code completion for boto3.client("codeartifact").get_associated_package_group
method.
boto3 documentation
# get_associated_package_group method definition
def get_associated_package_group(
self,
*,
domain: str,
format: PackageFormatType, # (1)
package: str,
domainOwner: str = ...,
namespace: str = ...,
) -> GetAssociatedPackageGroupResultTypeDef: # (2)
...
# get_associated_package_group method usage example with argument unpacking
kwargs: GetAssociatedPackageGroupRequestRequestTypeDef = { # (1)
"domain": ...,
"format": ...,
"package": ...,
}
parent.get_associated_package_group(**kwargs)
get_authorization_token#
Generates a temporary authorization token for accessing repositories in the domain.
Type annotations and code completion for boto3.client("codeartifact").get_authorization_token
method.
boto3 documentation
# get_authorization_token method definition
def get_authorization_token(
self,
*,
domain: str,
domainOwner: str = ...,
durationSeconds: int = ...,
) -> GetAuthorizationTokenResultTypeDef: # (1)
...
# get_authorization_token method usage example with argument unpacking
kwargs: GetAuthorizationTokenRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.get_authorization_token(**kwargs)
get_domain_permissions_policy#
Returns the resource policy attached to the specified domain.
Type annotations and code completion for boto3.client("codeartifact").get_domain_permissions_policy
method.
boto3 documentation
# get_domain_permissions_policy method definition
def get_domain_permissions_policy(
self,
*,
domain: str,
domainOwner: str = ...,
) -> GetDomainPermissionsPolicyResultTypeDef: # (1)
...
# get_domain_permissions_policy method usage example with argument unpacking
kwargs: GetDomainPermissionsPolicyRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.get_domain_permissions_policy(**kwargs)
get_package_version_asset#
Returns an asset (or file) that is in a package.
Type annotations and code completion for boto3.client("codeartifact").get_package_version_asset
method.
boto3 documentation
# get_package_version_asset method definition
def get_package_version_asset(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
packageVersion: str,
asset: str,
domainOwner: str = ...,
namespace: str = ...,
packageVersionRevision: str = ...,
) -> GetPackageVersionAssetResultTypeDef: # (2)
...
# get_package_version_asset method usage example with argument unpacking
kwargs: GetPackageVersionAssetRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"packageVersion": ...,
"asset": ...,
}
parent.get_package_version_asset(**kwargs)
get_package_version_readme#
Gets the readme file or descriptive text for a package version.
Type annotations and code completion for boto3.client("codeartifact").get_package_version_readme
method.
boto3 documentation
# get_package_version_readme method definition
def get_package_version_readme(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
packageVersion: str,
domainOwner: str = ...,
namespace: str = ...,
) -> GetPackageVersionReadmeResultTypeDef: # (2)
...
# get_package_version_readme method usage example with argument unpacking
kwargs: GetPackageVersionReadmeRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"packageVersion": ...,
}
parent.get_package_version_readme(**kwargs)
get_repository_endpoint#
Returns the endpoint of a repository for a specific package format.
Type annotations and code completion for boto3.client("codeartifact").get_repository_endpoint
method.
boto3 documentation
# get_repository_endpoint method definition
def get_repository_endpoint(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
domainOwner: str = ...,
endpointType: EndpointTypeType = ..., # (2)
) -> GetRepositoryEndpointResultTypeDef: # (3)
...
# get_repository_endpoint method usage example with argument unpacking
kwargs: GetRepositoryEndpointRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
}
parent.get_repository_endpoint(**kwargs)
get_repository_permissions_policy#
Returns the resource policy that is set on a repository.
Type annotations and code completion for boto3.client("codeartifact").get_repository_permissions_policy
method.
boto3 documentation
# get_repository_permissions_policy method definition
def get_repository_permissions_policy(
self,
*,
domain: str,
repository: str,
domainOwner: str = ...,
) -> GetRepositoryPermissionsPolicyResultTypeDef: # (1)
...
# get_repository_permissions_policy method usage example with argument unpacking
kwargs: GetRepositoryPermissionsPolicyRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
}
parent.get_repository_permissions_policy(**kwargs)
list_allowed_repositories_for_group#
Lists the repositories in the added repositories list of the specified restriction type for a package group.
Type annotations and code completion for boto3.client("codeartifact").list_allowed_repositories_for_group
method.
boto3 documentation
# list_allowed_repositories_for_group method definition
def list_allowed_repositories_for_group(
self,
*,
domain: str,
packageGroup: str,
originRestrictionType: PackageGroupOriginRestrictionTypeType, # (1)
domainOwner: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListAllowedRepositoriesForGroupResultTypeDef: # (2)
...
# list_allowed_repositories_for_group method usage example with argument unpacking
kwargs: ListAllowedRepositoriesForGroupRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
"originRestrictionType": ...,
}
parent.list_allowed_repositories_for_group(**kwargs)
list_associated_packages#
Returns a list of packages associated with the requested package group.
Type annotations and code completion for boto3.client("codeartifact").list_associated_packages
method.
boto3 documentation
# list_associated_packages method definition
def list_associated_packages(
self,
*,
domain: str,
packageGroup: str,
domainOwner: str = ...,
maxResults: int = ...,
nextToken: str = ...,
preview: bool = ...,
) -> ListAssociatedPackagesResultTypeDef: # (1)
...
# list_associated_packages method usage example with argument unpacking
kwargs: ListAssociatedPackagesRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
}
parent.list_associated_packages(**kwargs)
list_domains#
Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call.
Type annotations and code completion for boto3.client("codeartifact").list_domains
method.
boto3 documentation
# list_domains method definition
def list_domains(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDomainsResultTypeDef: # (1)
...
# list_domains method usage example with argument unpacking
kwargs: ListDomainsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_domains(**kwargs)
list_package_groups#
Returns a list of package groups in the requested domain.
Type annotations and code completion for boto3.client("codeartifact").list_package_groups
method.
boto3 documentation
# list_package_groups method definition
def list_package_groups(
self,
*,
domain: str,
domainOwner: str = ...,
maxResults: int = ...,
nextToken: str = ...,
prefix: str = ...,
) -> ListPackageGroupsResultTypeDef: # (1)
...
# list_package_groups method usage example with argument unpacking
kwargs: ListPackageGroupsRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.list_package_groups(**kwargs)
list_package_version_assets#
Returns a list of AssetSummary objects for assets in a package version.
Type annotations and code completion for boto3.client("codeartifact").list_package_version_assets
method.
boto3 documentation
# list_package_version_assets method definition
def list_package_version_assets(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
packageVersion: str,
domainOwner: str = ...,
namespace: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListPackageVersionAssetsResultTypeDef: # (2)
...
# list_package_version_assets method usage example with argument unpacking
kwargs: ListPackageVersionAssetsRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"packageVersion": ...,
}
parent.list_package_version_assets(**kwargs)
list_package_version_dependencies#
Returns the direct dependencies for a package version.
Type annotations and code completion for boto3.client("codeartifact").list_package_version_dependencies
method.
boto3 documentation
# list_package_version_dependencies method definition
def list_package_version_dependencies(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
packageVersion: str,
domainOwner: str = ...,
namespace: str = ...,
nextToken: str = ...,
) -> ListPackageVersionDependenciesResultTypeDef: # (2)
...
# list_package_version_dependencies method usage example with argument unpacking
kwargs: ListPackageVersionDependenciesRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"packageVersion": ...,
}
parent.list_package_version_dependencies(**kwargs)
list_package_versions#
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
Type annotations and code completion for boto3.client("codeartifact").list_package_versions
method.
boto3 documentation
# list_package_versions method definition
def list_package_versions(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
domainOwner: str = ...,
namespace: str = ...,
status: PackageVersionStatusType = ..., # (2)
sortBy: PackageVersionSortTypeType = ..., # (3)
maxResults: int = ...,
nextToken: str = ...,
originType: PackageVersionOriginTypeType = ..., # (4)
) -> ListPackageVersionsResultTypeDef: # (5)
...
- See PackageFormatType
- See PackageVersionStatusType
- See PackageVersionSortTypeType
- See PackageVersionOriginTypeType
- See ListPackageVersionsResultTypeDef
# list_package_versions method usage example with argument unpacking
kwargs: ListPackageVersionsRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
}
parent.list_package_versions(**kwargs)
list_packages#
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
Type annotations and code completion for boto3.client("codeartifact").list_packages
method.
boto3 documentation
# list_packages method definition
def list_packages(
self,
*,
domain: str,
repository: str,
domainOwner: str = ...,
format: PackageFormatType = ..., # (1)
namespace: str = ...,
packagePrefix: str = ...,
maxResults: int = ...,
nextToken: str = ...,
publish: AllowPublishType = ..., # (2)
upstream: AllowUpstreamType = ..., # (3)
) -> ListPackagesResultTypeDef: # (4)
...
- See PackageFormatType
- See AllowPublishType
- See AllowUpstreamType
- See ListPackagesResultTypeDef
# list_packages method usage example with argument unpacking
kwargs: ListPackagesRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
}
parent.list_packages(**kwargs)
list_repositories#
Returns a list of RepositorySummary objects.
Type annotations and code completion for boto3.client("codeartifact").list_repositories
method.
boto3 documentation
# list_repositories method definition
def list_repositories(
self,
*,
repositoryPrefix: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListRepositoriesResultTypeDef: # (1)
...
# list_repositories method usage example with argument unpacking
kwargs: ListRepositoriesRequestRequestTypeDef = { # (1)
"repositoryPrefix": ...,
}
parent.list_repositories(**kwargs)
list_repositories_in_domain#
Returns a list of RepositorySummary objects.
Type annotations and code completion for boto3.client("codeartifact").list_repositories_in_domain
method.
boto3 documentation
# list_repositories_in_domain method definition
def list_repositories_in_domain(
self,
*,
domain: str,
domainOwner: str = ...,
administratorAccount: str = ...,
repositoryPrefix: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListRepositoriesInDomainResultTypeDef: # (1)
...
# list_repositories_in_domain method usage example with argument unpacking
kwargs: ListRepositoriesInDomainRequestRequestTypeDef = { # (1)
"domain": ...,
}
parent.list_repositories_in_domain(**kwargs)
list_sub_package_groups#
Returns a list of direct children of the specified package group.
Type annotations and code completion for boto3.client("codeartifact").list_sub_package_groups
method.
boto3 documentation
# list_sub_package_groups method definition
def list_sub_package_groups(
self,
*,
domain: str,
packageGroup: str,
domainOwner: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSubPackageGroupsResultTypeDef: # (1)
...
# list_sub_package_groups method usage example with argument unpacking
kwargs: ListSubPackageGroupsRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
}
parent.list_sub_package_groups(**kwargs)
list_tags_for_resource#
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
Type annotations and code completion for boto3.client("codeartifact").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResultTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
publish_package_version#
Creates a new package version containing one or more assets (or files).
Type annotations and code completion for boto3.client("codeartifact").publish_package_version
method.
boto3 documentation
# publish_package_version method definition
def publish_package_version(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
packageVersion: str,
assetContent: BlobTypeDef,
assetName: str,
assetSHA256: str,
domainOwner: str = ...,
namespace: str = ...,
unfinished: bool = ...,
) -> PublishPackageVersionResultTypeDef: # (2)
...
# publish_package_version method usage example with argument unpacking
kwargs: PublishPackageVersionRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"packageVersion": ...,
"assetContent": ...,
"assetName": ...,
"assetSHA256": ...,
}
parent.publish_package_version(**kwargs)
put_domain_permissions_policy#
Sets a resource policy on a domain that specifies permissions to access it.
Type annotations and code completion for boto3.client("codeartifact").put_domain_permissions_policy
method.
boto3 documentation
# put_domain_permissions_policy method definition
def put_domain_permissions_policy(
self,
*,
domain: str,
policyDocument: str,
domainOwner: str = ...,
policyRevision: str = ...,
) -> PutDomainPermissionsPolicyResultTypeDef: # (1)
...
# put_domain_permissions_policy method usage example with argument unpacking
kwargs: PutDomainPermissionsPolicyRequestRequestTypeDef = { # (1)
"domain": ...,
"policyDocument": ...,
}
parent.put_domain_permissions_policy(**kwargs)
put_package_origin_configuration#
Sets the package origin configuration for a package.
Type annotations and code completion for boto3.client("codeartifact").put_package_origin_configuration
method.
boto3 documentation
# put_package_origin_configuration method definition
def put_package_origin_configuration(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
restrictions: PackageOriginRestrictionsTypeDef, # (2)
domainOwner: str = ...,
namespace: str = ...,
) -> PutPackageOriginConfigurationResultTypeDef: # (3)
...
- See PackageFormatType
- See PackageOriginRestrictionsTypeDef
- See PutPackageOriginConfigurationResultTypeDef
# put_package_origin_configuration method usage example with argument unpacking
kwargs: PutPackageOriginConfigurationRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"restrictions": ...,
}
parent.put_package_origin_configuration(**kwargs)
put_repository_permissions_policy#
Sets the resource policy on a repository that specifies permissions to access it.
Type annotations and code completion for boto3.client("codeartifact").put_repository_permissions_policy
method.
boto3 documentation
# put_repository_permissions_policy method definition
def put_repository_permissions_policy(
self,
*,
domain: str,
repository: str,
policyDocument: str,
domainOwner: str = ...,
policyRevision: str = ...,
) -> PutRepositoryPermissionsPolicyResultTypeDef: # (1)
...
# put_repository_permissions_policy method usage example with argument unpacking
kwargs: PutRepositoryPermissionsPolicyRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"policyDocument": ...,
}
parent.put_repository_permissions_policy(**kwargs)
tag_resource#
Adds or updates tags for a resource in CodeArtifact.
Type annotations and code completion for boto3.client("codeartifact").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes tags from a resource in CodeArtifact.
Type annotations and code completion for boto3.client("codeartifact").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_package_group#
Updates a package group.
Type annotations and code completion for boto3.client("codeartifact").update_package_group
method.
boto3 documentation
# update_package_group method definition
def update_package_group(
self,
*,
domain: str,
packageGroup: str,
domainOwner: str = ...,
contactInfo: str = ...,
description: str = ...,
) -> UpdatePackageGroupResultTypeDef: # (1)
...
# update_package_group method usage example with argument unpacking
kwargs: UpdatePackageGroupRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
}
parent.update_package_group(**kwargs)
update_package_group_origin_configuration#
Updates the package origin configuration for a package group.
Type annotations and code completion for boto3.client("codeartifact").update_package_group_origin_configuration
method.
boto3 documentation
# update_package_group_origin_configuration method definition
def update_package_group_origin_configuration(
self,
*,
domain: str,
packageGroup: str,
domainOwner: str = ...,
restrictions: Mapping[PackageGroupOriginRestrictionTypeType, PackageGroupOriginRestrictionModeType] = ..., # (1)
addAllowedRepositories: Sequence[PackageGroupAllowedRepositoryTypeDef] = ..., # (2)
removeAllowedRepositories: Sequence[PackageGroupAllowedRepositoryTypeDef] = ..., # (2)
) -> UpdatePackageGroupOriginConfigurationResultTypeDef: # (4)
...
- See PackageGroupOriginRestrictionTypeType PackageGroupOriginRestrictionModeType
- See PackageGroupAllowedRepositoryTypeDef
- See PackageGroupAllowedRepositoryTypeDef
- See UpdatePackageGroupOriginConfigurationResultTypeDef
# update_package_group_origin_configuration method usage example with argument unpacking
kwargs: UpdatePackageGroupOriginConfigurationRequestRequestTypeDef = { # (1)
"domain": ...,
"packageGroup": ...,
}
parent.update_package_group_origin_configuration(**kwargs)
update_package_versions_status#
Updates the status of one or more versions of a package.
Type annotations and code completion for boto3.client("codeartifact").update_package_versions_status
method.
boto3 documentation
# update_package_versions_status method definition
def update_package_versions_status(
self,
*,
domain: str,
repository: str,
format: PackageFormatType, # (1)
package: str,
versions: Sequence[str],
targetStatus: PackageVersionStatusType, # (2)
domainOwner: str = ...,
namespace: str = ...,
versionRevisions: Mapping[str, str] = ...,
expectedStatus: PackageVersionStatusType = ..., # (2)
) -> UpdatePackageVersionsStatusResultTypeDef: # (4)
...
- See PackageFormatType
- See PackageVersionStatusType
- See PackageVersionStatusType
- See UpdatePackageVersionsStatusResultTypeDef
# update_package_versions_status method usage example with argument unpacking
kwargs: UpdatePackageVersionsStatusRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
"format": ...,
"package": ...,
"versions": ...,
"targetStatus": ...,
}
parent.update_package_versions_status(**kwargs)
update_repository#
Update the properties of a repository.
Type annotations and code completion for boto3.client("codeartifact").update_repository
method.
boto3 documentation
# update_repository method definition
def update_repository(
self,
*,
domain: str,
repository: str,
domainOwner: str = ...,
description: str = ...,
upstreams: Sequence[UpstreamRepositoryTypeDef] = ..., # (1)
) -> UpdateRepositoryResultTypeDef: # (2)
...
# update_repository method usage example with argument unpacking
kwargs: UpdateRepositoryRequestRequestTypeDef = { # (1)
"domain": ...,
"repository": ...,
}
parent.update_repository(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("codeartifact").get_paginator
method with overloads.
client.get_paginator("list_allowed_repositories_for_group")
-> ListAllowedRepositoriesForGroupPaginatorclient.get_paginator("list_associated_packages")
-> ListAssociatedPackagesPaginatorclient.get_paginator("list_domains")
-> ListDomainsPaginatorclient.get_paginator("list_package_groups")
-> ListPackageGroupsPaginatorclient.get_paginator("list_package_version_assets")
-> ListPackageVersionAssetsPaginatorclient.get_paginator("list_package_versions")
-> ListPackageVersionsPaginatorclient.get_paginator("list_packages")
-> ListPackagesPaginatorclient.get_paginator("list_repositories_in_domain")
-> ListRepositoriesInDomainPaginatorclient.get_paginator("list_repositories")
-> ListRepositoriesPaginatorclient.get_paginator("list_sub_package_groups")
-> ListSubPackageGroupsPaginator