delete_package `async` ¶

delete_package(
    domain: DomainName,
    repository: RepositoryName,
    format: PackageFormat,
    package: PackageName,
    *,
    config_overrides: Optional[AsynccodeartifactClientConfig] = None,
    domain_owner: Optional[AccountId] = None,
    namespace: Optional[PackageNamespace] = None,
) -> DeletePackageResult

Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.

Parameters:

domain (DomainName) –

The name of the domain that contains the package to delete.
domain_owner (Optional[AccountId], default: None ) –

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository (RepositoryName) –

The name of the repository that contains the package to delete.
format (PackageFormat) –

The format of the requested package to delete.
namespace (Optional[PackageNamespace], default: None ) –
The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting packages of the following formats:
- Maven
- Swift
- generic
- The namespace of a Maven package version is its groupId.
- The namespace of an npm or Swift package version is its scope.
- The namespace of a generic package is its namespace.
- Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
package (PackageName) –

The name of the package to delete.

Raises:

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.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_codeartifact/_services/async_codeartifact.py

async def delete_package(
    self,
    domain: "capo_codeartifact.types.domain_name.DomainName",
    repository: "capo_codeartifact.types.repository_name.RepositoryName",
    format: "capo_codeartifact.types.package_format.PackageFormat",
    package: "capo_codeartifact.types.package_name.PackageName",
    *,
    config_overrides: Optional[AsynccodeartifactClientConfig] = None,
    domain_owner: Optional["capo_codeartifact.types.account_id.AccountId"] = None,
    namespace: Optional[
        "capo_codeartifact.types.package_namespace.PackageNamespace"
    ] = None,
) -> "capo_codeartifact.types.delete_package_result.DeletePackageResult":
    """<p>Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html">DeletePackageVersions</a> API.</p>

    Args:
        domain: <p>The name of the domain that contains the package to delete.</p>
        domain_owner: <p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>
        repository: <p>The name of the repository that contains the package to delete.</p>
        format: <p>The format of the requested package to delete.</p>
        namespace: <p>The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:</p> <note> <p>The namespace is required when deleting packages of the following formats:</p> <ul> <li> <p>Maven</p> </li> <li> <p>Swift</p> </li> <li> <p>generic</p> </li> </ul> </note> <ul> <li> <p> The namespace of a Maven package version is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm or Swift package version is its <code>scope</code>. </p> </li> <li> <p>The namespace of a generic package is its <code>namespace</code>.</p> </li> <li> <p> Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace. </p> </li> </ul>
        package: <p>The name of the package to delete.</p>

    Raises:
        capo_codeartifact.errors.access_denied_exception.AccessDeniedException: <p> The operation did not succeed because of an unauthorized access attempt. </p>
        capo_codeartifact.errors.conflict_exception.ConflictException: <p> The operation did not succeed because prerequisites are not met. </p>
        capo_codeartifact.errors.internal_server_exception.InternalServerException: <p> The operation did not succeed because of an error that occurred inside CodeArtifact. </p>
        capo_codeartifact.errors.resource_not_found_exception.ResourceNotFoundException: <p> The operation did not succeed because the resource requested is not found in the service. </p>
        capo_codeartifact.errors.throttling_exception.ThrottlingException: <p> The operation did not succeed because too many requests are sent to the service. </p>
        capo_codeartifact.errors.validation_exception.ValidationException: <p> The operation did not succeed because a parameter in the request was sent with an invalid value. </p>
        capo_codeartifact.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codeartifact.types.delete_package_request.DeletePackageRequest]",
    ) -> AsyncOperationResponse[
        "capo_codeartifact.types.delete_package_result.DeletePackageResult"
    ]:
        import capo_codeartifact._operations.code_artifact_control_plane_service.delete_package

        (
            output,
            http_response,
        ) = await capo_codeartifact._operations.code_artifact_control_plane_service.delete_package.async_delete_package(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePackage")
    )
    input_: capo_codeartifact.types.delete_package_request.DeletePackageRequest = {
        "domain": domain,
        "repository": repository,
        "format": format,
        "package": package,
    }
    if domain_owner is not None:
        input_["domain_owner"] = domain_owner
    if namespace is not None:
        input_["namespace"] = namespace

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_package async ¶

delete_package `async` ¶