AWS admin queries schema

service.aws.admin.graphqls, service.aws.common.graphqls

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.

API Endpoints
https://your-server-address/api/gql

Queries

awsAdminX

Response

Returns a Boolean

Example

Query
query awsAdminX {
  awsAdminX
}
Response
{"data": {"awsAdminX": "<boolean>"}}
Queries

awsAvailableRegions

Description

List of available regions

Response

Returns [AWSRegion!]!

Example

Query
query awsAvailableRegions {
  awsAvailableRegions {
    id
    displayName
    superRegion
    global
    partition
    domain
  }
}
Response
{
  "data": {
    "awsAvailableRegions": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "superRegion": "<string>",
        "global": "<boolean>",
        "partition": "<string>",
        "domain": "<string>"
      }
    ]
  }
}
Queries

awsConfiguration

Description

AWS cloud configuration. Null if AWS wasn't configured

Response

Returns an AWSConfiguration

Example

Query
query awsConfiguration {
  awsConfiguration {
    cloudId
    cloudName
    allowedAccounts
    regions
    federatedAccessEnabled
    govRegionsEnabled
    proxyUser {
      ...AWSUserInfoFragment
    }
    useDefaultCredentials
    assumeRoleName
  }
}
Response
{
  "data": {
    "awsConfiguration": {
      "cloudId": "<string>",
      "cloudName": "<string>",
      "allowedAccounts": ["<string>"],
      "regions": ["<string>"],
      "federatedAccessEnabled": "<boolean>",
      "govRegionsEnabled": "<boolean>",
      "proxyUser": AWSUserInfo,
      "useDefaultCredentials": "<boolean>",
      "assumeRoleName": "<string>"
    }
  }
}
Queries

awsInstallInfo

Description

Information about CB AWS installation (EC2)

Response

Returns an AWSInstallInfo!

Example

Query
query awsInstallInfo {
  awsInstallInfo {
    instanceId
    instanceType
    instanceRole
    accountId
    version
    marketplaceProductCodes
    amiId
    agreementId
    defaultRegion
    accountRegions
  }
}
Response
{
  "data": {
    "awsInstallInfo": {
      "instanceId": "<string>",
      "instanceType": "<string>",
      "instanceRole": "<string>",
      "accountId": "<string>",
      "version": "<string>",
      "marketplaceProductCodes": ["<string>"],
      "amiId": "<string>",
      "agreementId": "<string>",
      "defaultRegion": "<string>",
      "accountRegions": ["<string>"]
    }
  }
}
Queries

awsPartitions

Description

List of available partitions

Response

Returns [AWSPartition!]!

Example

Query
query awsPartitions {
  awsPartitions {
    id
    name
  }
}
Response
{"data": {"awsPartitions": [{"id": "<id>", "name": "<string>"}]}}
Queries

awsSetSessionRegions

use awsSetRegions (24.3.1)
Description

Sets session regions

Response

Returns a Boolean

Arguments
Name Description
regions - [String!]!

Example

Query
query awsSetSessionRegions($regions: [String!]!) {
  awsSetSessionRegions(regions: $regions)
}
Variables
{"regions": "<string>"}
Response
{
  "data": {
    "awsSetSessionRegions": "<boolean>"
  }
}
Queries

awsUserInfo

Description

Information about currently logged user

Response

Returns an AWSUserInfo

Example

Query
query awsUserInfo {
  awsUserInfo {
    userId
    userName
    userPath
    userArn
    accountId
    organizationName
    createDate
    tags {
      ...AWSTagFragment
    }
  }
}
Response
{
  "data": {
    "awsUserInfo": {
      "userId": "<string>",
      "userName": "<string>",
      "userPath": "<string>",
      "userArn": "<string>",
      "accountId": "<string>",
      "organizationName": "<string>",
      "createDate": "<datetime>",
      "tags": [AWSTag]
    }
  }
}

Mutations

awsEnableFederatedAccess

No longer supported
Response

Returns a Boolean

Arguments
Name Description
enable - Boolean

Example

Query
mutation awsEnableFederatedAccess($enable: Boolean) {
  awsEnableFederatedAccess(enable: $enable)
}
Variables
{"enable": "<boolean>"}
Response
{
  "data": {
    "awsEnableFederatedAccess": "<boolean>"
  }
}
Mutations

awsEnableGovRegions

use awsUpdateCloudConfiguration (24.3.1)
Description

Allows or disallows the use of AWS GovCloud regions.

Response

Returns a Boolean!

Arguments
Name Description
enable - Boolean!

Example

