QuickSight / Client / describe_agent

describe_agent¶

QuickSight.Client.describe_agent(**kwargs)¶

Describes an agent.

Request Syntax

response = client.describe_agent(
    AgentId='string',
    AwsAccountId='string'
)

Parameters:

AgentId (string) –
[REQUIRED]

The unique identifier for the agent.
AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the agent.

Return type:

dict

Returns:

Response Syntax

{
    'Agent': {
        'Spaces': [
            'string',
        ],
        'ActionConnectors': [
            'string',
        ],
        'Description': 'string',
        'IconId': 'string',
        'Name': 'string',
        'StarterPrompts': [
            'string',
        ],
        'WelcomeMessage': 'string',
        'Arn': 'string',
        'AgentId': 'string',
        'AgentLifecycle': 'PREVIEW'|'PUBLISHED',
        'AgentStatus': 'ACTIVE'|'UPDATING'|'FAILED'|'CREATING',
        'CreatedAt': datetime(2015, 1, 1),
        'Creator': 'string',
        'CustomPromptInterface': {
            'ModelProfileId': 'string',
            'SubscriptionId': 'string',
            'QbsAwsAccountId': 'string',
            'ResponseLength': 'string',
            'OutputStyle': 'string',
            'Identity': 'string',
            'Tone': 'string',
            'CustomInstructions': 'string',
            'promptSummary': 'string'
        },
        'ErrorMessage': 'string',
        'UpdatedAt': datetime(2015, 1, 1)
    },
    'RequestId': 'string'
}

Response Structure

(dict) –
- Agent (dict) –
  
  The full details of the agent, including its configuration, status, and associations.
  - Spaces (list) –
    
    The Amazon Resource Names (ARNs) of the spaces attached to the agent.
    - (string) –
  - ActionConnectors (list) –
    
    The Amazon Resource Names (ARNs) of the action connectors attached to the agent.
    - (string) –
  - Description (string) –
    
    A description of the agent.
  - IconId (string) –
    
    The icon identifier for the agent.
  - Name (string) –
    
    The name of the agent.
  - StarterPrompts (list) –
    
    A list of starter prompts that are displayed to users when they begin interacting with the agent.
    - (string) –
  - WelcomeMessage (string) –
    
    The welcome message that is displayed when a user starts a conversation with the agent.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) of the agent.
  - AgentId (string) –
    
    The unique identifier for the agent.
  - AgentLifecycle (string) –
    
    The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
  - AgentStatus (string) –
    
    The status of the agent.
  - CreatedAt (datetime) –
    
    The date and time that the agent was created.
  - Creator (string) –
    
    The identity of the user who created the agent.
  - CustomPromptInterface (dict) –
    
    The custom prompt interface configuration for the agent.
    - ModelProfileId (string) –
      
      The identifier of the model profile.
    - SubscriptionId (string) –
      
      The subscription identifier.
    - QbsAwsAccountId (string) –
      
      The Amazon Web Services account ID for the Q Business service.
    - ResponseLength (string) –
      
      Instructions for the desired response length.
    - OutputStyle (string) –
      
      Instructions for the desired output style.
    - Identity (string) –
      
      Instructions that define the agent’s identity and persona.
    - Tone (string) –
      
      Instructions for the desired tone of responses.
    - CustomInstructions (string) –
      
      Custom instructions for the agent’s behavior.
    - promptSummary (string) –
      
      A summary of the custom prompt configuration.
  - ErrorMessage (string) –
    
    An error message associated with the agent, if applicable.
  - UpdatedAt (datetime) –
    
    The date and time that the agent was last updated.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.PreconditionNotMetException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.AccessDeniedException