Amazon Web Services Kx API

openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Kx 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: Kx
paths:
  /kx/environments/{environmentId}/databases/{databaseName}/changesets:
    GET:
      summary: Amazon Web Services Listkxchangesets
      description: Returns a list of all the changesets for a database.
      operationId: amazonWebServicesListKxChangesets
      tags:
      - Kx
  /kx/environments/{environmentId}/clusters:
    GET:
      summary: Amazon Web Services Listkxclusters
      description: Returns a list of clusters.
      operationId: amazonWebServicesListKxClusters
      tags:
      - Kx
  /kx/environments/{environmentId}/databases:
    GET:
      summary: Amazon Web Services Listkxdatabases
      description: Returns a list of all the databases in the kdb environment.
      operationId: amazonWebServicesListKxDatabases
      tags:
      - Kx
  /kx/environments/{environmentId}/databases/{databaseName}/dataviews:
    GET:
      summary: Amazon Web Services Listkxdataviews
      description: ' Returns a list of all the dataviews in the database.'
      operationId: amazonWebServicesListKxDataviews
      tags:
      - Kx
  /kx/environments:
    GET:
      summary: Amazon Web Services Listkxenvironments
      description: Returns a list of kdb environments created in an account.
      operationId: amazonWebServicesListKxEnvironments
      tags:
      - Kx
  /kx/environments/{environmentId}/scalingGroups:
    GET:
      summary: Amazon Web Services Listkxscalinggroups
      description: ' Returns a list of scaling groups in a kdb environment.'
      operationId: amazonWebServicesListKxScalingGroups
      tags:
      - Kx
  /kx/environments/{environmentId}/users:
    GET:
      summary: Amazon Web Services Listkxusers
      description: Lists all the users in a kdb environment.
      operationId: amazonWebServicesListKxUsers
      tags:
      - Kx
  /kx/environments/{environmentId}/kxvolumes:
    GET:
      summary: Amazon Web Services Listkxvolumes
      description: ' Lists all the volumes in a kdb environment. '
      operationId: amazonWebServicesListKxVolumes
      tags:
      - Kx
  /kx/environments/{environmentId}/clusters/{clusterName}:
    GET:
      summary: Amazon Web Services Getkxcluster
      description: Retrieves information about a kdb cluster.
      operationId: amazonWebServicesGetKxCluster
      tags:
      - Kx
  /kx/environments/{environmentId}/databases/{databaseName}:
    PUT:
      summary: Amazon Web Services Updatekxdatabase
      description: Updates information for the given kdb database.
      operationId: amazonWebServicesUpdateKxDatabase
      tags:
      - Kx
  /kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}:
    PUT:
      summary: Amazon Web Services Updatekxdataview
      description: ' Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations'
      operationId: amazonWebServicesUpdateKxDataview
      tags:
      - Kx
  /kx/environments/{environmentId}:
    PUT:
      summary: Amazon Web Services Updatekxenvironment
      description: Updates information for the given kdb environment.
      operationId: amazonWebServicesUpdateKxEnvironment
      tags:
      - Kx
  /kx/environments/{environmentId}/scalingGroups/{scalingGroupName}:
    GET:
      summary: Amazon Web Services Getkxscalinggroup
      description: ' Retrieves details of a scaling group.'
      operationId: amazonWebServicesGetKxScalingGroup
      tags:
      - Kx
  /kx/environments/{environmentId}/users/{userName}:
    PUT:
      summary: Amazon Web Services Updatekxuser
      description: Updates the user details. You can only update the IAM role associated with a user.
      operationId: amazonWebServicesUpdateKxUser
      tags:
      - Kx
  /kx/environments/{environmentId}/kxvolumes/{volumeName}:
    PATCH:
      summary: Amazon Web Services Updatekxvolume
      description: ' Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete. '
      operationId: amazonWebServicesUpdateKxVolume
      tags:
      - Kx
  /kx/environments/{environmentId}/databases/{databaseName}/changesets/{changesetId}:
    GET:
      summary: Amazon Web Services Getkxchangeset
      description: Returns information about a kdb changeset.
      operationId: amazonWebServicesGetKxChangeset
      tags:
      - Kx
  /kx/environments/{environmentId}/connectionString:
    GET:
      summary: Amazon Web Services Getkxconnectionstring
      description: 'Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user. '
      operationId: amazonWebServicesGetKxConnectionString
      tags:
      - Kx
  /kx/environments/{environmentId}/clusters/{clusterName}/nodes:
    GET:
      summary: Amazon Web Services Listkxclusternodes
      description: Lists all the nodes in a kdb cluster.
      operationId: amazonWebServicesListKxClusterNodes
      tags:
      - Kx
  /kx/environments/{environmentId}/clusters/{clusterName}/configuration/code:
    PUT:
      summary: Amazon Web Services Updatekxclustercodeconfiguration
      description: ' Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster. '
      operationId: amazonWebServicesUpdateKxClusterCodeConfiguration
      tags:
      - Kx
  /kx/environments/{environmentId}/clusters/{clusterName}/configuration/databases:
    PUT:
      summary: Amazon Web Services Updatekxclusterdatabases
      description: Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.  Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
      operationId: amazonWebServicesUpdateKxClusterDatabases
      tags:
      - Kx
  /kx/environments/{environmentId}/network:
    PUT:
      summary: Amazon Web Services Updatekxenvironmentnetwork
      description: Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
      operationId: amazonWebServicesUpdateKxEnvironmentNetwork
      tags:
      - Kx