Interface CodeartifactAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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 concepts
-
Repository: A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the
npm
CLI, the Maven CLI (mvn
), Python CLIs (pip
andtwine
), NuGet CLIs (nuget
anddotnet
), and the Swift package manager (swift
). -
Domain: Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).
Each repository is a member of a single domain and can't be moved to a different domain.
The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.
Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.
-
Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, and generic package formats.
In CodeArtifact, a package consists of:
-
A name (for example,
webpack
is the name of a popular npm package) -
An optional namespace (for example,
@types
in@types/node
) -
A set of versions (for example,
1.0.0
,1.0.1
,1.0.2
, etc.) -
Package-level metadata (for example, npm tags)
-
-
Package group: A group of packages that match a specified definition. Package groups can be used to apply configuration to multiple packages that match a defined pattern using package format, package namespace, and package name. You can use package groups to more conveniently configure package origin controls for multiple packages. Package origin controls are used to block or allow ingestion or publishing of new package versions, which protects users from malicious actions known as dependency substitution attacks.
-
Package version: A version of a package, such as
@types/node 12.6.9
. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic Versioning specification. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets. -
Upstream repository: One repository is upstream of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.
-
Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm
.tgz
file or Maven POM and JAR files.
CodeArtifact supported API operations
-
AssociateExternalConnection
: Adds an existing external connection to a repository. -
CopyPackageVersions
: Copies package versions from one repository to another repository in the same domain. -
CreateDomain
: Creates a domain. -
CreatePackageGroup
: Creates a package group. -
CreateRepository
: Creates a CodeArtifact repository in a domain. -
DeleteDomain
: Deletes a domain. You cannot delete a domain that contains repositories. -
DeleteDomainPermissionsPolicy
: Deletes the resource policy that is set on a domain. -
DeletePackage
: Deletes a package and all associated package versions. -
DeletePackageGroup
: Deletes a package group. Does not delete packages or package versions that are associated with a package group. -
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 aDomainDescription
object that contains information about the requested domain. -
DescribePackage
: Returns a PackageDescription object that contains details about a package. -
DescribePackageGroup
: Returns a PackageGroup object that contains details about a package group. -
DescribePackageVersion
: Returns a PackageVersionDescription object that contains details about a package version. -
DescribeRepository
: Returns aRepositoryDescription
object that contains detailed information about the requested repository. -
DisposePackageVersions
: Disposes versions of a package. A package version with the statusDisposed
cannot be restored because they have been permanently removed from storage. -
DisassociateExternalConnection
: Removes an existing external connection from a repository. -
GetAssociatedPackageGroup
: Returns the most closely associated package group to the specified package. -
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:-
generic
-
maven
-
npm
-
nuget
-
pypi
-
swift
-
-
GetRepositoryPermissionsPolicy
: Returns the resource policy that is set on a repository. -
ListAllowedRepositoriesForGroup
: Lists the allowed repositories for a package group that has origin configuration set toALLOW_SPECIFIC_REPOSITORIES
. -
ListAssociatedPackages
: Returns a list of packages associated with the requested package group. -
ListDomains
: Returns a list ofDomainSummary
objects. Each returnedDomainSummary
object contains information about a domain. -
ListPackages
: Lists the packages in a repository. -
ListPackageGroups
: Returns a list of package groups in the requested domain. -
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. -
ListSubPackageGroups
: Returns a list of direct children of the specified package group. -
PublishPackageVersion
: Creates a new package version containing one or more assets. -
PutDomainPermissionsPolicy
: Attaches a resource policy to a domain. -
PutPackageOriginConfiguration
: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository. -
PutRepositoryPermissionsPolicy
: Sets the resource policy on a repository that specifies permissions to access it. -
UpdatePackageGroup
: Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. -
UpdatePackageGroupOriginConfiguration
: Updates the package origin configuration for a package group. -
UpdatePackageVersionsStatus
: Updates the status of one or more versions of a package. -
UpdateRepository
: Updates the properties of a repository.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateExternalConnection
(Consumer<AssociateExternalConnectionRequest.Builder> associateExternalConnectionRequest) Adds an existing external connection to a repository.associateExternalConnection
(AssociateExternalConnectionRequest associateExternalConnectionRequest) Adds an existing external connection to a repository.builder()
Create a builder that can be used to configure and create aCodeartifactAsyncClient
.copyPackageVersions
(Consumer<CopyPackageVersionsRequest.Builder> copyPackageVersionsRequest) Copies package versions from one repository to another repository in the same domain.copyPackageVersions
(CopyPackageVersionsRequest copyPackageVersionsRequest) Copies package versions from one repository to another repository in the same domain.static CodeartifactAsyncClient
create()
Create aCodeartifactAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateDomainResponse> createDomain
(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a domain.default CompletableFuture
<CreateDomainResponse> createDomain
(CreateDomainRequest createDomainRequest) Creates a domain.createPackageGroup
(Consumer<CreatePackageGroupRequest.Builder> createPackageGroupRequest) Creates a package group.createPackageGroup
(CreatePackageGroupRequest createPackageGroupRequest) Creates a package group.createRepository
(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) Creates a repository.createRepository
(CreateRepositoryRequest createRepositoryRequest) Creates a repository.default CompletableFuture
<DeleteDomainResponse> deleteDomain
(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes a domain.default CompletableFuture
<DeleteDomainResponse> deleteDomain
(DeleteDomainRequest deleteDomainRequest) Deletes a domain.deleteDomainPermissionsPolicy
(Consumer<DeleteDomainPermissionsPolicyRequest.Builder> deleteDomainPermissionsPolicyRequest) Deletes the resource policy set on a domain.deleteDomainPermissionsPolicy
(DeleteDomainPermissionsPolicyRequest deleteDomainPermissionsPolicyRequest) Deletes the resource policy set on a domain.default CompletableFuture
<DeletePackageResponse> deletePackage
(Consumer<DeletePackageRequest.Builder> deletePackageRequest) Deletes a package and all associated package versions.default CompletableFuture
<DeletePackageResponse> deletePackage
(DeletePackageRequest deletePackageRequest) Deletes a package and all associated package versions.deletePackageGroup
(Consumer<DeletePackageGroupRequest.Builder> deletePackageGroupRequest) Deletes a package group.deletePackageGroup
(DeletePackageGroupRequest deletePackageGroupRequest) Deletes a package group.deletePackageVersions
(Consumer<DeletePackageVersionsRequest.Builder> deletePackageVersionsRequest) Deletes one or more versions of a package.deletePackageVersions
(DeletePackageVersionsRequest deletePackageVersionsRequest) Deletes one or more versions of a package.deleteRepository
(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) Deletes a repository.deleteRepository
(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository.deleteRepositoryPermissionsPolicy
(Consumer<DeleteRepositoryPermissionsPolicyRequest.Builder> deleteRepositoryPermissionsPolicyRequest) Deletes the resource policy that is set on a repository.deleteRepositoryPermissionsPolicy
(DeleteRepositoryPermissionsPolicyRequest deleteRepositoryPermissionsPolicyRequest) Deletes the resource policy that is set on a repository.default CompletableFuture
<DescribeDomainResponse> describeDomain
(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) Returns a DomainDescription object that contains information about the requested domain.default CompletableFuture
<DescribeDomainResponse> describeDomain
(DescribeDomainRequest describeDomainRequest) Returns a DomainDescription object that contains information about the requested domain.default CompletableFuture
<DescribePackageResponse> describePackage
(Consumer<DescribePackageRequest.Builder> describePackageRequest) Returns a PackageDescription object that contains information about the requested package.default CompletableFuture
<DescribePackageResponse> describePackage
(DescribePackageRequest describePackageRequest) Returns a PackageDescription object that contains information about the requested package.describePackageGroup
(Consumer<DescribePackageGroupRequest.Builder> describePackageGroupRequest) Returns a PackageGroupDescription object that contains information about the requested package group.describePackageGroup
(DescribePackageGroupRequest describePackageGroupRequest) Returns a PackageGroupDescription object that contains information about the requested package group.describePackageVersion
(Consumer<DescribePackageVersionRequest.Builder> describePackageVersionRequest) Returns a PackageVersionDescription object that contains information about the requested package version.describePackageVersion
(DescribePackageVersionRequest describePackageVersionRequest) Returns a PackageVersionDescription object that contains information about the requested package version.describeRepository
(Consumer<DescribeRepositoryRequest.Builder> describeRepositoryRequest) Returns aRepositoryDescription
object that contains detailed information about the requested repository.describeRepository
(DescribeRepositoryRequest describeRepositoryRequest) Returns aRepositoryDescription
object that contains detailed information about the requested repository.disassociateExternalConnection
(Consumer<DisassociateExternalConnectionRequest.Builder> disassociateExternalConnectionRequest) Removes an existing external connection from a repository.disassociateExternalConnection
(DisassociateExternalConnectionRequest disassociateExternalConnectionRequest) Removes an existing external connection from a repository.disposePackageVersions
(Consumer<DisposePackageVersionsRequest.Builder> disposePackageVersionsRequest) Deletes the assets in package versions and sets the package versions' status toDisposed
.disposePackageVersions
(DisposePackageVersionsRequest disposePackageVersionsRequest) Deletes the assets in package versions and sets the package versions' status toDisposed
.getAssociatedPackageGroup
(Consumer<GetAssociatedPackageGroupRequest.Builder> getAssociatedPackageGroupRequest) Returns the most closely associated package group to the specified package.getAssociatedPackageGroup
(GetAssociatedPackageGroupRequest getAssociatedPackageGroupRequest) Returns the most closely associated package group to the specified package.getAuthorizationToken
(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) Generates a temporary authorization token for accessing repositories in the domain.getAuthorizationToken
(GetAuthorizationTokenRequest getAuthorizationTokenRequest) Generates a temporary authorization token for accessing repositories in the domain.getDomainPermissionsPolicy
(Consumer<GetDomainPermissionsPolicyRequest.Builder> getDomainPermissionsPolicyRequest) Returns the resource policy attached to the specified domain.getDomainPermissionsPolicy
(GetDomainPermissionsPolicyRequest getDomainPermissionsPolicyRequest) Returns the resource policy attached to the specified domain.getPackageVersionAsset
(Consumer<GetPackageVersionAssetRequest.Builder> getPackageVersionAssetRequest, Path destinationPath) Returns an asset (or file) that is in a package.default <ReturnT> CompletableFuture
<ReturnT> getPackageVersionAsset
(Consumer<GetPackageVersionAssetRequest.Builder> getPackageVersionAssetRequest, AsyncResponseTransformer<GetPackageVersionAssetResponse, ReturnT> asyncResponseTransformer) Returns an asset (or file) that is in a package.getPackageVersionAsset
(GetPackageVersionAssetRequest getPackageVersionAssetRequest, Path destinationPath) Returns an asset (or file) that is in a package.default <ReturnT> CompletableFuture
<ReturnT> getPackageVersionAsset
(GetPackageVersionAssetRequest getPackageVersionAssetRequest, AsyncResponseTransformer<GetPackageVersionAssetResponse, ReturnT> asyncResponseTransformer) Returns an asset (or file) that is in a package.getPackageVersionReadme
(Consumer<GetPackageVersionReadmeRequest.Builder> getPackageVersionReadmeRequest) Gets the readme file or descriptive text for a package version.getPackageVersionReadme
(GetPackageVersionReadmeRequest getPackageVersionReadmeRequest) Gets the readme file or descriptive text for a package version.getRepositoryEndpoint
(Consumer<GetRepositoryEndpointRequest.Builder> getRepositoryEndpointRequest) Returns the endpoint of a repository for a specific package format.getRepositoryEndpoint
(GetRepositoryEndpointRequest getRepositoryEndpointRequest) Returns the endpoint of a repository for a specific package format.getRepositoryPermissionsPolicy
(Consumer<GetRepositoryPermissionsPolicyRequest.Builder> getRepositoryPermissionsPolicyRequest) Returns the resource policy that is set on a repository.getRepositoryPermissionsPolicy
(GetRepositoryPermissionsPolicyRequest getRepositoryPermissionsPolicyRequest) Returns the resource policy that is set on a repository.listAllowedRepositoriesForGroup
(Consumer<ListAllowedRepositoriesForGroupRequest.Builder> listAllowedRepositoriesForGroupRequest) Lists the repositories in the added repositories list of the specified restriction type for a package group.listAllowedRepositoriesForGroup
(ListAllowedRepositoriesForGroupRequest listAllowedRepositoriesForGroupRequest) Lists the repositories in the added repositories list of the specified restriction type for a package group.listAllowedRepositoriesForGroupPaginator
(Consumer<ListAllowedRepositoriesForGroupRequest.Builder> listAllowedRepositoriesForGroupRequest) This is a variant oflistAllowedRepositoriesForGroup(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupRequest)
operation.listAllowedRepositoriesForGroupPaginator
(ListAllowedRepositoriesForGroupRequest listAllowedRepositoriesForGroupRequest) This is a variant oflistAllowedRepositoriesForGroup(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupRequest)
operation.listAssociatedPackages
(Consumer<ListAssociatedPackagesRequest.Builder> listAssociatedPackagesRequest) Returns a list of packages associated with the requested package group.listAssociatedPackages
(ListAssociatedPackagesRequest listAssociatedPackagesRequest) Returns a list of packages associated with the requested package group.default ListAssociatedPackagesPublisher
listAssociatedPackagesPaginator
(Consumer<ListAssociatedPackagesRequest.Builder> listAssociatedPackagesRequest) This is a variant oflistAssociatedPackages(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesRequest)
operation.default ListAssociatedPackagesPublisher
listAssociatedPackagesPaginator
(ListAssociatedPackagesRequest listAssociatedPackagesRequest) This is a variant oflistAssociatedPackages(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesRequest)
operation.default CompletableFuture
<ListDomainsResponse> listDomains
(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call.default CompletableFuture
<ListDomainsResponse> listDomains
(ListDomainsRequest listDomainsRequest) Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call.default ListDomainsPublisher
listDomainsPaginator
(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.codeartifact.model.ListDomainsRequest)
operation.default ListDomainsPublisher
listDomainsPaginator
(ListDomainsRequest listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.codeartifact.model.ListDomainsRequest)
operation.listPackageGroups
(Consumer<ListPackageGroupsRequest.Builder> listPackageGroupsRequest) Returns a list of package groups in the requested domain.listPackageGroups
(ListPackageGroupsRequest listPackageGroupsRequest) Returns a list of package groups in the requested domain.default ListPackageGroupsPublisher
listPackageGroupsPaginator
(Consumer<ListPackageGroupsRequest.Builder> listPackageGroupsRequest) This is a variant oflistPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsRequest)
operation.default ListPackageGroupsPublisher
listPackageGroupsPaginator
(ListPackageGroupsRequest listPackageGroupsRequest) This is a variant oflistPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsRequest)
operation.default CompletableFuture
<ListPackagesResponse> listPackages
(Consumer<ListPackagesRequest.Builder> listPackagesRequest) Returns a list of PackageSummary objects for packages in a repository that match the request parameters.default CompletableFuture
<ListPackagesResponse> listPackages
(ListPackagesRequest listPackagesRequest) Returns a list of PackageSummary objects for packages in a repository that match the request parameters.default ListPackagesPublisher
listPackagesPaginator
(Consumer<ListPackagesRequest.Builder> listPackagesRequest) This is a variant oflistPackages(software.amazon.awssdk.services.codeartifact.model.ListPackagesRequest)
operation.default ListPackagesPublisher
listPackagesPaginator
(ListPackagesRequest listPackagesRequest) This is a variant oflistPackages(software.amazon.awssdk.services.codeartifact.model.ListPackagesRequest)
operation.listPackageVersionAssets
(Consumer<ListPackageVersionAssetsRequest.Builder> listPackageVersionAssetsRequest) Returns a list of AssetSummary objects for assets in a package version.listPackageVersionAssets
(ListPackageVersionAssetsRequest listPackageVersionAssetsRequest) Returns a list of AssetSummary objects for assets in a package version.listPackageVersionAssetsPaginator
(Consumer<ListPackageVersionAssetsRequest.Builder> listPackageVersionAssetsRequest) This is a variant oflistPackageVersionAssets(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsRequest)
operation.listPackageVersionAssetsPaginator
(ListPackageVersionAssetsRequest listPackageVersionAssetsRequest) This is a variant oflistPackageVersionAssets(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsRequest)
operation.listPackageVersionDependencies
(Consumer<ListPackageVersionDependenciesRequest.Builder> listPackageVersionDependenciesRequest) Returns the direct dependencies for a package version.listPackageVersionDependencies
(ListPackageVersionDependenciesRequest listPackageVersionDependenciesRequest) Returns the direct dependencies for a package version.listPackageVersions
(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.listPackageVersions
(ListPackageVersionsRequest listPackageVersionsRequest) Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.default ListPackageVersionsPublisher
listPackageVersionsPaginator
(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) This is a variant oflistPackageVersions(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsRequest)
operation.default ListPackageVersionsPublisher
listPackageVersionsPaginator
(ListPackageVersionsRequest listPackageVersionsRequest) This is a variant oflistPackageVersions(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsRequest)
operation.listRepositories
(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) Returns a list of RepositorySummary objects.listRepositories
(ListRepositoriesRequest listRepositoriesRequest) Returns a list of RepositorySummary objects.listRepositoriesInDomain
(Consumer<ListRepositoriesInDomainRequest.Builder> listRepositoriesInDomainRequest) Returns a list of RepositorySummary objects.listRepositoriesInDomain
(ListRepositoriesInDomainRequest listRepositoriesInDomainRequest) Returns a list of RepositorySummary objects.listRepositoriesInDomainPaginator
(Consumer<ListRepositoriesInDomainRequest.Builder> listRepositoriesInDomainRequest) This is a variant oflistRepositoriesInDomain(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainRequest)
operation.listRepositoriesInDomainPaginator
(ListRepositoriesInDomainRequest listRepositoriesInDomainRequest) This is a variant oflistRepositoriesInDomain(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainRequest)
operation.default ListRepositoriesPublisher
listRepositoriesPaginator
(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) This is a variant oflistRepositories(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesRequest)
operation.default ListRepositoriesPublisher
listRepositoriesPaginator
(ListRepositoriesRequest listRepositoriesRequest) This is a variant oflistRepositories(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesRequest)
operation.listSubPackageGroups
(Consumer<ListSubPackageGroupsRequest.Builder> listSubPackageGroupsRequest) Returns a list of direct children of the specified package group.listSubPackageGroups
(ListSubPackageGroupsRequest listSubPackageGroupsRequest) Returns a list of direct children of the specified package group.default ListSubPackageGroupsPublisher
listSubPackageGroupsPaginator
(Consumer<ListSubPackageGroupsRequest.Builder> listSubPackageGroupsRequest) This is a variant oflistSubPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsRequest)
operation.default ListSubPackageGroupsPublisher
listSubPackageGroupsPaginator
(ListSubPackageGroupsRequest listSubPackageGroupsRequest) This is a variant oflistSubPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.publishPackageVersion
(Consumer<PublishPackageVersionRequest.Builder> publishPackageVersionRequest, Path sourcePath) Creates a new package version containing one or more assets (or files).publishPackageVersion
(Consumer<PublishPackageVersionRequest.Builder> publishPackageVersionRequest, AsyncRequestBody requestBody) Creates a new package version containing one or more assets (or files).publishPackageVersion
(PublishPackageVersionRequest publishPackageVersionRequest, Path sourcePath) Creates a new package version containing one or more assets (or files).publishPackageVersion
(PublishPackageVersionRequest publishPackageVersionRequest, AsyncRequestBody requestBody) Creates a new package version containing one or more assets (or files).putDomainPermissionsPolicy
(Consumer<PutDomainPermissionsPolicyRequest.Builder> putDomainPermissionsPolicyRequest) Sets a resource policy on a domain that specifies permissions to access it.putDomainPermissionsPolicy
(PutDomainPermissionsPolicyRequest putDomainPermissionsPolicyRequest) Sets a resource policy on a domain that specifies permissions to access it.putPackageOriginConfiguration
(Consumer<PutPackageOriginConfigurationRequest.Builder> putPackageOriginConfigurationRequest) Sets the package origin configuration for a package.putPackageOriginConfiguration
(PutPackageOriginConfigurationRequest putPackageOriginConfigurationRequest) Sets the package origin configuration for a package.putRepositoryPermissionsPolicy
(Consumer<PutRepositoryPermissionsPolicyRequest.Builder> putRepositoryPermissionsPolicyRequest) Sets the resource policy on a repository that specifies permissions to access it.putRepositoryPermissionsPolicy
(PutRepositoryPermissionsPolicyRequest putRepositoryPermissionsPolicyRequest) Sets the resource policy on a repository that specifies permissions to access it.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for a resource in CodeArtifact.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or updates tags for a resource in CodeArtifact.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource in CodeArtifact.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from a resource in CodeArtifact.updatePackageGroup
(Consumer<UpdatePackageGroupRequest.Builder> updatePackageGroupRequest) Updates a package group.updatePackageGroup
(UpdatePackageGroupRequest updatePackageGroupRequest) Updates a package group.updatePackageGroupOriginConfiguration
(Consumer<UpdatePackageGroupOriginConfigurationRequest.Builder> updatePackageGroupOriginConfigurationRequest) Updates the package origin configuration for a package group.updatePackageGroupOriginConfiguration
(UpdatePackageGroupOriginConfigurationRequest updatePackageGroupOriginConfigurationRequest) Updates the package origin configuration for a package group.updatePackageVersionsStatus
(Consumer<UpdatePackageVersionsStatusRequest.Builder> updatePackageVersionsStatusRequest) Updates the status of one or more versions of a package.updatePackageVersionsStatus
(UpdatePackageVersionsStatusRequest updatePackageVersionsStatusRequest) Updates the status of one or more versions of a package.updateRepository
(Consumer<UpdateRepositoryRequest.Builder> updateRepositoryRequest) Update the properties of a repository.updateRepository
(UpdateRepositoryRequest updateRepositoryRequest) Update the properties of a repository.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateExternalConnection
default CompletableFuture<AssociateExternalConnectionResponse> associateExternalConnection(AssociateExternalConnectionRequest associateExternalConnectionRequest) Adds an existing external connection to a repository. One external connection is allowed per repository.
A repository can have one or more upstream repositories, or an external connection.
- Parameters:
associateExternalConnectionRequest
-- Returns:
- A Java Future containing the result of the AssociateExternalConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateExternalConnection
default CompletableFuture<AssociateExternalConnectionResponse> associateExternalConnection(Consumer<AssociateExternalConnectionRequest.Builder> associateExternalConnectionRequest) Adds an existing external connection to a repository. One external connection is allowed per repository.
A repository can have one or more upstream repositories, or an external connection.
This is a convenience which creates an instance of the
AssociateExternalConnectionRequest.Builder
avoiding the need to create one manually viaAssociateExternalConnectionRequest.builder()
- Parameters:
associateExternalConnectionRequest
- AConsumer
that will call methods onAssociateExternalConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateExternalConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copyPackageVersions
default CompletableFuture<CopyPackageVersionsResponse> copyPackageVersions(CopyPackageVersionsRequest copyPackageVersionsRequest) Copies package versions from one repository to another repository in the same domain.
You must specify
versions
orversionRevisions
. You cannot specify both.- Parameters:
copyPackageVersionsRequest
-- Returns:
- A Java Future containing the result of the CopyPackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copyPackageVersions
default CompletableFuture<CopyPackageVersionsResponse> copyPackageVersions(Consumer<CopyPackageVersionsRequest.Builder> copyPackageVersionsRequest) Copies package versions from one repository to another repository in the same domain.
You must specify
versions
orversionRevisions
. You cannot specify both.
This is a convenience which creates an instance of the
CopyPackageVersionsRequest.Builder
avoiding the need to create one manually viaCopyPackageVersionsRequest.builder()
- Parameters:
copyPackageVersionsRequest
- AConsumer
that will call methods onCopyPackageVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyPackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest) 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.
- Parameters:
createDomainRequest
-- Returns:
- A Java Future containing the result of the CreateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) 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.
This is a convenience which creates an instance of the
CreateDomainRequest.Builder
avoiding the need to create one manually viaCreateDomainRequest.builder()
- Parameters:
createDomainRequest
- AConsumer
that will call methods onCreateDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPackageGroup
default CompletableFuture<CreatePackageGroupResponse> createPackageGroup(CreatePackageGroupRequest createPackageGroupRequest) Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.
- Parameters:
createPackageGroupRequest
-- Returns:
- A Java Future containing the result of the CreatePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPackageGroup
default CompletableFuture<CreatePackageGroupResponse> createPackageGroup(Consumer<CreatePackageGroupRequest.Builder> createPackageGroupRequest) Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
CreatePackageGroupRequest.Builder
avoiding the need to create one manually viaCreatePackageGroupRequest.builder()
- Parameters:
createPackageGroupRequest
- AConsumer
that will call methods onCreatePackageGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRepository
default CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest createRepositoryRequest) Creates a repository.
- Parameters:
createRepositoryRequest
-- Returns:
- A Java Future containing the result of the CreateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRepository
default CompletableFuture<CreateRepositoryResponse> createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) Creates a repository.
This is a convenience which creates an instance of the
CreateRepositoryRequest.Builder
avoiding the need to create one manually viaCreateRepositoryRequest.builder()
- Parameters:
createRepositoryRequest
- AConsumer
that will call methods onCreateRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
- Parameters:
deleteDomainRequest
-- Returns:
- A Java Future containing the result of the DeleteDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builder
avoiding the need to create one manually viaDeleteDomainRequest.builder()
- Parameters:
deleteDomainRequest
- AConsumer
that will call methods onDeleteDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainPermissionsPolicy
default CompletableFuture<DeleteDomainPermissionsPolicyResponse> deleteDomainPermissionsPolicy(DeleteDomainPermissionsPolicyRequest deleteDomainPermissionsPolicyRequest) Deletes the resource policy set on a domain.
- Parameters:
deleteDomainPermissionsPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteDomainPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainPermissionsPolicy
default CompletableFuture<DeleteDomainPermissionsPolicyResponse> deleteDomainPermissionsPolicy(Consumer<DeleteDomainPermissionsPolicyRequest.Builder> deleteDomainPermissionsPolicyRequest) Deletes the resource policy set on a domain.
This is a convenience which creates an instance of the
DeleteDomainPermissionsPolicyRequest.Builder
avoiding the need to create one manually viaDeleteDomainPermissionsPolicyRequest.builder()
- Parameters:
deleteDomainPermissionsPolicyRequest
- AConsumer
that will call methods onDeleteDomainPermissionsPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDomainPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackage
default CompletableFuture<DeletePackageResponse> deletePackage(DeletePackageRequest deletePackageRequest) 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.
- Parameters:
deletePackageRequest
-- Returns:
- A Java Future containing the result of the DeletePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackage
default CompletableFuture<DeletePackageResponse> deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) 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.
This is a convenience which creates an instance of the
DeletePackageRequest.Builder
avoiding the need to create one manually viaDeletePackageRequest.builder()
- Parameters:
deletePackageRequest
- AConsumer
that will call methods onDeletePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackageGroup
default CompletableFuture<DeletePackageGroupResponse> deletePackageGroup(DeletePackageGroupRequest deletePackageGroupRequest) Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.
- Parameters:
deletePackageGroupRequest
-- Returns:
- A Java Future containing the result of the DeletePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackageGroup
default CompletableFuture<DeletePackageGroupResponse> deletePackageGroup(Consumer<DeletePackageGroupRequest.Builder> deletePackageGroupRequest) Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.
This is a convenience which creates an instance of the
DeletePackageGroupRequest.Builder
avoiding the need to create one manually viaDeletePackageGroupRequest.builder()
- Parameters:
deletePackageGroupRequest
- AConsumer
that will call methods onDeletePackageGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackageVersions
default CompletableFuture<DeletePackageVersionsResponse> deletePackageVersions(DeletePackageVersionsRequest deletePackageVersionsRequest) 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, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.- Parameters:
deletePackageVersionsRequest
-- Returns:
- A Java Future containing the result of the DeletePackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackageVersions
default CompletableFuture<DeletePackageVersionsResponse> deletePackageVersions(Consumer<DeletePackageVersionsRequest.Builder> deletePackageVersionsRequest) 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, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.
This is a convenience which creates an instance of the
DeletePackageVersionsRequest.Builder
avoiding the need to create one manually viaDeletePackageVersionsRequest.builder()
- Parameters:
deletePackageVersionsRequest
- AConsumer
that will call methods onDeletePackageVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepository
default CompletableFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository.
- Parameters:
deleteRepositoryRequest
-- Returns:
- A Java Future containing the result of the DeleteRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepository
default CompletableFuture<DeleteRepositoryResponse> deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) Deletes a repository.
This is a convenience which creates an instance of the
DeleteRepositoryRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryRequest.builder()
- Parameters:
deleteRepositoryRequest
- AConsumer
that will call methods onDeleteRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepositoryPermissionsPolicy
default CompletableFuture<DeleteRepositoryPermissionsPolicyResponse> deleteRepositoryPermissionsPolicy(DeleteRepositoryPermissionsPolicyRequest deleteRepositoryPermissionsPolicyRequest) Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.
Use
DeleteRepositoryPermissionsPolicy
with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.- Parameters:
deleteRepositoryPermissionsPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteRepositoryPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepositoryPermissionsPolicy
default CompletableFuture<DeleteRepositoryPermissionsPolicyResponse> deleteRepositoryPermissionsPolicy(Consumer<DeleteRepositoryPermissionsPolicyRequest.Builder> deleteRepositoryPermissionsPolicyRequest) Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.
Use
DeleteRepositoryPermissionsPolicy
with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.
This is a convenience which creates an instance of the
DeleteRepositoryPermissionsPolicyRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryPermissionsPolicyRequest.builder()
- Parameters:
deleteRepositoryPermissionsPolicyRequest
- AConsumer
that will call methods onDeleteRepositoryPermissionsPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRepositoryPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDomain
default CompletableFuture<DescribeDomainResponse> describeDomain(DescribeDomainRequest describeDomainRequest) Returns a DomainDescription object that contains information about the requested domain.
- Parameters:
describeDomainRequest
-- Returns:
- A Java Future containing the result of the DescribeDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDomain
default CompletableFuture<DescribeDomainResponse> describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) Returns a DomainDescription object that contains information about the requested domain.
This is a convenience which creates an instance of the
DescribeDomainRequest.Builder
avoiding the need to create one manually viaDescribeDomainRequest.builder()
- Parameters:
describeDomainRequest
- AConsumer
that will call methods onDescribeDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackage
default CompletableFuture<DescribePackageResponse> describePackage(DescribePackageRequest describePackageRequest) Returns a PackageDescription object that contains information about the requested package.
- Parameters:
describePackageRequest
-- Returns:
- A Java Future containing the result of the DescribePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackage
default CompletableFuture<DescribePackageResponse> describePackage(Consumer<DescribePackageRequest.Builder> describePackageRequest) Returns a PackageDescription object that contains information about the requested package.
This is a convenience which creates an instance of the
DescribePackageRequest.Builder
avoiding the need to create one manually viaDescribePackageRequest.builder()
- Parameters:
describePackageRequest
- AConsumer
that will call methods onDescribePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageGroup
default CompletableFuture<DescribePackageGroupResponse> describePackageGroup(DescribePackageGroupRequest describePackageGroupRequest) Returns a PackageGroupDescription object that contains information about the requested package group.
- Parameters:
describePackageGroupRequest
-- Returns:
- A Java Future containing the result of the DescribePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageGroup
default CompletableFuture<DescribePackageGroupResponse> describePackageGroup(Consumer<DescribePackageGroupRequest.Builder> describePackageGroupRequest) Returns a PackageGroupDescription object that contains information about the requested package group.
This is a convenience which creates an instance of the
DescribePackageGroupRequest.Builder
avoiding the need to create one manually viaDescribePackageGroupRequest.builder()
- Parameters:
describePackageGroupRequest
- AConsumer
that will call methods onDescribePackageGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageVersion
default CompletableFuture<DescribePackageVersionResponse> describePackageVersion(DescribePackageVersionRequest describePackageVersionRequest) Returns a PackageVersionDescription object that contains information about the requested package version.
- Parameters:
describePackageVersionRequest
-- Returns:
- A Java Future containing the result of the DescribePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageVersion
default CompletableFuture<DescribePackageVersionResponse> describePackageVersion(Consumer<DescribePackageVersionRequest.Builder> describePackageVersionRequest) Returns a PackageVersionDescription object that contains information about the requested package version.
This is a convenience which creates an instance of the
DescribePackageVersionRequest.Builder
avoiding the need to create one manually viaDescribePackageVersionRequest.builder()
- Parameters:
describePackageVersionRequest
- AConsumer
that will call methods onDescribePackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRepository
default CompletableFuture<DescribeRepositoryResponse> describeRepository(DescribeRepositoryRequest describeRepositoryRequest) Returns a
RepositoryDescription
object that contains detailed information about the requested repository.- Parameters:
describeRepositoryRequest
-- Returns:
- A Java Future containing the result of the DescribeRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRepository
default CompletableFuture<DescribeRepositoryResponse> describeRepository(Consumer<DescribeRepositoryRequest.Builder> describeRepositoryRequest) Returns a
RepositoryDescription
object that contains detailed information about the requested repository.
This is a convenience which creates an instance of the
DescribeRepositoryRequest.Builder
avoiding the need to create one manually viaDescribeRepositoryRequest.builder()
- Parameters:
describeRepositoryRequest
- AConsumer
that will call methods onDescribeRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateExternalConnection
default CompletableFuture<DisassociateExternalConnectionResponse> disassociateExternalConnection(DisassociateExternalConnectionRequest disassociateExternalConnectionRequest) Removes an existing external connection from a repository.
- Parameters:
disassociateExternalConnectionRequest
-- Returns:
- A Java Future containing the result of the DisassociateExternalConnection operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateExternalConnection
default CompletableFuture<DisassociateExternalConnectionResponse> disassociateExternalConnection(Consumer<DisassociateExternalConnectionRequest.Builder> disassociateExternalConnectionRequest) Removes an existing external connection from a repository.
This is a convenience which creates an instance of the
DisassociateExternalConnectionRequest.Builder
avoiding the need to create one manually viaDisassociateExternalConnectionRequest.builder()
- Parameters:
disassociateExternalConnectionRequest
- AConsumer
that will call methods onDisassociateExternalConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateExternalConnection operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disposePackageVersions
default CompletableFuture<DisposePackageVersionsResponse> disposePackageVersions(DisposePackageVersionsRequest disposePackageVersionsRequest) 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.
- Parameters:
disposePackageVersionsRequest
-- Returns:
- A Java Future containing the result of the DisposePackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disposePackageVersions
default CompletableFuture<DisposePackageVersionsResponse> disposePackageVersions(Consumer<DisposePackageVersionsRequest.Builder> disposePackageVersionsRequest) 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.
This is a convenience which creates an instance of the
DisposePackageVersionsRequest.Builder
avoiding the need to create one manually viaDisposePackageVersionsRequest.builder()
- Parameters:
disposePackageVersionsRequest
- AConsumer
that will call methods onDisposePackageVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisposePackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAssociatedPackageGroup
default CompletableFuture<GetAssociatedPackageGroupResponse> getAssociatedPackageGroup(GetAssociatedPackageGroupRequest getAssociatedPackageGroupRequest) Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such,
GetAssociatedPackageGroup
can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
- Parameters:
getAssociatedPackageGroupRequest
-- Returns:
- A Java Future containing the result of the GetAssociatedPackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAssociatedPackageGroup
default CompletableFuture<GetAssociatedPackageGroupResponse> getAssociatedPackageGroup(Consumer<GetAssociatedPackageGroupRequest.Builder> getAssociatedPackageGroupRequest) Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such,
GetAssociatedPackageGroup
can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
GetAssociatedPackageGroupRequest.Builder
avoiding the need to create one manually viaGetAssociatedPackageGroupRequest.builder()
- Parameters:
getAssociatedPackageGroupRequest
- AConsumer
that will call methods onGetAssociatedPackageGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAssociatedPackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAuthorizationToken
default CompletableFuture<GetAuthorizationTokenResponse> getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) Generates a temporary authorization token for accessing repositories in the domain. This API requires the
codeartifact:GetAuthorizationToken
andsts:GetServiceBearerToken
permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.CodeArtifact authorization tokens are valid for a period of 12 hours when created with the
login
command. You can calllogin
periodically to refresh the token. When you create an authorization token with theGetAuthorizationToken
API, you can set a custom authorization period, up to a maximum of 12 hours, with thedurationSeconds
parameter.The authorization period begins after
login
orGetAuthorizationToken
is called. Iflogin
orGetAuthorizationToken
is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you callsts 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.
- Parameters:
getAuthorizationTokenRequest
-- Returns:
- A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAuthorizationToken
default CompletableFuture<GetAuthorizationTokenResponse> getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) Generates a temporary authorization token for accessing repositories in the domain. This API requires the
codeartifact:GetAuthorizationToken
andsts:GetServiceBearerToken
permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.CodeArtifact authorization tokens are valid for a period of 12 hours when created with the
login
command. You can calllogin
periodically to refresh the token. When you create an authorization token with theGetAuthorizationToken
API, you can set a custom authorization period, up to a maximum of 12 hours, with thedurationSeconds
parameter.The authorization period begins after
login
orGetAuthorizationToken
is called. Iflogin
orGetAuthorizationToken
is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you callsts 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.
This is a convenience which creates an instance of the
GetAuthorizationTokenRequest.Builder
avoiding the need to create one manually viaGetAuthorizationTokenRequest.builder()
- Parameters:
getAuthorizationTokenRequest
- AConsumer
that will call methods onGetAuthorizationTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainPermissionsPolicy
default CompletableFuture<GetDomainPermissionsPolicyResponse> getDomainPermissionsPolicy(GetDomainPermissionsPolicyRequest getDomainPermissionsPolicyRequest) Returns the resource policy attached to the specified domain.
The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.
- Parameters:
getDomainPermissionsPolicyRequest
-- Returns:
- A Java Future containing the result of the GetDomainPermissionsPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainPermissionsPolicy
default CompletableFuture<GetDomainPermissionsPolicyResponse> getDomainPermissionsPolicy(Consumer<GetDomainPermissionsPolicyRequest.Builder> getDomainPermissionsPolicyRequest) Returns the resource policy attached to the specified domain.
The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.
This is a convenience which creates an instance of the
GetDomainPermissionsPolicyRequest.Builder
avoiding the need to create one manually viaGetDomainPermissionsPolicyRequest.builder()
- Parameters:
getDomainPermissionsPolicyRequest
- AConsumer
that will call methods onGetDomainPermissionsPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDomainPermissionsPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPackageVersionAsset
default <ReturnT> CompletableFuture<ReturnT> getPackageVersionAsset(GetPackageVersionAssetRequest getPackageVersionAssetRequest, AsyncResponseTransformer<GetPackageVersionAssetResponse, ReturnT> asyncResponseTransformer) Returns an asset (or file) that is in a package. For example, for a Maven package version, use
GetPackageVersionAsset
to download aJAR
file, aPOM
file, or any other assets in the package version.- Parameters:
getPackageVersionAssetRequest
-asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The binary file, or asset, that is downloaded.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ConflictException The operation did not succeed because prerequisites are not met.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPackageVersionAsset
default <ReturnT> CompletableFuture<ReturnT> getPackageVersionAsset(Consumer<GetPackageVersionAssetRequest.Builder> getPackageVersionAssetRequest, AsyncResponseTransformer<GetPackageVersionAssetResponse, ReturnT> asyncResponseTransformer) Returns an asset (or file) that is in a package. For example, for a Maven package version, use
GetPackageVersionAsset
to download aJAR
file, aPOM
file, or any other assets in the package version.
This is a convenience which creates an instance of the
GetPackageVersionAssetRequest.Builder
avoiding the need to create one manually viaGetPackageVersionAssetRequest.builder()
- Parameters:
getPackageVersionAssetRequest
- AConsumer
that will call methods onGetPackageVersionAssetRequest.Builder
to create a request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The binary file, or asset, that is downloaded.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ConflictException The operation did not succeed because prerequisites are not met.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPackageVersionAsset
default CompletableFuture<GetPackageVersionAssetResponse> getPackageVersionAsset(GetPackageVersionAssetRequest getPackageVersionAssetRequest, Path destinationPath) Returns an asset (or file) that is in a package. For example, for a Maven package version, use
GetPackageVersionAsset
to download aJAR
file, aPOM
file, or any other assets in the package version.- Parameters:
getPackageVersionAssetRequest
-destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The binary file, or asset, that is downloaded.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ConflictException The operation did not succeed because prerequisites are not met.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPackageVersionAsset
default CompletableFuture<GetPackageVersionAssetResponse> getPackageVersionAsset(Consumer<GetPackageVersionAssetRequest.Builder> getPackageVersionAssetRequest, Path destinationPath) Returns an asset (or file) that is in a package. For example, for a Maven package version, use
GetPackageVersionAsset
to download aJAR
file, aPOM
file, or any other assets in the package version.
This is a convenience which creates an instance of the
GetPackageVersionAssetRequest.Builder
avoiding the need to create one manually viaGetPackageVersionAssetRequest.builder()
- Parameters:
getPackageVersionAssetRequest
- AConsumer
that will call methods onGetPackageVersionAssetRequest.Builder
to create a request.destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The binary file, or asset, that is downloaded.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ConflictException The operation did not succeed because prerequisites are not met.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPackageVersionReadme
default CompletableFuture<GetPackageVersionReadmeResponse> getPackageVersionReadme(GetPackageVersionReadmeRequest getPackageVersionReadmeRequest) 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.
- Parameters:
getPackageVersionReadmeRequest
-- Returns:
- A Java Future containing the result of the GetPackageVersionReadme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPackageVersionReadme
default CompletableFuture<GetPackageVersionReadmeResponse> getPackageVersionReadme(Consumer<GetPackageVersionReadmeRequest.Builder> getPackageVersionReadmeRequest) 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.
This is a convenience which creates an instance of the
GetPackageVersionReadmeRequest.Builder
avoiding the need to create one manually viaGetPackageVersionReadmeRequest.builder()
- Parameters:
getPackageVersionReadmeRequest
- AConsumer
that will call methods onGetPackageVersionReadmeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPackageVersionReadme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRepositoryEndpoint
default CompletableFuture<GetRepositoryEndpointResponse> getRepositoryEndpoint(GetRepositoryEndpointRequest getRepositoryEndpointRequest) Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
-
generic
-
maven
-
npm
-
nuget
-
pypi
-
swift
- Parameters:
getRepositoryEndpointRequest
-- Returns:
- A Java Future containing the result of the GetRepositoryEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getRepositoryEndpoint
default CompletableFuture<GetRepositoryEndpointResponse> getRepositoryEndpoint(Consumer<GetRepositoryEndpointRequest.Builder> getRepositoryEndpointRequest) Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
-
generic
-
maven
-
npm
-
nuget
-
pypi
-
swift
This is a convenience which creates an instance of the
GetRepositoryEndpointRequest.Builder
avoiding the need to create one manually viaGetRepositoryEndpointRequest.builder()
- Parameters:
getRepositoryEndpointRequest
- AConsumer
that will call methods onGetRepositoryEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRepositoryEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getRepositoryPermissionsPolicy
default CompletableFuture<GetRepositoryPermissionsPolicyResponse> getRepositoryPermissionsPolicy(GetRepositoryPermissionsPolicyRequest getRepositoryPermissionsPolicyRequest) Returns the resource policy that is set on a repository.
- Parameters:
getRepositoryPermissionsPolicyRequest
-- Returns:
- A Java Future containing the result of the GetRepositoryPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRepositoryPermissionsPolicy
default CompletableFuture<GetRepositoryPermissionsPolicyResponse> getRepositoryPermissionsPolicy(Consumer<GetRepositoryPermissionsPolicyRequest.Builder> getRepositoryPermissionsPolicyRequest) Returns the resource policy that is set on a repository.
This is a convenience which creates an instance of the
GetRepositoryPermissionsPolicyRequest.Builder
avoiding the need to create one manually viaGetRepositoryPermissionsPolicyRequest.builder()
- Parameters:
getRepositoryPermissionsPolicyRequest
- AConsumer
that will call methods onGetRepositoryPermissionsPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRepositoryPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAllowedRepositoriesForGroup
default CompletableFuture<ListAllowedRepositoriesForGroupResponse> listAllowedRepositoriesForGroup(ListAllowedRepositoriesForGroupRequest listAllowedRepositoriesForGroupRequest) Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.
- Parameters:
listAllowedRepositoriesForGroupRequest
-- Returns:
- A Java Future containing the result of the ListAllowedRepositoriesForGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAllowedRepositoriesForGroup
default CompletableFuture<ListAllowedRepositoriesForGroupResponse> listAllowedRepositoriesForGroup(Consumer<ListAllowedRepositoriesForGroupRequest.Builder> listAllowedRepositoriesForGroupRequest) Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
ListAllowedRepositoriesForGroupRequest.Builder
avoiding the need to create one manually viaListAllowedRepositoriesForGroupRequest.builder()
- Parameters:
listAllowedRepositoriesForGroupRequest
- AConsumer
that will call methods onListAllowedRepositoriesForGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAllowedRepositoriesForGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAllowedRepositoriesForGroupPaginator
default ListAllowedRepositoriesForGroupPublisher listAllowedRepositoriesForGroupPaginator(ListAllowedRepositoriesForGroupRequest listAllowedRepositoriesForGroupRequest) This is a variant of
listAllowedRepositoriesForGroup(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListAllowedRepositoriesForGroupPublisher publisher = client.listAllowedRepositoriesForGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListAllowedRepositoriesForGroupPublisher publisher = client.listAllowedRepositoriesForGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAllowedRepositoriesForGroup(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupRequest)
operation.- Parameters:
listAllowedRepositoriesForGroupRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAllowedRepositoriesForGroupPaginator
default ListAllowedRepositoriesForGroupPublisher listAllowedRepositoriesForGroupPaginator(Consumer<ListAllowedRepositoriesForGroupRequest.Builder> listAllowedRepositoriesForGroupRequest) This is a variant of
listAllowedRepositoriesForGroup(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListAllowedRepositoriesForGroupPublisher publisher = client.listAllowedRepositoriesForGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListAllowedRepositoriesForGroupPublisher publisher = client.listAllowedRepositoriesForGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAllowedRepositoriesForGroup(software.amazon.awssdk.services.codeartifact.model.ListAllowedRepositoriesForGroupRequest)
operation.
This is a convenience which creates an instance of the
ListAllowedRepositoriesForGroupRequest.Builder
avoiding the need to create one manually viaListAllowedRepositoriesForGroupRequest.builder()
- Parameters:
listAllowedRepositoriesForGroupRequest
- AConsumer
that will call methods onListAllowedRepositoriesForGroupRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedPackages
default CompletableFuture<ListAssociatedPackagesResponse> listAssociatedPackages(ListAssociatedPackagesRequest listAssociatedPackagesRequest) Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
- Parameters:
listAssociatedPackagesRequest
-- Returns:
- A Java Future containing the result of the ListAssociatedPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedPackages
default CompletableFuture<ListAssociatedPackagesResponse> listAssociatedPackages(Consumer<ListAssociatedPackagesRequest.Builder> listAssociatedPackagesRequest) Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
ListAssociatedPackagesRequest.Builder
avoiding the need to create one manually viaListAssociatedPackagesRequest.builder()
- Parameters:
listAssociatedPackagesRequest
- AConsumer
that will call methods onListAssociatedPackagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAssociatedPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedPackagesPaginator
default ListAssociatedPackagesPublisher listAssociatedPackagesPaginator(ListAssociatedPackagesRequest listAssociatedPackagesRequest) This is a variant of
listAssociatedPackages(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListAssociatedPackagesPublisher publisher = client.listAssociatedPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListAssociatedPackagesPublisher publisher = client.listAssociatedPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedPackages(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesRequest)
operation.- Parameters:
listAssociatedPackagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedPackagesPaginator
default ListAssociatedPackagesPublisher listAssociatedPackagesPaginator(Consumer<ListAssociatedPackagesRequest.Builder> listAssociatedPackagesRequest) This is a variant of
listAssociatedPackages(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListAssociatedPackagesPublisher publisher = client.listAssociatedPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListAssociatedPackagesPublisher publisher = client.listAssociatedPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedPackages(software.amazon.awssdk.services.codeartifact.model.ListAssociatedPackagesRequest)
operation.
This is a convenience which creates an instance of the
ListAssociatedPackagesRequest.Builder
avoiding the need to create one manually viaListAssociatedPackagesRequest.builder()
- Parameters:
listAssociatedPackagesRequest
- AConsumer
that will call methods onListAssociatedPackagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomains
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.- Parameters:
listDomainsRequest
-- Returns:
- A Java Future containing the result of the ListDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomains
default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) 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.
This is a convenience which creates an instance of the
ListDomainsRequest.Builder
avoiding the need to create one manually viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
This is a variant of
listDomains(software.amazon.awssdk.services.codeartifact.model.ListDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListDomainsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.codeartifact.model.ListDomainsRequest)
operation.- Parameters:
listDomainsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant of
listDomains(software.amazon.awssdk.services.codeartifact.model.ListDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListDomainsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.codeartifact.model.ListDomainsRequest)
operation.
This is a convenience which creates an instance of the
ListDomainsRequest.Builder
avoiding the need to create one manually viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageGroups
default CompletableFuture<ListPackageGroupsResponse> listPackageGroups(ListPackageGroupsRequest listPackageGroupsRequest) Returns a list of package groups in the requested domain.
- Parameters:
listPackageGroupsRequest
-- Returns:
- A Java Future containing the result of the ListPackageGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageGroups
default CompletableFuture<ListPackageGroupsResponse> listPackageGroups(Consumer<ListPackageGroupsRequest.Builder> listPackageGroupsRequest) Returns a list of package groups in the requested domain.
This is a convenience which creates an instance of the
ListPackageGroupsRequest.Builder
avoiding the need to create one manually viaListPackageGroupsRequest.builder()
- Parameters:
listPackageGroupsRequest
- AConsumer
that will call methods onListPackageGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackageGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageGroupsPaginator
default ListPackageGroupsPublisher listPackageGroupsPaginator(ListPackageGroupsRequest listPackageGroupsRequest) This is a variant of
listPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackageGroupsPublisher publisher = client.listPackageGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackageGroupsPublisher publisher = client.listPackageGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsRequest)
operation.- Parameters:
listPackageGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageGroupsPaginator
default ListPackageGroupsPublisher listPackageGroupsPaginator(Consumer<ListPackageGroupsRequest.Builder> listPackageGroupsRequest) This is a variant of
listPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackageGroupsPublisher publisher = client.listPackageGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackageGroupsPublisher publisher = client.listPackageGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListPackageGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListPackageGroupsRequest.Builder
avoiding the need to create one manually viaListPackageGroupsRequest.builder()
- Parameters:
listPackageGroupsRequest
- AConsumer
that will call methods onListPackageGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionAssets
default CompletableFuture<ListPackageVersionAssetsResponse> listPackageVersionAssets(ListPackageVersionAssetsRequest listPackageVersionAssetsRequest) Returns a list of AssetSummary objects for assets in a package version.
- Parameters:
listPackageVersionAssetsRequest
-- Returns:
- A Java Future containing the result of the ListPackageVersionAssets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionAssets
default CompletableFuture<ListPackageVersionAssetsResponse> listPackageVersionAssets(Consumer<ListPackageVersionAssetsRequest.Builder> listPackageVersionAssetsRequest) Returns a list of AssetSummary objects for assets in a package version.
This is a convenience which creates an instance of the
ListPackageVersionAssetsRequest.Builder
avoiding the need to create one manually viaListPackageVersionAssetsRequest.builder()
- Parameters:
listPackageVersionAssetsRequest
- AConsumer
that will call methods onListPackageVersionAssetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackageVersionAssets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionAssetsPaginator
default ListPackageVersionAssetsPublisher listPackageVersionAssetsPaginator(ListPackageVersionAssetsRequest listPackageVersionAssetsRequest) This is a variant of
listPackageVersionAssets(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionAssetsPublisher publisher = client.listPackageVersionAssetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionAssetsPublisher publisher = client.listPackageVersionAssetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageVersionAssets(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsRequest)
operation.- Parameters:
listPackageVersionAssetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionAssetsPaginator
default ListPackageVersionAssetsPublisher listPackageVersionAssetsPaginator(Consumer<ListPackageVersionAssetsRequest.Builder> listPackageVersionAssetsRequest) This is a variant of
listPackageVersionAssets(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionAssetsPublisher publisher = client.listPackageVersionAssetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionAssetsPublisher publisher = client.listPackageVersionAssetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageVersionAssets(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionAssetsRequest)
operation.
This is a convenience which creates an instance of the
ListPackageVersionAssetsRequest.Builder
avoiding the need to create one manually viaListPackageVersionAssetsRequest.builder()
- Parameters:
listPackageVersionAssetsRequest
- AConsumer
that will call methods onListPackageVersionAssetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionDependencies
default CompletableFuture<ListPackageVersionDependenciesResponse> listPackageVersionDependencies(ListPackageVersionDependenciesRequest listPackageVersionDependenciesRequest) 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 thepom.xml
file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.- Parameters:
listPackageVersionDependenciesRequest
-- Returns:
- A Java Future containing the result of the ListPackageVersionDependencies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionDependencies
default CompletableFuture<ListPackageVersionDependenciesResponse> listPackageVersionDependencies(Consumer<ListPackageVersionDependenciesRequest.Builder> listPackageVersionDependenciesRequest) 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 thepom.xml
file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.
This is a convenience which creates an instance of the
ListPackageVersionDependenciesRequest.Builder
avoiding the need to create one manually viaListPackageVersionDependenciesRequest.builder()
- Parameters:
listPackageVersionDependenciesRequest
- AConsumer
that will call methods onListPackageVersionDependenciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackageVersionDependencies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersions
default CompletableFuture<ListPackageVersionsResponse> listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest) 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.- Parameters:
listPackageVersionsRequest
-- Returns:
- A Java Future containing the result of the ListPackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersions
default CompletableFuture<ListPackageVersionsResponse> listPackageVersions(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) 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.
This is a convenience which creates an instance of the
ListPackageVersionsRequest.Builder
avoiding the need to create one manually viaListPackageVersionsRequest.builder()
- Parameters:
listPackageVersionsRequest
- AConsumer
that will call methods onListPackageVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionsPaginator
default ListPackageVersionsPublisher listPackageVersionsPaginator(ListPackageVersionsRequest listPackageVersionsRequest) This is a variant of
listPackageVersions(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageVersions(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsRequest)
operation.- Parameters:
listPackageVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageVersionsPaginator
default ListPackageVersionsPublisher listPackageVersionsPaginator(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) This is a variant of
listPackageVersions(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageVersions(software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListPackageVersionsRequest.Builder
avoiding the need to create one manually viaListPackageVersionsRequest.builder()
- Parameters:
listPackageVersionsRequest
- AConsumer
that will call methods onListPackageVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackages
default CompletableFuture<ListPackagesResponse> listPackages(ListPackagesRequest listPackagesRequest) Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
- Parameters:
listPackagesRequest
-- Returns:
- A Java Future containing the result of the ListPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackages
default CompletableFuture<ListPackagesResponse> listPackages(Consumer<ListPackagesRequest.Builder> listPackagesRequest) Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
This is a convenience which creates an instance of the
ListPackagesRequest.Builder
avoiding the need to create one manually viaListPackagesRequest.builder()
- Parameters:
listPackagesRequest
- AConsumer
that will call methods onListPackagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackagesPaginator
This is a variant of
listPackages(software.amazon.awssdk.services.codeartifact.model.ListPackagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackages(software.amazon.awssdk.services.codeartifact.model.ListPackagesRequest)
operation.- Parameters:
listPackagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackagesPaginator
default ListPackagesPublisher listPackagesPaginator(Consumer<ListPackagesRequest.Builder> listPackagesRequest) This is a variant of
listPackages(software.amazon.awssdk.services.codeartifact.model.ListPackagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListPackagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackages(software.amazon.awssdk.services.codeartifact.model.ListPackagesRequest)
operation.
This is a convenience which creates an instance of the
ListPackagesRequest.Builder
avoiding the need to create one manually viaListPackagesRequest.builder()
- Parameters:
listPackagesRequest
- AConsumer
that will call methods onListPackagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositories
default CompletableFuture<ListRepositoriesResponse> listRepositories(ListRepositoriesRequest listRepositoriesRequest) 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.- Parameters:
listRepositoriesRequest
-- Returns:
- A Java Future containing the result of the ListRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositories
default CompletableFuture<ListRepositoriesResponse> listRepositories(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) 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.
This is a convenience which creates an instance of the
ListRepositoriesRequest.Builder
avoiding the need to create one manually viaListRepositoriesRequest.builder()
- Parameters:
listRepositoriesRequest
- AConsumer
that will call methods onListRepositoriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositoriesInDomain
default CompletableFuture<ListRepositoriesInDomainResponse> listRepositoriesInDomain(ListRepositoriesInDomainRequest listRepositoriesInDomainRequest) Returns a list of RepositorySummary objects. Each
RepositorySummary
contains information about a repository in the specified domain and that matches the input parameters.- Parameters:
listRepositoriesInDomainRequest
-- Returns:
- A Java Future containing the result of the ListRepositoriesInDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositoriesInDomain
default CompletableFuture<ListRepositoriesInDomainResponse> listRepositoriesInDomain(Consumer<ListRepositoriesInDomainRequest.Builder> listRepositoriesInDomainRequest) Returns a list of RepositorySummary objects. Each
RepositorySummary
contains information about a repository in the specified domain and that matches the input parameters.
This is a convenience which creates an instance of the
ListRepositoriesInDomainRequest.Builder
avoiding the need to create one manually viaListRepositoriesInDomainRequest.builder()
- Parameters:
listRepositoriesInDomainRequest
- AConsumer
that will call methods onListRepositoriesInDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRepositoriesInDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositoriesInDomainPaginator
default ListRepositoriesInDomainPublisher listRepositoriesInDomainPaginator(ListRepositoriesInDomainRequest listRepositoriesInDomainRequest) This is a variant of
listRepositoriesInDomain(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesInDomainPublisher publisher = client.listRepositoriesInDomainPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesInDomainPublisher publisher = client.listRepositoriesInDomainPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositoriesInDomain(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainRequest)
operation.- Parameters:
listRepositoriesInDomainRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositoriesInDomainPaginator
default ListRepositoriesInDomainPublisher listRepositoriesInDomainPaginator(Consumer<ListRepositoriesInDomainRequest.Builder> listRepositoriesInDomainRequest) This is a variant of
listRepositoriesInDomain(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesInDomainPublisher publisher = client.listRepositoriesInDomainPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesInDomainPublisher publisher = client.listRepositoriesInDomainPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositoriesInDomain(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesInDomainRequest)
operation.
This is a convenience which creates an instance of the
ListRepositoriesInDomainRequest.Builder
avoiding the need to create one manually viaListRepositoriesInDomainRequest.builder()
- Parameters:
listRepositoriesInDomainRequest
- AConsumer
that will call methods onListRepositoriesInDomainRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositoriesPaginator
default ListRepositoriesPublisher listRepositoriesPaginator(ListRepositoriesRequest listRepositoriesRequest) This is a variant of
listRepositories(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositories(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesRequest)
operation.- Parameters:
listRepositoriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRepositoriesPaginator
default ListRepositoriesPublisher listRepositoriesPaginator(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) This is a variant of
listRepositories(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositories(software.amazon.awssdk.services.codeartifact.model.ListRepositoriesRequest)
operation.
This is a convenience which creates an instance of the
ListRepositoriesRequest.Builder
avoiding the need to create one manually viaListRepositoriesRequest.builder()
- Parameters:
listRepositoriesRequest
- AConsumer
that will call methods onListRepositoriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubPackageGroups
default CompletableFuture<ListSubPackageGroupsResponse> listSubPackageGroups(ListSubPackageGroupsRequest listSubPackageGroupsRequest) Returns a list of direct children of the specified package group.
For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
- Parameters:
listSubPackageGroupsRequest
-- Returns:
- A Java Future containing the result of the ListSubPackageGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubPackageGroups
default CompletableFuture<ListSubPackageGroupsResponse> listSubPackageGroups(Consumer<ListSubPackageGroupsRequest.Builder> listSubPackageGroupsRequest) Returns a list of direct children of the specified package group.
For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
ListSubPackageGroupsRequest.Builder
avoiding the need to create one manually viaListSubPackageGroupsRequest.builder()
- Parameters:
listSubPackageGroupsRequest
- AConsumer
that will call methods onListSubPackageGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSubPackageGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubPackageGroupsPaginator
default ListSubPackageGroupsPublisher listSubPackageGroupsPaginator(ListSubPackageGroupsRequest listSubPackageGroupsRequest) This is a variant of
listSubPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListSubPackageGroupsPublisher publisher = client.listSubPackageGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListSubPackageGroupsPublisher publisher = client.listSubPackageGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsRequest)
operation.- Parameters:
listSubPackageGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubPackageGroupsPaginator
default ListSubPackageGroupsPublisher listSubPackageGroupsPaginator(Consumer<ListSubPackageGroupsRequest.Builder> listSubPackageGroupsRequest) This is a variant of
listSubPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codeartifact.paginators.ListSubPackageGroupsPublisher publisher = client.listSubPackageGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codeartifact.paginators.ListSubPackageGroupsPublisher publisher = client.listSubPackageGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubPackageGroups(software.amazon.awssdk.services.codeartifact.model.ListSubPackageGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListSubPackageGroupsRequest.Builder
avoiding the need to create one manually viaListSubPackageGroupsRequest.builder()
- Parameters:
listSubPackageGroupsRequest
- AConsumer
that will call methods onListSubPackageGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
publishPackageVersion
default CompletableFuture<PublishPackageVersionResponse> publishPackageVersion(PublishPackageVersionRequest publishPackageVersionRequest, AsyncRequestBody requestBody) Creates a new package version containing one or more assets (or files).
The
unfinished
flag can be used to keep the package version in theUnfinished
state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status toPublished
, omit theunfinished
flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set toPublished
, it cannot change back toUnfinished
.Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
- Parameters:
publishPackageVersionRequest
-requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBody
for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The content of the asset to publish.
'- Returns:
- A Java Future containing the result of the PublishPackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
publishPackageVersion
default CompletableFuture<PublishPackageVersionResponse> publishPackageVersion(Consumer<PublishPackageVersionRequest.Builder> publishPackageVersionRequest, AsyncRequestBody requestBody) Creates a new package version containing one or more assets (or files).
The
unfinished
flag can be used to keep the package version in theUnfinished
state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status toPublished
, omit theunfinished
flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set toPublished
, it cannot change back toUnfinished
.Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
PublishPackageVersionRequest.Builder
avoiding the need to create one manually viaPublishPackageVersionRequest.builder()
- Parameters:
publishPackageVersionRequest
- AConsumer
that will call methods onPublishPackageVersionRequest.Builder
to create a request.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBody
for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The content of the asset to publish.
'- Returns:
- A Java Future containing the result of the PublishPackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
publishPackageVersion
default CompletableFuture<PublishPackageVersionResponse> publishPackageVersion(PublishPackageVersionRequest publishPackageVersionRequest, Path sourcePath) Creates a new package version containing one or more assets (or files).
The
unfinished
flag can be used to keep the package version in theUnfinished
state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status toPublished
, omit theunfinished
flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set toPublished
, it cannot change back toUnfinished
.Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
- Parameters:
publishPackageVersionRequest
-sourcePath
-Path
to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The content of the asset to publish.
'- Returns:
- A Java Future containing the result of the PublishPackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
publishPackageVersion
default CompletableFuture<PublishPackageVersionResponse> publishPackageVersion(Consumer<PublishPackageVersionRequest.Builder> publishPackageVersionRequest, Path sourcePath) Creates a new package version containing one or more assets (or files).
The
unfinished
flag can be used to keep the package version in theUnfinished
state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status toPublished
, omit theunfinished
flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set toPublished
, it cannot change back toUnfinished
.Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
PublishPackageVersionRequest.Builder
avoiding the need to create one manually viaPublishPackageVersionRequest.builder()
- Parameters:
publishPackageVersionRequest
- AConsumer
that will call methods onPublishPackageVersionRequest.Builder
to create a request.sourcePath
-Path
to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The content of the asset to publish.
'- Returns:
- A Java Future containing the result of the PublishPackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDomainPermissionsPolicy
default CompletableFuture<PutDomainPermissionsPolicyResponse> putDomainPermissionsPolicy(PutDomainPermissionsPolicyRequest putDomainPermissionsPolicyRequest) 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.- Parameters:
putDomainPermissionsPolicyRequest
-- Returns:
- A Java Future containing the result of the PutDomainPermissionsPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDomainPermissionsPolicy
default CompletableFuture<PutDomainPermissionsPolicyResponse> putDomainPermissionsPolicy(Consumer<PutDomainPermissionsPolicyRequest.Builder> putDomainPermissionsPolicyRequest) 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.
This is a convenience which creates an instance of the
PutDomainPermissionsPolicyRequest.Builder
avoiding the need to create one manually viaPutDomainPermissionsPolicyRequest.builder()
- Parameters:
putDomainPermissionsPolicyRequest
- AConsumer
that will call methods onPutDomainPermissionsPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutDomainPermissionsPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putPackageOriginConfiguration
default CompletableFuture<PutPackageOriginConfigurationResponse> putPackageOriginConfiguration(PutPackageOriginConfigurationRequest putPackageOriginConfigurationRequest) Sets the package origin configuration for a package.
The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.
PutPackageOriginConfiguration
can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.- Parameters:
putPackageOriginConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutPackageOriginConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putPackageOriginConfiguration
default CompletableFuture<PutPackageOriginConfigurationResponse> putPackageOriginConfiguration(Consumer<PutPackageOriginConfigurationRequest.Builder> putPackageOriginConfigurationRequest) Sets the package origin configuration for a package.
The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.
PutPackageOriginConfiguration
can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.
This is a convenience which creates an instance of the
PutPackageOriginConfigurationRequest.Builder
avoiding the need to create one manually viaPutPackageOriginConfigurationRequest.builder()
- Parameters:
putPackageOriginConfigurationRequest
- AConsumer
that will call methods onPutPackageOriginConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutPackageOriginConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRepositoryPermissionsPolicy
default CompletableFuture<PutRepositoryPermissionsPolicyResponse> putRepositoryPermissionsPolicy(PutRepositoryPermissionsPolicyRequest putRepositoryPermissionsPolicyRequest) 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.- Parameters:
putRepositoryPermissionsPolicyRequest
-- Returns:
- A Java Future containing the result of the PutRepositoryPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRepositoryPermissionsPolicy
default CompletableFuture<PutRepositoryPermissionsPolicyResponse> putRepositoryPermissionsPolicy(Consumer<PutRepositoryPermissionsPolicyRequest.Builder> putRepositoryPermissionsPolicyRequest) 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.
This is a convenience which creates an instance of the
PutRepositoryPermissionsPolicyRequest.Builder
avoiding the need to create one manually viaPutRepositoryPermissionsPolicyRequest.builder()
- Parameters:
putRepositoryPermissionsPolicyRequest
- AConsumer
that will call methods onPutRepositoryPermissionsPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRepositoryPermissionsPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds or updates tags for a resource in CodeArtifact.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for a resource in CodeArtifact.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource in CodeArtifact.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource in CodeArtifact.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePackageGroup
default CompletableFuture<UpdatePackageGroupResponse> updatePackageGroup(UpdatePackageGroupRequest updatePackageGroupRequest) Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.
- Parameters:
updatePackageGroupRequest
-- Returns:
- A Java Future containing the result of the UpdatePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePackageGroup
default CompletableFuture<UpdatePackageGroupResponse> updatePackageGroup(Consumer<UpdatePackageGroupRequest.Builder> updatePackageGroupRequest) Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.
This is a convenience which creates an instance of the
UpdatePackageGroupRequest.Builder
avoiding the need to create one manually viaUpdatePackageGroupRequest.builder()
- Parameters:
updatePackageGroupRequest
- AConsumer
that will call methods onUpdatePackageGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePackageGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePackageGroupOriginConfiguration
default CompletableFuture<UpdatePackageGroupOriginConfigurationResponse> updatePackageGroupOriginConfiguration(UpdatePackageGroupOriginConfigurationRequest updatePackageGroupOriginConfigurationRequest) Updates the package origin configuration for a package group.
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 group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.
- Parameters:
updatePackageGroupOriginConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdatePackageGroupOriginConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePackageGroupOriginConfiguration
default CompletableFuture<UpdatePackageGroupOriginConfigurationResponse> updatePackageGroupOriginConfiguration(Consumer<UpdatePackageGroupOriginConfigurationRequest.Builder> updatePackageGroupOriginConfigurationRequest) Updates the package origin configuration for a package group.
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 group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.
This is a convenience which creates an instance of the
UpdatePackageGroupOriginConfigurationRequest.Builder
avoiding the need to create one manually viaUpdatePackageGroupOriginConfigurationRequest.builder()
- Parameters:
updatePackageGroupOriginConfigurationRequest
- AConsumer
that will call methods onUpdatePackageGroupOriginConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePackageGroupOriginConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePackageVersionsStatus
default CompletableFuture<UpdatePackageVersionsStatusResponse> updatePackageVersionsStatus(UpdatePackageVersionsStatusRequest updatePackageVersionsStatusRequest) Updates the status of one or more versions of a package. Using
UpdatePackageVersionsStatus
, you can update the status of package versions toArchived
,Published
, orUnlisted
. To set the status of a package version toDisposed
, use DisposePackageVersions.- Parameters:
updatePackageVersionsStatusRequest
-- Returns:
- A Java Future containing the result of the UpdatePackageVersionsStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePackageVersionsStatus
default CompletableFuture<UpdatePackageVersionsStatusResponse> updatePackageVersionsStatus(Consumer<UpdatePackageVersionsStatusRequest.Builder> updatePackageVersionsStatusRequest) Updates the status of one or more versions of a package. Using
UpdatePackageVersionsStatus
, you can update the status of package versions toArchived
,Published
, orUnlisted
. To set the status of a package version toDisposed
, use DisposePackageVersions.
This is a convenience which creates an instance of the
UpdatePackageVersionsStatusRequest.Builder
avoiding the need to create one manually viaUpdatePackageVersionsStatusRequest.builder()
- Parameters:
updatePackageVersionsStatusRequest
- AConsumer
that will call methods onUpdatePackageVersionsStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePackageVersionsStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRepository
default CompletableFuture<UpdateRepositoryResponse> updateRepository(UpdateRepositoryRequest updateRepositoryRequest) Update the properties of a repository.
- Parameters:
updateRepositoryRequest
-- Returns:
- A Java Future containing the result of the UpdateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRepository
default CompletableFuture<UpdateRepositoryResponse> updateRepository(Consumer<UpdateRepositoryRequest.Builder> updateRepositoryRequest) Update the properties of a repository.
This is a convenience which creates an instance of the
UpdateRepositoryRequest.Builder
avoiding the need to create one manually viaUpdateRepositoryRequest.builder()
- Parameters:
updateRepositoryRequest
- AConsumer
that will call methods onUpdateRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException The operation did not succeed because of an unauthorized access attempt.
- ConflictException The operation did not succeed because prerequisites are not met.
- InternalServerException The operation did not succeed because of an error that occurred inside CodeArtifact.
- ResourceNotFoundException The operation did not succeed because the resource requested is not found in the service.
- ServiceQuotaExceededException The operation did not succeed because it would have exceeded a service limit for your account.
- ThrottlingException The operation did not succeed because too many requests are sent to the service.
- ValidationException The operation did not succeed because a parameter in the request was sent with an invalid value.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeartifactException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCodeartifactAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCodeartifactAsyncClient
.
-