cancel_session ¶

cancel_session(
    session_arn: SessionArn, *, config_overrides: Optional[MPAClientConfig] = None
) -> CancelSessionResponse

Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.

Parameters:

session_arn (SessionArn) –

Amazon Resource Name (ARN) for the session.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action. Check your permissions, and try again.
ConflictException –

The request cannot be completed because it conflicts with the current state of a resource.
InternalServerException –

The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
ResourceNotFoundException –

The specified resource doesn't exist. Check the resource ID, and try again.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

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

Source code in docs_src/capo_mpa/_services/mpa.py

def cancel_session(
    self,
    session_arn: "capo_mpa.types.session_arn.SessionArn",
    *,
    config_overrides: Optional[MPAClientConfig] = None,
) -> "capo_mpa.types.cancel_session_response.CancelSessionResponse":
    """<p>Cancels an approval session. For more information, see <a href="https://docs.aws.amazon.com/mpa/latest/userguide/mpa-concepts.html">Session</a> in the <i>Multi-party approval User Guide</i>.</p>

    Args:
        session_arn: <p>Amazon Resource Name (ARN) for the session.</p>

    Raises:
        capo_mpa.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. Check your permissions, and try again.</p>
        capo_mpa.errors.conflict_exception.ConflictException: <p>The request cannot be completed because it conflicts with the current state of a resource.</p>
        capo_mpa.errors.internal_server_exception.InternalServerException: <p>The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.</p>
        capo_mpa.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist. Check the resource ID, and try again.</p>
        capo_mpa.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_mpa.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_mpa.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mpa.types.cancel_session_request.CancelSessionRequest]",
    ) -> OperationResponse[
        "capo_mpa.types.cancel_session_response.CancelSessionResponse"
    ]:
        import capo_mpa._operations.aws_fluffy_core_service.cancel_session

        output, http_response = (
            capo_mpa._operations.aws_fluffy_core_service.cancel_session.cancel_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelSession")
    )
    input_: capo_mpa.types.cancel_session_request.CancelSessionRequest = {
        "session_arn": session_arn
    }

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