CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

Create a new FinSpace environment.

Parameter Syntax

$result = $client->createEnvironment([
    'dataBundles' => ['<string>', ...],
    'description' => '<string>',
    'federationMode' => 'FEDERATED|LOCAL',
    'federationParameters' => [
        'applicationCallBackURL' => '<string>',
        'attributeMap' => ['<string>', ...],
        'federationProviderName' => '<string>',
        'federationURN' => '<string>',
        'samlMetadataDocument' => '<string>',
        'samlMetadataURL' => '<string>',
    ],
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'superuserParameters' => [
        'emailAddress' => '<string>', // REQUIRED
        'firstName' => '<string>', // REQUIRED
        'lastName' => '<string>', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'environmentArn' => '<string>',
    'environmentId' => '<string>',
    'environmentUrl' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

LimitExceededException:

A service limit or quota is exceeded.

CreateKxChangeset

$result = $client->createKxChangeset([/* ... */]);
$promise = $client->createKxChangesetAsync([/* ... */]);

Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.

Parameter Syntax

$result = $client->createKxChangeset([
    'changeRequests' => [ // REQUIRED
        [
            'changeType' => 'PUT|DELETE', // REQUIRED
            'dbPath' => '<string>', // REQUIRED
            's3Path' => '<string>',
        ],
        // ...
    ],
    'clientToken' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'changeRequests' => [
        [
            'changeType' => 'PUT|DELETE',
            'dbPath' => '<string>',
            's3Path' => '<string>',
        ],
        // ...
    ],
    'changesetId' => '<string>',
    'createdTimestamp' => <DateTime>,
    'databaseName' => '<string>',
    'environmentId' => '<string>',
    'errorInfo' => [
        'errorMessage' => '<string>',
        'errorType' => 'The inputs to this request are invalid.|Service limits have been exceeded.|Missing required permission to perform this request.|One or more inputs to this request were not found.|The system temporarily lacks sufficient resources to process the request.|An internal error has occurred.|Cancelled|A user recoverable error has occurred',
    ],
    'lastModifiedTimestamp' => <DateTime>,
    'status' => 'PENDING|PROCESSING|FAILED|COMPLETED',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ConflictException:

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

LimitExceededException:

A service limit or quota is exceeded.

CreateKxCluster

$result = $client->createKxCluster([/* ... */]);
$promise = $client->createKxClusterAsync([/* ... */]);

Creates a new kdb cluster.

Parameter Syntax

$result = $client->createKxCluster([
    'autoScalingConfiguration' => [
        'autoScalingMetric' => 'CPU_UTILIZATION_PERCENTAGE',
        'maxNodeCount' => <integer>,
        'metricTarget' => <float>,
        'minNodeCount' => <integer>,
        'scaleInCooldownSeconds' => <float>,
        'scaleOutCooldownSeconds' => <float>,
    ],
    'availabilityZoneId' => '<string>',
    'azMode' => 'SINGLE|MULTI', // REQUIRED
    'cacheStorageConfigurations' => [
        [
            'size' => <integer>, // REQUIRED
            'type' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'capacityConfiguration' => [
        'nodeCount' => <integer>,
        'nodeType' => '<string>',
    ],
    'clientToken' => '<string>',
    'clusterDescription' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'clusterType' => 'HDB|RDB|GATEWAY|GP|TICKERPLANT', // REQUIRED
    'code' => [
        's3Bucket' => '<string>',
        's3Key' => '<string>',
        's3ObjectVersion' => '<string>',
    ],
    'commandLineArguments' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'databases' => [
        [
            'cacheConfigurations' => [
                [
                    'cacheType' => '<string>', // REQUIRED
                    'dataviewName' => '<string>',
                    'dbPaths' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'changesetId' => '<string>',
            'databaseName' => '<string>', // REQUIRED
            'dataviewConfiguration' => [
                'changesetId' => '<string>',
                'dataviewName' => '<string>',
                'dataviewVersionId' => '<string>',
                'segmentConfigurations' => [
                    [
                        'dbPaths' => ['<string>', ...], // REQUIRED
                        'onDemand' => true || false,
                        'volumeName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'dataviewName' => '<string>',
        ],
        // ...
    ],
    'environmentId' => '<string>', // REQUIRED
    'executionRole' => '<string>',
    'initializationScript' => '<string>',
    'releaseLabel' => '<string>', // REQUIRED
    'savedownStorageConfiguration' => [
        'size' => <integer>,
        'type' => 'SDS01',
        'volumeName' => '<string>',
    ],
    'scalingGroupConfiguration' => [
        'cpu' => <float>,
        'memoryLimit' => <integer>,
        'memoryReservation' => <integer>, // REQUIRED
        'nodeCount' => <integer>, // REQUIRED
        'scalingGroupName' => '<string>', // REQUIRED
    ],
    'tags' => ['<string>', ...],
    'tickerplantLogConfiguration' => [
        'tickerplantLogVolumes' => ['<string>', ...],
    ],
    'vpcConfiguration' => [ // REQUIRED
        'ipAddressType' => 'IP_V4',
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'autoScalingConfiguration' => [
        'autoScalingMetric' => 'CPU_UTILIZATION_PERCENTAGE',
        'maxNodeCount' => <integer>,
        'metricTarget' => <float>,
        'minNodeCount' => <integer>,
        'scaleInCooldownSeconds' => <float>,
        'scaleOutCooldownSeconds' => <float>,
    ],
    'availabilityZoneId' => '<string>',
    'azMode' => 'SINGLE|MULTI',
    'cacheStorageConfigurations' => [
        [
            'size' => <integer>,
            'type' => '<string>',
        ],
        // ...
    ],
    'capacityConfiguration' => [
        'nodeCount' => <integer>,
        'nodeType' => '<string>',
    ],
    'clusterDescription' => '<string>',
    'clusterName' => '<string>',
    'clusterType' => 'HDB|RDB|GATEWAY|GP|TICKERPLANT',
    'code' => [
        's3Bucket' => '<string>',
        's3Key' => '<string>',
        's3ObjectVersion' => '<string>',
    ],
    'commandLineArguments' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'createdTimestamp' => <DateTime>,
    'databases' => [
        [
            'cacheConfigurations' => [
                [
                    'cacheType' => '<string>',
                    'dataviewName' => '<string>',
                    'dbPaths' => ['<string>', ...],
                ],
                // ...
            ],
            'changesetId' => '<string>',
            'databaseName' => '<string>',
            'dataviewConfiguration' => [
                'changesetId' => '<string>',
                'dataviewName' => '<string>',
                'dataviewVersionId' => '<string>',
                'segmentConfigurations' => [
                    [
                        'dbPaths' => ['<string>', ...],
                        'onDemand' => true || false,
                        'volumeName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'dataviewName' => '<string>',
        ],
        // ...
    ],
    'environmentId' => '<string>',
    'executionRole' => '<string>',
    'initializationScript' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'releaseLabel' => '<string>',
    'savedownStorageConfiguration' => [
        'size' => <integer>,
        'type' => 'SDS01',
        'volumeName' => '<string>',
    ],
    'scalingGroupConfiguration' => [
        'cpu' => <float>,
        'memoryLimit' => <integer>,
        'memoryReservation' => <integer>,
        'nodeCount' => <integer>,
        'scalingGroupName' => '<string>',
    ],
    'status' => 'PENDING|CREATING|CREATE_FAILED|RUNNING|UPDATING|DELETING|DELETED|DELETE_FAILED',
    'statusReason' => '<string>',
    'tickerplantLogConfiguration' => [
        'tickerplantLogVolumes' => ['<string>', ...],
    ],
    'volumes' => [
        [
            'volumeName' => '<string>',
            'volumeType' => 'NAS_1',
        ],
        // ...
    ],
    'vpcConfiguration' => [
        'ipAddressType' => 'IP_V4',
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateKxDatabase

$result = $client->createKxDatabase([/* ... */]);
$promise = $client->createKxDatabaseAsync([/* ... */]);

Creates a new kdb database in the environment.

Parameter Syntax

$result = $client->createKxDatabase([
    'clientToken' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'description' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'createdTimestamp' => <DateTime>,
    'databaseArn' => '<string>',
    'databaseName' => '<string>',
    'description' => '<string>',
    'environmentId' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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

ResourceAlreadyExistsException:

The specified resource group already exists.

ResourceNotFoundException:

One or more resources can't be found.

LimitExceededException:

A service limit or quota is exceeded.

CreateKxDataview

$result = $client->createKxDataview([/* ... */]);
$promise = $client->createKxDataviewAsync([/* ... */]);

Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.

Parameter Syntax

$result = $client->createKxDataview([
    'autoUpdate' => true || false,
    'availabilityZoneId' => '<string>',
    'azMode' => 'SINGLE|MULTI', // REQUIRED
    'changesetId' => '<string>',
    'clientToken' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'dataviewName' => '<string>', // REQUIRED
    'description' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'readWrite' => true || false,
    'segmentConfigurations' => [
        [
            'dbPaths' => ['<string>', ...], // REQUIRED
            'onDemand' => true || false,
            'volumeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'autoUpdate' => true || false,
    'availabilityZoneId' => '<string>',
    'azMode' => 'SINGLE|MULTI',
    'changesetId' => '<string>',
    'createdTimestamp' => <DateTime>,
    'databaseName' => '<string>',
    'dataviewName' => '<string>',
    'description' => '<string>',
    'environmentId' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'readWrite' => true || false,
    'segmentConfigurations' => [
        [
            'dbPaths' => ['<string>', ...],
            'onDemand' => true || false,
            'volumeName' => '<string>',
        ],
        // ...
    ],
    'status' => 'CREATING|ACTIVE|UPDATING|FAILED|DELETING',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ConflictException:

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

LimitExceededException:

A service limit or quota is exceeded.

ResourceAlreadyExistsException:

The specified resource group already exists.

CreateKxEnvironment

$result = $client->createKxEnvironment([/* ... */]);
$promise = $client->createKxEnvironmentAsync([/* ... */]);

Creates a managed kdb environment for the account.

Parameter Syntax

$result = $client->createKxEnvironment([
    'clientToken' => '<string>',
    'description' => '<string>',
    'kmsKeyId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'creationTimestamp' => <DateTime>,
    'description' => '<string>',
    'environmentArn' => '<string>',
    'environmentId' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<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',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

CreateKxScalingGroup

$result = $client->createKxScalingGroup([/* ... */]);
$promise = $client->createKxScalingGroupAsync([/* ... */]);

Creates a new scaling group.

Parameter Syntax

$result = $client->createKxScalingGroup([
    'availabilityZoneId' => '<string>', // REQUIRED
    'clientToken' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
    'hostType' => '<string>', // REQUIRED
    'scalingGroupName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'availabilityZoneId' => '<string>',
    'createdTimestamp' => <DateTime>,
    'environmentId' => '<string>',
    'hostType' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'scalingGroupName' => '<string>',
    'status' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED|DELETE_FAILED',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateKxUser

$result = $client->createKxUser([/* ... */]);
$promise = $client->createKxUserAsync([/* ... */]);

Creates a user in FinSpace kdb environment with an associated IAM role.

Parameter Syntax

$result = $client->createKxUser([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'iamRole' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'userName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentId' => '<string>',
    'iamRole' => '<string>',
    'userArn' => '<string>',
    'userName' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

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

ResourceAlreadyExistsException:

The specified resource group already exists.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

CreateKxVolume

$result = $client->createKxVolume([/* ... */]);
$promise = $client->createKxVolumeAsync([/* ... */]);

Creates a new volume with a specific amount of throughput and storage capacity.

Parameter Syntax

$result = $client->createKxVolume([
    'availabilityZoneIds' => ['<string>', ...], // REQUIRED
    'azMode' => 'SINGLE|MULTI', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'nas1Configuration' => [
        'size' => <integer>,
        'type' => 'SSD_1000|SSD_250|HDD_12',
    ],
    'tags' => ['<string>', ...],
    'volumeName' => '<string>', // REQUIRED
    'volumeType' => 'NAS_1', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'availabilityZoneIds' => ['<string>', ...],
    'azMode' => 'SINGLE|MULTI',
    'createdTimestamp' => <DateTime>,
    'description' => '<string>',
    'environmentId' => '<string>',
    'nas1Configuration' => [
        'size' => <integer>,
        'type' => 'SSD_1000|SSD_250|HDD_12',
    ],
    'status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED|DELETE_FAILED',
    'statusReason' => '<string>',
    'volumeArn' => '<string>',
    'volumeName' => '<string>',
    'volumeType' => 'NAS_1',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

ResourceAlreadyExistsException:

The specified resource group already exists.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

Delete an FinSpace environment.

Parameter Syntax

$result = $client->deleteEnvironment([
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

InternalServerException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

DeleteKxCluster

$result = $client->deleteKxCluster([/* ... */]);
$promise = $client->deleteKxClusterAsync([/* ... */]);

Deletes a kdb cluster.

Parameter Syntax

$result = $client->deleteKxCluster([
    'clientToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

DeleteKxClusterNode

$result = $client->deleteKxClusterNode([/* ... */]);
$promise = $client->deleteKxClusterNodeAsync([/* ... */]);

Deletes the specified nodes from a cluster.

Parameter Syntax

$result = $client->deleteKxClusterNode([
    'clusterName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
    'nodeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

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

ResourceNotFoundException:

One or more resources can't be found.

DeleteKxDatabase

$result = $client->deleteKxDatabase([/* ... */]);
$promise = $client->deleteKxDatabaseAsync([/* ... */]);

Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.

Parameter Syntax

$result = $client->deleteKxDatabase([
    'clientToken' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ConflictException:

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

DeleteKxDataview

$result = $client->deleteKxDataview([/* ... */]);
$promise = $client->deleteKxDataviewAsync([/* ... */]);

Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.

Parameter Syntax

$result = $client->deleteKxDataview([
    'clientToken' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'dataviewName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ConflictException:

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

DeleteKxEnvironment

$result = $client->deleteKxEnvironment([/* ... */]);
$promise = $client->deleteKxEnvironmentAsync([/* ... */]);

Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

Parameter Syntax

$result = $client->deleteKxEnvironment([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

InternalServerException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

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

DeleteKxScalingGroup

$result = $client->deleteKxScalingGroup([/* ... */]);
$promise = $client->deleteKxScalingGroupAsync([/* ... */]);

Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.

Parameter Syntax

$result = $client->deleteKxScalingGroup([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'scalingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

DeleteKxUser

$result = $client->deleteKxUser([/* ... */]);
$promise = $client->deleteKxUserAsync([/* ... */]);

Deletes a user in the specified kdb environment.

Parameter Syntax

$result = $client->deleteKxUser([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'userName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

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

ConflictException:

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

DeleteKxVolume

$result = $client->deleteKxVolume([/* ... */]);
$promise = $client->deleteKxVolumeAsync([/* ... */]);

Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

Parameter Syntax

$result = $client->deleteKxVolume([
    'clientToken' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'volumeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Returns the FinSpace environment object.

Parameter Syntax

$result = $client->getEnvironment([
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'awsAccountId' => '<string>',
        'dedicatedServiceAccountId' => '<string>',
        'description' => '<string>',
        'environmentArn' => '<string>',
        'environmentId' => '<string>',
        'environmentUrl' => '<string>',
        'federationMode' => 'FEDERATED|LOCAL',
        'federationParameters' => [
            'applicationCallBackURL' => '<string>',
            'attributeMap' => ['<string>', ...],
            'federationProviderName' => '<string>',
            'federationURN' => '<string>',
            'samlMetadataDocument' => '<string>',
            'samlMetadataURL' => '<string>',
        ],
        'kmsKeyId' => '<string>',
        'name' => '<string>',
        'sageMakerStudioDomainUrl' => '<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',
    ],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

InternalServerException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

GetKxChangeset

$result = $client->getKxChangeset([/* ... */]);
$promise = $client->getKxChangesetAsync([/* ... */]);

Returns information about a kdb changeset.

Parameter Syntax

$result = $client->getKxChangeset([
    'changesetId' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'activeFromTimestamp' => <DateTime>,
    'changeRequests' => [
        [
            'changeType' => 'PUT|DELETE',
            'dbPath' => '<string>',
            's3Path' => '<string>',
        ],
        // ...
    ],
    'changesetId' => '<string>',
    'createdTimestamp' => <DateTime>,
    'databaseName' => '<string>',
    'environmentId' => '<string>',
    'errorInfo' => [
        'errorMessage' => '<string>',
        'errorType' => 'The inputs to this request are invalid.|Service limits have been exceeded.|Missing required permission to perform this request.|One or more inputs to this request were not found.|The system temporarily lacks sufficient resources to process the request.|An internal error has occurred.|Cancelled|A user recoverable error has occurred',
    ],
    'lastModifiedTimestamp' => <DateTime>,
    'status' => 'PENDING|PROCESSING|FAILED|COMPLETED',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

GetKxCluster

$result = $client->getKxCluster([/* ... */]);
$promise = $client->getKxClusterAsync([/* ... */]);

Retrieves information about a kdb cluster.

Parameter Syntax

$result = $client->getKxCluster([
    'clusterName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autoScalingConfiguration' => [
        'autoScalingMetric' => 'CPU_UTILIZATION_PERCENTAGE',
        'maxNodeCount' => <integer>,
        'metricTarget' => <float>,
        'minNodeCount' => <integer>,
        'scaleInCooldownSeconds' => <float>,
        'scaleOutCooldownSeconds' => <float>,
    ],
    'availabilityZoneId' => '<string>',
    'azMode' => 'SINGLE|MULTI',
    'cacheStorageConfigurations' => [
        [
            'size' => <integer>,
            'type' => '<string>',
        ],
        // ...
    ],
    'capacityConfiguration' => [
        'nodeCount' => <integer>,
        'nodeType' => '<string>',
    ],
    'clusterDescription' => '<string>',
    'clusterName' => '<string>',
    'clusterType' => 'HDB|RDB|GATEWAY|GP|TICKERPLANT',
    'code' => [
        's3Bucket' => '<string>',
        's3Key' => '<string>',
        's3ObjectVersion' => '<string>',
    ],
    'commandLineArguments' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'createdTimestamp' => <DateTime>,
    'databases' => [
        [
            'cacheConfigurations' => [
                [
                    'cacheType' => '<string>',
                    'dataviewName' => '<string>',
                    'dbPaths' => ['<string>', ...],
                ],
                // ...
            ],
            'changesetId' => '<string>',
            'databaseName' => '<string>',
            'dataviewConfiguration' => [
                'changesetId' => '<string>',
                'dataviewName' => '<string>',
                'dataviewVersionId' => '<string>',
                'segmentConfigurations' => [
                    [
                        'dbPaths' => ['<string>', ...],
                        'onDemand' => true || false,
                        'volumeName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'dataviewName' => '<string>',
        ],
        // ...
    ],
    'executionRole' => '<string>',
    'initializationScript' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'releaseLabel' => '<string>',
    'savedownStorageConfiguration' => [
        'size' => <integer>,
        'type' => 'SDS01',
        'volumeName' => '<string>',
    ],
    'scalingGroupConfiguration' => [
        'cpu' => <float>,
        'memoryLimit' => <integer>,
        'memoryReservation' => <integer>,
        'nodeCount' => <integer>,
        'scalingGroupName' => '<string>',
    ],
    'status' => 'PENDING|CREATING|CREATE_FAILED|RUNNING|UPDATING|DELETING|DELETED|DELETE_FAILED',
    'statusReason' => '<string>',
    'tickerplantLogConfiguration' => [
        'tickerplantLogVolumes' => ['<string>', ...],
    ],
    'volumes' => [
        [
            'volumeName' => '<string>',
            'volumeType' => 'NAS_1',
        ],
        // ...
    ],
    'vpcConfiguration' => [
        'ipAddressType' => 'IP_V4',
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

GetKxConnectionString

$result = $client->getKxConnectionString([/* ... */]);
$promise = $client->getKxConnectionStringAsync([/* ... */]);

Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.

Parameter Syntax

$result = $client->getKxConnectionString([
    'clusterName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
    'userArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'signedConnectionString' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

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

GetKxDatabase

$result = $client->getKxDatabase([/* ... */]);
$promise = $client->getKxDatabaseAsync([/* ... */]);

Returns database information for the specified environment ID.

Parameter Syntax

$result = $client->getKxDatabase([
    'databaseName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdTimestamp' => <DateTime>,
    'databaseArn' => '<string>',
    'databaseName' => '<string>',
    'description' => '<string>',
    'environmentId' => '<string>',
    'lastCompletedChangesetId' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'numBytes' => <integer>,
    'numChangesets' => <integer>,
    'numFiles' => <integer>,
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

GetKxDataview

$result = $client->getKxDataview([/* ... */]);
$promise = $client->getKxDataviewAsync([/* ... */]);

Retrieves details of the dataview.

Parameter Syntax

$result = $client->getKxDataview([
    'databaseName' => '<string>', // REQUIRED
    'dataviewName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'activeVersions' => [
        [
            'attachedClusters' => ['<string>', ...],
            'changesetId' => '<string>',
            'createdTimestamp' => <DateTime>,
            'segmentConfigurations' => [
                [
                    'dbPaths' => ['<string>', ...],
                    'onDemand' => true || false,
                    'volumeName' => '<string>',
                ],
                // ...
            ],
            'versionId' => '<string>',
        ],
        // ...
    ],
    'autoUpdate' => true || false,
    'availabilityZoneId' => '<string>',
    'azMode' => 'SINGLE|MULTI',
    'changesetId' => '<string>',
    'createdTimestamp' => <DateTime>,
    'databaseName' => '<string>',
    'dataviewName' => '<string>',
    'description' => '<string>',
    'environmentId' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'readWrite' => true || false,
    'segmentConfigurations' => [
        [
            'dbPaths' => ['<string>', ...],
            'onDemand' => true || false,
            'volumeName' => '<string>',
        ],
        // ...
    ],
    'status' => 'CREATING|ACTIVE|UPDATING|FAILED|DELETING',
    'statusReason' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

GetKxEnvironment

$result = $client->getKxEnvironment([/* ... */]);
$promise = $client->getKxEnvironmentAsync([/* ... */]);

Retrieves all the information for the specified kdb environment.

Parameter Syntax

$result = $client->getKxEnvironment([
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'availabilityZoneIds' => ['<string>', ...],
    'awsAccountId' => '<string>',
    'certificateAuthorityArn' => '<string>',
    'creationTimestamp' => <DateTime>,
    'customDNSConfiguration' => [
        [
            'customDNSServerIP' => '<string>',
            'customDNSServerName' => '<string>',
        ],
        // ...
    ],
    'dedicatedServiceAccountId' => '<string>',
    'description' => '<string>',
    'dnsStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED',
    'environmentArn' => '<string>',
    'environmentId' => '<string>',
    'errorMessage' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<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',
    'transitGatewayConfiguration' => [
        'attachmentNetworkAclConfiguration' => [
            [
                'cidrBlock' => '<string>',
                'icmpTypeCode' => [
                    'code' => <integer>,
                    'type' => <integer>,
                ],
                'portRange' => [
                    'from' => <integer>,
                    'to' => <integer>,
                ],
                'protocol' => '<string>',
                'ruleAction' => 'allow|deny',
                'ruleNumber' => <integer>,
            ],
            // ...
        ],
        'routableCIDRSpace' => '<string>',
        'transitGatewayID' => '<string>',
    ],
    'updateTimestamp' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

InternalServerException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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

GetKxScalingGroup

$result = $client->getKxScalingGroup([/* ... */]);
$promise = $client->getKxScalingGroupAsync([/* ... */]);

Retrieves details of a scaling group.

Parameter Syntax

$result = $client->getKxScalingGroup([
    'environmentId' => '<string>', // REQUIRED
    'scalingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'availabilityZoneId' => '<string>',
    'clusters' => ['<string>', ...],
    'createdTimestamp' => <DateTime>,
    'hostType' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'scalingGroupArn' => '<string>',
    'scalingGroupName' => '<string>',
    'status' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED|DELETE_FAILED',
    'statusReason' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

GetKxUser

$result = $client->getKxUser([/* ... */]);
$promise = $client->getKxUserAsync([/* ... */]);

Retrieves information about the specified kdb user.

Parameter Syntax

$result = $client->getKxUser([
    'environmentId' => '<string>', // REQUIRED
    'userName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentId' => '<string>',
    'iamRole' => '<string>',
    'userArn' => '<string>',
    'userName' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

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

GetKxVolume

$result = $client->getKxVolume([/* ... */]);
$promise = $client->getKxVolumeAsync([/* ... */]);

Retrieves the information about the volume.

Parameter Syntax

$result = $client->getKxVolume([
    'environmentId' => '<string>', // REQUIRED
    'volumeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attachedClusters' => [
        [
            'clusterName' => '<string>',
            'clusterStatus' => 'PENDING|CREATING|CREATE_FAILED|RUNNING|UPDATING|DELETING|DELETED|DELETE_FAILED',
            'clusterType' => 'HDB|RDB|GATEWAY|GP|TICKERPLANT',
        ],
        // ...
    ],
    'availabilityZoneIds' => ['<string>', ...],
    'azMode' => 'SINGLE|MULTI',
    'createdTimestamp' => <DateTime>,
    'description' => '<string>',
    'environmentId' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'nas1Configuration' => [
        'size' => <integer>,
        'type' => 'SSD_1000|SSD_250|HDD_12',
    ],
    'status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED|DELETE_FAILED',
    'statusReason' => '<string>',
    'volumeArn' => '<string>',
    'volumeName' => '<string>',
    'volumeType' => 'NAS_1',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

A list of all of your FinSpace environments.

Parameter Syntax

$result = $client->listEnvironments([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'environments' => [
        [
            'awsAccountId' => '<string>',
            'dedicatedServiceAccountId' => '<string>',
            'description' => '<string>',
            'environmentArn' => '<string>',
            'environmentId' => '<string>',
            'environmentUrl' => '<string>',
            'federationMode' => 'FEDERATED|LOCAL',
            'federationParameters' => [
                'applicationCallBackURL' => '<string>',
                'attributeMap' => ['<string>', ...],
                'federationProviderName' => '<string>',
                'federationURN' => '<string>',
                'samlMetadataDocument' => '<string>',
                'samlMetadataURL' => '<string>',
            ],
            'kmsKeyId' => '<string>',
            'name' => '<string>',
            'sageMakerStudioDomainUrl' => '<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',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ListKxChangesets

$result = $client->listKxChangesets([/* ... */]);
$promise = $client->listKxChangesetsAsync([/* ... */]);

Returns a list of all the changesets for a database.

Parameter Syntax

$result = $client->listKxChangesets([
    'databaseName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'kxChangesets' => [
        [
            'activeFromTimestamp' => <DateTime>,
            'changesetId' => '<string>',
            'createdTimestamp' => <DateTime>,
            'lastModifiedTimestamp' => <DateTime>,
            'status' => 'PENDING|PROCESSING|FAILED|COMPLETED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ListKxClusterNodes

$result = $client->listKxClusterNodes([/* ... */]);
$promise = $client->listKxClusterNodesAsync([/* ... */]);

Lists all the nodes in a kdb cluster.

Parameter Syntax

$result = $client->listKxClusterNodes([
    'clusterName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'nodes' => [
        [
            'availabilityZoneId' => '<string>',
            'launchTime' => <DateTime>,
            'nodeId' => '<string>',
            'status' => 'RUNNING|PROVISIONING',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ValidationException:

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

ResourceNotFoundException:

One or more resources can't be found.

ListKxClusters

$result = $client->listKxClusters([/* ... */]);
$promise = $client->listKxClustersAsync([/* ... */]);

Returns a list of clusters.

Parameter Syntax

$result = $client->listKxClusters([
    'clusterType' => 'HDB|RDB|GATEWAY|GP|TICKERPLANT',
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'kxClusterSummaries' => [
        [
            'availabilityZoneId' => '<string>',
            'azMode' => 'SINGLE|MULTI',
            'clusterDescription' => '<string>',
            'clusterName' => '<string>',
            'clusterType' => 'HDB|RDB|GATEWAY|GP|TICKERPLANT',
            'createdTimestamp' => <DateTime>,
            'executionRole' => '<string>',
            'initializationScript' => '<string>',
            'lastModifiedTimestamp' => <DateTime>,
            'releaseLabel' => '<string>',
            'status' => 'PENDING|CREATING|CREATE_FAILED|RUNNING|UPDATING|DELETING|DELETED|DELETE_FAILED',
            'statusReason' => '<string>',
            'volumes' => [
                [
                    'volumeName' => '<string>',
                    'volumeType' => 'NAS_1',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

ListKxDatabases

$result = $client->listKxDatabases([/* ... */]);
$promise = $client->listKxDatabasesAsync([/* ... */]);

Returns a list of all the databases in the kdb environment.

Parameter Syntax

$result = $client->listKxDatabases([
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'kxDatabases' => [
        [
            'createdTimestamp' => <DateTime>,
            'databaseName' => '<string>',
            'lastModifiedTimestamp' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ListKxDataviews

$result = $client->listKxDataviews([/* ... */]);
$promise = $client->listKxDataviewsAsync([/* ... */]);

Returns a list of all the dataviews in the database.

Parameter Syntax

$result = $client->listKxDataviews([
    'databaseName' => '<string>', // REQUIRED
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'kxDataviews' => [
        [
            'activeVersions' => [
                [
                    'attachedClusters' => ['<string>', ...],
                    'changesetId' => '<string>',
                    'createdTimestamp' => <DateTime>,
                    'segmentConfigurations' => [
                        [
                            'dbPaths' => ['<string>', ...],
                            'onDemand' => true || false,
                            'volumeName' => '<string>',
                        ],
                        // ...
                    ],
                    'versionId' => '<string>',
                ],
                // ...
            ],
            'autoUpdate' => true || false,
            'availabilityZoneId' => '<string>',
            'azMode' => 'SINGLE|MULTI',
            'changesetId' => '<string>',
            'createdTimestamp' => <DateTime>,
            'databaseName' => '<string>',
            'dataviewName' => '<string>',
            'description' => '<string>',
            'environmentId' => '<string>',
            'lastModifiedTimestamp' => <DateTime>,
            'readWrite' => true || false,
            'segmentConfigurations' => [
                [
                    'dbPaths' => ['<string>', ...],
                    'onDemand' => true || false,
                    'volumeName' => '<string>',
                ],
                // ...
            ],
            'status' => 'CREATING|ACTIVE|UPDATING|FAILED|DELETING',
            'statusReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ListKxEnvironments

$result = $client->listKxEnvironments([/* ... */]);
$promise = $client->listKxEnvironmentsAsync([/* ... */]);

Returns a list of kdb environments created in an account.

Parameter Syntax

$result = $client->listKxEnvironments([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'environments' => [
        [
            'availabilityZoneIds' => ['<string>', ...],
            'awsAccountId' => '<string>',
            'certificateAuthorityArn' => '<string>',
            'creationTimestamp' => <DateTime>,
            'customDNSConfiguration' => [
                [
                    'customDNSServerIP' => '<string>',
                    'customDNSServerName' => '<string>',
                ],
                // ...
            ],
            'dedicatedServiceAccountId' => '<string>',
            'description' => '<string>',
            'dnsStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED',
            'environmentArn' => '<string>',
            'environmentId' => '<string>',
            'errorMessage' => '<string>',
            'kmsKeyId' => '<string>',
            'name' => '<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',
            'transitGatewayConfiguration' => [
                'attachmentNetworkAclConfiguration' => [
                    [
                        'cidrBlock' => '<string>',
                        'icmpTypeCode' => [
                            'code' => <integer>,
                            'type' => <integer>,
                        ],
                        'portRange' => [
                            'from' => <integer>,
                            'to' => <integer>,
                        ],
                        'protocol' => '<string>',
                        'ruleAction' => 'allow|deny',
                        'ruleNumber' => <integer>,
                    ],
                    // ...
                ],
                'routableCIDRSpace' => '<string>',
                'transitGatewayID' => '<string>',
            ],
            'updateTimestamp' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

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

ListKxScalingGroups

$result = $client->listKxScalingGroups([/* ... */]);
$promise = $client->listKxScalingGroupsAsync([/* ... */]);

Returns a list of scaling groups in a kdb environment.

Parameter Syntax

$result = $client->listKxScalingGroups([
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'scalingGroups' => [
        [
            'availabilityZoneId' => '<string>',
            'clusters' => ['<string>', ...],
            'createdTimestamp' => <DateTime>,
            'hostType' => '<string>',
            'lastModifiedTimestamp' => <DateTime>,
            'scalingGroupName' => '<string>',
            'status' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETED|DELETE_FAILED',
            'statusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

ListKxUsers

$result = $client->listKxUsers([/* ... */]);
$promise = $client->listKxUsersAsync([/* ... */]);

Lists all the users in a kdb environment.

Parameter Syntax

$result = $client->listKxUsers([
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'users' => [
        [
            'createTimestamp' => <DateTime>,
            'iamRole' => '<string>',
            'updateTimestamp' => <DateTime>,
            'userArn' => '<string>',
            'userName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

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

ListKxVolumes

$result = $client->listKxVolumes([/* ... */]);
$promise = $client->listKxVolumesAsync([/* ... */]);

Lists all the volumes in a kdb environment.

Parameter Syntax

$result = $client->listKxVolumes([
    'environmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'volumeType' => 'NAS_1',
]);

Parameter Details

Result Syntax

[
    'kxVolumeSummaries' => [
        [
            'availabilityZoneIds' => ['<string>', ...],
            'azMode' => 'SINGLE|MULTI',
            'createdTimestamp' => <DateTime>,
            'description' => '<string>',
            'lastModifiedTimestamp' => <DateTime>,
            'status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETED|DELETE_FAILED',
            'statusReason' => '<string>',
            'volumeName' => '<string>',
            'volumeType' => 'NAS_1',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

A list of all tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

The request is invalid. Something is wrong with the input to the request.

ResourceNotFoundException:

One or more resources can't be found.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds metadata tags to a FinSpace resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

The request is invalid. Something is wrong with the input to the request.

ResourceNotFoundException:

One or more resources can't be found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes metadata tags from a FinSpace resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

The request is invalid. Something is wrong with the input to the request.

ResourceNotFoundException:

One or more resources can't be found.

UpdateEnvironment

$result = $client->updateEnvironment([/* ... */]);
$promise = $client->updateEnvironmentAsync([/* ... */]);

Update your FinSpace environment.

Parameter Syntax

$result = $client->updateEnvironment([
    'description' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'federationMode' => 'FEDERATED|LOCAL',
    'federationParameters' => [
        'applicationCallBackURL' => '<string>',
        'attributeMap' => ['<string>', ...],
        'federationProviderName' => '<string>',
        'federationURN' => '<string>',
        'samlMetadataDocument' => '<string>',
        'samlMetadataURL' => '<string>',
    ],
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'awsAccountId' => '<string>',
        'dedicatedServiceAccountId' => '<string>',
        'description' => '<string>',
        'environmentArn' => '<string>',
        'environmentId' => '<string>',
        'environmentUrl' => '<string>',
        'federationMode' => 'FEDERATED|LOCAL',
        'federationParameters' => [
            'applicationCallBackURL' => '<string>',
            'attributeMap' => ['<string>', ...],
            'federationProviderName' => '<string>',
            'federationURN' => '<string>',
            'samlMetadataDocument' => '<string>',
            'samlMetadataURL' => '<string>',
        ],
        'kmsKeyId' => '<string>',
        'name' => '<string>',
        'sageMakerStudioDomainUrl' => '<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',
    ],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

InternalServerException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

UpdateKxClusterCodeConfiguration

$result = $client->updateKxClusterCodeConfiguration([/* ... */]);
$promise = $client->updateKxClusterCodeConfigurationAsync([/* ... */]);

Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.

Parameter Syntax

$result = $client->updateKxClusterCodeConfiguration([
    'clientToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'code' => [ // REQUIRED
        's3Bucket' => '<string>',
        's3Key' => '<string>',
        's3ObjectVersion' => '<string>',
    ],
    'commandLineArguments' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'deploymentConfiguration' => [
        'deploymentStrategy' => 'NO_RESTART|ROLLING|FORCE', // REQUIRED
    ],
    'environmentId' => '<string>', // REQUIRED
    'initializationScript' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ValidationException:

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

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

UpdateKxClusterDatabases

$result = $client->updateKxClusterDatabases([/* ... */]);
$promise = $client->updateKxClusterDatabasesAsync([/* ... */]);

Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

Parameter Syntax

$result = $client->updateKxClusterDatabases([
    'clientToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'databases' => [ // REQUIRED
        [
            'cacheConfigurations' => [
                [
                    'cacheType' => '<string>', // REQUIRED
                    'dataviewName' => '<string>',
                    'dbPaths' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'changesetId' => '<string>',
            'databaseName' => '<string>', // REQUIRED
            'dataviewConfiguration' => [
                'changesetId' => '<string>',
                'dataviewName' => '<string>',
                'dataviewVersionId' => '<string>',
                'segmentConfigurations' => [
                    [
                        'dbPaths' => ['<string>', ...], // REQUIRED
                        'onDemand' => true || false,
                        'volumeName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'dataviewName' => '<string>',
        ],
        // ...
    ],
    'deploymentConfiguration' => [
        'deploymentStrategy' => 'NO_RESTART|ROLLING', // REQUIRED
    ],
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

LimitExceededException:

A service limit or quota is exceeded.

ValidationException:

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

ConflictException:

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

ResourceNotFoundException:

One or more resources can't be found.

UpdateKxDatabase

$result = $client->updateKxDatabase([/* ... */]);
$promise = $client->updateKxDatabaseAsync([/* ... */]);

Updates information for the given kdb database.

Parameter Syntax

$result = $client->updateKxDatabase([
    'clientToken' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'description' => '<string>',
    'environmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'databaseName' => '<string>',
    'description' => '<string>',
    'environmentId' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

One or more resources can't be found.

ConflictException:

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

UpdateKxDataview

$result = $client->updateKxDataview([/* ... */]);
$promise = $client->updateKxDataviewAsync([/* ... */]);

Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations

Parameter Syntax

$result = $client->updateKxDataview([
    'changesetId' => '<string>',
    'clientToken' => '<string>', // REQUIRED
    'databaseName' => '<string>', // REQUIRED
    'dataviewName' => '<string>', // REQUIRED
    'description' => '<string>',
    'environmentId' => '<string>', // REQUIRED
    'segmentConfigurations' => [
        [
            'dbPaths' => ['<string>', ...], // REQUIRED
            'onDemand' => true || false,
            'volumeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'activeVersions' => [
        [
            'attachedClusters' => ['<string>', ...],
            'changesetId' => '<string>',
            'createdTimestamp' => <DateTime>,
            'segmentConfigurations' => [
                [
                    'dbPaths' => ['<string>', ...],
                    'onDemand' => true || false,
                    'volumeName' => '<string>',
                ],
                // ...
            ],
            'versionId' => '<string>',
        ],
        // ...
    ],
    'autoUpdate' => true || false,
    'availabilityZoneId' => '<string>',
    'azMode' => 'SINGLE|MULTI',
    'changesetId' => '<string>',
    'createdTimestamp' => <DateTime>,
    'databaseName' => '<string>',
    'dataviewName' => '<string>',
    'description' => '<string>',
    'environmentId' => '<string>',
    'lastModifiedTimestamp' => <DateTime>,
    'readWrite' => true || false,
    'segmentConfigurations' => [
        [
            'dbPaths' => ['<string>', ...],
            'onDemand' => true || false,
            'volumeName' => '<string>',
        ],
        // ...
    ],
    'status' => 'CREATING|ACTIVE|UPDATING|FAILED|DELETING',
]

Result Details