agents

Creates, updates, deletes, gets or lists an agents resource.

Overview

Name	agents
Type	Resource
Id	aws.quicksight.agents

Fields

The following fields are returned by SELECT queries:

describe_agent

Name	Datatype	Description
agent	object	The full details of the agent, including its configuration, status, and associations.
request_id	string	The Amazon Web Services request ID for this operation.

search_agents

Name	Datatype	Description
agent_summaries	array	A list of agent summaries.
next_token	string	The token for the next set of results, or null if there are no more results.
request_id	string	The Amazon Web Services request ID for this operation.

list_agents

Name	Datatype	Description
agent_summaries	array	A list of agent summaries.
next_token	string	The token for the next set of results, or null if there are no more results.
request_id	string	The Amazon Web Services request ID for this operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_agent	select	agent_id, aws_account_id, region		Describes an agent.
search_agents	select	aws_account_id, region	max-results, next-token	Searches for agents based on specified filters.
list_agents	select	aws_account_id, region	max-results, next-token	Lists all agents in an Amazon QuickSight account.
create_agent	insert	aws_account_id, region, AgentId, Name		Creates an agent in Amazon QuickSight.
update_agent	update	agent_id, aws_account_id, region, Name		Updates an existing agent.
delete_agent	delete	agent_id, aws_account_id, region		Deletes an agent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agent_id	string	The unique identifier for the agent to delete.
aws_account_id	string	The ID of the Amazon Web Services account that contains the agent.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_agent

Describes an agent.

SELECT
agent,
request_id
FROM aws.quicksight.agents
WHERE agent_id = '{{ agent_id }}' -- required
AND aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

search_agents

Searches for agents based on specified filters.

SELECT
agent_summaries,
next_token,
request_id
FROM aws.quicksight.agents
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

list_agents

Lists all agents in an Amazon QuickSight account.

SELECT
agent_summaries,
next_token,
request_id
FROM aws.quicksight.agents
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_agent

Creates an agent in Amazon QuickSight.

INSERT INTO aws.quicksight.agents (
Spaces,
ActionConnectors,
AgentId,
Name,
Description,
IconId,
StarterPrompts,
WelcomeMessage,
AgentLifecycle,
CustomPromptInput,
aws_account_id,
region
)
SELECT 
'{{ Spaces }}',
'{{ ActionConnectors }}',
'{{ AgentId }}' /* required */,
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ IconId }}',
'{{ StarterPrompts }}',
'{{ WelcomeMessage }}',
'{{ AgentLifecycle }}',
'{{ CustomPromptInput }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
agent_id,
agent_name,
agent_status,
arn,
request_id
;

Manifest

# Description fields are for documentation purposes
- name: agents
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the agents resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agents resource.
  - name: Spaces
    value:
      - "{{ Spaces }}"
  - name: ActionConnectors
    value:
      - "{{ ActionConnectors }}"
  - name: AgentId
    value: "{{ AgentId }}"
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: IconId
    value: "{{ IconId }}"
  - name: StarterPrompts
    value:
      - "{{ StarterPrompts }}"
  - name: WelcomeMessage
    value: "{{ WelcomeMessage }}"
  - name: AgentLifecycle
    value: "{{ AgentLifecycle }}"
    valid_values: ['PREVIEW', 'PUBLISHED']
  - name: CustomPromptInput
    description: |
      The custom prompt input for an agent. This is a union type that can be either an existing prompt profile or new prompt parameters.
    value:
      ExistingPrompt:
        ModelProfileId: "{{ ModelProfileId }}"
        SubscriptionId: "{{ SubscriptionId }}"
        QbsAwsAccountId: "{{ QbsAwsAccountId }}"
      NewPrompt:
        ResponseLength: "{{ ResponseLength }}"
        OutputStyle: "{{ OutputStyle }}"
        Identity: "{{ Identity }}"
        Tone: "{{ Tone }}"
        CustomInstructions: "{{ CustomInstructions }}"

UPDATE examples

update_agent

Updates an existing agent.

UPDATE aws.quicksight.agents
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
IconId = '{{ IconId }}',
StarterPrompts = '{{ StarterPrompts }}',
WelcomeMessage = '{{ WelcomeMessage }}',
CustomPromptInput = '{{ CustomPromptInput }}',
SpacesToAdd = '{{ SpacesToAdd }}',
SpacesToRemove = '{{ SpacesToRemove }}',
ActionConnectorsToAdd = '{{ ActionConnectorsToAdd }}',
ActionConnectorsToRemove = '{{ ActionConnectorsToRemove }}'
WHERE 
agent_id = '{{ agent_id }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
RETURNING
agent_id,
agent_status,
arn,
failed_to_add_action_connectors,
failed_to_add_spaces,
failed_to_remove_action_connectors,
failed_to_remove_spaces,
request_id;

DELETE examples

delete_agent

Deletes an agent.

DELETE FROM aws.quicksight.agents
WHERE agent_id = '{{ agent_id }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
;