delete_package ¶

delete_package(
    package_id: NodePackageId,
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    force_delete: Optional[Boolean] = None,
) -> DeletePackageResponse

Deletes a package.

To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.

Parameters:

package_id (NodePackageId) –

The package's ID.
force_delete (Optional[Boolean], default: None ) –

Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

Raises:

AccessDeniedException –

The requestor does not have permission to access the target action or resource.
ConflictException –

The target resource is in use.
InternalServerException –

An internal error occurred.
ResourceNotFoundException –

The target resource was not found.
ValidationException –

The request contains an invalid parameter value.
UnknownServiceError –

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

Source code in docs_src/capo_panorama/_services/panorama.py

def delete_package(
    self,
    package_id: "capo_panorama.types.node_package_id.NodePackageId",
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    force_delete: Optional["capo_panorama.types.boolean.Boolean"] = None,
) -> "capo_panorama.types.delete_package_response.DeletePackageResponse":
    """<p>Deletes a package.</p> <note> <p>To delete a package, you need permission to call <code>s3:DeleteObject</code> in addition to permissions for the AWS Panorama API.</p> </note>

    Args:
        package_id: <p>The package's ID.</p>
        force_delete: <p>Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.</p>

    Raises:
        capo_panorama.errors.access_denied_exception.AccessDeniedException: <p>The requestor does not have permission to access the target action or resource.</p>
        capo_panorama.errors.conflict_exception.ConflictException: <p>The target resource is in use.</p>
        capo_panorama.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_panorama.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found.</p>
        capo_panorama.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value.</p>
        capo_panorama.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_panorama.types.delete_package_request.DeletePackageRequest]",
    ) -> OperationResponse[
        "capo_panorama.types.delete_package_response.DeletePackageResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.delete_package

        output, http_response = (
            capo_panorama._operations.omni_cloud_service_lambda.delete_package.delete_package(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePackage")
    )
    input_: capo_panorama.types.delete_package_request.DeletePackageRequest = {
        "package_id": package_id
    }
    if force_delete is not None:
        input_["force_delete"] = force_delete

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output