terminate_stream_session `async` ¶

terminate_stream_session(
    identifier: Identifier,
    stream_session_identifier: Identifier,
    *,
    config_overrides: Optional[AsyncGameLiftStreamsClientConfig] = None,
) -> None

Permanently terminates an active stream session. When called, the stream session status changes to TERMINATING. You can terminate a stream session in any status except ACTIVATING. If the stream session is in ACTIVATING status, an exception is thrown.

Parameters:

identifier (Identifier) –

Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

The stream group that runs this stream session.
stream_session_identifier (Identifier) –

Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.

Raises:

AccessDeniedException –

You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
InternalServerException –

The service encountered an internal error and is unable to complete the request.
ResourceNotFoundException –

The resource specified in the request was not found. Correct the request before you try again.
ThrottlingException –

The request was denied due to request throttling. Retry the request after the suggested wait time.
ValidationException –

One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
UnknownServiceError –

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

Source code in docs_src/capo_gameliftstreams/_services/async_game_lift_streams.py

async def terminate_stream_session(
    self,
    identifier: "capo_gameliftstreams.types.identifier.Identifier",
    stream_session_identifier: "capo_gameliftstreams.types.identifier.Identifier",
    *,
    config_overrides: Optional[AsyncGameLiftStreamsClientConfig] = None,
) -> None:
    """<p>Permanently terminates an active stream session. When called, the stream session status changes to <code>TERMINATING</code>. You can terminate a stream session in any status except <code>ACTIVATING</code>. If the stream session is in <code>ACTIVATING</code> status, an exception is thrown.</p>

    Args:
        identifier: <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p> <p>The stream group that runs this stream session.</p>
        stream_session_identifier: <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</code>. Example ID: <code>ABC123def4567</code>. </p>

    Raises:
        capo_gameliftstreams.errors.access_denied_exception.AccessDeniedException: <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
        capo_gameliftstreams.errors.internal_server_exception.InternalServerException: <p>The service encountered an internal error and is unable to complete the request.</p>
        capo_gameliftstreams.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request was not found. Correct the request before you try again.</p>
        capo_gameliftstreams.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
        capo_gameliftstreams.errors.validation_exception.ValidationException: <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
        capo_gameliftstreams.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_gameliftstreams.types.terminate_stream_session_input.TerminateStreamSessionInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_gameliftstreams._operations.game_lift_streams.terminate_stream_session

        (
            output,
            http_response,
        ) = await capo_gameliftstreams._operations.game_lift_streams.terminate_stream_session.async_terminate_stream_session(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TerminateStreamSession")
    )
    input_: capo_gameliftstreams.types.terminate_stream_session_input.TerminateStreamSessionInput = {
        "identifier": identifier,
        "stream_session_identifier": stream_session_identifier,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

terminate_stream_session async ¶

terminate_stream_session `async` ¶