Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Parameters:
-
invocation_identifier
(Optional[InvocationIdentifier], default:
None
)
–
The unique identifier (in UUID format) for the invocation to list invocation steps for.
-
next_token
(Optional[NextToken], default:
None
)
–
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
-
session_identifier
(SessionIdentifier)
–
The unique identifier for the session associated with the invocation steps. 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.
-
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/async_bedrock_agent_runtime.py
| async def list_invocation_steps(
self,
session_identifier: "capo_bedrock_agent_runtime.types.session_identifier.SessionIdentifier",
*,
config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = None,
invocation_identifier: Optional[
"capo_bedrock_agent_runtime.types.invocation_identifier.InvocationIdentifier"
] = None,
next_token: Optional[
"capo_bedrock_agent_runtime.types.next_token.NextToken"
] = None,
max_results: Optional[
"capo_bedrock_agent_runtime.types.max_results.MaxResults"
] = None,
) -> "capo_bedrock_agent_runtime.types.list_invocation_steps_response.ListInvocationStepsResponse":
"""<p>Lists all invocation steps associated with a session and optionally, an invocation within the session. 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:
invocation_identifier: <p>The unique identifier (in UUID format) for the invocation to list invocation steps for.</p>
next_token: <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results. </p>
max_results: <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
session_identifier: <p>The unique identifier for the session associated with the invocation steps. 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.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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_bedrock_agent_runtime.types.list_invocation_steps_request.ListInvocationStepsRequest]",
) -> AsyncOperationResponse[
"capo_bedrock_agent_runtime.types.list_invocation_steps_response.ListInvocationStepsResponse"
]:
import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.list_invocation_steps
(
output,
http_response,
) = await capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.list_invocation_steps.async_list_invocation_steps(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListInvocationSteps")
)
input_: capo_bedrock_agent_runtime.types.list_invocation_steps_request.ListInvocationStepsRequest = {
"session_identifier": session_identifier
}
if invocation_identifier is not None:
input_["invocation_identifier"] = invocation_identifier
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|