AgentsforBedrockRuntime / Paginator / ListInvocationSteps

ListInvocationSteps#

class AgentsforBedrockRuntime.Paginator.ListInvocationSteps#
paginator = client.get_paginator('list_invocation_steps')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from AgentsforBedrockRuntime.Client.list_invocation_steps().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    invocationIdentifier='string',
    sessionIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • invocationIdentifier (string) – The unique identifier (in UUID format) for the invocation to list invocation steps for.

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'invocationStepSummaries': [
        {
            'invocationId': 'string',
            'invocationStepId': 'string',
            'invocationStepTime': datetime(2015, 1, 1),
            'sessionId': 'string'
        },
    ],
    '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.

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

        • sessionId (string) –

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

    • NextToken (string) –

      A token to resume pagination.