Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListKxEnvironments

Returns a list of kdb environments created in an account.

Request Syntax


GET /kx/environments?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return in this request.

nextToken

A token that indicates where a results page should begin.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "environments": [ 
      { 
         "availabilityZoneIds": [ "string" ],
         "awsAccountId": "string",
         "certificateAuthorityArn": "string",
         "creationTimestamp": number,
         "customDNSConfiguration": [ 
            { 
               "customDNSServerIP": "string",
               "customDNSServerName": "string"
            }
         ],
         "dedicatedServiceAccountId": "string",
         "description": "string",
         "dnsStatus": "string",
         "environmentArn": "string",
         "environmentId": "string",
         "errorMessage": "string",
         "kmsKeyId": "string",
         "name": "string",
         "status": "string",
         "tgwStatus": "string",
         "transitGatewayConfiguration": { 
            "attachmentNetworkAclConfiguration": [ 
               { 
                  "cidrBlock": "string",
                  "icmpTypeCode": { 
                     "code": number,
                     "type": number
                  },
                  "portRange": { 
                     "from": number,
                     "to": number
                  },
                  "protocol": "string",
                  "ruleAction": "string",
                  "ruleNumber": number
               }
            ],
            "routableCIDRSpace": "string",
            "transitGatewayID": "string"
         },
         "updateTimestamp": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environments

A list of environments in an account.

Type: Array of KxEnvironment objects

nextToken

A token that indicates where a results page should begin.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400