Skip to content

terminate_workspaces_pool_session

terminate_workspaces_pool_session(
    session_id: AmazonUuid, *, config_overrides: Optional[WorkSpacesClientConfig] = None
) -> TerminateWorkspacesPoolSessionResult

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support.

Terminates the pool session.

Parameters:

  • session_id (AmazonUuid) –

    The identifier of the pool session.

Raises:

Source code in docs_src/capo_workspaces/_services/work_spaces.py
def terminate_workspaces_pool_session(
    self,
    session_id: "capo_workspaces.types.amazon_uuid.AmazonUuid",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
) -> "capo_workspaces.types.terminate_workspaces_pool_session_result.TerminateWorkspacesPoolSessionResult":
    """<note> <p>End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/wsp-pools-end-of-support.html">Amazon WorkSpaces Pools end of support</a>. </p> </note> <p>Terminates the pool session.</p>

    Args:
        session_id: <p>The identifier of the pool session.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.operation_in_progress_exception.OperationInProgressException: <p>The properties of this WorkSpace are currently being modified. Try again in a moment.</p>
        capo_workspaces.errors.operation_not_supported_exception.OperationNotSupportedException: <p>This operation is not supported.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.terminate_workspaces_pool_session_request.TerminateWorkspacesPoolSessionRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.terminate_workspaces_pool_session_result.TerminateWorkspacesPoolSessionResult"
    ]:
        import capo_workspaces._operations.workspaces_service.terminate_workspaces_pool_session

        output, http_response = (
            capo_workspaces._operations.workspaces_service.terminate_workspaces_pool_session.terminate_workspaces_pool_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TerminateWorkspacesPoolSession")
    )
    input_: capo_workspaces.types.terminate_workspaces_pool_session_request.TerminateWorkspacesPoolSessionRequest = {
        "session_id": session_id
    }

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