find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-agents-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon QuickSight Agents API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://quicksight.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /accounts/{AwsAccountId}/agents:
    post:
      operationId: CreateAgent
      summary: Create Agent
      description: Creates an agent in Amazon QuickSight.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAgentResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException; ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentRequest'
      tags:
      - Agents
    get:
      operationId: ListAgents
      summary: List Agents
      description: Lists all agents in an Amazon QuickSight account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAgentsResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidNextTokenException; InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '403':
          description: UnsupportedUserEditionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedUserEditionException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAgentsRequest'
      tags:
      - Agents
  /accounts/{AwsAccountId}/agents/{AgentId}:
    delete:
      operationId: DeleteAgent
      summary: Delete Agent
      description: Deletes an agent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAgentResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAgentRequest'
      tags:
      - Agents
    get:
      operationId: DescribeAgent
      summary: Describe Agent
      description: Describes an agent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAgentResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAgentRequest'
      tags:
      - Agents
    put:
      operationId: UpdateAgent
      summary: Update Agent
      description: Updates an existing agent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAgentResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAgentRequest'
      tags:
      - Agents
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: quicksight
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    Agent:
      type: object
      properties:
        Spaces:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the spaces attached to the agent.
        ActionConnectors:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the action connectors attached to the agent.
        Description:
          type: string
          description: A description of the agent.
        IconId:
          type: string
          description: The icon identifier for the agent.
        Name:
          type: string
          description: The name of the agent.
        StarterPrompts:
          type: array
          items:
            type: string
          description: A list of starter prompts that are displayed to users when they begin interacting with the agent.
        WelcomeMessage:
          type: string
          description: The welcome message that is displayed when a user starts a conversation with the agent.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the agent.
        AgentId:
          type: string
          description: The unique identifier for the agent.
        AgentLifecycle:
          type: string
          enum:
          - PREVIEW
          - PUBLISHED
          description: The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
        AgentStatus:
          type: string
          enum:
          - ACTIVE
          - UPDATING
          - FAILED
          - CREATING
          description: The status of the agent.
        CreatedAt:
          type: string
          description: The date and time that the agent was created.
        Creator:
          type: string
          description: The identity of the user who created the agent.
        CustomPromptInterface:
          $ref: '#/components/schemas/CustomPromptInterface'
        ErrorMessage:
          type: string
          description: An error message associated with the agent, if applicable.
        UpdatedAt:
          type: string
          description: The date and time that the agent was last updated.
      required:
      - Name
      - Arn
      - AgentId
      - AgentLifecycle
      - AgentStatus
      - CreatedAt
      - Creator
      - UpdatedAt
    AgentSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the agent.
        AgentId:
          type: string
          description: The unique identifier for the agent.
        Name:
          type: string
          description: The name of the agent.
        Description:
          type: string
          description: A description of the agent.
        CreatedAt:
          type: string
          description: The date and time that the agent was created.
        UpdatedAt:
          type: string
          description: The date and time that the agent was last updated.
        IconId:
          type: string
          description: The icon identifier for the agent.
      required:
      - Arn
      - AgentId
      - Name
      - CreatedAt
      - UpdatedAt
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    CreateAgentRequest:
      type: object
      properties:
        Spaces:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
        ActionConnectors:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the agent.
        AgentId:
          type: string
          description: A unique identifier for the agent.
        Name:
          type: string
          description: The name of the agent.
        Description:
          type: string
          description: A description of the agent.
        IconId:
          type: string
          description: The icon identifier for the agent.
        StarterPrompts:
          type: array
          items:
            type: string
          description: A list of starter prompts that are displayed to users when they begin interacting with the agent.
        WelcomeMessage:
          type: string
          description: The welcome message that is displayed when a user starts a conversation with the agent.
        AgentLifecycle:
          type: string
          enum:
          - PREVIEW
          - PUBLISHED
          description: The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
        CustomPromptInput:
          $ref: '#/components/schemas/CustomPromptInput'
      required:
      - AwsAccountId
      - AgentId
      - Name
    CreateAgentResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the agent.
        AgentId:
          type: string
          description: The unique identifier for the agent.
        AgentStatus:
          type: string
          enum:
          - ACTIVE
          - UPDATING
          - FAILED
          - CREATING
          description: The status of the agent.
        AgentName:
          type: string
          description: The name of the agent.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
      required:
      - Arn
      - AgentId
      - AgentStatus
      - AgentName
    CustomPromptInput:
      type: object
      properties:
        ExistingPrompt:
          $ref: '#/components/schemas/CustomPromptProfile'
        NewPrompt:
          $ref: '#/components/schemas/CustomPromptInputParameters'
      description: Exactly one member is set.
    CustomPromptInputParameters:
      type: object
      properties:
        ResponseLength:
          type: string
          description: Instructions for the desired response length.
        OutputStyle:
          type: string
          description: Instructions for the desired output style.
        Identity:
          type: string
          description: Instructions that define the agent's identity and persona.
        Tone:
          type: string
          description: Instructions for the desired tone of responses.
        CustomInstructions:
          type: string
          description: Custom instructions for the agent's behavior.
    CustomPromptInterface:
      type: object
      properties:
        ModelProfileId:
          type: string
          description: The identifier of the model profile.
        SubscriptionId:
          type: string
          description: The subscription identifier.
        QbsAwsAccountId:
          type: string
          description: The Amazon Web Services account ID for the Q Business service.
        ResponseLength:
          type: string
          description: Instructions for the desired response length.
        OutputStyle:
          type: string
          description: Instructions for the desired output style.
        Identity:
          type: string
          description: Instructions that define the agent's identity and persona.
        Tone:
          type: string
          description: Instructions for the desired tone of responses.
        CustomInstructions:
          type: string
          description: Custom instructions for the agent's behavior.
        promptSummary:
          type: string
          description: A summary of the custom prompt configuration.
      required:
      - ModelProfileId
      - SubscriptionId
      - QbsAwsAccountId
    CustomPromptProfile:
      type: object
      properties:
        ModelProfileId:
          type: string
          description: The identifier of the model profile.
        SubscriptionId:
          type: string
          description: The subscription identifier.
        QbsAwsAccountId:
          type: string
          description: The Amazon Web Services account ID for the Q Business service.
      required:
      - ModelProfileId
      - SubscriptionId
      - QbsAwsAccountId
    DeleteAgentRequest:
      type: object
      properties:
        AgentId:
          type: string
          description: The unique identifier for the agent to delete.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the agent.
      required:
      - AgentId
      - AwsAccountId
    DeleteAgentResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
    DescribeAgentRequest:
      type: object
      properties:
        AgentId:
          type: string
          description: The unique identifier for the agent.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the agent.
      required:
      - AgentId
      - AwsAccountId
    DescribeAgentResponse:
      type: object
      properties:
        Agent:
          $ref: '#/components/schemas/Agent'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
      required:
      - Agent
    FailedToUpdateAssociation:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN that could not be added or removed.
        ErrorMessage:
          type: string
          description: A description of the failure.
        ErrorCode:
          type: string
          description: The error code for the failure.
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidNextTokenException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidParameterValueException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ListAgentsRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the agents.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
      required:
      - AwsAccountId
    ListAgentsResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        AgentSummaries:
          type: array
          items:
            $ref: '#/components/schemas/AgentSummary'
          description: A list of agent summaries.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
      required:
      - AgentSummaries
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - USER
          - GROUP
          - NAMESPACE
          - ACCOUNT_SETTINGS
          - IAMPOLICY_ASSIGNMENT
          - DATA_SOURCE
          - DATA_SET
          - VPC_CONNECTION
          - INGESTION
          description: The resource type for this request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UnsupportedUserEditionException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UpdateAgentRequest:
      type: object
      properties:
        AgentId:
          type: string
          description: The unique identifier for the agent to update.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the agent.
        Name:
          type: string
          description: The name of the agent.
        Description:
          type: string
          description: A description of the agent.
        IconId:
          type: string
          description: The icon identifier for the agent.
        StarterPrompts:
          type: array
          items:
            type: string
          description: A list of starter prompts that are displayed to users when they begin interacting with the agent.
        WelcomeMessage:
          type: string
          description: The welcome message that is displayed when a user starts a conversation with the agent.
        CustomPromptInput:
          $ref: '#/components/schemas/CustomPromptInput'
        SpacesToAdd:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
        SpacesToRemove:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the spaces to detach from the agent.
        ActionConnectorsToAdd:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.
        ActionConnectorsToRemove:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.
      required:
      - AgentId
      - AwsAccountId
      - Name
    UpdateAgentResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the agent.
        AgentId:
          type: string
          description: The unique identifier for the agent.
        AgentStatus:
          type: string
          enum:
          - ACTIVE
          - UPDATING
          - FAILED
          - CREATING
          description: The status of the agent.
        FailedToAddSpaces:
          type: array
          items:
            $ref: '#/components/schemas/FailedToUpdateAssociation'
          description: A list of per-ARN failures from the spaces that were requested to be added.
        FailedToRemoveSpaces:
          type: array
          items:
            $ref: '#/components/schemas/FailedToUpdateAssociation'
          description: A list of per-ARN failures from the spaces that were requested to be removed.
        FailedToAddActionConnectors:
          type: array
          items:
            $ref: '#/components/schemas/FailedToUpdateAssociation'
          description: A list of per-ARN failures from the action connectors that were requested to be added.
        FailedToRemoveActionConnectors:
          type: array
          items:
            $ref: '#/components/schemas/FailedToUpdateAssociation'
          description: A list of per-ARN failures from the action connectors that were requested to be removed.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
      required:
      - Arn
      - AgentId
      - AgentStatus
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/quicksight/service/2018-04-01/quicksight-2018-04-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)