@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSCodeArtifact extends Object implements AWSCodeArtifact
AWSCodeArtifact
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public AssociateExternalConnectionResult associateExternalConnection(AssociateExternalConnectionRequest request)
AWSCodeArtifact
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
public CopyPackageVersionsResult copyPackageVersions(CopyPackageVersionsRequest request)
AWSCodeArtifact
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
public CreateDomainResult createDomain(CreateDomainRequest request)
AWSCodeArtifact
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
public CreatePackageGroupResult createPackageGroup(CreatePackageGroupRequest request)
AWSCodeArtifact
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
public CreateRepositoryResult createRepository(CreateRepositoryRequest request)
AWSCodeArtifact
Creates a repository.
createRepository
in interface AWSCodeArtifact
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AWSCodeArtifact
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
public DeleteDomainPermissionsPolicyResult deleteDomainPermissionsPolicy(DeleteDomainPermissionsPolicyRequest request)
AWSCodeArtifact
Deletes the resource policy set on a domain.
deleteDomainPermissionsPolicy
in interface AWSCodeArtifact
public DeletePackageResult deletePackage(DeletePackageRequest request)
AWSCodeArtifact
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
public DeletePackageGroupResult deletePackageGroup(DeletePackageGroupRequest request)
AWSCodeArtifact
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
public DeletePackageVersionsResult deletePackageVersions(DeletePackageVersionsRequest request)
AWSCodeArtifact
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
public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
AWSCodeArtifact
Deletes a repository.
deleteRepository
in interface AWSCodeArtifact
public DeleteRepositoryPermissionsPolicyResult deleteRepositoryPermissionsPolicy(DeleteRepositoryPermissionsPolicyRequest request)
AWSCodeArtifact
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
public DescribeDomainResult describeDomain(DescribeDomainRequest request)
AWSCodeArtifact
Returns a DomainDescription object that contains information about the requested domain.
describeDomain
in interface AWSCodeArtifact
public DescribePackageResult describePackage(DescribePackageRequest request)
AWSCodeArtifact
Returns a PackageDescription object that contains information about the requested package.
describePackage
in interface AWSCodeArtifact
public DescribePackageGroupResult describePackageGroup(DescribePackageGroupRequest request)
AWSCodeArtifact
Returns a PackageGroupDescription object that contains information about the requested package group.
describePackageGroup
in interface AWSCodeArtifact
public DescribePackageVersionResult describePackageVersion(DescribePackageVersionRequest request)
AWSCodeArtifact
Returns a PackageVersionDescription object that contains information about the requested package version.
describePackageVersion
in interface AWSCodeArtifact
public DescribeRepositoryResult describeRepository(DescribeRepositoryRequest request)
AWSCodeArtifact
Returns a RepositoryDescription
object that contains detailed information about the requested
repository.
describeRepository
in interface AWSCodeArtifact
public DisassociateExternalConnectionResult disassociateExternalConnection(DisassociateExternalConnectionRequest request)
AWSCodeArtifact
Removes an existing external connection from a repository.
disassociateExternalConnection
in interface AWSCodeArtifact
public DisposePackageVersionsResult disposePackageVersions(DisposePackageVersionsRequest request)
AWSCodeArtifact
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
public GetAssociatedPackageGroupResult getAssociatedPackageGroup(GetAssociatedPackageGroupRequest request)
AWSCodeArtifact
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
public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)
AWSCodeArtifact
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
public GetDomainPermissionsPolicyResult getDomainPermissionsPolicy(GetDomainPermissionsPolicyRequest request)
AWSCodeArtifact
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
public GetPackageVersionAssetResult getPackageVersionAsset(GetPackageVersionAssetRequest request)
AWSCodeArtifact
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
public GetPackageVersionReadmeResult getPackageVersionReadme(GetPackageVersionReadmeRequest request)
AWSCodeArtifact
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
public GetRepositoryEndpointResult getRepositoryEndpoint(GetRepositoryEndpointRequest request)
AWSCodeArtifact
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
public GetRepositoryPermissionsPolicyResult getRepositoryPermissionsPolicy(GetRepositoryPermissionsPolicyRequest request)
AWSCodeArtifact
Returns the resource policy that is set on a repository.
getRepositoryPermissionsPolicy
in interface AWSCodeArtifact
public ListAllowedRepositoriesForGroupResult listAllowedRepositoriesForGroup(ListAllowedRepositoriesForGroupRequest request)
AWSCodeArtifact
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
public ListAssociatedPackagesResult listAssociatedPackages(ListAssociatedPackagesRequest request)
AWSCodeArtifact
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
public ListDomainsResult listDomains(ListDomainsRequest request)
AWSCodeArtifact
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
public ListPackageGroupsResult listPackageGroups(ListPackageGroupsRequest request)
AWSCodeArtifact
Returns a list of package groups in the requested domain.
listPackageGroups
in interface AWSCodeArtifact
public ListPackageVersionAssetsResult listPackageVersionAssets(ListPackageVersionAssetsRequest request)
AWSCodeArtifact
Returns a list of AssetSummary objects for assets in a package version.
listPackageVersionAssets
in interface AWSCodeArtifact
public ListPackageVersionDependenciesResult listPackageVersionDependencies(ListPackageVersionDependenciesRequest request)
AWSCodeArtifact
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
public ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest request)
AWSCodeArtifact
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
public ListPackagesResult listPackages(ListPackagesRequest request)
AWSCodeArtifact
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
listPackages
in interface AWSCodeArtifact
public ListRepositoriesResult listRepositories(ListRepositoriesRequest request)
AWSCodeArtifact
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
public ListRepositoriesInDomainResult listRepositoriesInDomain(ListRepositoriesInDomainRequest request)
AWSCodeArtifact
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
public ListSubPackageGroupsResult listSubPackageGroups(ListSubPackageGroupsRequest request)
AWSCodeArtifact
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
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSCodeArtifact
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
listTagsForResource
in interface AWSCodeArtifact
public PublishPackageVersionResult publishPackageVersion(PublishPackageVersionRequest request)
AWSCodeArtifact
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
public PutDomainPermissionsPolicyResult putDomainPermissionsPolicy(PutDomainPermissionsPolicyRequest request)
AWSCodeArtifact
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
public PutPackageOriginConfigurationResult putPackageOriginConfiguration(PutPackageOriginConfigurationRequest request)
AWSCodeArtifact
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
public PutRepositoryPermissionsPolicyResult putRepositoryPermissionsPolicy(PutRepositoryPermissionsPolicyRequest request)
AWSCodeArtifact
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
public TagResourceResult tagResource(TagResourceRequest request)
AWSCodeArtifact
Adds or updates tags for a resource in CodeArtifact.
tagResource
in interface AWSCodeArtifact
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSCodeArtifact
Removes tags from a resource in CodeArtifact.
untagResource
in interface AWSCodeArtifact
public UpdatePackageGroupResult updatePackageGroup(UpdatePackageGroupRequest request)
AWSCodeArtifact
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
public UpdatePackageGroupOriginConfigurationResult updatePackageGroupOriginConfiguration(UpdatePackageGroupOriginConfigurationRequest request)
AWSCodeArtifact
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
public UpdatePackageVersionsStatusResult updatePackageVersionsStatus(UpdatePackageVersionsStatusRequest request)
AWSCodeArtifact
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
public UpdateRepositoryResult updateRepository(UpdateRepositoryRequest request)
AWSCodeArtifact
Update the properties of a repository.
updateRepository
in interface AWSCodeArtifact
public void shutdown()
AWSCodeArtifact
shutdown
in interface AWSCodeArtifact
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCodeArtifact
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.
getCachedResponseMetadata
in interface AWSCodeArtifact
request
- The originally executed request.