List Kx Environments

finspace_list_kx_environments

R Documentation

Returns a list of kdb environments created in an account

Description

Returns a list of kdb environments created in an account.

Usage

finspace_list_kx_environments(nextToken, maxResults)

Arguments

nextToken

A token that indicates where a results page should begin.

maxResults

The maximum number of results to return in this request.

Value

A list with the following syntax:

list(
  environments = list(
    list(
      name = "string",
      environmentId = "string",
      awsAccountId = "string",
      status = "CREATE_REQUESTED"|"CREATING"|"CREATED"|"DELETE_REQUESTED"|"DELETING"|"DELETED"|"FAILED_CREATION"|"RETRY_DELETION"|"FAILED_DELETION"|"UPDATE_NETWORK_REQUESTED"|"UPDATING_NETWORK"|"FAILED_UPDATING_NETWORK"|"SUSPENDED",
      tgwStatus = "NONE"|"UPDATE_REQUESTED"|"UPDATING"|"FAILED_UPDATE"|"SUCCESSFULLY_UPDATED",
      dnsStatus = "NONE"|"UPDATE_REQUESTED"|"UPDATING"|"FAILED_UPDATE"|"SUCCESSFULLY_UPDATED",
      errorMessage = "string",
      description = "string",
      environmentArn = "string",
      kmsKeyId = "string",
      dedicatedServiceAccountId = "string",
      transitGatewayConfiguration = list(
        transitGatewayID = "string",
        routableCIDRSpace = "string",
        attachmentNetworkAclConfiguration = list(
          list(
            ruleNumber = 123,
            protocol = "string",
            ruleAction = "allow"|"deny",
            portRange = list(
              from = 123,
              to = 123
            ),
            icmpTypeCode = list(
              type = 123,
              code = 123
            ),
            cidrBlock = "string"
          )
        )
      ),
      customDNSConfiguration = list(
        list(
          customDNSServerName = "string",
          customDNSServerIP = "string"
        )
      ),
      creationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      updateTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      availabilityZoneIds = list(
        "string"
      ),
      certificateAuthorityArn = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_kx_environments(
  nextToken = "string",
  maxResults = 123
)