@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodeArtifact
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCodeArtifact instead.
CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
CodeArtifact Components
Use the information in this guide to help you work with the following CodeArtifact components:
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 and twine), and NuGet CLIs (nuget and dotnet).
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, and NuGet 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 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 supports these operations:
AssociateExternalConnection: Adds an existing external connection to a repository.
CopyPackageVersions: Copies package versions from one repository to another repository in the same
domain.
CreateDomain: Creates a domain
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.
DeletePackageVersions: Deletes versions of a package. After a package has been deleted, it can be
republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.
DeleteRepository: Deletes a repository.
DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
DescribeDomain: Returns a DomainDescription object that contains information about the
requested domain.
DescribePackage: Returns a PackageDescription object that contains details about a package.
DescribePackageVersion: Returns a PackageVersionDescription object that contains details about a package version.
DescribeRepository: Returns a RepositoryDescription object that contains detailed
information about the requested repository.
DisposePackageVersions: Disposes versions of a package. A package version with the status
Disposed cannot be restored because they have been permanently removed from storage.
DisassociateExternalConnection: Removes an existing external connection from a repository.
GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the
domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can
be customized to any length with a maximum of 12 hours.
GetDomainPermissionsPolicy: Returns the policy of a resource that is attached to the specified domain.
GetPackageVersionAsset: Returns the contents of an asset that is in a package version.
GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository
has one endpoint for each package format:
maven
npm
nuget
pypi
GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository.
ListDomains: Returns a list of DomainSummary objects. Each returned
DomainSummary object contains information about a domain.
ListPackages: Lists the packages in a repository.
ListPackageVersionAssets: Lists the assets for a given package version.
ListPackageVersionDependencies: Returns a list of the direct dependencies for a package version.
ListPackageVersions: Returns a list of package versions for a specified package in a repository.
ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called
this method.
ListRepositoriesInDomain: Returns a list of the repositories in a domain.
PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine how
new versions of the package can be added to a specific repository.
PutRepositoryPermissionsPolicy: Sets the resource policy on a repository that specifies permissions to
access it.
UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
UpdateRepository: Updates the properties of a repository.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateExternalConnectionResult |
associateExternalConnection(AssociateExternalConnectionRequest associateExternalConnectionRequest)
Adds an existing external connection to a repository.
|
CopyPackageVersionsResult |
copyPackageVersions(CopyPackageVersionsRequest copyPackageVersionsRequest)
Copies package versions from one repository to another repository in the same domain.
|
CreateDomainResult |
createDomain(CreateDomainRequest createDomainRequest)
Creates a domain.
|
CreateRepositoryResult |
createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a repository.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes a domain.
|
DeleteDomainPermissionsPolicyResult |
deleteDomainPermissionsPolicy(DeleteDomainPermissionsPolicyRequest deleteDomainPermissionsPolicyRequest)
Deletes the resource policy set on a domain.
|
DeletePackageVersionsResult |
deletePackageVersions(DeletePackageVersionsRequest deletePackageVersionsRequest)
Deletes one or more versions of a package.
|
DeleteRepositoryResult |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes a repository.
|
DeleteRepositoryPermissionsPolicyResult |
deleteRepositoryPermissionsPolicy(DeleteRepositoryPermissionsPolicyRequest deleteRepositoryPermissionsPolicyRequest)
Deletes the resource policy that is set on a repository.
|
DescribeDomainResult |
describeDomain(DescribeDomainRequest describeDomainRequest)
Returns a
DomainDescription object that contains information about the requested domain.
|
DescribePackageResult |
describePackage(DescribePackageRequest describePackageRequest)
Returns a
PackageDescription object that contains information about the requested package.
|
DescribePackageVersionResult |
describePackageVersion(DescribePackageVersionRequest describePackageVersionRequest)
Returns a PackageVersionDescription object that contains information about the requested package version.
|
DescribeRepositoryResult |
describeRepository(DescribeRepositoryRequest describeRepositoryRequest)
Returns a
RepositoryDescription object that contains detailed information about the requested
repository. |
DisassociateExternalConnectionResult |
disassociateExternalConnection(DisassociateExternalConnectionRequest disassociateExternalConnectionRequest)
Removes an existing external connection from a repository.
|
DisposePackageVersionsResult |
disposePackageVersions(DisposePackageVersionsRequest disposePackageVersionsRequest)
Deletes the assets in package versions and sets the package versions' status to
Disposed. |
GetAuthorizationTokenResult |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
Generates a temporary authorization token for accessing repositories in the domain.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDomainPermissionsPolicyResult |
getDomainPermissionsPolicy(GetDomainPermissionsPolicyRequest getDomainPermissionsPolicyRequest)
Returns the resource policy attached to the specified domain.
|
GetPackageVersionAssetResult |
getPackageVersionAsset(GetPackageVersionAssetRequest getPackageVersionAssetRequest)
Returns an asset (or file) that is in a package.
|
GetPackageVersionReadmeResult |
getPackageVersionReadme(GetPackageVersionReadmeRequest getPackageVersionReadmeRequest)
Gets the readme file or descriptive text for a package version.
|
GetRepositoryEndpointResult |
getRepositoryEndpoint(GetRepositoryEndpointRequest getRepositoryEndpointRequest)
Returns the endpoint of a repository for a specific package format.
|
GetRepositoryPermissionsPolicyResult |
getRepositoryPermissionsPolicy(GetRepositoryPermissionsPolicyRequest getRepositoryPermissionsPolicyRequest)
Returns the resource policy that is set on a repository.
|
ListDomainsResult |
listDomains(ListDomainsRequest listDomainsRequest)
Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call.
|
ListPackagesResult |
listPackages(ListPackagesRequest listPackagesRequest)
Returns a list of PackageSummary
objects for packages in a repository that match the request parameters.
|
ListPackageVersionAssetsResult |
listPackageVersionAssets(ListPackageVersionAssetsRequest listPackageVersionAssetsRequest)
Returns a list of AssetSummary
objects for assets in a package version.
|
ListPackageVersionDependenciesResult |
listPackageVersionDependencies(ListPackageVersionDependenciesRequest listPackageVersionDependenciesRequest)
Returns the direct dependencies for a package version.
|
ListPackageVersionsResult |
listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest)
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
|
ListRepositoriesResult |
listRepositories(ListRepositoriesRequest listRepositoriesRequest)
Returns a list of RepositorySummary objects.
|
ListRepositoriesInDomainResult |
listRepositoriesInDomain(ListRepositoriesInDomainRequest listRepositoriesInDomainRequest)
Returns a list of RepositorySummary objects.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
|
PutDomainPermissionsPolicyResult |
putDomainPermissionsPolicy(PutDomainPermissionsPolicyRequest putDomainPermissionsPolicyRequest)
Sets a resource policy on a domain that specifies permissions to access it.
|
PutPackageOriginConfigurationResult |
putPackageOriginConfiguration(PutPackageOriginConfigurationRequest putPackageOriginConfigurationRequest)
Sets the package origin configuration for a package.
|
PutRepositoryPermissionsPolicyResult |
putRepositoryPermissionsPolicy(PutRepositoryPermissionsPolicyRequest putRepositoryPermissionsPolicyRequest)
Sets the resource policy on a repository that specifies permissions to access it.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for a resource in CodeArtifact.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource in CodeArtifact.
|
UpdatePackageVersionsStatusResult |
updatePackageVersionsStatus(UpdatePackageVersionsStatusRequest updatePackageVersionsStatusRequest)
Updates the status of one or more versions of a package.
|
UpdateRepositoryResult |
updateRepository(UpdateRepositoryRequest updateRepositoryRequest)
Update the properties of a repository.
|
static final String ENDPOINT_PREFIX
AssociateExternalConnectionResult 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.
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.CopyPackageVersionsResult copyPackageVersions(CopyPackageVersionsRequest copyPackageVersionsRequest)
Copies package versions from one repository to another repository in the same domain.
You must specify versions or versionRevisions. You cannot specify both.
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.CreateDomainResult 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.
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.CreateRepositoryResult createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a repository.
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.DeleteDomainResult 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.
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.DeleteDomainPermissionsPolicyResult deleteDomainPermissionsPolicy(DeleteDomainPermissionsPolicyRequest deleteDomainPermissionsPolicyRequest)
Deletes the resource policy set on a domain.
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.DeletePackageVersionsResult 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, ListackageVersions), but you can restore them using UpdatePackageVersionsStatus.
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.DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes a repository.
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.DeleteRepositoryPermissionsPolicyResult 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.
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.DescribeDomainResult describeDomain(DescribeDomainRequest describeDomainRequest)
Returns a DomainDescription object that contains information about the requested domain.
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.DescribePackageResult describePackage(DescribePackageRequest describePackageRequest)
Returns a PackageDescription object that contains information about the requested package.
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.DescribePackageVersionResult describePackageVersion(DescribePackageVersionRequest describePackageVersionRequest)
Returns a PackageVersionDescription object that contains information about the requested package version.
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.DescribeRepositoryResult describeRepository(DescribeRepositoryRequest describeRepositoryRequest)
Returns a RepositoryDescription object that contains detailed information about the requested
repository.
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.DisassociateExternalConnectionResult disassociateExternalConnection(DisassociateExternalConnectionRequest disassociateExternalConnectionRequest)
Removes an existing external connection from a repository.
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.DisposePackageVersionsResult 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.
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.GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
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.
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.GetDomainPermissionsPolicyResult 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.
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.GetPackageVersionAssetResult getPackageVersionAsset(GetPackageVersionAssetRequest getPackageVersionAssetRequest)
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.
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.GetPackageVersionReadmeResult getPackageVersionReadme(GetPackageVersionReadmeRequest getPackageVersionReadmeRequest)
Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file,
CodeArtifact extracts a description from a metadata file. For example, from the <description>
element in the pom.xml file of a Maven package.
The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
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.GetRepositoryEndpointResult getRepositoryEndpoint(GetRepositoryEndpointRequest getRepositoryEndpointRequest)
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
maven
npm
nuget
pypi
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.GetRepositoryPermissionsPolicyResult getRepositoryPermissionsPolicy(GetRepositoryPermissionsPolicyRequest getRepositoryPermissionsPolicyRequest)
Returns the resource policy that is set on a repository.
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.ListDomainsResult listDomains(ListDomainsRequest 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.
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.ListPackageVersionAssetsResult listPackageVersionAssets(ListPackageVersionAssetsRequest listPackageVersionAssetsRequest)
Returns a list of AssetSummary objects for assets in a package version.
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.ListPackageVersionDependenciesResult 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 the
pom.xml file for Maven). Any package version dependencies that are not listed in the configuration
file are not returned.
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.ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest)
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
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.ListPackagesResult listPackages(ListPackagesRequest listPackagesRequest)
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
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.ListRepositoriesResult 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.
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.ListRepositoriesInDomainResult 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.
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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
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.PutDomainPermissionsPolicyResult 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.
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.PutPackageOriginConfigurationResult 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.
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.PutRepositoryPermissionsPolicyResult 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.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for a resource in CodeArtifact.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource in CodeArtifact.
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.UpdatePackageVersionsStatusResult updatePackageVersionsStatus(UpdatePackageVersionsStatusRequest updatePackageVersionsStatusRequest)
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.
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.UpdateRepositoryResult updateRepository(UpdateRepositoryRequest updateRepositoryRequest)
Update the properties of a repository.
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.void shutdown()
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 a request.
request - The originally executed request.Copyright © 2022. All rights reserved.