delete_package_group ¶

delete_package_group(
    domain: DomainName,
    package_group: String,
    *,
    config_overrides: Optional[codeartifactClientConfig] = None,
    domain_owner: Optional[AccountId] = None,
) -> DeletePackageGroupResult

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.

Parameters:

domain (DomainName) –

The domain that contains the package group to be deleted.
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.
package_group (String) –

The pattern of the package group to be deleted.

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

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

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

def delete_package_group(
    self,
    domain: "capo_codeartifact.types.domain_name.DomainName",
    package_group: "capo_codeartifact.types.string.String",
    *,
    config_overrides: Optional[codeartifactClientConfig] = None,
    domain_owner: Optional["capo_codeartifact.types.account_id.AccountId"] = None,
) -> "capo_codeartifact.types.delete_package_group_result.DeletePackageGroupResult":
    """<p>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.</p>

    Args:
        domain: <p> The domain that contains the package group to be deleted. </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>
        package_group: <p>The pattern of the package group to be deleted.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p> The operation did not succeed because it would have exceeded a service limit for your account. </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.
    """

    def _handler(
        req: "OperationRequest[capo_codeartifact.types.delete_package_group_request.DeletePackageGroupRequest]",
    ) -> OperationResponse[
        "capo_codeartifact.types.delete_package_group_result.DeletePackageGroupResult"
    ]:
        import capo_codeartifact._operations.code_artifact_control_plane_service.delete_package_group

        output, http_response = (
            capo_codeartifact._operations.code_artifact_control_plane_service.delete_package_group.delete_package_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePackageGroup")
    )
    input_: capo_codeartifact.types.delete_package_group_request.DeletePackageGroupRequest = {
        "domain": domain,
        "package_group": package_group,
    }
    if domain_owner is not None:
        input_["domain_owner"] = domain_owner

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