Amazon Web Services Assistants API

openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Assistants API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Assistants
paths:
  /assistants:
    GET:
      summary: Amazon Web Services Listassistants
      description: Lists information about assistants.
      operationId: amazonWebServicesListAssistants
      tags:
      - Assistants
  /assistants/{assistantId}/associations:
    GET:
      summary: Amazon Web Services Listassistantassociations
      description: Lists information about assistant associations.
      operationId: amazonWebServicesListAssistantAssociations
      tags:
      - Assistants
  /assistants/{assistantId}/sessions:
    POST:
      summary: Amazon Web Services Createsession
      description: Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q session for each contact on which Amazon Q is enabled.
      operationId: amazonWebServicesCreateSession
      tags:
      - Assistants
  /assistants/{assistantId}:
    GET:
      summary: Amazon Web Services Getassistant
      description: Retrieves information about an assistant.
      operationId: amazonWebServicesGetAssistant
      tags:
      - Assistants
  /assistants/{assistantId}/associations/{assistantAssociationId}:
    GET:
      summary: Amazon Web Services Getassistantassociation
      description: Retrieves information about an assistant association.
      operationId: amazonWebServicesGetAssistantAssociation
      tags:
      - Assistants
  /assistants/{assistantId}/sessions/{sessionId}/recommendations:
    GET:
      summary: Amazon Web Services Getrecommendations
      description: Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
      operationId: amazonWebServicesGetRecommendations
      tags:
      - Assistants
  /assistants/{assistantId}/sessions/{sessionId}:
    GET:
      summary: Amazon Web Services Getsession
      description: Retrieves information for a specified session.
      operationId: amazonWebServicesGetSession
      tags:
      - Assistants
  /assistants/{assistantId}/sessions/{sessionId}/recommendations/notify:
    POST:
      summary: Amazon Web Services Notifyrecommendationsreceived
      description: Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
      operationId: amazonWebServicesNotifyRecommendationsReceived
      tags:
      - Assistants
  /assistants/{assistantId}/feedback:
    PUT:
      summary: Amazon Web Services Putfeedback
      description: Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
      operationId: amazonWebServicesPutFeedback
      tags:
      - Assistants
  /assistants/{assistantId}/query:
    POST:
      summary: Amazon Web Services Queryassistant
      description: 'Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations. '
      operationId: amazonWebServicesQueryAssistant
      tags:
      - Assistants
  /assistants/{assistantId}/searchSessions:
    POST:
      summary: Amazon Web Services Searchsessions
      description: Searches for sessions.
      operationId: amazonWebServicesSearchSessions
      tags:
      - Assistants