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.

Request Syntax

response = client.list_ai_guardrails(
    assistantId='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.
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

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

Response Structure

(dict) –
- aiGuardrailSummaries (list) –
  
  The summaries of the AI Guardrails.
  - (dict) –
    
    The summary of the AI Guardrail.
    - 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) –
- 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.ResourceNotFoundException
QConnect.Client.exceptions.ThrottlingException