finspace

package module
v1.24.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 41 Imported by: 2

Documentation

Overview

Package finspace provides the API client, operations, and parameter types for FinSpace User Environment Management service.

The FinSpace management service provides the APIs for managing FinSpace environments.

Index

Constants

View Source 
const ServiceAPIVersion = "2021-03-12"
View Source 
const ServiceID = "finspace"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.11.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.17.0 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.17.0 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.17.0 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.17.0 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for FinSpace User Environment Management service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateEnvironment deprecated 

func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)

Create a new FinSpace environment.

Deprecated: This method will be discontinued.

func (*Client) CreateKxChangeset added in v1.10.0 

func (c *Client) CreateKxChangeset(ctx context.Context, params *CreateKxChangesetInput, optFns ...func(*Options)) (*CreateKxChangesetOutput, error)

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.

func (*Client) CreateKxCluster added in v1.10.0 

func (c *Client) CreateKxCluster(ctx context.Context, params *CreateKxClusterInput, optFns ...func(*Options)) (*CreateKxClusterOutput, error)

Creates a new kdb cluster.

func (*Client) CreateKxDatabase added in v1.10.0 

func (c *Client) CreateKxDatabase(ctx context.Context, params *CreateKxDatabaseInput, optFns ...func(*Options)) (*CreateKxDatabaseOutput, error)

Creates a new kdb database in the environment.

func (*Client) CreateKxDataview added in v1.20.0 

func (c *Client) CreateKxDataview(ctx context.Context, params *CreateKxDataviewInput, optFns ...func(*Options)) (*CreateKxDataviewOutput, error)

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.

func (*Client) CreateKxEnvironment added in v1.10.0 

func (c *Client) CreateKxEnvironment(ctx context.Context, params *CreateKxEnvironmentInput, optFns ...func(*Options)) (*CreateKxEnvironmentOutput, error)

Creates a managed kdb environment for the account.

func (*Client) CreateKxScalingGroup added in v1.20.0 

func (c *Client) CreateKxScalingGroup(ctx context.Context, params *CreateKxScalingGroupInput, optFns ...func(*Options)) (*CreateKxScalingGroupOutput, error)

Creates a new scaling group.

func (*Client) CreateKxUser added in v1.10.0 

func (c *Client) CreateKxUser(ctx context.Context, params *CreateKxUserInput, optFns ...func(*Options)) (*CreateKxUserOutput, error)

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

func (*Client) CreateKxVolume added in v1.20.0 

func (c *Client) CreateKxVolume(ctx context.Context, params *CreateKxVolumeInput, optFns ...func(*Options)) (*CreateKxVolumeOutput, error)

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

func (*Client) DeleteEnvironment deprecated 

func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error)

Delete an FinSpace environment.

Deprecated: This method will be discontinued.

func (*Client) DeleteKxCluster added in v1.10.0 

func (c *Client) DeleteKxCluster(ctx context.Context, params *DeleteKxClusterInput, optFns ...func(*Options)) (*DeleteKxClusterOutput, error)

Deletes a kdb cluster.

func (*Client) DeleteKxClusterNode added in v1.24.0 

func (c *Client) DeleteKxClusterNode(ctx context.Context, params *DeleteKxClusterNodeInput, optFns ...func(*Options)) (*DeleteKxClusterNodeOutput, error)

Deletes the specified nodes from a cluster.

func (*Client) DeleteKxDatabase added in v1.10.0 

func (c *Client) DeleteKxDatabase(ctx context.Context, params *DeleteKxDatabaseInput, optFns ...func(*Options)) (*DeleteKxDatabaseOutput, error)

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.

func (*Client) DeleteKxDataview added in v1.20.0 

func (c *Client) DeleteKxDataview(ctx context.Context, params *DeleteKxDataviewInput, optFns ...func(*Options)) (*DeleteKxDataviewOutput, error)

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

func (*Client) DeleteKxEnvironment added in v1.10.0 

func (c *Client) DeleteKxEnvironment(ctx context.Context, params *DeleteKxEnvironmentInput, optFns ...func(*Options)) (*DeleteKxEnvironmentOutput, error)

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

func (*Client) DeleteKxScalingGroup added in v1.20.0 

func (c *Client) DeleteKxScalingGroup(ctx context.Context, params *DeleteKxScalingGroupInput, optFns ...func(*Options)) (*DeleteKxScalingGroupOutput, error)

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.

func (*Client) DeleteKxUser added in v1.10.0 

func (c *Client) DeleteKxUser(ctx context.Context, params *DeleteKxUserInput, optFns ...func(*Options)) (*DeleteKxUserOutput, error)

Deletes a user in the specified kdb environment.

func (*Client) DeleteKxVolume added in v1.20.0 

func (c *Client) DeleteKxVolume(ctx context.Context, params *DeleteKxVolumeInput, optFns ...func(*Options)) (*DeleteKxVolumeOutput, error)

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.

func (*Client) GetEnvironment deprecated 

func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error)

Returns the FinSpace environment object.

Deprecated: This method will be discontinued.

func (*Client) GetKxChangeset added in v1.10.0 

func (c *Client) GetKxChangeset(ctx context.Context, params *GetKxChangesetInput, optFns ...func(*Options)) (*GetKxChangesetOutput, error)

Returns information about a kdb changeset.

func (*Client) GetKxCluster added in v1.10.0 

func (c *Client) GetKxCluster(ctx context.Context, params *GetKxClusterInput, optFns ...func(*Options)) (*GetKxClusterOutput, error)

Retrieves information about a kdb cluster.

func (*Client) GetKxConnectionString added in v1.10.0 

func (c *Client) GetKxConnectionString(ctx context.Context, params *GetKxConnectionStringInput, optFns ...func(*Options)) (*GetKxConnectionStringOutput, error)

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.

func (*Client) GetKxDatabase added in v1.10.0 

func (c *Client) GetKxDatabase(ctx context.Context, params *GetKxDatabaseInput, optFns ...func(*Options)) (*GetKxDatabaseOutput, error)

Returns database information for the specified environment ID.

func (*Client) GetKxDataview added in v1.20.0 

func (c *Client) GetKxDataview(ctx context.Context, params *GetKxDataviewInput, optFns ...func(*Options)) (*GetKxDataviewOutput, error)

Retrieves details of the dataview.

func (*Client) GetKxEnvironment added in v1.10.0 

func (c *Client) GetKxEnvironment(ctx context.Context, params *GetKxEnvironmentInput, optFns ...func(*Options)) (*GetKxEnvironmentOutput, error)

Retrieves all the information for the specified kdb environment.

func (*Client) GetKxScalingGroup added in v1.20.0 

func (c *Client) GetKxScalingGroup(ctx context.Context, params *GetKxScalingGroupInput, optFns ...func(*Options)) (*GetKxScalingGroupOutput, error)

Retrieves details of a scaling group.

func (*Client) GetKxUser added in v1.10.0 

func (c *Client) GetKxUser(ctx context.Context, params *GetKxUserInput, optFns ...func(*Options)) (*GetKxUserOutput, error)

Retrieves information about the specified kdb user.

func (*Client) GetKxVolume added in v1.20.0 

func (c *Client) GetKxVolume(ctx context.Context, params *GetKxVolumeInput, optFns ...func(*Options)) (*GetKxVolumeOutput, error)

Retrieves the information about the volume.

func (*Client) ListEnvironments deprecated 

func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)

A list of all of your FinSpace environments.

Deprecated: This method will be discontinued.

func (*Client) ListKxChangesets added in v1.10.0 

func (c *Client) ListKxChangesets(ctx context.Context, params *ListKxChangesetsInput, optFns ...func(*Options)) (*ListKxChangesetsOutput, error)

Returns a list of all the changesets for a database.

func (*Client) ListKxClusterNodes added in v1.10.0 

func (c *Client) ListKxClusterNodes(ctx context.Context, params *ListKxClusterNodesInput, optFns ...func(*Options)) (*ListKxClusterNodesOutput, error)

Lists all the nodes in a kdb cluster.

func (*Client) ListKxClusters added in v1.10.0 

func (c *Client) ListKxClusters(ctx context.Context, params *ListKxClustersInput, optFns ...func(*Options)) (*ListKxClustersOutput, error)

Returns a list of clusters.

func (*Client) ListKxDatabases added in v1.10.0 

func (c *Client) ListKxDatabases(ctx context.Context, params *ListKxDatabasesInput, optFns ...func(*Options)) (*ListKxDatabasesOutput, error)

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

func (*Client) ListKxDataviews added in v1.20.0 

func (c *Client) ListKxDataviews(ctx context.Context, params *ListKxDataviewsInput, optFns ...func(*Options)) (*ListKxDataviewsOutput, error)

Returns a list of all the dataviews in the database.

func (*Client) ListKxEnvironments added in v1.10.0 

func (c *Client) ListKxEnvironments(ctx context.Context, params *ListKxEnvironmentsInput, optFns ...func(*Options)) (*ListKxEnvironmentsOutput, error)

Returns a list of kdb environments created in an account.

func (*Client) ListKxScalingGroups added in v1.20.0 

func (c *Client) ListKxScalingGroups(ctx context.Context, params *ListKxScalingGroupsInput, optFns ...func(*Options)) (*ListKxScalingGroupsOutput, error)

Returns a list of scaling groups in a kdb environment.

func (*Client) ListKxUsers added in v1.10.0 

func (c *Client) ListKxUsers(ctx context.Context, params *ListKxUsersInput, optFns ...func(*Options)) (*ListKxUsersOutput, error)

Lists all the users in a kdb environment.

func (*Client) ListKxVolumes added in v1.20.0 

func (c *Client) ListKxVolumes(ctx context.Context, params *ListKxVolumesInput, optFns ...func(*Options)) (*ListKxVolumesOutput, error)

Lists all the volumes in a kdb environment.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

A list of all tags for a resource.

func (*Client) Options added in v1.18.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds metadata tags to a FinSpace resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes metadata tags from a FinSpace resource.

