AgentsforBedrockRuntime / Client / list_invocation_steps

list_invocation_steps

AgentsforBedrockRuntime.Client.list_invocation_steps(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_invocation_steps(
    invocationIdentifier='string',
    nextToken='string',
    maxResults=123,
    sessionIdentifier='string'
)
Parameters:

  • invocationIdentifier (string) – The unique identifier (in UUID format) for the invocation to list invocation steps for.

  • nextToken (string) – 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.

  • maxResults (integer) – 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.

  • sessionIdentifier (string) –

    [REQUIRED]

    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).

Return type:

dict

Returns:

Response Syntax

{
    'invocationStepSummaries': [
        {
            'sessionId': 'string',
            'invocationId': 'string',
            'invocationStepId': 'string',
            'invocationStepTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • invocationStepSummaries (list) –

      A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.

      • (dict) –

        Contains details about an invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

        • sessionId (string) –

          The unique identifier for the session associated with the invocation step.

        • invocationId (string) –

          A unique identifier for the invocation in UUID format.

        • invocationStepId (string) –

          The unique identifier (in UUID format) for the invocation step.

        • invocationStepTime (datetime) –

          The timestamp for when the invocation step was created.

    • nextToken (string) –

      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.

Exceptions