record_handler_progress ¶

def record_handler_progress(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    bearer_token: Optional[
        "capo_cloudformation.types.client_token.ClientToken"
    ] = None,
    operation_status: Optional[
        "capo_cloudformation.types.operation_status.OperationStatus"
    ] = None,
    current_operation_status: Optional[
        "capo_cloudformation.types.operation_status.OperationStatus"
    ] = None,
    status_message: Optional[
        "capo_cloudformation.types.status_message.StatusMessage"
    ] = None,
    error_code: Optional[
        "capo_cloudformation.types.handler_error_code.HandlerErrorCode"
    ] = None,
    resource_model: Optional[
        "capo_cloudformation.types.resource_model.ResourceModel"
    ] = None,
    client_request_token: Optional[
        "capo_cloudformation.types.client_request_token.ClientRequestToken"
    ] = None,
) -> "capo_cloudformation.types.record_handler_progress_output.RecordHandlerProgressOutput":
    """<p>Reports progress of a resource handler to CloudFormation.</p> <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. Don't use this API in your code.</p>

    Args:
        bearer_token: <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>
        operation_status: <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>
        current_operation_status: <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>
        status_message: <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>
        error_code: <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>
        resource_model: <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>
        client_request_token: <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>

    Raises:
        capo_cloudformation.errors.invalid_state_transition_exception.InvalidStateTransitionException: <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation doesn't return this error to users.</p>
        capo_cloudformation.errors.operation_status_check_failed_exception.OperationStatusCheckFailedException: <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation doesn't return this error to users.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.record_handler_progress_input.RecordHandlerProgressInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.record_handler_progress_output.RecordHandlerProgressOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.record_handler_progress

        output, http_response = (
            capo_cloudformation._operations.cloud_formation.record_handler_progress.record_handler_progress(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RecordHandlerProgress")
    )
    input_: capo_cloudformation.types.record_handler_progress_input.RecordHandlerProgressInput = {}
    if bearer_token is not None:
        input_["bearer_token"] = bearer_token
    if operation_status is not None:
        input_["operation_status"] = operation_status
    if current_operation_status is not None:
        input_["current_operation_status"] = current_operation_status
    if status_message is not None:
        input_["status_message"] = status_message
    if error_code is not None:
        input_["error_code"] = error_code
    if resource_model is not None:
        input_["resource_model"] = resource_model
    if client_request_token is not None:
        input_["client_request_token"] = client_request_token

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