Query
mutation awsEnableGovRegions($enable: Boolean!) {
  awsEnableGovRegions(enable: $enable)
}
Variables
{"enable": "<boolean>"}
Response
{
  "data": {
    "awsEnableGovRegions": "<boolean>"
  }
}
Mutations

awsSetAssumeRoleName

use awsUpdateCloudConfiguration (24.3.1)
Description

Sets assume role name for the global credentials

Response

Returns a Boolean!

Arguments
Name Description
roleName - String

Example

Query
mutation awsSetAssumeRoleName($roleName: String) {
  awsSetAssumeRoleName(roleName: $roleName)
}
Variables
{"roleName": "<string>"}
Response
{
  "data": {
    "awsSetAssumeRoleName": "<boolean>"
  }
}
Mutations

awsSetProxyUser

No longer supported
Response

Returns a Boolean

Arguments
Name Description
useSessionUser - Boolean
accessKey - String
secretKey - String

Example

Query
mutation awsSetProxyUser(
  $useSessionUser: Boolean,
  $accessKey: String,
  $secretKey: String
) {
  awsSetProxyUser(
    useSessionUser: $useSessionUser,
    accessKey: $accessKey,
    secretKey: $secretKey
  )
}
Variables
{
  "useSessionUser": "<boolean>",
  "accessKey": "<string>",
  "secretKey": "<string>"
}
Response
{"data": {"awsSetProxyUser": "<boolean>"}}
Mutations

awsSetRegions

use awsUpdateCloudConfiguration (24.3.1)
Description

Updates regions in cloud configuration

Response

Returns a Boolean!

Arguments
Name Description
regions - [String!]!

Example

Query
mutation awsSetRegions($regions: [String!]!) {
  awsSetRegions(regions: $regions)
}
Variables
{"regions": "<string>"}
Response
{"data": {"awsSetRegions": "<boolean>"}}
Mutations

awsUpdateCloudConfiguration

Description

Updates AWS cloud configuration. Use this mutation to update regions, credentials, and other AWS settings.

Response

Returns an AWSConfiguration!

Arguments
Name Description
config - AWSConfigurationInput!

Example

Query
mutation awsUpdateCloudConfiguration($config: AWSConfigurationInput!) {
  awsUpdateCloudConfiguration(config: $config) {
    cloudId
    cloudName
    allowedAccounts
    regions
    federatedAccessEnabled
    govRegionsEnabled
    proxyUser {
      ...AWSUserInfoFragment
    }
    useDefaultCredentials
    assumeRoleName
  }
}
Variables
{"config": AWSConfigurationInput}
Response
{
  "data": {
    "awsUpdateCloudConfiguration": {
      "cloudId": "<string>",
      "cloudName": "<string>",
      "allowedAccounts": ["<string>"],
      "regions": ["<string>"],
      "federatedAccessEnabled": "<boolean>",
      "govRegionsEnabled": "<boolean>",
      "proxyUser": AWSUserInfo,
      "useDefaultCredentials": "<boolean>",
      "assumeRoleName": "<string>"
    }
  }
}
Mutations

awsUpdateInstallConfiguration

Description

Updates AWS install configuration. Use this mutation to update the agreement ID for AWS installation.

Response

Returns an AWSInstallInfo!

Arguments
Name Description
config - AWSInstallConfigurationInput!

Example

Query
mutation awsUpdateInstallConfiguration($config: AWSInstallConfigurationInput!) {
  awsUpdateInstallConfiguration(config: $config) {
    instanceId
    instanceType
    instanceRole
    accountId
    version
    marketplaceProductCodes
    amiId
    agreementId
    defaultRegion
    accountRegions
  }
}
Variables
{"config": AWSInstallConfigurationInput}
Response
{
  "data": {
    "awsUpdateInstallConfiguration": {
      "instanceId": "<string>",
      "instanceType": "<string>",
      "instanceRole": "<string>",
      "accountId": "<string>",
      "version": "<string>",
      "marketplaceProductCodes": ["<string>"],
      "amiId": "<string>",
      "agreementId": "<string>",
      "defaultRegion": "<string>",
      "accountRegions": ["<string>"]
    }
  }
}
Mutations

awsUseDefaultCredentials

use awsUpdateCloudConfiguration (24.3.1)
Description

Enables or disables use of the default AWS credentials (e.g., a role with credentials is set to EC2 machine).

Response

Returns a Boolean!

Arguments
Name Description
enable - Boolean!

Example

Query
mutation awsUseDefaultCredentials($enable: Boolean!) {
  awsUseDefaultCredentials(enable: $enable)
}
Variables
{"enable": "<boolean>"}
Response
{
  "data": {
    "awsUseDefaultCredentials": "<boolean>"
  }
}
Mutations

