Skip to content

put_invocation_step

Operation

put_invocation_step

put_invocation_step(request: PutInvocationStepInput | PutInvocationStepInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutInvocationStepInputDict]) -> PutInvocationStepOutput

Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Related APIs:

Parameters:

Name Type Description Default
request PutInvocationStepInput | PutInvocationStepInputDict | 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[PutInvocationStepInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutInvocationStepOutput

An instance of PutInvocationStepOutput.

put_invocation_step async

put_invocation_step(request: PutInvocationStepInput | PutInvocationStepInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutInvocationStepInputDict]) -> PutInvocationStepOutput

Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Related APIs:

Parameters:

Name Type Description Default
request PutInvocationStepInput | PutInvocationStepInputDict | 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[PutInvocationStepInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutInvocationStepOutput

An instance of PutInvocationStepOutput.

Input

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

PutInvocationStepInputDict

Bases: TypedDict

Dictionary form of PutInvocationStepInput.

Attributes

invocation_identifier instance-attribute
invocation_identifier: Required[str]

The unique identifier (in UUID format) of the invocation to add the invocation step to.

invocation_step_id instance-attribute
invocation_step_id: str | None

The unique identifier of the invocation step in UUID format.

invocation_step_time instance-attribute
invocation_step_time: Required[datetime]

The timestamp for when the invocation step occurred.

payload instance-attribute

The payload for the invocation step, including text and images for the interaction.

session_identifier instance-attribute
session_identifier: Required[str]

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

PutInvocationStepInput dataclass

Bases: _SerdeShape

Dataclass for PutInvocationStepInput structure.

Attributes

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

The unique identifier (in UUID format) of the invocation to add the invocation step to.

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

The unique identifier of the invocation step in UUID format.

invocation_step_time class-attribute instance-attribute
invocation_step_time: datetime | None = ...

The timestamp for when the invocation step occurred.

payload class-attribute instance-attribute
payload: InvocationStepPayload | None = ...

The payload for the invocation step, including text and images for the interaction.

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

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

Output

PutInvocationStepOutput dataclass

Bases: _SerdeShape

Dataclass for PutInvocationStepOutput structure.

Attributes

invocation_step_id instance-attribute
invocation_step_id: str

The unique identifier of the invocation step in UUID format.

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.