QConnect / Paginator / ListAIGuardrailVersions

ListAIGuardrailVersions#

class QConnect.Paginator.ListAIGuardrailVersions#
paginator = client.get_paginator('list_ai_guardrail_versions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from QConnect.Client.list_ai_guardrail_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    aiGuardrailId='string',
    assistantId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • aiGuardrailId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed.

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the 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

{
    'aiGuardrailVersionSummaries': [
        {
            'aiGuardrailSummary': {
                'aiGuardrailArn': 'string',
                'aiGuardrailId': 'string',
                'assistantArn': 'string',
                'assistantId': 'string',
                'description': 'string',
                'modifiedTime': datetime(2015, 1, 1),
                'name': 'string',
                'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
                'tags': {
                    'string': 'string'
                },
                'visibilityStatus': 'SAVED'|'PUBLISHED'
            },
            'versionNumber': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • aiGuardrailVersionSummaries (list) –

      The summaries of the AI Guardrail versions.

      • (dict) –

        The summary of the AI Guardrail version.

        • aiGuardrailSummary (dict) –

          The data for the summary of the AI Guardrail version.

          • aiGuardrailArn (string) –

            The Amazon Resource Name (ARN) of the AI Guardrail.

          • aiGuardrailId (string) –

            The identifier of the Amazon Q in Connect AI Guardrail.

          • assistantArn (string) –

            The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

          • assistantId (string) –

            The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

          • description (string) –

            A description of the AI Guardrail.

          • modifiedTime (datetime) –

            The time the AI Guardrail was last modified.

          • name (string) –

            The name of the AI Guardrail.

          • status (string) –

            The status of the AI Guardrail.

          • tags (dict) –

            The tags used to organize, track, or control access for this resource.

            • (string) –

              • (string) –

          • visibilityStatus (string) –

            The visibility status of the AI Guardrail.

        • versionNumber (integer) –

          The version number for this AI Guardrail version.

    • NextToken (string) –

      A token to resume pagination.