BedrockAgentCoreDataPlaneFrontingLayer / Client / stop_runtime_session

stop_runtime_session

BedrockAgentCoreDataPlaneFrontingLayer.Client.stop_runtime_session(**kwargs)

Stops a session that is running in an running AgentCore Runtime agent.

See also: AWS API Documentation

Request Syntax

response = client.stop_runtime_session(
    runtimeSessionId='string',
    agentRuntimeArn='string',
    qualifier='string',
    clientToken='string'
)
Parameters:

  • runtimeSessionId (string) –

    [REQUIRED]

    The ID of the session that you want to stop.

  • agentRuntimeArn (string) –

    [REQUIRED]

    The ARN of the agent that contains the session that you want to stop.

  • qualifier (string) – Optional qualifier to specify an agent alias, such as prod``code> or ``dev. If you don’t provide a value, the DEFAULT alias is used.

  • clientToken (string) –

    Idempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'runtimeSessionId': 'string',
    'statusCode': 123
}

Response Structure

  • (dict) –

    • runtimeSessionId (string) –

      The ID of the session that you requested to stop.

    • statusCode (integer) –

      The status code of the request to stop the session.

Exceptions

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ServiceQuotaExceededException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.UnauthorizedException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ValidationException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.AccessDeniedException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ConflictException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.RuntimeClientError

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ThrottlingException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ResourceNotFoundException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.InternalServerException