QConnect / Client / list_ai_guardrails

list_ai_guardrails#

QConnect.Client.list_ai_guardrails(**kwargs)#

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

See also: AWS API Documentation

Request Syntax

response = client.list_ai_guardrails(
    assistantId='string',
    maxResults=123,
    nextToken='string'
)
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.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'aiGuardrailSummaries': [
        {
            '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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • aiGuardrailSummaries (list) –

      The summaries of the AI Guardrails.

      • (dict) –

        The summary of the AI Guardrail.

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

    • 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