CodeArtifact / Client / update_package_versions_status
update_package_versions_status#
- CodeArtifact.Client.update_package_versions_status(**kwargs)#
Updates the status of one or more versions of a package. Using
UpdatePackageVersionsStatus
, you can update the status of package versions toArchived
,Published
, orUnlisted
. To set the status of a package version toDisposed
, use DisposePackageVersions.See also: AWS API Documentation
Request Syntax
response = client.update_package_versions_status( domain='string', domainOwner='string', repository='string', format='npm'|'pypi'|'maven'|'nuget'|'generic'|'swift', namespace='string', package='string', versions=[ 'string', ], versionRevisions={ 'string': 'string' }, expectedStatus='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted', targetStatus='Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted' )
- Parameters:
domain (string) –
[REQUIRED]
The name of the domain that contains the repository that contains the package versions with a status to be updated.
domainOwner (string) – The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository (string) –
[REQUIRED]
The repository that contains the package versions with the status you want to update.
format (string) –
[REQUIRED]
A format that specifies the type of the package with the statuses to update.
namespace (string) –
The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its
groupId
.The namespace of an npm package version is its
scope
.Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its
namespace
.
package (string) –
[REQUIRED]
The name of the package with the version statuses to update.
versions (list) –
[REQUIRED]
An array of strings that specify the versions of the package with the statuses to update.
(string) –
versionRevisions (dict) –
A map of package versions and package version revisions. The map
key
is the package version (for example,3.5.2
), and the mapvalue
is the package version revision.(string) –
(string) –
expectedStatus (string) – The package version’s expected status before it is updated. If
expectedStatus
is provided, the package version’s status is updated only if its status at the timeUpdatePackageVersionsStatus
is called matchesexpectedStatus
.targetStatus (string) –
[REQUIRED]
The status you want to change the package version status to.
- Return type:
dict
- Returns:
Response Syntax
{ 'successfulVersions': { 'string': { 'revision': 'string', 'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted' } }, 'failedVersions': { 'string': { 'errorCode': 'ALREADY_EXISTS'|'MISMATCHED_REVISION'|'MISMATCHED_STATUS'|'NOT_ALLOWED'|'NOT_FOUND'|'SKIPPED', 'errorMessage': 'string' } } }
Response Structure
(dict) –
successfulVersions (dict) –
A list of
PackageVersionError
objects, one for each package version with a status that failed to update.(string) –
(dict) –
Contains the revision and status of a package version.
revision (string) –
The revision of a package version.
status (string) –
The status of a package version.
failedVersions (dict) –
A list of
SuccessfulPackageVersionInfo
objects, one for each package version with a status that successfully updated.(string) –
(dict) –
l An error associated with package.
errorCode (string) –
The error code associated with the error. Valid error codes are:
ALREADY_EXISTS
MISMATCHED_REVISION
MISMATCHED_STATUS
NOT_ALLOWED
NOT_FOUND
SKIPPED
errorMessage (string) –
The error message associated with the error.
Exceptions
CodeArtifact.Client.exceptions.AccessDeniedException
CodeArtifact.Client.exceptions.ConflictException
CodeArtifact.Client.exceptions.InternalServerException
CodeArtifact.Client.exceptions.ResourceNotFoundException
CodeArtifact.Client.exceptions.ThrottlingException
CodeArtifact.Client.exceptions.ValidationException