QConnect / Client / list_ai_guardrail_versions

list_ai_guardrail_versions

QConnect.Client.list_ai_guardrail_versions(**kwargs)

Lists AI Guardrail versions.

See also: AWS API Documentation

Request Syntax

response = client.list_ai_guardrail_versions(
    assistantId='string',
    aiGuardrailId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

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

• aiGuardrailId (string) –

  [REQUIRED]

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

• nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

• maxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'aiGuardrailVersionSummaries': [
        {
            'aiGuardrailSummary': {
                'name': 'string',
                'assistantId': 'string',
                'assistantArn': 'string',
                'aiGuardrailId': 'string',
                'aiGuardrailArn': 'string',
                'modifiedTime': datetime(2015, 1, 1),
                'visibilityStatus': 'SAVED'|'PUBLISHED',
                'description': 'string',
                'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
                'tags': {
                    'string': 'string'
                }
            },
            '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.

        • name (string) –

          The name of the AI Guardrail.

        • assistantId (string) –

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

        • assistantArn (string) –

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

        • aiGuardrailId (string) –

          The identifier of the Amazon Q in Connect AI Guardrail.

        • aiGuardrailArn (string) –

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

        • modifiedTime (datetime) –

          The time the AI Guardrail was last modified.

        • visibilityStatus (string) –

          The visibility status of the AI Guardrail.

        • description (string) –

          A description 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) –

      • versionNumber (integer) –

        The version number for this AI Guardrail version.

  • nextToken (string) –

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Exceptions

• QConnect.Client.exceptions.ValidationException

• QConnect.Client.exceptions.UnauthorizedException

• QConnect.Client.exceptions.AccessDeniedException

• QConnect.Client.exceptions.ThrottlingException

• QConnect.Client.exceptions.ResourceNotFoundException