AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . finspace ]

get-kx-environment

Description

Retrieves all the information for the specified kdb environment.

See also: AWS API Documentation

Synopsis

  get-kx-environment
--environment-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--environment-id (string)

A unique identifier for the kdb environment.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

name -> (string)

The name of the kdb environment.

environmentId -> (string)

A unique identifier for the kdb environment.

awsAccountId -> (string)

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

status -> (string)

The status of the kdb environment.

tgwStatus -> (string)

The status of the network configuration.

dnsStatus -> (string)

The status of DNS configuration.

errorMessage -> (string)

Specifies the error message that appears if a flow fails.

description -> (string)

A description for the kdb environment.

environmentArn -> (string)

The ARN identifier of the environment.

kmsKeyId -> (string)

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

dedicatedServiceAccountId -> (string)

A unique identifier for the AWS environment infrastructure account.

transitGatewayConfiguration -> (structure)

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

transitGatewayID -> (string)

The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.

routableCIDRSpace -> (string)

The routing CIDR on behalf of kdb environment. It could be any "/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.

attachmentNetworkAclConfiguration -> (list)

The rules that define how you manage the outbound traffic from kdb network to your internal network.

(structure)

The network access control list (ACL) is an optional layer of security for your VPC that acts as a firewall for controlling traffic in and out of one or more subnets. The entry is a set of numbered ingress and egress rules that determine whether a packet should be allowed in or out of a subnet associated with the ACL. We process the entries in the ACL according to the rule numbers, in ascending order.

ruleNumber -> (integer)

The rule number for the entry. For example 100 . All the network ACL entries are processed in ascending order by rule number.

protocol -> (string)

The protocol number. A value of -1 means all the protocols.

ruleAction -> (string)

Indicates whether to allow or deny the traffic that matches the rule.

portRange -> (structure)

The range of ports the rule applies to.

from -> (integer)

The first port in the range.

to -> (integer)

The last port in the range.

icmpTypeCode -> (structure)

Defines the ICMP protocol that consists of the ICMP type and code.

type -> (integer)

The ICMP type. A value of -1 means all types.

code -> (integer)

The ICMP code. A value of -1 means all codes for the specified ICMP type.

cidrBlock -> (string)

The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24 . We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .

customDNSConfiguration -> (list)

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

(structure)

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

customDNSServerName -> (string)

The name of the DNS server.

customDNSServerIP -> (string)

The IP address of the DNS server.

creationTimestamp -> (timestamp)

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

updateTimestamp -> (timestamp)

The timestamp at which the kdb environment was updated.

availabilityZoneIds -> (list)

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

(string)

certificateAuthorityArn -> (string)

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