Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs
Parameters:
-
invocation_id
(Optional[Uuid], default:
None
)
–
A unique identifier for the invocation in UUID format.
-
description
(Optional[InvocationDescription], default:
None
)
–
A description for the interactions in the invocation. For example, "User asking about weather in Seattle".
-
session_identifier
(SessionIdentifier)
–
The unique identifier for the associated session for the invocation. 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.
-
ServiceQuotaExceededException
–
The number of requests exceeds the service quota. Resubmit your request later.
-
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 create_invocation(
self,
session_identifier: "capo_bedrock_agent_runtime.types.session_identifier.SessionIdentifier",
*,
config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
invocation_id: Optional["capo_bedrock_agent_runtime.types.uuid.Uuid"] = None,
description: Optional[
"capo_bedrock_agent_runtime.types.invocation_description.InvocationDescription"
] = None,
) -> "capo_bedrock_agent_runtime.types.create_invocation_response.CreateInvocationResponse":
"""<p>Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. 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> <p>Related APIs</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html">ListInvocations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListSessions.html">ListSessions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetSession.html">GetSession</a> </p> </li> </ul>
Args:
invocation_id: <p>A unique identifier for the invocation in UUID format.</p>
description: <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
session_identifier: <p>The unique identifier for the associated session for the invocation. 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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</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.create_invocation_request.CreateInvocationRequest]",
) -> OperationResponse[
"capo_bedrock_agent_runtime.types.create_invocation_response.CreateInvocationResponse"
]:
import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.create_invocation
output, http_response = (
capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.create_invocation.create_invocation(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateInvocation")
)
input_: capo_bedrock_agent_runtime.types.create_invocation_request.CreateInvocationRequest = {
"session_identifier": session_identifier
}
if invocation_id is not None:
input_["invocation_id"] = invocation_id
if description is not None:
input_["description"] = description
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|