openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 2021 01 01 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: 2021 01 01
paths:
  /2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/accept:
    PUT:
      summary: Amazon Web Services Acceptinboundconnection
      description: Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
      operationId: amazonWebServicesAcceptInboundConnection
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/dataSource:
    GET:
      summary: Amazon Web Services Listdatasources
      description: Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
      operationId: amazonWebServicesListDataSources
      tags:
      - 2021 01 01
  /2021-01-01/tags:
    POST:
      summary: Amazon Web Services Addtags
      description: Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
      operationId: amazonWebServicesAddTags
      tags:
      - 2021 01 01
  /2021-01-01/packages/associate/{PackageID}/{DomainName}:
    POST:
      summary: Amazon Web Services Associatepackage
      description: Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesAssociatePackage
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess:
    POST:
      summary: Amazon Web Services Authorizevpcendpointaccess
      description: Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
      operationId: amazonWebServicesAuthorizeVpcEndpointAccess
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/config/cancel:
    POST:
      summary: Amazon Web Services Canceldomainconfigchange
      description: Cancels a pending configuration change on an Amazon OpenSearch Service domain.
      operationId: amazonWebServicesCancelDomainConfigChange
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/serviceSoftwareUpdate/cancel:
    POST:
      summary: Amazon Web Services Cancelservicesoftwareupdate
      description: Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.
      operationId: amazonWebServicesCancelServiceSoftwareUpdate
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain:
    POST:
      summary: Amazon Web Services Createdomain
      description: Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
      operationId: amazonWebServicesCreateDomain
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/cc/outboundConnection:
    POST:
      summary: Amazon Web Services Createoutboundconnection
      description: Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
      operationId: amazonWebServicesCreateOutboundConnection
      tags:
      - 2021 01 01
  /2021-01-01/packages:
    POST:
      summary: Amazon Web Services Createpackage
      description: Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesCreatePackage
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/vpcEndpoints:
    GET:
      summary: Amazon Web Services Listvpcendpoints
      description: Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
      operationId: amazonWebServicesListVpcEndpoints
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}:
    PUT:
      summary: Amazon Web Services Updatedatasource
      description: Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.
      operationId: amazonWebServicesUpdateDataSource
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}:
    GET:
      summary: Amazon Web Services Describedomain
      description: Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
      operationId: amazonWebServicesDescribeDomain
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}:
    DELETE:
      summary: Amazon Web Services Deleteinboundconnection
      description: Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
      operationId: amazonWebServicesDeleteInboundConnection
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}:
    DELETE:
      summary: Amazon Web Services Deleteoutboundconnection
      description: Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
      operationId: amazonWebServicesDeleteOutboundConnection
      tags:
      - 2021 01 01
  /2021-01-01/packages/{PackageID}:
    DELETE:
      summary: Amazon Web Services Deletepackage
      description: Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesDeletePackage
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}:
    DELETE:
      summary: Amazon Web Services Deletevpcendpoint
      description: Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
      operationId: amazonWebServicesDeleteVpcEndpoint
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/autoTunes:
    GET:
      summary: Amazon Web Services Describedomainautotunes
      description: Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
      operationId: amazonWebServicesDescribeDomainAutoTunes
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/progress:
    GET:
      summary: Amazon Web Services Describedomainchangeprogress
      description: Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
      operationId: amazonWebServicesDescribeDomainChangeProgress
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/config:
    POST:
      summary: Amazon Web Services Updatedomainconfig
      description: Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
      operationId: amazonWebServicesUpdateDomainConfig
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/health:
    GET:
      summary: Amazon Web Services Describedomainhealth
      description: Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
      operationId: amazonWebServicesDescribeDomainHealth
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/nodes:
    GET:
      summary: Amazon Web Services Describedomainnodes
      description: Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
      operationId: amazonWebServicesDescribeDomainNodes
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain-info:
    POST:
      summary: Amazon Web Services Describedomains
      description: Returns domain configuration information about the specified Amazon OpenSearch Service domains.
      operationId: amazonWebServicesDescribeDomains
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/dryRun:
    GET:
      summary: Amazon Web Services Describedryrunprogress
      description: Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.
      operationId: amazonWebServicesDescribeDryRunProgress
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/cc/inboundConnection/search:
    POST:
      summary: Amazon Web Services Describeinboundconnections
      description: Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
      operationId: amazonWebServicesDescribeInboundConnections
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}:
    GET:
      summary: Amazon Web Services Describeinstancetypelimits
      description: Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
      operationId: amazonWebServicesDescribeInstanceTypeLimits
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/cc/outboundConnection/search:
    POST:
      summary: Amazon Web Services Describeoutboundconnections
      description: Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
      operationId: amazonWebServicesDescribeOutboundConnections
      tags:
      - 2021 01 01
  /2021-01-01/packages/describe:
    POST:
      summary: Amazon Web Services Describepackages
      description: Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesDescribePackages
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/reservedInstanceOfferings:
    GET:
      summary: Amazon Web Services Describereservedinstanceofferings
      description: Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
      operationId: amazonWebServicesDescribeReservedInstanceOfferings
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/reservedInstances:
    GET:
      summary: Amazon Web Services Describereservedinstances
      description: Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
      operationId: amazonWebServicesDescribeReservedInstances
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/vpcEndpoints/describe:
    POST:
      summary: Amazon Web Services Describevpcendpoints
      description: Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
      operationId: amazonWebServicesDescribeVpcEndpoints
      tags:
      - 2021 01 01
  /2021-01-01/packages/dissociate/{PackageID}/{DomainName}:
    POST:
      summary: Amazon Web Services Dissociatepackage
      description: Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesDissociatePackage
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/compatibleVersions:
    GET:
      summary: Amazon Web Services Getcompatibleversions
      description: Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
      operationId: amazonWebServicesGetCompatibleVersions
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/domainMaintenance:
    POST:
      summary: Amazon Web Services Startdomainmaintenance
      description: Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.
      operationId: amazonWebServicesStartDomainMaintenance
      tags:
      - 2021 01 01
  /2021-01-01/packages/{PackageID}/history:
    GET:
      summary: Amazon Web Services Getpackageversionhistory
      description: Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesGetPackageVersionHistory
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/upgradeDomain/{DomainName}/history:
    GET:
      summary: Amazon Web Services Getupgradehistory
      description: Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
      operationId: amazonWebServicesGetUpgradeHistory
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/upgradeDomain/{DomainName}/status:
    GET:
      summary: Amazon Web Services Getupgradestatus
      description: Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
      operationId: amazonWebServicesGetUpgradeStatus
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/domainMaintenances:
    GET:
      summary: Amazon Web Services Listdomainmaintenances
      description: A list of maintenance actions for the domain.
      operationId: amazonWebServicesListDomainMaintenances
      tags:
      - 2021 01 01
  /2021-01-01/domain:
    GET:
      summary: Amazon Web Services Listdomainnames
      description: Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
      operationId: amazonWebServicesListDomainNames
      tags:
      - 2021 01 01
  /2021-01-01/packages/{PackageID}/domains:
    GET:
      summary: Amazon Web Services Listdomainsforpackage
      description: Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesListDomainsForPackage
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}:
    GET:
      summary: Amazon Web Services Listinstancetypedetails
      description: Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
      operationId: amazonWebServicesListInstanceTypeDetails
      tags:
      - 2021 01 01
  /2021-01-01/domain/{DomainName}/packages:
    GET:
      summary: Amazon Web Services Listpackagesfordomain
      description: Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesListPackagesForDomain
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/scheduledActions:
    GET:
      summary: Amazon Web Services Listscheduledactions
      description: Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.
      operationId: amazonWebServicesListScheduledActions
      tags:
      - 2021 01 01
  /2021-01-01/tags/:
    GET:
      summary: Amazon Web Services Listtags
      description: Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
      operationId: amazonWebServicesListTags
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/versions:
    GET:
      summary: Amazon Web Services Listversions
      description: Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
      operationId: amazonWebServicesListVersions
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess:
    GET:
      summary: Amazon Web Services Listvpcendpointaccess
      description: Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
      operationId: amazonWebServicesListVpcEndpointAccess
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints:
    GET:
      summary: Amazon Web Services Listvpcendpointsfordomain
      description: Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
      operationId: amazonWebServicesListVpcEndpointsForDomain
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/purchaseReservedInstanceOffering:
    POST:
      summary: Amazon Web Services Purchasereservedinstanceoffering
      description: Allows you to purchase Amazon OpenSearch Service Reserved Instances.
      operationId: amazonWebServicesPurchaseReservedInstanceOffering
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject:
    PUT:
      summary: Amazon Web Services Rejectinboundconnection
      description: Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
      operationId: amazonWebServicesRejectInboundConnection
      tags:
      - 2021 01 01
  /2021-01-01/tags-removal:
    POST:
      summary: Amazon Web Services Removetags
      description: Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see  Tagging Amazon OpenSearch Service domains.
      operationId: amazonWebServicesRemoveTags
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess:
    POST:
      summary: Amazon Web Services Revokevpcendpointaccess
      description: Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
      operationId: amazonWebServicesRevokeVpcEndpointAccess
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/serviceSoftwareUpdate/start:
    POST:
      summary: Amazon Web Services Startservicesoftwareupdate
      description: Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
      operationId: amazonWebServicesStartServiceSoftwareUpdate
      tags:
      - 2021 01 01
  /2021-01-01/packages/update:
    POST:
      summary: Amazon Web Services Updatepackage
      description: Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
      operationId: amazonWebServicesUpdatePackage
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update:
    PUT:
      summary: Amazon Web Services Updatescheduledaction
      description: Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.
      operationId: amazonWebServicesUpdateScheduledAction
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/vpcEndpoints/update:
    POST:
      summary: Amazon Web Services Updatevpcendpoint
      description: Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
      operationId: amazonWebServicesUpdateVpcEndpoint
      tags:
      - 2021 01 01
  /2021-01-01/opensearch/upgradeDomain:
    POST:
      summary: Amazon Web Services Upgradedomain
      description: Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
      operationId: amazonWebServicesUpgradeDomain
      tags:
      - 2021 01 01