cancel_profile_update_task ¶

def cancel_profile_update_task(
    self,
    catalog: "capo_partnercentral_account.types.catalog.Catalog",
    identifier: "capo_partnercentral_account.types.partner_identifier.PartnerIdentifier",
    task_id: "capo_partnercentral_account.types.profile_task_id.ProfileTaskId",
    *,
    config_overrides: Optional[PartnerCentralAccountClientConfig] = None,
    client_token: Optional[
        "capo_partnercentral_account.types.client_token.ClientToken"
    ] = None,
) -> "capo_partnercentral_account.types.cancel_profile_update_task_response.CancelProfileUpdateTaskResponse":
    """<p>Cancels an in-progress profile update task, stopping any pending changes to the partner profile.</p>

    Args:
        catalog: <p>The catalog identifier for the partner account.</p>
        identifier: <p>The unique identifier of the partner account.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
        task_id: <p>The unique identifier of the profile update task to cancel.</p>

    Raises:
        capo_partnercentral_account.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.</p>
        capo_partnercentral_account.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.</p>
        capo_partnercentral_account.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.</p>
        capo_partnercentral_account.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.</p>
        capo_partnercentral_account.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.</p>
        capo_partnercentral_account.errors.validation_exception.ValidationException: <p>The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.</p>
        capo_partnercentral_account.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_account.types.cancel_profile_update_task_request.CancelProfileUpdateTaskRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_account.types.cancel_profile_update_task_response.CancelProfileUpdateTaskResponse"
    ]:
        import capo_partnercentral_account._operations.partner_central_account.cancel_profile_update_task

        output, http_response = (
            capo_partnercentral_account._operations.partner_central_account.cancel_profile_update_task.cancel_profile_update_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelProfileUpdateTask")
    )
    input_: capo_partnercentral_account.types.cancel_profile_update_task_request.CancelProfileUpdateTaskRequest = {
        "catalog": catalog,
        "identifier": identifier,
        "task_id": task_id,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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