@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCodeArtifactClient extends AmazonWebServiceClient implements AWSCodeArtifact
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 such as the npm
CLI or the Maven CLI ( mvn
). For a list of supported
package managers, see the CodeArtifact User
Guide.
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, Ruby, Cargo, and generic package formats. For more information about the supported package formats and how to use CodeArtifact with them, see the CodeArtifact User Guide.
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 a DomainDescription
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 a RepositoryDescription
object that contains detailed
information about the requested repository.
DisposePackageVersions
: Disposes versions of a package. A package version with the status
Disposed
cannot be restored because they have been permanently removed from storage.
DisassociateExternalConnection
: Removes an existing external connection from a repository.
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:
cargo
generic
maven
npm
nuget
pypi
ruby
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 to ALLOW_SPECIFIC_REPOSITORIES
.
ListAssociatedPackages
: Returns a list of packages associated with the requested package group.
ListDomains
: Returns a list of DomainSummary
objects. Each returned
DomainSummary
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSCodeArtifactClientBuilder builder()
public AssociateExternalConnectionResult associateExternalConnection(AssociateExternalConnectionRequest request)
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.
associateExternalConnection
in interface AWSCodeArtifact
associateExternalConnectionRequest
- 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.public CopyPackageVersionsResult copyPackageVersions(CopyPackageVersionsRequest request)
Copies package versions from one repository to another repository in the same domain.
You must specify versions
or versionRevisions
. You cannot specify both.
copyPackageVersions
in interface AWSCodeArtifact
copyPackageVersionsRequest
- 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.public CreateDomainResult createDomain(CreateDomainRequest request)
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.
createDomain
in interface AWSCodeArtifact
createDomainRequest
- 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.public CreatePackageGroupResult createPackageGroup(CreatePackageGroupRequest request)
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.
createPackageGroup
in interface AWSCodeArtifact
createPackageGroupRequest
- 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.public CreateRepositoryResult createRepository(CreateRepositoryRequest request)
Creates a repository.
createRepository
in interface AWSCodeArtifact
createRepositoryRequest
- 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.public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
deleteDomain
in interface AWSCodeArtifact
deleteDomainRequest
- 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.public DeleteDomainPermissionsPolicyResult deleteDomainPermissionsPolicy(DeleteDomainPermissionsPolicyRequest request)
Deletes the resource policy set on a domain.
deleteDomainPermissionsPolicy
in interface AWSCodeArtifact
deleteDomainPermissionsPolicyRequest
- 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.public DeletePackageResult deletePackage(DeletePackageRequest request)
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.
deletePackage
in interface AWSCodeArtifact
deletePackageRequest
- 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.public DeletePackageGroupResult deletePackageGroup(DeletePackageGroupRequest request)
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.
deletePackageGroup
in interface AWSCodeArtifact
deletePackageGroupRequest
- 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.public DeletePackageVersionsResult deletePackageVersions(DeletePackageVersionsRequest request)
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.
deletePackageVersions
in interface AWSCodeArtifact
deletePackageVersionsRequest
- 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.public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
Deletes a repository.
deleteRepository
in interface AWSCodeArtifact
deleteRepositoryRequest
- 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.public DeleteRepositoryPermissionsPolicyResult deleteRepositoryPermissionsPolicy(DeleteRepositoryPermissionsPolicyRequest request)
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.
deleteRepositoryPermissionsPolicy
in interface AWSCodeArtifact
deleteRepositoryPermissionsPolicyRequest
- 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.public DescribeDomainResult describeDomain(DescribeDomainRequest request)
Returns a DomainDescription object that contains information about the requested domain.
describeDomain
in interface AWSCodeArtifact
describeDomainRequest
- 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.public DescribePackageResult describePackage(DescribePackageRequest request)
Returns a PackageDescription object that contains information about the requested package.
describePackage
in interface AWSCodeArtifact
describePackageRequest
- 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.public DescribePackageGroupResult describePackageGroup(DescribePackageGroupRequest request)
Returns a PackageGroupDescription object that contains information about the requested package group.
describePackageGroup
in interface AWSCodeArtifact
describePackageGroupRequest
- 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.public DescribePackageVersionResult describePackageVersion(DescribePackageVersionRequest request)
Returns a PackageVersionDescription object that contains information about the requested package version.
describePackageVersion
in interface AWSCodeArtifact
describePackageVersionRequest
- 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.public DescribeRepositoryResult describeRepository(DescribeRepositoryRequest request)
Returns a RepositoryDescription
object that contains detailed information about the requested
repository.
describeRepository
in interface AWSCodeArtifact
describeRepositoryRequest
- 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.public DisassociateExternalConnectionResult disassociateExternalConnection(DisassociateExternalConnectionRequest request)
Removes an existing external connection from a repository.
disassociateExternalConnection
in interface AWSCodeArtifact
disassociateExternalConnectionRequest
- 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.public DisposePackageVersionsResult disposePackageVersions(DisposePackageVersionsRequest request)
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.
disposePackageVersions
in interface AWSCodeArtifact
disposePackageVersionsRequest
- 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.public GetAssociatedPackageGroupResult getAssociatedPackageGroup(GetAssociatedPackageGroupRequest request)
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.
getAssociatedPackageGroup
in interface AWSCodeArtifact
getAssociatedPackageGroupRequest
- 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.public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)
Generates a temporary authorization token for accessing repositories in the domain. This API requires the
codeartifact:GetAuthorizationToken
and sts:GetServiceBearerToken
permissions. For more
information about authorization tokens, see CodeArtifact authentication
and tokens.
CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login
command. You can call login
periodically to refresh the token. When you create an authorization
token with the GetAuthorizationToken
API, you can set a custom authorization period, up to a maximum
of 12 hours, with the durationSeconds
parameter.
The authorization period begins after login
or GetAuthorizationToken
is called. If
login
or GetAuthorizationToken
is called while assuming a role, the token lifetime is
independent of the maximum session duration of the role. For example, if you call sts assume-role
and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be
valid for the full authorization period even though this is longer than the 15-minute session duration.
See Using IAM Roles for more information on controlling session duration.
getAuthorizationToken
in interface AWSCodeArtifact
getAuthorizationTokenRequest
- 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.public GetDomainPermissionsPolicyResult getDomainPermissionsPolicy(GetDomainPermissionsPolicyRequest request)
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.
getDomainPermissionsPolicy
in interface AWSCodeArtifact
getDomainPermissionsPolicyRequest
- 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.public GetPackageVersionAssetResult getPackageVersionAsset(GetPackageVersionAssetRequest request)
Returns an asset (or file) that is in a package. For example, for a Maven package version, use
GetPackageVersionAsset
to download a JAR
file, a POM
file, or any other
assets in the package version.
getPackageVersionAsset
in interface AWSCodeArtifact
getPackageVersionAssetRequest
- 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.public GetPackageVersionReadmeResult getPackageVersionReadme(GetPackageVersionReadmeRequest request)
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.
getPackageVersionReadme
in interface AWSCodeArtifact
getPackageVersionReadmeRequest
- 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.public GetRepositoryEndpointResult getRepositoryEndpoint(GetRepositoryEndpointRequest request)
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
cargo
generic
maven
npm
nuget
pypi
ruby
swift
getRepositoryEndpoint
in interface AWSCodeArtifact
getRepositoryEndpointRequest
- 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.public GetRepositoryPermissionsPolicyResult getRepositoryPermissionsPolicy(GetRepositoryPermissionsPolicyRequest request)
Returns the resource policy that is set on a repository.
getRepositoryPermissionsPolicy
in interface AWSCodeArtifact
getRepositoryPermissionsPolicyRequest
- 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.public ListAllowedRepositoriesForGroupResult listAllowedRepositoriesForGroup(ListAllowedRepositoriesForGroupRequest request)
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.
listAllowedRepositoriesForGroup
in interface AWSCodeArtifact
listAllowedRepositoriesForGroupRequest
- 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.public ListAssociatedPackagesResult listAssociatedPackages(ListAssociatedPackagesRequest request)
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.
listAssociatedPackages
in interface AWSCodeArtifact
listAssociatedPackagesRequest
- 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.public ListDomainsResult listDomains(ListDomainsRequest request)
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.
listDomains
in interface AWSCodeArtifact
listDomainsRequest
- 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.public ListPackageGroupsResult listPackageGroups(ListPackageGroupsRequest request)
Returns a list of package groups in the requested domain.
listPackageGroups
in interface AWSCodeArtifact
listPackageGroupsRequest
- 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.public ListPackageVersionAssetsResult listPackageVersionAssets(ListPackageVersionAssetsRequest request)
Returns a list of AssetSummary objects for assets in a package version.
listPackageVersionAssets
in interface AWSCodeArtifact
listPackageVersionAssetsRequest
- 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.public ListPackageVersionDependenciesResult listPackageVersionDependencies(ListPackageVersionDependenciesRequest request)
Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata
file for the package format (for example, the package.json
file for npm packages and the
pom.xml
file for Maven). Any package version dependencies that are not listed in the configuration
file are not returned.
listPackageVersionDependencies
in interface AWSCodeArtifact
listPackageVersionDependenciesRequest
- 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.public ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest request)
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.
listPackageVersions
in interface AWSCodeArtifact
listPackageVersionsRequest
- 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.public ListPackagesResult listPackages(ListPackagesRequest request)
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
listPackages
in interface AWSCodeArtifact
listPackagesRequest
- 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.public ListRepositoriesResult listRepositories(ListRepositoriesRequest request)
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.
listRepositories
in interface AWSCodeArtifact
listRepositoriesRequest
- 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.public ListRepositoriesInDomainResult listRepositoriesInDomain(ListRepositoriesInDomainRequest request)
Returns a list of RepositorySummary objects. Each RepositorySummary
contains information about a repository in
the specified domain and that matches the input parameters.
listRepositoriesInDomain
in interface AWSCodeArtifact
listRepositoriesInDomainRequest
- 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.public ListSubPackageGroupsResult listSubPackageGroups(ListSubPackageGroupsRequest request)
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.
listSubPackageGroups
in interface AWSCodeArtifact
listSubPackageGroupsRequest
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
listTagsForResource
in interface AWSCodeArtifact
listTagsForResourceRequest
- 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.public PublishPackageVersionResult publishPackageVersion(PublishPackageVersionRequest request)
Creates a new package version containing one or more assets (or files).
The unfinished
flag can be used to keep the package version in the Unfinished
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 to
Published
, omit the unfinished
flag when uploading the final asset, or set the status
using
UpdatePackageVersionStatus. Once a package version’s status is set to Published
, it cannot
change back to Unfinished
.
Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
publishPackageVersion
in interface AWSCodeArtifact
publishPackageVersionRequest
- 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.public PutDomainPermissionsPolicyResult putDomainPermissionsPolicy(PutDomainPermissionsPolicyRequest request)
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.
putDomainPermissionsPolicy
in interface AWSCodeArtifact
putDomainPermissionsPolicyRequest
- 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.public PutPackageOriginConfigurationResult putPackageOriginConfiguration(PutPackageOriginConfigurationRequest request)
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.
putPackageOriginConfiguration
in interface AWSCodeArtifact
putPackageOriginConfigurationRequest
- 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.public PutRepositoryPermissionsPolicyResult putRepositoryPermissionsPolicy(PutRepositoryPermissionsPolicyRequest request)
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.
putRepositoryPermissionsPolicy
in interface AWSCodeArtifact
putRepositoryPermissionsPolicyRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds or updates tags for a resource in CodeArtifact.
tagResource
in interface AWSCodeArtifact
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a resource in CodeArtifact.
untagResource
in interface AWSCodeArtifact
untagResourceRequest
- 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.public UpdatePackageGroupResult updatePackageGroup(UpdatePackageGroupRequest request)
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.
updatePackageGroup
in interface AWSCodeArtifact
updatePackageGroupRequest
- 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.public UpdatePackageGroupOriginConfigurationResult updatePackageGroupOriginConfiguration(UpdatePackageGroupOriginConfigurationRequest request)
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.
updatePackageGroupOriginConfiguration
in interface AWSCodeArtifact
updatePackageGroupOriginConfigurationRequest
- 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.public UpdatePackageVersionsStatusResult updatePackageVersionsStatus(UpdatePackageVersionsStatusRequest request)
Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus
, you can
update the status of package versions to Archived
, Published
, or Unlisted
.
To set the status of a package version to Disposed
, use DisposePackageVersions.
updatePackageVersionsStatus
in interface AWSCodeArtifact
updatePackageVersionsStatusRequest
- 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.public UpdateRepositoryResult updateRepository(UpdateRepositoryRequest request)
Update the properties of a repository.
updateRepository
in interface AWSCodeArtifact
updateRepositoryRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSCodeArtifact
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSCodeArtifact
shutdown
in class AmazonWebServiceClient