func (*Client) UpdateEnvironment deprecated 

func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error)

Update your FinSpace environment.

Deprecated: This method will be discontinued.

func (*Client) UpdateKxClusterCodeConfiguration added in v1.14.0 

func (c *Client) UpdateKxClusterCodeConfiguration(ctx context.Context, params *UpdateKxClusterCodeConfigurationInput, optFns ...func(*Options)) (*UpdateKxClusterCodeConfigurationOutput, error)

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.

func (*Client) UpdateKxClusterDatabases added in v1.10.0 

func (c *Client) UpdateKxClusterDatabases(ctx context.Context, params *UpdateKxClusterDatabasesInput, optFns ...func(*Options)) (*UpdateKxClusterDatabasesOutput, error)

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.

func (*Client) UpdateKxDatabase added in v1.10.0 

func (c *Client) UpdateKxDatabase(ctx context.Context, params *UpdateKxDatabaseInput, optFns ...func(*Options)) (*UpdateKxDatabaseOutput, error)

Updates information for the given kdb database.

func (*Client) UpdateKxDataview added in v1.20.0 

func (c *Client) UpdateKxDataview(ctx context.Context, params *UpdateKxDataviewInput, optFns ...func(*Options)) (*UpdateKxDataviewOutput, error)

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

func (*Client) UpdateKxEnvironment added in v1.10.0 

func (c *Client) UpdateKxEnvironment(ctx context.Context, params *UpdateKxEnvironmentInput, optFns ...func(*Options)) (*UpdateKxEnvironmentOutput, error)

Updates information for the given kdb environment.

func (*Client) UpdateKxEnvironmentNetwork added in v1.10.0 

func (c *Client) UpdateKxEnvironmentNetwork(ctx context.Context, params *UpdateKxEnvironmentNetworkInput, optFns ...func(*Options)) (*UpdateKxEnvironmentNetworkOutput, error)

Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

func (*Client) UpdateKxUser added in v1.10.0 

func (c *Client) UpdateKxUser(ctx context.Context, params *UpdateKxUserInput, optFns ...func(*Options)) (*UpdateKxUserOutput, error)

Updates the user details. You can only update the IAM role associated with a user.

func (*Client) UpdateKxVolume added in v1.20.0 

func (c *Client) UpdateKxVolume(ctx context.Context, params *UpdateKxVolumeInput, optFns ...func(*Options)) (*UpdateKxVolumeOutput, error)

Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.

type CreateEnvironmentInput 

