Skip to content

list_invocations

Operation

list_invocations

list_invocations(request: ListInvocationsInput | ListInvocationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListInvocationsInputDict]) -> ListInvocationsOutput

Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

Name Type Description Default
request ListInvocationsInput | ListInvocationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListInvocationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListInvocationsOutput

An instance of ListInvocationsOutput.

list_invocations async

list_invocations(request: ListInvocationsInput | ListInvocationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListInvocationsInputDict]) -> ListInvocationsOutput

Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

Name Type Description Default
request ListInvocationsInput | ListInvocationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListInvocationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListInvocationsOutput

An instance of ListInvocationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListInvocationsInputDict

Bases: TypedDict

Dictionary form of ListInvocationsInput.

Attributes

max_results instance-attribute
max_results: int | 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.

next_token instance-attribute
next_token: str | 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.

session_identifier instance-attribute
session_identifier: Required[str]

The unique identifier for the session to list invocations for. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

ListInvocationsInput dataclass

Bases: _SerdeShape

Dataclass for ListInvocationsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int = ...

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.

next_token class-attribute instance-attribute
next_token: str | 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.

session_identifier class-attribute instance-attribute
session_identifier: str | None = ...

The unique identifier for the session to list invocations for. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

Output

ListInvocationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListInvocationsOutput structure.

Attributes

invocation_summaries instance-attribute
invocation_summaries: list[InvocationSummary]

A list of invocation summaries associated with the session.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.