Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Parameters:
-
session_identifier
(SessionIdentifier)
–
The unique identifier for the session to be deleted. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
Raises:
-
AccessDeniedException
–
The request is denied because of missing access permissions. Check your permissions and retry your request.
-
ConflictException
–
There was a conflict performing an operation. Resolve the conflict and retry your request.
-
InternalServerException
–
An internal server error occurred. Retry your request.
-
ResourceNotFoundException
–
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
-
ThrottlingException
–
The number of requests exceeds the limit. Resubmit your request later.
-
ValidationException
–
Input validation failed. Check your request parameters and retry the request.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_bedrock_agent_runtime/_services/bedrock_agent_runtime.py
| def delete_session(
self,
session_identifier: "capo_bedrock_agent_runtime.types.session_identifier.SessionIdentifier",
*,
config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
) -> (
"capo_bedrock_agent_runtime.types.delete_session_response.DeleteSessionResponse"
):
"""<p>Deletes a session that you ended. You can't delete a session with an <code>ACTIVE</code> status. To delete an active session, you must first end it with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_EndSession.html">EndSession</a> API operation. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
Args:
session_identifier: <p>The unique identifier for the session to be deleted. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
Raises:
capo_bedrock_agent_runtime.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
capo_bedrock_agent_runtime.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
capo_bedrock_agent_runtime.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
capo_bedrock_agent_runtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
capo_bedrock_agent_runtime.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
capo_bedrock_agent_runtime.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
capo_bedrock_agent_runtime.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_bedrock_agent_runtime.types.delete_session_request.DeleteSessionRequest]",
) -> OperationResponse[
"capo_bedrock_agent_runtime.types.delete_session_response.DeleteSessionResponse"
]:
import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.delete_session
output, http_response = (
capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.delete_session.delete_session(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteSession")
)
input_: capo_bedrock_agent_runtime.types.delete_session_request.DeleteSessionRequest = {
"session_identifier": session_identifier
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|