fakeFunctionAWS

Response

Returns an Object

Example

Query
mutation fakeFunctionAWS {
  fakeFunctionAWS
}
Response
{"data": {"fakeFunctionAWS": "<object>"}}

Types

AWSConfiguration

Fields
Field Name Description
cloudId - String! Unique identifier of the AWS cloud configuration.
cloudName - String! Name of the AWS cloud configuration.
allowedAccounts - [String!]! List of AWS account ids that are allowed to access the AWS cloud configuration.
regions - [String!] List of AWS regions that are allowed to access the AWS cloud configuration.
federatedAccessEnabled - Boolean! Indicates if federated access is enabled for the AWS cloud configuration.
govRegionsEnabled - Boolean! Indicates if AWS GovCloud regions are enabled for the AWS cloud configuration.
proxyUser - AWSUserInfo
useDefaultCredentials - Boolean! Indicates if the default AWS credentials are used for the AWS cloud configuration.
assumeRoleName - String The role name to assume for global credentials.
Example
{
  "cloudId": "<string>",
  "cloudName": "<string>",
  "allowedAccounts": ["<string>"],
  "regions": ["<string>"],
  "federatedAccessEnabled": "<boolean>",
  "govRegionsEnabled": "<boolean>",
  "proxyUser": AWSUserInfo,
  "useDefaultCredentials": "<boolean>",
  "assumeRoleName": "<string>"
}
Types

AWSConfigurationInput

Fields
Input Field Description
regions - [String!]
credentials - AWSCredentialsConfigurationInput
Example
{
  "regions": ["<string>"],
  "credentials": AWSCredentialsConfigurationInput
}
Types

AWSCredentialsConfigurationInput

Fields
Input Field Description
useDefaultCredentials - Boolean Enable using default credentials from AWS machine (e.g., IAM role on EC2 instance).
assumeRoleName - String The role name to assume for global credentials.
Example
{"useDefaultCredentials": "<boolean>", "assumeRoleName": "<string>"}
Types

AWSInstallConfigurationInput

Fields
Input Field Description
agreementId - ID
Example
{"agreementId": "<id>"}
Types

AWSInstallInfo

Fields
Field Name Description
instanceId - String
instanceType - String
instanceRole - String
accountId - String
version - String
marketplaceProductCodes - [String!]
amiId - String
agreementId - String
defaultRegion - String
accountRegions - [String!] use regions from AWSConfiguration (24.3.1)
Example
{
  "instanceId": "<string>",
  "instanceType": "<string>",
  "instanceRole": "<string>",
  "accountId": "<string>",
  "version": "<string>",
  "marketplaceProductCodes": ["<string>"],
  "amiId": "<string>",
  "agreementId": "<string>",
  "defaultRegion": "<string>",
  "accountRegions": ["<string>"]
}
Types

AWSPartition

Fields
Field Name Description
id - ID!
name - String!
Example
{"id": "<id>", "name": "<string>"}
Types

AWSRegion

Fields
Field Name Description
id - String! Unique identifier of the region, such as 'us-east-1', 'eu-west-1', etc.
displayName - String Name of the region, such as 'US East (N. Virginia)', 'EU (Ireland)', etc.
superRegion - String Returns the region group, such as Europe, Asia Pacific, etc.
global - Boolean! Indicates if the region is global or not. Global regions are used for AWS services that are not region-specific, such as IAM.
partition - String! Returns the partition ID of the region, such as 'aws', 'aws-cn', or 'aws-us-gov'.
domain - String
Example
{
  "id": "<string>",
  "displayName": "<string>",
  "superRegion": "<string>",
  "global": "<boolean>",
  "partition": "<string>",
  "domain": "<string>"
}
Types

AWSTag

Fields
Field Name Description
name - String!
value - String
Example
{"name": "<string>", "value": "<string>"}
Types

AWSUserInfo

Fields
Field Name Description
userId - String
userName - String
userPath - String
userArn - String
accountId - String
organizationName - String
createDate - DateTime
tags - [AWSTag!]
Example
{
  "userId": "<string>",
  "userName": "<string>",
  "userPath": "<string>",
  "userArn": "<string>",
  "accountId": "<string>",
  "organizationName": "<string>",
  "createDate": "<datetime>",
  "tags": [AWSTag]
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

DateTime

Description

Date/Time

Example
"<datetime>"
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"<id>"
Types

Object

Description

Any object (JSON)

Example
"<object>"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"<string>"
Documentation by Anvil SpectaQL