type CreateEnvironmentInput struct {

	// The name of the FinSpace environment to be created.
	//
	// This member is required.
	Name *string

	// The list of Amazon Resource Names (ARN) of the data bundles to install.
	// Currently supported data bundle ARNs:
	//   - arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains
	//   sample Capital Markets datasets, categories and controlled vocabularies.
	//   - arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and
	//   quotes data in addition to sample Capital Markets data.
	DataBundles []string

	// The description of the FinSpace environment to be created.
	Description *string

	// Authentication mode for the environment.
	//   - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your
	//   Identity provider.
	//   - LOCAL - Users access FinSpace via email and password managed within the
	//   FinSpace environment.
	FederationMode types.FederationMode

	// Configuration information when authentication mode is FEDERATED.
	FederationParameters *types.FederationParameters

	// The KMS key id to encrypt your data in the FinSpace environment.
	KmsKeyId *string

	// Configuration information for the superuser.
	SuperuserParameters *types.SuperuserParameters

	// Add tags to your FinSpace environment.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateEnvironmentOutput 

type CreateEnvironmentOutput struct {

	// The Amazon Resource Name (ARN) of the FinSpace environment that you created.
	EnvironmentArn *string

	// The unique identifier for FinSpace environment that you created.
	EnvironmentId *string

	// The sign-in URL for the web application of the FinSpace environment you created.
	EnvironmentUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxChangesetInput added in v1.10.0 

type CreateKxChangesetInput struct {

	// A list of change request objects that are run in order. A change request object
	// consists of changeType , s3Path , and dbPath . A changeType can have the
	// following values:
	//   - PUT – Adds or updates files in a database.
	//   - DELETE – Deletes files in a database.
	// All the change requests require a mandatory dbPath attribute that defines the
	// path within the database directory. All database paths must start with a leading
	// / and end with a trailing /. The s3Path attribute defines the s3 source file
	// path and is required for a PUT change type. The s3path must end with a trailing
	// / if it is a directory and must end without a trailing / if it is a file. Here
	// are few examples of how you can use the change request object:
	//   - This request adds a single sym file at database root location. {
	//   "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
	//   - This request adds files in the given s3Path under the 2020.01.02 partition
	//   of the database. { "changeType": "PUT",
	//   "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}
	//   - This request adds files in the given s3Path under the taq table partition of
	//   the database. [ { "changeType": "PUT",
	//   "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]
	//   - This request deletes the 2020.01.02 partition of the database. [{
	//   "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]
	//   - The DELETE request allows you to delete the existing files under the
	//   2020.01.02 partition of the database, and the PUT request adds a new taq table
	//   under it. [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType":
	//   "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]
	//
	// This member is required.
	ChangeRequests []types.ChangeRequest

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// The name of the kdb database.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier of the kdb environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type CreateKxChangesetOutput added in v1.10.0 

type CreateKxChangesetOutput struct {

	// A list of change requests.
	ChangeRequests []types.ChangeRequest

	// A unique identifier for the changeset.
	ChangesetId *string

	// The timestamp at which the changeset 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.
	CreatedTimestamp *time.Time

	// The name of the kdb database.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// The details of the error that you receive when creating a changeset. It
	// consists of the type of error and the error message.
	ErrorInfo *types.ErrorInfo

	// The timestamp at which the changeset was updated 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.
	LastModifiedTimestamp *time.Time

	// Status of the changeset creation process.
	//   - Pending – Changeset creation is pending.
	//   - Processing – Changeset creation is running.
	//   - Failed – Changeset creation has failed.
	//   - Complete – Changeset creation has succeeded.
	Status types.ChangesetStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxClusterInput added in v1.10.0 

type CreateKxClusterInput struct {

	// The number of availability zones you want to assign per cluster. This can be
	// one of the following
	//   - SINGLE – Assigns one availability zone per cluster.
	//   - MULTI – Assigns all the availability zones per cluster.
	//
	// This member is required.
	AzMode types.KxAzMode

	// A unique name for the cluster that you want to create.
	//
	// This member is required.
	ClusterName *string

	// Specifies the type of KDB database that is being created. The following types
	// are available:
	//   - HDB – A Historical Database. The data is only accessible with read-only
	//   permissions from one of the FinSpace managed kdb databases mounted to the
	//   cluster.
	//   - RDB – A Realtime Database. This type of database captures all the data from
	//   a ticker plant and stores it in memory until the end of day, after which it
	//   writes all of its data to a disk and reloads the HDB. This cluster type requires
	//   local storage for temporary storage of data during the savedown process. If you
	//   specify this field in your request, you must provide the
	//   savedownStorageConfiguration parameter.
	//   - GATEWAY – A gateway cluster allows you to access data across processes in
	//   kdb systems. It allows you to create your own routing logic using the
	//   initialization scripts and custom code. This type of cluster does not require a
	//   writable local storage.
	//   - GP – A general purpose cluster allows you to quickly iterate on code during
	//   development by granting greater access to system commands and enabling a fast
	//   reload of custom code. This cluster type can optionally mount databases
	//   including cache and savedown storage. For this cluster type, the node count is
	//   fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
	//   - Tickerplant – A tickerplant cluster allows you to subscribe to feed
	//   handlers based on IAM permissions. It can publish to RDBs, other Tickerplants,
	//   and real-time subscribers (RTS). Tickerplants can persist messages to log, which
	//   is readable by any RDB environment. It supports only single-node that is only
	//   one kdb process.
	//
	// This member is required.
	ClusterType types.KxClusterType

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// The version of FinSpace managed kdb to run.
	//
	// This member is required.
	ReleaseLabel *string

	// Configuration details about the network where the Privatelink endpoint of the
	// cluster resides.
	//
	// This member is required.
	VpcConfiguration *types.VpcConfiguration

	// The configuration based on which FinSpace will scale in or scale out nodes in
	// your cluster.
	AutoScalingConfiguration *types.AutoScalingConfiguration

	// The availability zone identifiers for the requested regions.
	AvailabilityZoneId *string

	// The configurations for a read only cache storage associated with a cluster.
	// This cache will be stored as an FSx Lustre that reads from the S3 store.
	CacheStorageConfigurations []types.KxCacheStorageConfiguration

	// A structure for the metadata of a cluster. It includes information like the
	// CPUs needed, memory of instances, and number of instances.
	CapacityConfiguration *types.CapacityConfiguration

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// A description of the cluster.
	ClusterDescription *string

	// The details of the custom code that you want to use inside a cluster when
	// analyzing a data. It consists of the S3 source bucket, location, S3 object
	// version, and the relative path from where the custom code is loaded into the
	// cluster.
	Code *types.CodeConfiguration

	// Defines the key-value pairs to make them available inside the cluster.
	CommandLineArguments []types.KxCommandLineArgument

	// A list of databases that will be available for querying.
	Databases []types.KxDatabaseConfiguration

	// An IAM role that defines a set of permissions associated with a cluster. These
	// permissions are assumed when a cluster attempts to access another cluster.
	ExecutionRole *string

	// Specifies a Q program that will be run at launch of a cluster. It is a relative
	// path within .zip file that contains the custom code, which will be loaded on the
	// cluster. It must include the file name itself. For example, somedir/init.q .
	InitializationScript *string

	// The size and type of the temporary storage that is used to hold data during the
	// savedown process. This parameter is required when you choose clusterType as
	// RDB. All the data written to this storage space is lost when the cluster node is
	// restarted.
	SavedownStorageConfiguration *types.KxSavedownStorageConfiguration

	// The structure that stores the configuration details of a scaling group.
	ScalingGroupConfiguration *types.KxScalingGroupConfiguration

	// A list of key-value pairs to label the cluster. You can add up to 50 tags to a
	// cluster.
	Tags map[string]string

	// A configuration to store Tickerplant logs. It consists of a list of volumes
	// that will be mounted to your cluster. For the cluster type Tickerplant , the
	// location of the TP volume on the cluster will be available by using the global
	// variable .aws.tp_log_path .
	TickerplantLogConfiguration *types.TickerplantLogConfiguration
	// contains filtered or unexported fields
}

type CreateKxClusterOutput added in v1.10.0 

type CreateKxClusterOutput struct {

	// The configuration based on which FinSpace will scale in or scale out nodes in
	// your cluster.
	AutoScalingConfiguration *types.AutoScalingConfiguration

	// The availability zone identifiers for the requested regions.
	AvailabilityZoneId *string

	// The number of availability zones you want to assign per cluster. This can be
	// one of the following
	//   - SINGLE – Assigns one availability zone per cluster.
	//   - MULTI – Assigns all the availability zones per cluster.
	AzMode types.KxAzMode

	// The configurations for a read only cache storage associated with a cluster.
	// This cache will be stored as an FSx Lustre that reads from the S3 store.
	CacheStorageConfigurations []types.KxCacheStorageConfiguration

	// A structure for the metadata of a cluster. It includes information like the
	// CPUs needed, memory of instances, and number of instances.
	CapacityConfiguration *types.CapacityConfiguration

	// A description of the cluster.
	ClusterDescription *string

	// A unique name for the cluster.
	ClusterName *string

	// Specifies the type of KDB database that is being created. The following types
	// are available:
	//   - HDB – A Historical Database. The data is only accessible with read-only
	//   permissions from one of the FinSpace managed kdb databases mounted to the
	//   cluster.
	//   - RDB – A Realtime Database. This type of database captures all the data from
	//   a ticker plant and stores it in memory until the end of day, after which it
	//   writes all of its data to a disk and reloads the HDB. This cluster type requires
	//   local storage for temporary storage of data during the savedown process. If you
	//   specify this field in your request, you must provide the
	//   savedownStorageConfiguration parameter.
	//   - GATEWAY – A gateway cluster allows you to access data across processes in
	//   kdb systems. It allows you to create your own routing logic using the
	//   initialization scripts and custom code. This type of cluster does not require a
	//   writable local storage.
	//   - GP – A general purpose cluster allows you to quickly iterate on code during
	//   development by granting greater access to system commands and enabling a fast
	//   reload of custom code. This cluster type can optionally mount databases
	//   including cache and savedown storage. For this cluster type, the node count is
	//   fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
	//   - Tickerplant – A tickerplant cluster allows you to subscribe to feed
	//   handlers based on IAM permissions. It can publish to RDBs, other Tickerplants,
	//   and real-time subscribers (RTS). Tickerplants can persist messages to log, which
	//   is readable by any RDB environment. It supports only single-node that is only
	//   one kdb process.
	ClusterType types.KxClusterType

	// The details of the custom code that you want to use inside a cluster when
	// analyzing a data. It consists of the S3 source bucket, location, S3 object
	// version, and the relative path from where the custom code is loaded into the
	// cluster.
	Code *types.CodeConfiguration

	// Defines the key-value pairs to make them available inside the cluster.
	CommandLineArguments []types.KxCommandLineArgument

	// The timestamp at which the cluster 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.
	CreatedTimestamp *time.Time

	// A list of databases that will be available for querying.
	Databases []types.KxDatabaseConfiguration

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// An IAM role that defines a set of permissions associated with a cluster. These
	// permissions are assumed when a cluster attempts to access another cluster.
	ExecutionRole *string

	// Specifies a Q program that will be run at launch of a cluster. It is a relative
	// path within .zip file that contains the custom code, which will be loaded on the
	// cluster. It must include the file name itself. For example, somedir/init.q .
	InitializationScript *string

	// The last time that the cluster was modified. 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.
	LastModifiedTimestamp *time.Time

	// A version of the FinSpace managed kdb to run.
	ReleaseLabel *string

	// The size and type of the temporary storage that is used to hold data during the
	// savedown process. This parameter is required when you choose clusterType as
	// RDB. All the data written to this storage space is lost when the cluster node is
	// restarted.
	SavedownStorageConfiguration *types.KxSavedownStorageConfiguration

	// The structure that stores the configuration details of a scaling group.
	ScalingGroupConfiguration *types.KxScalingGroupConfiguration

	// The status of cluster creation.
	//   - PENDING – The cluster is pending creation.
	//   - CREATING – The cluster creation process is in progress.
	//   - CREATE_FAILED – The cluster creation process has failed.
	//   - RUNNING – The cluster creation process is running.
	//   - UPDATING – The cluster is in the process of being updated.
	//   - DELETING – The cluster is in the process of being deleted.
	//   - DELETED – The cluster has been deleted.
	//   - DELETE_FAILED – The cluster failed to delete.
	Status types.KxClusterStatus

	// The error message when a failed state occurs.
	StatusReason *string

	// A configuration to store the Tickerplant logs. It consists of a list of volumes
	// that will be mounted to your cluster. For the cluster type Tickerplant , the
	// location of the TP volume on the cluster will be available by using the global
	// variable .aws.tp_log_path .
	TickerplantLogConfiguration *types.TickerplantLogConfiguration

	// A list of volumes mounted on the cluster.
	Volumes []types.Volume

	// Configuration details about the network where the Privatelink endpoint of the
	// cluster resides.
	VpcConfiguration *types.VpcConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxDatabaseInput added in v1.10.0 

type CreateKxDatabaseInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// The name of the kdb database.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A description of the database.
	Description *string

	// A list of key-value pairs to label the kdb database. You can add up to 50 tags
	// to your kdb database
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateKxDatabaseOutput added in v1.10.0 

type CreateKxDatabaseOutput struct {

	// The timestamp at which the database is 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.
	CreatedTimestamp *time.Time

	// The ARN identifier of the database.
	DatabaseArn *string

	// The name of the kdb database.
	DatabaseName *string

	// A description of the database.
	Description *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// The last time that the database was updated 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.
	LastModifiedTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxDataviewInput added in v1.20.0 

type CreateKxDataviewInput struct {

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	//
	// This member is required.
	AzMode types.KxAzMode

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// The name of the database where you want to create a dataview.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the dataview.
	//
	// This member is required.
	DataviewName *string

	// A unique identifier for the kdb environment, where you want to create the
	// dataview.
	//
	// This member is required.
	EnvironmentId *string

	// The option to specify whether you want to apply all the future additions and
	// corrections automatically to the dataview, when you ingest new changesets. The
	// default value is false.
	AutoUpdate bool

	// The identifier of the availability zones.
	AvailabilityZoneId *string

	// A unique identifier of the changeset that you want to use to ingest data.
	ChangesetId *string

	// A description of the dataview.
	Description *string

	// The option to specify whether you want to make the dataview writable to perform
	// database maintenance. The following are some considerations related to writable
	// dataviews.
	//   - You cannot create partial writable dataviews. When you create writeable
	//   dataviews you must provide the entire database path.
	//   - You cannot perform updates on a writeable dataview. Hence, autoUpdate must
	//   be set as False if readWrite is True for a dataview.
	//   - You must also use a unique volume for creating a writeable dataview. So, if
	//   you choose a volume that is already in use by another dataview, the dataview
	//   creation fails.
	//   - Once you create a dataview as writeable, you cannot change it to read-only.
	//   So, you cannot update the readWrite parameter later.
	ReadWrite bool

	// The configuration that contains the database path of the data that you want to
	// place on each selected volume. Each segment must have a unique database path for
	// each volume. If you do not explicitly specify any database path for a volume,
	// they are accessible from the cluster through the default S3/object store
	// segment.
	SegmentConfigurations []types.KxDataviewSegmentConfiguration

	// A list of key-value pairs to label the dataview. You can add up to 50 tags to a
	// dataview.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateKxDataviewOutput added in v1.20.0 

type CreateKxDataviewOutput struct {

	// The option to select whether you want to apply all the future additions and
	// corrections automatically to the dataview when you ingest new changesets. The
	// default value is false.
	AutoUpdate bool

	// The identifier of the availability zones.
	AvailabilityZoneId *string

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	AzMode types.KxAzMode

	// A unique identifier for the changeset.
	ChangesetId *string

	// The timestamp at which the dataview 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.
	CreatedTimestamp *time.Time

	// The name of the database where you want to create a dataview.
	DatabaseName *string

	// A unique identifier for the dataview.
	DataviewName *string

	// A description of the dataview.
	Description *string

	// A unique identifier for the kdb environment, where you want to create the
	// dataview.
	EnvironmentId *string

	// The last time that the dataview was updated 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.
	LastModifiedTimestamp *time.Time

	// Returns True if the dataview is created as writeable and False otherwise.
	ReadWrite bool

	// The configuration that contains the database path of the data that you want to
	// place on each selected volume. Each segment must have a unique database path for
	// each volume. If you do not explicitly specify any database path for a volume,
	// they are accessible from the cluster through the default S3/object store
	// segment.
	SegmentConfigurations []types.KxDataviewSegmentConfiguration

	// The status of dataview creation.
	//   - CREATING – The dataview creation is in progress.
	//   - UPDATING – The dataview is in the process of being updated.
	//   - ACTIVE – The dataview is active.
	Status types.KxDataviewStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxEnvironmentInput added in v1.10.0 

type CreateKxEnvironmentInput struct {

	// The KMS key ID to encrypt your data in the FinSpace environment.
	//
	// This member is required.
	KmsKeyId *string

	// The name of the kdb environment that you want to create.
	//
	// This member is required.
	Name *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// A description for the kdb environment.
	Description *string

	// A list of key-value pairs to label the kdb environment. You can add up to 50
	// tags to your kdb environment.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateKxEnvironmentOutput added in v1.10.0 

type CreateKxEnvironmentOutput struct {

	// The timestamp at which the kdb environment was created in FinSpace.
	CreationTimestamp *time.Time

	// A description for the kdb environment.
	Description *string

	// The ARN identifier of the environment.
	EnvironmentArn *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// The KMS key ID to encrypt your data in the FinSpace environment.
	KmsKeyId *string

	// The name of the kdb environment.
	Name *string

	// The status of the kdb environment.
	Status types.EnvironmentStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxScalingGroupInput added in v1.20.0 

type CreateKxScalingGroupInput struct {

	// The identifier of the availability zones.
	//
	// This member is required.
	AvailabilityZoneId *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// A unique identifier for the kdb environment, where you want to create the
	// scaling group.
	//
	// This member is required.
	EnvironmentId *string

	// The memory and CPU capabilities of the scaling group host on which FinSpace
	// Managed kdb clusters will be placed. You can add one of the following values:
	//   - kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16
	//   vCPUs.
	//   - kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32
	//   vCPUs.
	//   - kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64
	//   vCPUs.
	//   - kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and
	//   128 vCPUs.
	//   - kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and
	//   64 vCPUs.
	//   - kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and
	//   96 vCPUs.
	//
	// This member is required.
	HostType *string

	// A unique identifier for the kdb scaling group.
	//
	// This member is required.
	ScalingGroupName *string

	// A list of key-value pairs to label the scaling group. You can add up to 50 tags
	// to a scaling group.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateKxScalingGroupOutput added in v1.20.0 

type CreateKxScalingGroupOutput struct {

	// The identifier of the availability zones.
	AvailabilityZoneId *string

	// The timestamp at which the scaling group 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.
	CreatedTimestamp *time.Time

	// A unique identifier for the kdb environment, where you create the scaling group.
	EnvironmentId *string

	// The memory and CPU capabilities of the scaling group host on which FinSpace
	// Managed kdb clusters will be placed.
	HostType *string

	// The last time that the scaling group was updated 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.
	LastModifiedTimestamp *time.Time

	// A unique identifier for the kdb scaling group.
	ScalingGroupName *string

	// The status of scaling group.
	//   - CREATING – The scaling group creation is in progress.
	//   - CREATE_FAILED – The scaling group creation has failed.
	//   - ACTIVE – The scaling group is active.
	//   - UPDATING – The scaling group is in the process of being updated.
	//   - UPDATE_FAILED – The update action failed.
	//   - DELETING – The scaling group is in the process of being deleted.
	//   - DELETE_FAILED – The system failed to delete the scaling group.
	//   - DELETED – The scaling group is successfully deleted.
	Status types.KxScalingGroupStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxUserInput added in v1.10.0 

type CreateKxUserInput struct {

	// A unique identifier for the kdb environment where you want to create a user.
	//
	// This member is required.
	EnvironmentId *string

	// The IAM role ARN that will be associated with the user.
	//
	// This member is required.
	IamRole *string

	// A unique identifier for the user.
	//
	// This member is required.
	UserName *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// A list of key-value pairs to label the user. You can add up to 50 tags to a
	// user.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateKxUserOutput added in v1.10.0 

type CreateKxUserOutput struct {

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// The IAM role ARN that will be associated with the user.
	IamRole *string

	// The Amazon Resource Name (ARN) that identifies the user. For more information
	// about ARNs and how to use ARNs in policies, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the IAM User Guide.
	UserArn *string

	// A unique identifier for the user.
	UserName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKxVolumeInput added in v1.20.0 

type CreateKxVolumeInput struct {

	// The identifier of the availability zones.
	//
	// This member is required.
	AvailabilityZoneIds []string

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	//
	// This member is required.
	AzMode types.KxAzMode

	// A unique identifier for the kdb environment, whose clusters can attach to the
	// volume.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the volume.
	//
	// This member is required.
	VolumeName *string

	// The type of file system volume. Currently, FinSpace only supports NAS_1 volume
	// type. When you select NAS_1 volume type, you must also provide nas1Configuration
	// .
	//
	// This member is required.
	VolumeType types.KxVolumeType

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// A description of the volume.
	Description *string

	// Specifies the configuration for the Network attached storage (NAS_1) file
	// system volume. This parameter is required when you choose volumeType as NAS_1.
	Nas1Configuration *types.KxNAS1Configuration

	// A list of key-value pairs to label the volume. You can add up to 50 tags to a
	// volume.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateKxVolumeOutput added in v1.20.0 

type CreateKxVolumeOutput struct {

	// The identifier of the availability zones.
	AvailabilityZoneIds []string

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	AzMode types.KxAzMode

	// The timestamp at which the volume 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.
	CreatedTimestamp *time.Time

	// A description of the volume.
	Description *string

	// A unique identifier for the kdb environment, whose clusters can attach to the
	// volume.
	EnvironmentId *string

	// Specifies the configuration for the Network attached storage (NAS_1) file
	// system volume.
	Nas1Configuration *types.KxNAS1Configuration

	// The status of volume creation.
	//   - CREATING – The volume creation is in progress.
	//   - CREATE_FAILED – The volume creation has failed.
	//   - ACTIVE – The volume is active.
	//   - UPDATING – The volume is in the process of being updated.
	//   - UPDATE_FAILED – The update action failed.
	//   - UPDATED – The volume is successfully updated.
	//   - DELETING – The volume is in the process of being deleted.
	//   - DELETE_FAILED – The system failed to delete the volume.
	//   - DELETED – The volume is successfully deleted.
	Status types.KxVolumeStatus

	// The error message when a failed state occurs.
	StatusReason *string

	// The ARN identifier of the volume.
	VolumeArn *string

	// A unique identifier for the volume.
	VolumeName *string

	// The type of file system volume. Currently, FinSpace only supports NAS_1 volume
	// type.
	VolumeType types.KxVolumeType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEnvironmentInput 

type DeleteEnvironmentInput struct {

	// The identifier for the FinSpace environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type DeleteEnvironmentOutput 

type DeleteEnvironmentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxClusterInput added in v1.10.0 

type DeleteKxClusterInput struct {

	// The name of the cluster that you want to delete.
	//
	// This member is required.
	ClusterName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteKxClusterNodeInput added in v1.24.0 

type DeleteKxClusterNodeInput struct {

	// The name of the cluster, for which you want to delete the nodes.
	//
	// This member is required.
	ClusterName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the node that you want to delete.
	//
	// This member is required.
	NodeId *string
	// contains filtered or unexported fields
}

type DeleteKxClusterNodeOutput added in v1.24.0 

type DeleteKxClusterNodeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxClusterOutput added in v1.10.0 

type DeleteKxClusterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxDatabaseInput added in v1.10.0 

type DeleteKxDatabaseInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// The name of the kdb database that you want to delete.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type DeleteKxDatabaseOutput added in v1.10.0 

type DeleteKxDatabaseOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxDataviewInput added in v1.20.0 

type DeleteKxDataviewInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// The name of the database whose dataview you want to delete.
	//
	// This member is required.
	DatabaseName *string

	// The name of the dataview that you want to delete.
	//
	// This member is required.
	DataviewName *string

	// A unique identifier for the kdb environment, from where you want to delete the
	// dataview.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type DeleteKxDataviewOutput added in v1.20.0 

type DeleteKxDataviewOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxEnvironmentInput added in v1.10.0 

type DeleteKxEnvironmentInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteKxEnvironmentOutput added in v1.10.0 

type DeleteKxEnvironmentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxScalingGroupInput added in v1.20.0 

type DeleteKxScalingGroupInput struct {

	// A unique identifier for the kdb environment, from where you want to delete the
	// dataview.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the kdb scaling group.
	//
	// This member is required.
	ScalingGroupName *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteKxScalingGroupOutput added in v1.20.0 

type DeleteKxScalingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxUserInput added in v1.10.0 

type DeleteKxUserInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the user that you want to delete.
	//
	// This member is required.
	UserName *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteKxUserOutput added in v1.10.0 

type DeleteKxUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKxVolumeInput added in v1.20.0 

type DeleteKxVolumeInput struct {

	// A unique identifier for the kdb environment, whose clusters can attach to the
	// volume.
	//
	// This member is required.
	EnvironmentId *string

	// The name of the volume that you want to delete.
	//
	// This member is required.
	VolumeName *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteKxVolumeOutput added in v1.20.0 

type DeleteKxVolumeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.11.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.11.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.11.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.11.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.11.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetEnvironmentInput 

type GetEnvironmentInput struct {

	// The identifier of the FinSpace environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type GetEnvironmentOutput 

type GetEnvironmentOutput struct {

	// The name of the FinSpace environment.
	Environment *types.Environment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxChangesetInput added in v1.10.0 

type GetKxChangesetInput struct {

	// A unique identifier of the changeset for which you want to retrieve data.
	//
	// This member is required.
	ChangesetId *string

	// The name of the kdb database.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type GetKxChangesetOutput added in v1.10.0 

type GetKxChangesetOutput struct {

	// Beginning time from which the changeset is active. 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.
	ActiveFromTimestamp *time.Time

	// A list of change request objects that are run in order.
	ChangeRequests []types.ChangeRequest

	// A unique identifier for the changeset.
	ChangesetId *string

	// The timestamp at which the changeset 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.
	CreatedTimestamp *time.Time

	// The name of the kdb database.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// Provides details in the event of a failed flow, including the error type and
	// the related error message.
	ErrorInfo *types.ErrorInfo

	// The timestamp at which the changeset was updated 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.
	LastModifiedTimestamp *time.Time

	// Status of the changeset creation process.
	//   - Pending – Changeset creation is pending.
	//   - Processing – Changeset creation is running.
	//   - Failed – Changeset creation has failed.
	//   - Complete – Changeset creation has succeeded.
	Status types.ChangesetStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxClusterInput added in v1.10.0 

type GetKxClusterInput struct {

	// The name of the cluster that you want to retrieve.
	//
	// This member is required.
	ClusterName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type GetKxClusterOutput added in v1.10.0 

type GetKxClusterOutput struct {

	// The configuration based on which FinSpace will scale in or scale out nodes in
	// your cluster.
	AutoScalingConfiguration *types.AutoScalingConfiguration

	// The availability zone identifiers for the requested regions.
	AvailabilityZoneId *string

	// The number of availability zones you want to assign per cluster. This can be
	// one of the following
	//   - SINGLE – Assigns one availability zone per cluster.
	//   - MULTI – Assigns all the availability zones per cluster.
	AzMode types.KxAzMode

	// The configurations for a read only cache storage associated with a cluster.
	// This cache will be stored as an FSx Lustre that reads from the S3 store.
	CacheStorageConfigurations []types.KxCacheStorageConfiguration

	// A structure for the metadata of a cluster. It includes information like the
	// CPUs needed, memory of instances, and number of instances.
	CapacityConfiguration *types.CapacityConfiguration

	// A description of the cluster.
	ClusterDescription *string

	// A unique name for the cluster.
	ClusterName *string

	// Specifies the type of KDB database that is being created. The following types
	// are available:
	//   - HDB – A Historical Database. The data is only accessible with read-only
	//   permissions from one of the FinSpace managed kdb databases mounted to the
	//   cluster.
	//   - RDB – A Realtime Database. This type of database captures all the data from
	//   a ticker plant and stores it in memory until the end of day, after which it
	//   writes all of its data to a disk and reloads the HDB. This cluster type requires
	//   local storage for temporary storage of data during the savedown process. If you
	//   specify this field in your request, you must provide the
	//   savedownStorageConfiguration parameter.
	//   - GATEWAY – A gateway cluster allows you to access data across processes in
	//   kdb systems. It allows you to create your own routing logic using the
	//   initialization scripts and custom code. This type of cluster does not require a
	//   writable local storage.
	//   - GP – A general purpose cluster allows you to quickly iterate on code during
	//   development by granting greater access to system commands and enabling a fast
	//   reload of custom code. This cluster type can optionally mount databases
	//   including cache and savedown storage. For this cluster type, the node count is
	//   fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
	//   - Tickerplant – A tickerplant cluster allows you to subscribe to feed
	//   handlers based on IAM permissions. It can publish to RDBs, other Tickerplants,
	//   and real-time subscribers (RTS). Tickerplants can persist messages to log, which
	//   is readable by any RDB environment. It supports only single-node that is only
	//   one kdb process.
	ClusterType types.KxClusterType

	// The details of the custom code that you want to use inside a cluster when
	// analyzing a data. It consists of the S3 source bucket, location, S3 object
	// version, and the relative path from where the custom code is loaded into the
	// cluster.
	Code *types.CodeConfiguration

	// Defines key-value pairs to make them available inside the cluster.
	CommandLineArguments []types.KxCommandLineArgument

	// The timestamp at which the cluster 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.
	CreatedTimestamp *time.Time

	// A list of databases mounted on the cluster.
	Databases []types.KxDatabaseConfiguration

	// An IAM role that defines a set of permissions associated with a cluster. These
	// permissions are assumed when a cluster attempts to access another cluster.
	ExecutionRole *string

	// Specifies a Q program that will be run at launch of a cluster. It is a relative
	// path within .zip file that contains the custom code, which will be loaded on the
	// cluster. It must include the file name itself. For example, somedir/init.q .
	InitializationScript *string

	// The last time that the cluster was modified. 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.
	LastModifiedTimestamp *time.Time

	// The version of FinSpace managed kdb to run.
	ReleaseLabel *string

	// The size and type of the temporary storage that is used to hold data during the
	// savedown process. This parameter is required when you choose clusterType as
	// RDB. All the data written to this storage space is lost when the cluster node is
	// restarted.
	SavedownStorageConfiguration *types.KxSavedownStorageConfiguration

	// The structure that stores the capacity configuration details of a scaling group.
	ScalingGroupConfiguration *types.KxScalingGroupConfiguration

	// The status of cluster creation.
	//   - PENDING – The cluster is pending creation.
	//   - CREATING – The cluster creation process is in progress.
	//   - CREATE_FAILED – The cluster creation process has failed.
	//   - RUNNING – The cluster creation process is running.
	//   - UPDATING – The cluster is in the process of being updated.
	//   - DELETING – The cluster is in the process of being deleted.
	//   - DELETED – The cluster has been deleted.
	//   - DELETE_FAILED – The cluster failed to delete.
	Status types.KxClusterStatus

	// The error message when a failed state occurs.
	StatusReason *string

	// A configuration to store the Tickerplant logs. It consists of a list of volumes
	// that will be mounted to your cluster. For the cluster type Tickerplant , the
	// location of the TP volume on the cluster will be available by using the global
	// variable .aws.tp_log_path .
	TickerplantLogConfiguration *types.TickerplantLogConfiguration

	// A list of volumes attached to the cluster.
	Volumes []types.Volume

	// Configuration details about the network where the Privatelink endpoint of the
	// cluster resides.
	VpcConfiguration *types.VpcConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxConnectionStringInput added in v1.10.0 

type GetKxConnectionStringInput struct {

	// A name of the kdb cluster.
	//
	// This member is required.
	ClusterName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// The Amazon Resource Name (ARN) that identifies the user. For more information
	// about ARNs and how to use ARNs in policies, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the IAM User Guide.
	//
	// This member is required.
	UserArn *string
	// contains filtered or unexported fields
}

type GetKxConnectionStringOutput added in v1.10.0 

type GetKxConnectionStringOutput struct {

	// The signed connection string that you can use to connect to clusters.
	SignedConnectionString *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxDatabaseInput added in v1.10.0 

type GetKxDatabaseInput struct {

	// The name of the kdb database.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type GetKxDatabaseOutput added in v1.10.0 

type GetKxDatabaseOutput struct {

	// The timestamp at which the database is 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.
	CreatedTimestamp *time.Time

	// The ARN identifier of the database.
	DatabaseArn *string

	// The name of the kdb database for which the information is retrieved.
	DatabaseName *string

	// A description of the database.
	Description *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// A unique identifier for the changeset.
	LastCompletedChangesetId *string

	// The last time that the database was modified. 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.
	LastModifiedTimestamp *time.Time

	// The total number of bytes in the database.
	NumBytes int64

	// The total number of changesets in the database.
	NumChangesets int32

	// The total number of files in the database.
	NumFiles int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxDataviewInput added in v1.20.0 

type GetKxDataviewInput struct {

	// The name of the database where you created the dataview.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the dataview.
	//
	// This member is required.
	DataviewName *string

	// A unique identifier for the kdb environment, from where you want to retrieve
	// the dataview details.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type GetKxDataviewOutput added in v1.20.0 

type GetKxDataviewOutput struct {

	// The current active changeset versions of the database on the given dataview.
	ActiveVersions []types.KxDataviewActiveVersion

	// The option to specify whether you want to apply all the future additions and
	// corrections automatically to the dataview when new changesets are ingested. The
	// default value is false.
	AutoUpdate bool

	// The identifier of the availability zones.
	AvailabilityZoneId *string

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	AzMode types.KxAzMode

	// A unique identifier of the changeset that you want to use to ingest data.
	ChangesetId *string

	// The timestamp at which the dataview 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.
	CreatedTimestamp *time.Time

	// The name of the database where you created the dataview.
	DatabaseName *string

	// A unique identifier for the dataview.
	DataviewName *string

	// A description of the dataview.
	Description *string

	// A unique identifier for the kdb environment, from where you want to retrieve
	// the dataview details.
	EnvironmentId *string

	// The last time that the dataview was updated 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.
	LastModifiedTimestamp *time.Time

	// Returns True if the dataview is created as writeable and False otherwise.
	ReadWrite bool

	// The configuration that contains the database path of the data that you want to
	// place on each selected volume. Each segment must have a unique database path for
	// each volume. If you do not explicitly specify any database path for a volume,
	// they are accessible from the cluster through the default S3/object store
	// segment.
	SegmentConfigurations []types.KxDataviewSegmentConfiguration

	// The status of dataview creation.
	//   - CREATING – The dataview creation is in progress.
	//   - UPDATING – The dataview is in the process of being updated.
	//   - ACTIVE – The dataview is active.
	Status types.KxDataviewStatus

	// The error message when a failed state occurs.
	StatusReason *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxEnvironmentInput added in v1.10.0 

type GetKxEnvironmentInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string
	// contains filtered or unexported fields
}

type GetKxEnvironmentOutput added in v1.10.0 

type GetKxEnvironmentOutput struct {

	// The identifier of the availability zones where subnets for the environment are
	// created.
	AvailabilityZoneIds []string

	// The unique identifier of the AWS account that is used to create the kdb
	// environment.
	AwsAccountId *string

	// The Amazon Resource Name (ARN) of the certificate authority of the kdb
	// environment.
	CertificateAuthorityArn *string

	// The timestamp at which the kdb environment was created in FinSpace.
	CreationTimestamp *time.Time

	// A list of DNS server name and server IP. This is used to set up Route-53
	// outbound resolvers.
	CustomDNSConfiguration []types.CustomDNSServer

	// A unique identifier for the AWS environment infrastructure account.
	DedicatedServiceAccountId *string

	// A description for the kdb environment.
	Description *string

	// The status of DNS configuration.
	DnsStatus types.DnsStatus

	// The ARN identifier of the environment.
	EnvironmentArn *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// Specifies the error message that appears if a flow fails.
	ErrorMessage *string

	// The KMS key ID to encrypt your data in the FinSpace environment.
	KmsKeyId *string

	// The name of the kdb environment.
	Name *string

	// The status of the kdb environment.
	Status types.EnvironmentStatus

	// The status of the network configuration.
	TgwStatus types.TgwStatus

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

	// The timestamp at which the kdb environment was updated.
	UpdateTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxScalingGroupInput added in v1.20.0 

type GetKxScalingGroupInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the kdb scaling group.
	//
	// This member is required.
	ScalingGroupName *string
	// contains filtered or unexported fields
}

type GetKxScalingGroupOutput added in v1.20.0 

type GetKxScalingGroupOutput struct {

	// The identifier of the availability zones.
	AvailabilityZoneId *string

	// The list of Managed kdb clusters that are currently active in the given scaling
	// group.
	Clusters []string

	// The timestamp at which the scaling group 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.
	CreatedTimestamp *time.Time

	// The memory and CPU capabilities of the scaling group host on which FinSpace
	// Managed kdb clusters will be placed. It can have one of the following values:
	//   - kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16
	//   vCPUs.
	//   - kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32
	//   vCPUs.
	//   - kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64
	//   vCPUs.
	//   - kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and
	//   128 vCPUs.
	//   - kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and
	//   64 vCPUs.
	//   - kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and
	//   96 vCPUs.
	HostType *string

	// The last time that the scaling group was updated 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.
	LastModifiedTimestamp *time.Time

	// The ARN identifier for the scaling group.
	ScalingGroupArn *string

	// A unique identifier for the kdb scaling group.
	ScalingGroupName *string

	// The status of scaling group.
	//   - CREATING – The scaling group creation is in progress.
	//   - CREATE_FAILED – The scaling group creation has failed.
	//   - ACTIVE – The scaling group is active.
	//   - UPDATING – The scaling group is in the process of being updated.
	//   - UPDATE_FAILED – The update action failed.
	//   - DELETING – The scaling group is in the process of being deleted.
	//   - DELETE_FAILED – The system failed to delete the scaling group.
	//   - DELETED – The scaling group is successfully deleted.
	Status types.KxScalingGroupStatus

	// The error message when a failed state occurs.
	StatusReason *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxUserInput added in v1.10.0 

type GetKxUserInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the user.
	//
	// This member is required.
	UserName *string
	// contains filtered or unexported fields
}

type GetKxUserOutput added in v1.10.0 

type GetKxUserOutput struct {

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// The IAM role ARN that is associated with the user.
	IamRole *string

	// The Amazon Resource Name (ARN) that identifies the user. For more information
	// about ARNs and how to use ARNs in policies, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the IAM User Guide.
	UserArn *string

	// A unique identifier for the user.
	UserName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKxVolumeInput added in v1.20.0 

type GetKxVolumeInput struct {

	// A unique identifier for the kdb environment, whose clusters can attach to the
	// volume.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the volume.
	//
	// This member is required.
	VolumeName *string
	// contains filtered or unexported fields
}

type GetKxVolumeOutput added in v1.20.0 

type GetKxVolumeOutput struct {

	// A list of cluster identifiers that a volume is attached to.
	AttachedClusters []types.KxAttachedCluster

	// The identifier of the availability zones.
	AvailabilityZoneIds []string

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	AzMode types.KxAzMode

	// The timestamp at which the volume 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.
	CreatedTimestamp *time.Time

	// A description of the volume.
	Description *string

	// A unique identifier for the kdb environment, whose clusters can attach to the
	// volume.
	EnvironmentId *string

	// The last time that the volume was updated 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.
	LastModifiedTimestamp *time.Time

	// Specifies the configuration for the Network attached storage (NAS_1) file
	// system volume.
	Nas1Configuration *types.KxNAS1Configuration

	// The status of volume creation.
	//   - CREATING – The volume creation is in progress.
	//   - CREATE_FAILED – The volume creation has failed.
	//   - ACTIVE – The volume is active.
	//   - UPDATING – The volume is in the process of being updated.
	//   - UPDATE_FAILED – The update action failed.
	//   - UPDATED – The volume is successfully updated.
	//   - DELETING – The volume is in the process of being deleted.
	//   - DELETE_FAILED – The system failed to delete the volume.
	//   - DELETED – The volume is successfully deleted.
	Status types.KxVolumeStatus

	// The error message when a failed state occurs.
	StatusReason *string

	// The ARN identifier of the volume.
	VolumeArn *string

	// A unique identifier for the volume.
	VolumeName *string

	// The type of file system volume. Currently, FinSpace only supports NAS_1 volume
	// type.
	VolumeType types.KxVolumeType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider added in v1.10.0 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListEnvironmentsInput 

type ListEnvironmentsInput struct {

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token generated by FinSpace that specifies where to continue pagination if a
	// previous request was truncated. To get the next set of pages, pass in the
	// nextToken nextToken value from the response object of the previous page call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEnvironmentsOutput 

type ListEnvironmentsOutput struct {

	// A list of all of your FinSpace environments.
	Environments []types.Environment

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxChangesetsAPIClient added in v1.10.0 

type ListKxChangesetsAPIClient interface {
	ListKxChangesets(context.Context, *ListKxChangesetsInput, ...func(*Options)) (*ListKxChangesetsOutput, error)
}

ListKxChangesetsAPIClient is a client that implements the ListKxChangesets operation.

type ListKxChangesetsInput added in v1.10.0 

type ListKxChangesetsInput struct {

	// The name of the kdb database.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxChangesetsOutput added in v1.10.0 

type ListKxChangesetsOutput struct {

	// A list of changesets for a database.
	KxChangesets []types.KxChangesetListEntry

	// A token that indicates where a results page should begin.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxChangesetsPaginator added in v1.10.0 

type ListKxChangesetsPaginator struct {
	// contains filtered or unexported fields
}

ListKxChangesetsPaginator is a paginator for ListKxChangesets

func NewListKxChangesetsPaginator added in v1.10.0 

func NewListKxChangesetsPaginator(client ListKxChangesetsAPIClient, params *ListKxChangesetsInput, optFns ...func(*ListKxChangesetsPaginatorOptions)) *ListKxChangesetsPaginator

NewListKxChangesetsPaginator returns a new ListKxChangesetsPaginator

func (*ListKxChangesetsPaginator) HasMorePages added in v1.10.0 

func (p *ListKxChangesetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKxChangesetsPaginator) NextPage added in v1.10.0 

func (p *ListKxChangesetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKxChangesetsOutput, error)

NextPage retrieves the next ListKxChangesets page.

type ListKxChangesetsPaginatorOptions added in v1.10.0 

type ListKxChangesetsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKxChangesetsPaginatorOptions is the paginator options for ListKxChangesets

type ListKxClusterNodesAPIClient added in v1.10.0 

type ListKxClusterNodesAPIClient interface {
	ListKxClusterNodes(context.Context, *ListKxClusterNodesInput, ...func(*Options)) (*ListKxClusterNodesOutput, error)
}

ListKxClusterNodesAPIClient is a client that implements the ListKxClusterNodes operation.

type ListKxClusterNodesInput added in v1.10.0 

type ListKxClusterNodesInput struct {

	// A unique name for the cluster.
	//
	// This member is required.
	ClusterName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxClusterNodesOutput added in v1.10.0 

type ListKxClusterNodesOutput struct {

	// A token that indicates where a results page should begin.
	NextToken *string

	// A list of nodes associated with the cluster.
	Nodes []types.KxNode

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxClusterNodesPaginator added in v1.10.0 

type ListKxClusterNodesPaginator struct {
	// contains filtered or unexported fields
}

ListKxClusterNodesPaginator is a paginator for ListKxClusterNodes

func NewListKxClusterNodesPaginator added in v1.10.0 

func NewListKxClusterNodesPaginator(client ListKxClusterNodesAPIClient, params *ListKxClusterNodesInput, optFns ...func(*ListKxClusterNodesPaginatorOptions)) *ListKxClusterNodesPaginator

NewListKxClusterNodesPaginator returns a new ListKxClusterNodesPaginator

func (*ListKxClusterNodesPaginator) HasMorePages added in v1.10.0 

func (p *ListKxClusterNodesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKxClusterNodesPaginator) NextPage added in v1.10.0 

func (p *ListKxClusterNodesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKxClusterNodesOutput, error)

NextPage retrieves the next ListKxClusterNodes page.

type ListKxClusterNodesPaginatorOptions added in v1.10.0 

type ListKxClusterNodesPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKxClusterNodesPaginatorOptions is the paginator options for ListKxClusterNodes

type ListKxClustersInput added in v1.10.0 

type ListKxClustersInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// Specifies the type of KDB database that is being created. The following types
	// are available:
	//   - HDB – A Historical Database. The data is only accessible with read-only
	//   permissions from one of the FinSpace managed kdb databases mounted to the
	//   cluster.
	//   - RDB – A Realtime Database. This type of database captures all the data from
	//   a ticker plant and stores it in memory until the end of day, after which it
	//   writes all of its data to a disk and reloads the HDB. This cluster type requires
	//   local storage for temporary storage of data during the savedown process. If you
	//   specify this field in your request, you must provide the
	//   savedownStorageConfiguration parameter.
	//   - GATEWAY – A gateway cluster allows you to access data across processes in
	//   kdb systems. It allows you to create your own routing logic using the
	//   initialization scripts and custom code. This type of cluster does not require a
	//   writable local storage.
	//   - GP – A general purpose cluster allows you to quickly iterate on code during
	//   development by granting greater access to system commands and enabling a fast
	//   reload of custom code. This cluster type can optionally mount databases
	//   including cache and savedown storage. For this cluster type, the node count is
	//   fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
	//   - Tickerplant – A tickerplant cluster allows you to subscribe to feed
	//   handlers based on IAM permissions. It can publish to RDBs, other Tickerplants,
	//   and real-time subscribers (RTS). Tickerplants can persist messages to log, which
	//   is readable by any RDB environment. It supports only single-node that is only
	//   one kdb process.
	ClusterType types.KxClusterType

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxClustersOutput added in v1.10.0 

type ListKxClustersOutput struct {

	// Lists the cluster details.
	KxClusterSummaries []types.KxCluster

	// A token that indicates where a results page should begin.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxDatabasesAPIClient added in v1.10.0 

type ListKxDatabasesAPIClient interface {
	ListKxDatabases(context.Context, *ListKxDatabasesInput, ...func(*Options)) (*ListKxDatabasesOutput, error)
}

ListKxDatabasesAPIClient is a client that implements the ListKxDatabases operation.

type ListKxDatabasesInput added in v1.10.0 

type ListKxDatabasesInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxDatabasesOutput added in v1.10.0 

type ListKxDatabasesOutput struct {

	// A list of databases in the kdb environment.
	KxDatabases []types.KxDatabaseListEntry

	// A token that indicates where a results page should begin.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxDatabasesPaginator added in v1.10.0 

type ListKxDatabasesPaginator struct {
	// contains filtered or unexported fields
}

ListKxDatabasesPaginator is a paginator for ListKxDatabases

func NewListKxDatabasesPaginator added in v1.10.0 

func NewListKxDatabasesPaginator(client ListKxDatabasesAPIClient, params *ListKxDatabasesInput, optFns ...func(*ListKxDatabasesPaginatorOptions)) *ListKxDatabasesPaginator

NewListKxDatabasesPaginator returns a new ListKxDatabasesPaginator

func (*ListKxDatabasesPaginator) HasMorePages added in v1.10.0 

func (p *ListKxDatabasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKxDatabasesPaginator) NextPage added in v1.10.0 

func (p *ListKxDatabasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKxDatabasesOutput, error)

NextPage retrieves the next ListKxDatabases page.

type ListKxDatabasesPaginatorOptions added in v1.10.0 

type ListKxDatabasesPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKxDatabasesPaginatorOptions is the paginator options for ListKxDatabases

type ListKxDataviewsAPIClient added in v1.20.0 

type ListKxDataviewsAPIClient interface {
	ListKxDataviews(context.Context, *ListKxDataviewsInput, ...func(*Options)) (*ListKxDataviewsOutput, error)
}

ListKxDataviewsAPIClient is a client that implements the ListKxDataviews operation.

type ListKxDataviewsInput added in v1.20.0 

type ListKxDataviewsInput struct {

	// The name of the database where the dataviews were created.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the kdb environment, for which you want to retrieve a
	// list of dataviews.
	//
	// This member is required.
	EnvironmentId *string

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxDataviewsOutput added in v1.20.0 

type ListKxDataviewsOutput struct {

	// The list of kdb dataviews that are currently active for the given database.
	KxDataviews []types.KxDataviewListEntry

	// A token that indicates where a results page should begin.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxDataviewsPaginator added in v1.20.0 

type ListKxDataviewsPaginator struct {
	// contains filtered or unexported fields
}

ListKxDataviewsPaginator is a paginator for ListKxDataviews

func NewListKxDataviewsPaginator added in v1.20.0 

func NewListKxDataviewsPaginator(client ListKxDataviewsAPIClient, params *ListKxDataviewsInput, optFns ...func(*ListKxDataviewsPaginatorOptions)) *ListKxDataviewsPaginator

NewListKxDataviewsPaginator returns a new ListKxDataviewsPaginator

func (*ListKxDataviewsPaginator) HasMorePages added in v1.20.0 

func (p *ListKxDataviewsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKxDataviewsPaginator) NextPage added in v1.20.0 

func (p *ListKxDataviewsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKxDataviewsOutput, error)

NextPage retrieves the next ListKxDataviews page.

type ListKxDataviewsPaginatorOptions added in v1.20.0 

type ListKxDataviewsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKxDataviewsPaginatorOptions is the paginator options for ListKxDataviews

type ListKxEnvironmentsAPIClient added in v1.10.0 

type ListKxEnvironmentsAPIClient interface {
	ListKxEnvironments(context.Context, *ListKxEnvironmentsInput, ...func(*Options)) (*ListKxEnvironmentsOutput, error)
}

ListKxEnvironmentsAPIClient is a client that implements the ListKxEnvironments operation.

type ListKxEnvironmentsInput added in v1.10.0 

type ListKxEnvironmentsInput struct {

	// The maximum number of results to return in this request.
	MaxResults *int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxEnvironmentsOutput added in v1.10.0 

type ListKxEnvironmentsOutput struct {

	// A list of environments in an account.
	Environments []types.KxEnvironment

	// A token that indicates where a results page should begin.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxEnvironmentsPaginator added in v1.10.0 

type ListKxEnvironmentsPaginator struct {
	// contains filtered or unexported fields
}

ListKxEnvironmentsPaginator is a paginator for ListKxEnvironments

func NewListKxEnvironmentsPaginator added in v1.10.0 

func NewListKxEnvironmentsPaginator(client ListKxEnvironmentsAPIClient, params *ListKxEnvironmentsInput, optFns ...func(*ListKxEnvironmentsPaginatorOptions)) *ListKxEnvironmentsPaginator

NewListKxEnvironmentsPaginator returns a new ListKxEnvironmentsPaginator

func (*ListKxEnvironmentsPaginator) HasMorePages added in v1.10.0 

func (p *ListKxEnvironmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKxEnvironmentsPaginator) NextPage added in v1.10.0 

func (p *ListKxEnvironmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKxEnvironmentsOutput, error)

NextPage retrieves the next ListKxEnvironments page.

type ListKxEnvironmentsPaginatorOptions added in v1.10.0 

type ListKxEnvironmentsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKxEnvironmentsPaginatorOptions is the paginator options for ListKxEnvironments

type ListKxScalingGroupsAPIClient added in v1.20.0 

type ListKxScalingGroupsAPIClient interface {
	ListKxScalingGroups(context.Context, *ListKxScalingGroupsInput, ...func(*Options)) (*ListKxScalingGroupsOutput, error)
}

ListKxScalingGroupsAPIClient is a client that implements the ListKxScalingGroups operation.

type ListKxScalingGroupsInput added in v1.20.0 

type ListKxScalingGroupsInput struct {

	// A unique identifier for the kdb environment, for which you want to retrieve a
	// list of scaling groups.
	//
	// This member is required.
	EnvironmentId *string

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxScalingGroupsOutput added in v1.20.0 

type ListKxScalingGroupsOutput struct {

	// A token that indicates where a results page should begin.
	NextToken *string

	// A list of scaling groups available in a kdb environment.
	ScalingGroups []types.KxScalingGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxScalingGroupsPaginator added in v1.20.0 

type ListKxScalingGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListKxScalingGroupsPaginator is a paginator for ListKxScalingGroups

func NewListKxScalingGroupsPaginator added in v1.20.0 

func NewListKxScalingGroupsPaginator(client ListKxScalingGroupsAPIClient, params *ListKxScalingGroupsInput, optFns ...func(*ListKxScalingGroupsPaginatorOptions)) *ListKxScalingGroupsPaginator

NewListKxScalingGroupsPaginator returns a new ListKxScalingGroupsPaginator

func (*ListKxScalingGroupsPaginator) HasMorePages added in v1.20.0 

func (p *ListKxScalingGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKxScalingGroupsPaginator) NextPage added in v1.20.0 

func (p *ListKxScalingGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKxScalingGroupsOutput, error)

NextPage retrieves the next ListKxScalingGroups page.

type ListKxScalingGroupsPaginatorOptions added in v1.20.0 

type ListKxScalingGroupsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKxScalingGroupsPaginatorOptions is the paginator options for ListKxScalingGroups

type ListKxUsersInput added in v1.10.0 

type ListKxUsersInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKxUsersOutput added in v1.10.0 

type ListKxUsersOutput struct {

	// A token that indicates where a results page should begin.
	NextToken *string

	// A list of users in a kdb environment.
	Users []types.KxUser

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKxVolumesInput added in v1.20.0 

type ListKxVolumesInput struct {

	// A unique identifier for the kdb environment, whose clusters can attach to the
	// volume.
	//
	// This member is required.
	EnvironmentId *string

	// The maximum number of results to return in this request.
	MaxResults int32

	// A token that indicates where a results page should begin.
	NextToken *string

	// The type of file system volume. Currently, FinSpace only supports NAS_1 volume
	// type.
	VolumeType types.KxVolumeType
	// contains filtered or unexported fields
}

type ListKxVolumesOutput added in v1.20.0 

type ListKxVolumesOutput struct {

	// A summary of volumes.
	KxVolumeSummaries []types.KxVolume

	// A token that indicates where a results page should begin.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of all tags for a resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.17.0 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) for the resource.
	//
	// This member is required.
	ResourceArn *string

	// One or more tags to be assigned to the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// A FinSpace resource from which you want to remove a tag or tags. The value for
	// this parameter is an Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

	// The tag keys (names) of one or more tags to be removed.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEnvironmentInput 

type UpdateEnvironmentInput struct {

	// The identifier of the FinSpace environment.
	//
	// This member is required.
	EnvironmentId *string

	// The description of the environment.
	Description *string

	// Authentication mode for the environment.
	//   - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your
	//   Identity provider.
	//   - LOCAL - Users access FinSpace via email and password managed within the
	//   FinSpace environment.
	FederationMode types.FederationMode

	// Configuration information when authentication mode is FEDERATED.
	FederationParameters *types.FederationParameters

	// The name of the environment.
	Name *string
	// contains filtered or unexported fields
}

type UpdateEnvironmentOutput 

type UpdateEnvironmentOutput struct {

	// Returns the FinSpace environment object.
	Environment *types.Environment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxClusterCodeConfigurationInput added in v1.14.0 

type UpdateKxClusterCodeConfigurationInput struct {

	// The name of the cluster.
	//
	// This member is required.
	ClusterName *string

	// The structure of the customer code available within the running cluster.
	//
	// This member is required.
	Code *types.CodeConfiguration

	// A unique identifier of the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// Specifies the key-value pairs to make them available inside the cluster. You
	// cannot update this parameter for a NO_RESTART deployment.
	CommandLineArguments []types.KxCommandLineArgument

	// The configuration that allows you to choose how you want to update the code on
	// a cluster.
	DeploymentConfiguration *types.KxClusterCodeDeploymentConfiguration

	// Specifies a Q program that will be run at launch of a cluster. It is a relative
	// path within .zip file that contains the custom code, which will be loaded on the
	// cluster. It must include the file name itself. For example, somedir/init.q . You
	// cannot update this parameter for a NO_RESTART deployment.
	InitializationScript *string
	// contains filtered or unexported fields
}

type UpdateKxClusterCodeConfigurationOutput added in v1.14.0 

type UpdateKxClusterCodeConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxClusterDatabasesInput added in v1.10.0 

type UpdateKxClusterDatabasesInput struct {

	// A unique name for the cluster that you want to modify.
	//
	// This member is required.
	ClusterName *string

	// The structure of databases mounted on the cluster.
	//
	// This member is required.
	Databases []types.KxDatabaseConfiguration

	// The unique identifier of a kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// The configuration that allows you to choose how you want to update the
	// databases on a cluster.
	DeploymentConfiguration *types.KxDeploymentConfiguration
	// contains filtered or unexported fields
}

type UpdateKxClusterDatabasesOutput added in v1.10.0 

type UpdateKxClusterDatabasesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxDatabaseInput added in v1.10.0 

type UpdateKxDatabaseInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// The name of the kdb database.
	//
	// This member is required.
	DatabaseName *string

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A description of the database.
	Description *string
	// contains filtered or unexported fields
}

type UpdateKxDatabaseOutput added in v1.10.0 

type UpdateKxDatabaseOutput struct {

	// The name of the kdb database.
	DatabaseName *string

	// A description of the database.
	Description *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// The last time that the database was modified. 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.
	LastModifiedTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxDataviewInput added in v1.20.0 

type UpdateKxDataviewInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// The name of the database.
	//
	// This member is required.
	DatabaseName *string

	// The name of the dataview that you want to update.
	//
	// This member is required.
	DataviewName *string

	// A unique identifier for the kdb environment, where you want to update the
	// dataview.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the changeset.
	ChangesetId *string

	// The description for a dataview.
	Description *string

	// The configuration that contains the database path of the data that you want to
	// place on each selected volume. Each segment must have a unique database path for
	// each volume. If you do not explicitly specify any database path for a volume,
	// they are accessible from the cluster through the default S3/object store
	// segment.
	SegmentConfigurations []types.KxDataviewSegmentConfiguration
	// contains filtered or unexported fields
}

type UpdateKxDataviewOutput added in v1.20.0 

type UpdateKxDataviewOutput struct {

	// The current active changeset versions of the database on the given dataview.
	ActiveVersions []types.KxDataviewActiveVersion

	// The option to specify whether you want to apply all the future additions and
	// corrections automatically to the dataview when new changesets are ingested. The
	// default value is false.
	AutoUpdate bool

	// The identifier of the availability zones.
	AvailabilityZoneId *string

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	AzMode types.KxAzMode

	// A unique identifier for the changeset.
	ChangesetId *string

	// The timestamp at which the dataview 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.
	CreatedTimestamp *time.Time

	// The name of the database.
	DatabaseName *string

	// The name of the database under which the dataview was created.
	DataviewName *string

	// A description of the dataview.
	Description *string

	// A unique identifier for the kdb environment, where you want to update the
	// dataview.
	EnvironmentId *string

	// The last time that the dataview was updated 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.
	LastModifiedTimestamp *time.Time

	// Returns True if the dataview is created as writeable and False otherwise.
	ReadWrite bool

	// The configuration that contains the database path of the data that you want to
	// place on each selected volume. Each segment must have a unique database path for
	// each volume. If you do not explicitly specify any database path for a volume,
	// they are accessible from the cluster through the default S3/object store
	// segment.
	SegmentConfigurations []types.KxDataviewSegmentConfiguration

	// The status of dataview creation.
	//   - CREATING – The dataview creation is in progress.
	//   - UPDATING – The dataview is in the process of being updated.
	//   - ACTIVE – The dataview is active.
	Status types.KxDataviewStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxEnvironmentInput added in v1.10.0 

type UpdateKxEnvironmentInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// A description of the kdb environment.
	Description *string

	// The name of the kdb environment.
	Name *string
	// contains filtered or unexported fields
}

type UpdateKxEnvironmentNetworkInput added in v1.10.0 

type UpdateKxEnvironmentNetworkInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// A list of DNS server name and server IP. This is used to set up Route-53
	// outbound resolvers.
	CustomDNSConfiguration []types.CustomDNSServer

	// Specifies the transit gateway and network configuration to connect the kdb
	// environment to an internal network.
	TransitGatewayConfiguration *types.TransitGatewayConfiguration
	// contains filtered or unexported fields
}

type UpdateKxEnvironmentNetworkOutput added in v1.10.0 

type UpdateKxEnvironmentNetworkOutput struct {

	// The identifier of the availability zones where subnets for the environment are
	// created.
	AvailabilityZoneIds []string

	// The unique identifier of the AWS account that is used to create the kdb
	// environment.
	AwsAccountId *string

	// The timestamp at which the kdb environment was created in FinSpace.
	CreationTimestamp *time.Time

	// A list of DNS server name and server IP. This is used to set up Route-53
	// outbound resolvers.
	CustomDNSConfiguration []types.CustomDNSServer

	// A unique identifier for the AWS environment infrastructure account.
	DedicatedServiceAccountId *string

	// The description of the environment.
	Description *string

	// The status of DNS configuration.
	DnsStatus types.DnsStatus

	// The ARN identifier of the environment.
	EnvironmentArn *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// Specifies the error message that appears if a flow fails.
	ErrorMessage *string

	// The KMS key ID to encrypt your data in the FinSpace environment.
	KmsKeyId *string

	// The name of the kdb environment.
	Name *string

	// The status of the kdb environment.
	Status types.EnvironmentStatus

	// The status of the network configuration.
	TgwStatus types.TgwStatus

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

	// The timestamp at which the kdb environment was updated.
	UpdateTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxEnvironmentOutput added in v1.10.0 

type UpdateKxEnvironmentOutput struct {

	// The identifier of the availability zones where subnets for the environment are
	// created.
	AvailabilityZoneIds []string

	// The unique identifier of the AWS account that is used to create the kdb
	// environment.
	AwsAccountId *string

	// The timestamp at which the kdb environment was created in FinSpace.
	CreationTimestamp *time.Time

	// A list of DNS server name and server IP. This is used to set up Route-53
	// outbound resolvers.
	CustomDNSConfiguration []types.CustomDNSServer

	// A unique identifier for the AWS environment infrastructure account.
	DedicatedServiceAccountId *string

	// The description of the environment.
	Description *string

	// The status of DNS configuration.
	DnsStatus types.DnsStatus

	// The ARN identifier of the environment.
	EnvironmentArn *string

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// Specifies the error message that appears if a flow fails.
	ErrorMessage *string

	// The KMS key ID to encrypt your data in the FinSpace environment.
	KmsKeyId *string

	// The name of the kdb environment.
	Name *string

	// The status of the kdb environment.
	Status types.EnvironmentStatus

	// The status of the network configuration.
	TgwStatus types.TgwStatus

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

	// The timestamp at which the kdb environment was updated.
	UpdateTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxUserInput added in v1.10.0 

type UpdateKxUserInput struct {

	// A unique identifier for the kdb environment.
	//
	// This member is required.
	EnvironmentId *string

	// The IAM role ARN that is associated with the user.
	//
	// This member is required.
	IamRole *string

	// A unique identifier for the user.
	//
	// This member is required.
	UserName *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateKxUserOutput added in v1.10.0 

type UpdateKxUserOutput struct {

	// A unique identifier for the kdb environment.
	EnvironmentId *string

	// The IAM role ARN that is associated with the user.
	IamRole *string

	// The Amazon Resource Name (ARN) that identifies the user. For more information
	// about ARNs and how to use ARNs in policies, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the IAM User Guide.
	UserArn *string

	// A unique identifier for the user.
	UserName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKxVolumeInput added in v1.20.0 

type UpdateKxVolumeInput struct {

	// A unique identifier for the kdb environment where you created the storage
	// volume.
	//
	// This member is required.
	EnvironmentId *string

	// A unique identifier for the volume.
	//
	// This member is required.
	VolumeName *string

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string

	// A description of the volume.
	Description *string

	// Specifies the configuration for the Network attached storage (NAS_1) file
	// system volume.
	Nas1Configuration *types.KxNAS1Configuration
	// contains filtered or unexported fields
}

type UpdateKxVolumeOutput added in v1.20.0 

type UpdateKxVolumeOutput struct {

	// Specifies the clusters that a volume is attached to.
	AttachedClusters []types.KxAttachedCluster

	// The identifier of the availability zones.
	AvailabilityZoneIds []string

	// The number of availability zones you want to assign per volume. Currently,
	// FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
	AzMode types.KxAzMode

	// The timestamp at which the volume 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.
	CreatedTimestamp *time.Time

	// The description for the volume.
	Description *string

	// A unique identifier for the kdb environment where you want to update the volume.
	EnvironmentId *string

	// The last time that the volume was updated 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.
	LastModifiedTimestamp *time.Time

	// Specifies the configuration for the Network attached storage (NAS_1) file
	// system volume.
	Nas1Configuration *types.KxNAS1Configuration

	// The status of the volume.
	//   - CREATING – The volume creation is in progress.
	//   - CREATE_FAILED – The volume creation has failed.
	//   - ACTIVE – The volume is active.
	//   - UPDATING – The volume is in the process of being updated.
	//   - UPDATE_FAILED – The update action failed.
	//   - UPDATED – The volume is successfully updated.
	//   - DELETING – The volume is in the process of being deleted.
	//   - DELETE_FAILED – The system failed to delete the volume.
	//   - DELETED – The volume is successfully deleted.
	Status types.KxVolumeStatus

	// The error message when a failed state occurs.
	StatusReason *string

	// The ARN identifier of the volume.
	VolumeArn *string

	// A unique identifier for the volume that you want to update.
	VolumeName *string

	// The type of file system volume. Currently, FinSpace only supports NAS_1 volume
	// type.
	VolumeType types.KxVolumeType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.