finspace / Client / list_kx_environments

list_kx_environments#

finspace.Client.list_kx_environments(**kwargs)#

Returns a list of kdb environments created in an account.

See also: AWS API Documentation

Request Syntax

response = client.list_kx_environments(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – A token that indicates where a results page should begin.

  • maxResults (integer) – The maximum number of results to return in this request.

Return type:

dict

Returns:

Response Syntax

{
    'environments': [
        {
            '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': {
                'transitGatewayID': 'string',
                'routableCIDRSpace': 'string',
                'attachmentNetworkAclConfiguration': [
                    {
                        'ruleNumber': 123,
                        'protocol': 'string',
                        'ruleAction': 'allow'|'deny',
                        'portRange': {
                            'from': 123,
                            'to': 123
                        },
                        'icmpTypeCode': {
                            'type': 123,
                            'code': 123
                        },
                        'cidrBlock': 'string'
                    },
                ]
            },
            'customDNSConfiguration': [
                {
                    'customDNSServerName': 'string',
                    'customDNSServerIP': 'string'
                },
            ],
            'creationTimestamp': datetime(2015, 1, 1),
            'updateTimestamp': datetime(2015, 1, 1),
            'availabilityZoneIds': [
                'string',
            ],
            'certificateAuthorityArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • environments (list) –

      A list of environments in an account.

      • (dict) –

        The details of a kdb environment.

        • 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 in which you create the kdb environment.

        • status (string) –

          The status of the environment creation.

          • CREATE_REQUESTED – Environment creation has been requested.

          • CREATING – Environment is in the process of being created.

          • FAILED_CREATION – Environment creation has failed.

          • CREATED – Environment is successfully created and is currently active.

          • DELETE REQUESTED – Environment deletion has been requested.

          • DELETING – Environment is in the process of being deleted.

          • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

          • DELETED – Environment has been deleted.

          • FAILED_DELETION – Environment deletion has failed.

        • 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 of the kdb environment.

        • environmentArn (string) –

          The Amazon Resource Name (ARN) of your kdb environment.

        • kmsKeyId (string) –

          The unique identifier of the KMS key.

        • dedicatedServiceAccountId (string) –

          A unique identifier for the AWS environment infrastructure account.

        • transitGatewayConfiguration (dict) –

          Specifies the transit gateway and network configuration 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.

            • (dict) –

              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 (dict) –

                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 (dict) –

                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.

          • (dict) –

            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 (datetime) –

          The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        • updateTimestamp (datetime) –

          The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        • 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:

    • nextToken (string) –

      A token that indicates where a results page should begin.

Exceptions