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

GetKxEnvironment

Retrieves all the information for the specified kdb environment.

Request Syntax


GET /kx/environments/environmentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

environmentId

A unique identifier for the kdb environment.

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

Pattern: ^[a-zA-Z0-9]{1,26}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "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
}

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.

availabilityZoneIds

The identifier of the availability zones where subnets for the environment are created.

Type: Array of strings

Length Constraints: Minimum length of 8. Maximum length of 12.

Pattern: ^[a-zA-Z0-9-]+$

awsAccountId

The unique identifier of the AWS account that is used to create the kdb environment.

Type: String

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

Pattern: ^[a-zA-Z0-9]{1,26}$

certificateAuthorityArn

The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.

Type: String

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

creationTimestamp

The timestamp at which the kdb environment was created in FinSpace.

Type: Timestamp

customDNSConfiguration

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

Type: Array of CustomDNSServer objects

dedicatedServiceAccountId

A unique identifier for the AWS environment infrastructure account.

Type: String

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

Pattern: ^[a-zA-Z0-9]{1,26}$

description

A description for the kdb environment.

Type: String

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

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

dnsStatus

The status of DNS configuration.

Type: String

Valid Values: NONE | UPDATE_REQUESTED | UPDATING | FAILED_UPDATE | SUCCESSFULLY_UPDATED

environmentArn

The ARN identifier of the environment.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za-z_-]{1,128}$

environmentId

A unique identifier for the kdb environment.

Type: String

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

Pattern: ^[a-zA-Z0-9]{1,26}$

errorMessage

Specifies the error message that appears if a flow fails.

Type: String

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

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

kmsKeyId

The KMS key ID to encrypt your data in the FinSpace environment.

Type: String

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

Pattern: ^[a-zA-Z-0-9-:\/]*$

name

The name of the kdb environment.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

status

The status of the kdb environment.

Type: String

tgwStatus

The status of the network configuration.

Type: String

Valid Values: NONE | UPDATE_REQUESTED | UPDATING | FAILED_UPDATE | SUCCESSFULLY_UPDATED

transitGatewayConfiguration

The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.

Type: TransitGatewayConfiguration object

updateTimestamp

The timestamp at which the kdb environment was updated.

Type: Timestamp

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

ConflictException

There was a conflict with this action, and it could not be completed.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400