func AutoScalingMetric_Values() []string
AutoScalingMetric_Values returns all elements of the AutoScalingMetric enum
func ChangeType_Values() []string
ChangeType_Values returns all elements of the ChangeType enum
func ChangesetStatus_Values() []string
ChangesetStatus_Values returns all elements of the ChangesetStatus enum
func DnsStatus_Values() []string
DnsStatus_Values returns all elements of the DnsStatus enum
func EnvironmentStatus_Values() []string
EnvironmentStatus_Values returns all elements of the EnvironmentStatus enum
func ErrorDetails_Values() []string
ErrorDetails_Values returns all elements of the ErrorDetails enum
func FederationMode_Values() []string
FederationMode_Values returns all elements of the FederationMode enum
func IPAddressType_Values() []string
IPAddressType_Values returns all elements of the IPAddressType enum
func KxAzMode_Values() []string
KxAzMode_Values returns all elements of the KxAzMode enum
func KxClusterCodeDeploymentStrategy_Values() []string
KxClusterCodeDeploymentStrategy_Values returns all elements of the KxClusterCodeDeploymentStrategy enum
func KxClusterStatus_Values() []string
KxClusterStatus_Values returns all elements of the KxClusterStatus enum
func KxClusterType_Values() []string
KxClusterType_Values returns all elements of the KxClusterType enum
func KxDataviewStatus_Values() []string
KxDataviewStatus_Values returns all elements of the KxDataviewStatus enum
func KxDeploymentStrategy_Values() []string
KxDeploymentStrategy_Values returns all elements of the KxDeploymentStrategy enum
func KxNAS1Type_Values() []string
KxNAS1Type_Values returns all elements of the KxNAS1Type enum
func KxNodeStatus_Values() []string
KxNodeStatus_Values returns all elements of the KxNodeStatus enum
func KxSavedownStorageType_Values() []string
KxSavedownStorageType_Values returns all elements of the KxSavedownStorageType enum
func KxScalingGroupStatus_Values() []string
KxScalingGroupStatus_Values returns all elements of the KxScalingGroupStatus enum
func KxVolumeStatus_Values() []string
KxVolumeStatus_Values returns all elements of the KxVolumeStatus enum
func KxVolumeType_Values() []string
KxVolumeType_Values returns all elements of the KxVolumeType enum
func RuleAction_Values() []string
RuleAction_Values returns all elements of the RuleAction enum
func TgwStatus_Values() []string
TgwStatus_Values returns all elements of the TgwStatus enum
func VolumeType_Values() []string
VolumeType_Values returns all elements of the VolumeType enum
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You do not have sufficient access to perform this action.
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AutoScalingConfiguration struct { // The metric your cluster will track in order to scale in and out. For example, // CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes // in a cluster. AutoScalingMetric *string `locationName:"autoScalingMetric" type:"string" enum:"AutoScalingMetric"` // The highest number of nodes to scale. This value cannot be greater than 5. MaxNodeCount *int64 `locationName:"maxNodeCount" min:"1" type:"integer"` // The desired value of the chosen autoScalingMetric. When the metric drops // below this value, the cluster will scale in. When the metric goes above this // value, the cluster will scale out. You can set the target value between 1 // and 100 percent. MetricTarget *float64 `locationName:"metricTarget" min:"1" type:"double"` // The lowest number of nodes to scale. This value must be at least 1 and less // than the maxNodeCount. If the nodes in a cluster belong to multiple availability // zones, then minNodeCount must be at least 3. MinNodeCount *int64 `locationName:"minNodeCount" min:"1" type:"integer"` // The duration in seconds that FinSpace will wait after a scale in event before // initiating another scaling event. ScaleInCooldownSeconds *float64 `locationName:"scaleInCooldownSeconds" type:"double"` // The duration in seconds that FinSpace will wait after a scale out event before // initiating another scaling event. ScaleOutCooldownSeconds *float64 `locationName:"scaleOutCooldownSeconds" type:"double"` // contains filtered or unexported fields }
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
func (s AutoScalingConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoScalingConfiguration) SetAutoScalingMetric(v string) *AutoScalingConfiguration
SetAutoScalingMetric sets the AutoScalingMetric field's value.
func (s *AutoScalingConfiguration) SetMaxNodeCount(v int64) *AutoScalingConfiguration
SetMaxNodeCount sets the MaxNodeCount field's value.
func (s *AutoScalingConfiguration) SetMetricTarget(v float64) *AutoScalingConfiguration
SetMetricTarget sets the MetricTarget field's value.
func (s *AutoScalingConfiguration) SetMinNodeCount(v int64) *AutoScalingConfiguration
SetMinNodeCount sets the MinNodeCount field's value.
func (s *AutoScalingConfiguration) SetScaleInCooldownSeconds(v float64) *AutoScalingConfiguration
SetScaleInCooldownSeconds sets the ScaleInCooldownSeconds field's value.
func (s *AutoScalingConfiguration) SetScaleOutCooldownSeconds(v float64) *AutoScalingConfiguration
SetScaleOutCooldownSeconds sets the ScaleOutCooldownSeconds field's value.
func (s AutoScalingConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoScalingConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CapacityConfiguration struct { // The number of instances running in a cluster. NodeCount *int64 `locationName:"nodeCount" min:"1" type:"integer"` // The type that determines the hardware of the host computer used for your // cluster instance. Each node type offers different memory and storage capabilities. // Choose a node type based on the requirements of the application or software // that you plan to run on your instance. // // You can only specify one of the following values: // // * kx.s.large – The node type with a configuration of 12 GiB memory and // 2 vCPUs. // // * kx.s.xlarge – The node type with a configuration of 27 GiB memory // and 4 vCPUs. // // * kx.s.2xlarge – The node type with a configuration of 54 GiB memory // and 8 vCPUs. // // * kx.s.4xlarge – The node type with a configuration of 108 GiB memory // and 16 vCPUs. // // * kx.s.8xlarge – The node type with a configuration of 216 GiB memory // and 32 vCPUs. // // * kx.s.16xlarge – The node type with a configuration of 432 GiB memory // and 64 vCPUs. // // * kx.s.32xlarge – The node type with a configuration of 864 GiB memory // and 128 vCPUs. NodeType *string `locationName:"nodeType" min:"1" type:"string"` // contains filtered or unexported fields }
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
func (s CapacityConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CapacityConfiguration) SetNodeCount(v int64) *CapacityConfiguration
SetNodeCount sets the NodeCount field's value.
func (s *CapacityConfiguration) SetNodeType(v string) *CapacityConfiguration
SetNodeType sets the NodeType field's value.
func (s CapacityConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CapacityConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangeRequest struct { // Defines the type of change request. A changeType can have the following values: // // * PUT – Adds or updates files in a database. // // * DELETE – Deletes files in a database. // // ChangeType is a required field ChangeType *string `locationName:"changeType" type:"string" required:"true" enum:"ChangeType"` // Defines the path within the database directory. // // DbPath is a required field DbPath *string `locationName:"dbPath" min:"1" type:"string" required:"true"` // Defines the S3 path of the source file that is required to add or update // files in a database. S3Path *string `locationName:"s3Path" min:"9" type:"string"` // contains filtered or unexported fields }
A list of change request objects.
func (s ChangeRequest) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ChangeRequest) SetChangeType(v string) *ChangeRequest
SetChangeType sets the ChangeType field's value.
func (s *ChangeRequest) SetDbPath(v string) *ChangeRequest
SetDbPath sets the DbPath field's value.
func (s *ChangeRequest) SetS3Path(v string) *ChangeRequest
SetS3Path sets the S3Path field's value.
func (s ChangeRequest) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ChangeRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CodeConfiguration struct { // A unique name for the S3 bucket. S3Bucket *string `locationName:"s3Bucket" min:"3" type:"string"` // The full S3 path (excluding bucket) to the .zip file. This file contains // the code that is loaded onto the cluster when it's started. S3Key *string `locationName:"s3Key" min:"1" type:"string"` // The version of an S3 object. S3ObjectVersion *string `locationName:"s3ObjectVersion" min:"1" type:"string"` // contains filtered or unexported fields }
The structure of the customer code available within the running cluster.
func (s CodeConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CodeConfiguration) SetS3Bucket(v string) *CodeConfiguration
SetS3Bucket sets the S3Bucket field's value.
func (s *CodeConfiguration) SetS3Key(v string) *CodeConfiguration
SetS3Key sets the S3Key field's value.
func (s *CodeConfiguration) SetS3ObjectVersion(v string) *CodeConfiguration
SetS3ObjectVersion sets the S3ObjectVersion field's value.
func (s CodeConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CodeConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // The reason for the conflict exception. Reason *string `locationName:"reason" type:"string"` // contains filtered or unexported fields }
There was a conflict with this action, and it could not be completed.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateEnvironmentInput struct { // 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 `locationName:"dataBundles" type:"list"` // The description of the FinSpace environment to be created. Description *string `locationName:"description" min:"1" type:"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 *string `locationName:"federationMode" type:"string" enum:"FederationMode"` // Configuration information when authentication mode is FEDERATED. FederationParameters *FederationParameters `locationName:"federationParameters" type:"structure"` // The KMS key id to encrypt your data in the FinSpace environment. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` // The name of the FinSpace environment to be created. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // Configuration information for the superuser. SuperuserParameters *SuperuserParameters `locationName:"superuserParameters" type:"structure"` // Add tags to your FinSpace environment. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateEnvironmentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEnvironmentInput) SetDataBundles(v []*string) *CreateEnvironmentInput
SetDataBundles sets the DataBundles field's value.
func (s *CreateEnvironmentInput) SetDescription(v string) *CreateEnvironmentInput
SetDescription sets the Description field's value.
func (s *CreateEnvironmentInput) SetFederationMode(v string) *CreateEnvironmentInput
SetFederationMode sets the FederationMode field's value.
func (s *CreateEnvironmentInput) SetFederationParameters(v *FederationParameters) *CreateEnvironmentInput
SetFederationParameters sets the FederationParameters field's value.
func (s *CreateEnvironmentInput) SetKmsKeyId(v string) *CreateEnvironmentInput
SetKmsKeyId sets the KmsKeyId field's value.
func (s *CreateEnvironmentInput) SetName(v string) *CreateEnvironmentInput
SetName sets the Name field's value.
func (s *CreateEnvironmentInput) SetSuperuserParameters(v *SuperuserParameters) *CreateEnvironmentInput
SetSuperuserParameters sets the SuperuserParameters field's value.
func (s *CreateEnvironmentInput) SetTags(v map[string]*string) *CreateEnvironmentInput
SetTags sets the Tags field's value.
func (s CreateEnvironmentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the FinSpace environment that you created. EnvironmentArn *string `locationName:"environmentArn" min:"20" type:"string"` // The unique identifier for FinSpace environment that you created. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The sign-in URL for the web application of the FinSpace environment you created. EnvironmentUrl *string `locationName:"environmentUrl" min:"1" type:"string"` // contains filtered or unexported fields }
func (s CreateEnvironmentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEnvironmentOutput) SetEnvironmentArn(v string) *CreateEnvironmentOutput
SetEnvironmentArn sets the EnvironmentArn field's value.
func (s *CreateEnvironmentOutput) SetEnvironmentId(v string) *CreateEnvironmentOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateEnvironmentOutput) SetEnvironmentUrl(v string) *CreateEnvironmentOutput
SetEnvironmentUrl sets the EnvironmentUrl field's value.
func (s CreateEnvironmentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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/"}] // // ChangeRequests is a required field ChangeRequests []*ChangeRequest `locationName:"changeRequests" min:"1" type:"list" required:"true"` // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the kdb database. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier of the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateKxChangesetInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxChangesetInput) SetChangeRequests(v []*ChangeRequest) *CreateKxChangesetInput
SetChangeRequests sets the ChangeRequests field's value.
func (s *CreateKxChangesetInput) SetClientToken(v string) *CreateKxChangesetInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxChangesetInput) SetDatabaseName(v string) *CreateKxChangesetInput
SetDatabaseName sets the DatabaseName field's value.
func (s *CreateKxChangesetInput) SetEnvironmentId(v string) *CreateKxChangesetInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s CreateKxChangesetInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxChangesetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateKxChangesetOutput struct { // A list of change requests. ChangeRequests []*ChangeRequest `locationName:"changeRequests" min:"1" type:"list"` // A unique identifier for the changeset. ChangesetId *string `locationName:"changesetId" min:"1" type:"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 `locationName:"createdTimestamp" type:"timestamp"` // The name of the kdb database. DatabaseName *string `locationName:"databaseName" min:"3" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"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 *ErrorInfo `locationName:"errorInfo" type:"structure"` // 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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // 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 *string `locationName:"status" type:"string" enum:"ChangesetStatus"` // contains filtered or unexported fields }
func (s CreateKxChangesetOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxChangesetOutput) SetChangeRequests(v []*ChangeRequest) *CreateKxChangesetOutput
SetChangeRequests sets the ChangeRequests field's value.
func (s *CreateKxChangesetOutput) SetChangesetId(v string) *CreateKxChangesetOutput
SetChangesetId sets the ChangesetId field's value.
func (s *CreateKxChangesetOutput) SetCreatedTimestamp(v time.Time) *CreateKxChangesetOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *CreateKxChangesetOutput) SetDatabaseName(v string) *CreateKxChangesetOutput
SetDatabaseName sets the DatabaseName field's value.
func (s *CreateKxChangesetOutput) SetEnvironmentId(v string) *CreateKxChangesetOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxChangesetOutput) SetErrorInfo(v *ErrorInfo) *CreateKxChangesetOutput
SetErrorInfo sets the ErrorInfo field's value.
func (s *CreateKxChangesetOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxChangesetOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *CreateKxChangesetOutput) SetStatus(v string) *CreateKxChangesetOutput
SetStatus sets the Status field's value.
func (s CreateKxChangesetOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateKxClusterInput struct { // The configuration based on which FinSpace will scale in or scale out nodes // in your cluster. AutoScalingConfiguration *AutoScalingConfiguration `locationName:"autoScalingConfiguration" type:"structure"` // The availability zone identifiers for the requested regions. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 is a required field AzMode *string `locationName:"azMode" type:"string" required:"true" enum:"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 []*KxCacheStorageConfiguration `locationName:"cacheStorageConfigurations" type:"list"` // A structure for the metadata of a cluster. It includes information like the // CPUs needed, memory of instances, and number of instances. CapacityConfiguration *CapacityConfiguration `locationName:"capacityConfiguration" type:"structure"` // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A description of the cluster. ClusterDescription *string `locationName:"clusterDescription" min:"1" type:"string"` // A unique name for the cluster that you want to create. // // ClusterName is a required field ClusterName *string `locationName:"clusterName" min:"3" type:"string" required:"true"` // 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 is a required field ClusterType *string `locationName:"clusterType" type:"string" required:"true" enum:"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 *CodeConfiguration `locationName:"code" type:"structure"` // Defines the key-value pairs to make them available inside the cluster. CommandLineArguments []*KxCommandLineArgument `locationName:"commandLineArguments" type:"list"` // A list of databases that will be available for querying. Databases []*KxDatabaseConfiguration `locationName:"databases" type:"list"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // 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 `locationName:"executionRole" min:"1" type:"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 `locationName:"initializationScript" min:"1" type:"string"` // The version of FinSpace managed kdb to run. // // ReleaseLabel is a required field ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"string" required:"true"` // 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 *KxSavedownStorageConfiguration `locationName:"savedownStorageConfiguration" type:"structure"` // The structure that stores the configuration details of a scaling group. ScalingGroupConfiguration *KxScalingGroupConfiguration `locationName:"scalingGroupConfiguration" type:"structure"` // A list of key-value pairs to label the cluster. You can add up to 50 tags // to a cluster. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // 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 *TickerplantLogConfiguration `locationName:"tickerplantLogConfiguration" type:"structure"` // Configuration details about the network where the Privatelink endpoint of // the cluster resides. // // VpcConfiguration is a required field VpcConfiguration *VpcConfiguration `locationName:"vpcConfiguration" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s CreateKxClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxClusterInput) SetAutoScalingConfiguration(v *AutoScalingConfiguration) *CreateKxClusterInput
SetAutoScalingConfiguration sets the AutoScalingConfiguration field's value.
func (s *CreateKxClusterInput) SetAvailabilityZoneId(v string) *CreateKxClusterInput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *CreateKxClusterInput) SetAzMode(v string) *CreateKxClusterInput
SetAzMode sets the AzMode field's value.
func (s *CreateKxClusterInput) SetCacheStorageConfigurations(v []*KxCacheStorageConfiguration) *CreateKxClusterInput
SetCacheStorageConfigurations sets the CacheStorageConfigurations field's value.
func (s *CreateKxClusterInput) SetCapacityConfiguration(v *CapacityConfiguration) *CreateKxClusterInput
SetCapacityConfiguration sets the CapacityConfiguration field's value.
func (s *CreateKxClusterInput) SetClientToken(v string) *CreateKxClusterInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxClusterInput) SetClusterDescription(v string) *CreateKxClusterInput
SetClusterDescription sets the ClusterDescription field's value.
func (s *CreateKxClusterInput) SetClusterName(v string) *CreateKxClusterInput
SetClusterName sets the ClusterName field's value.
func (s *CreateKxClusterInput) SetClusterType(v string) *CreateKxClusterInput
SetClusterType sets the ClusterType field's value.
func (s *CreateKxClusterInput) SetCode(v *CodeConfiguration) *CreateKxClusterInput
SetCode sets the Code field's value.
func (s *CreateKxClusterInput) SetCommandLineArguments(v []*KxCommandLineArgument) *CreateKxClusterInput
SetCommandLineArguments sets the CommandLineArguments field's value.
func (s *CreateKxClusterInput) SetDatabases(v []*KxDatabaseConfiguration) *CreateKxClusterInput
SetDatabases sets the Databases field's value.
func (s *CreateKxClusterInput) SetEnvironmentId(v string) *CreateKxClusterInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxClusterInput) SetExecutionRole(v string) *CreateKxClusterInput
SetExecutionRole sets the ExecutionRole field's value.
func (s *CreateKxClusterInput) SetInitializationScript(v string) *CreateKxClusterInput
SetInitializationScript sets the InitializationScript field's value.
func (s *CreateKxClusterInput) SetReleaseLabel(v string) *CreateKxClusterInput
SetReleaseLabel sets the ReleaseLabel field's value.
func (s *CreateKxClusterInput) SetSavedownStorageConfiguration(v *KxSavedownStorageConfiguration) *CreateKxClusterInput
SetSavedownStorageConfiguration sets the SavedownStorageConfiguration field's value.
func (s *CreateKxClusterInput) SetScalingGroupConfiguration(v *KxScalingGroupConfiguration) *CreateKxClusterInput
SetScalingGroupConfiguration sets the ScalingGroupConfiguration field's value.
func (s *CreateKxClusterInput) SetTags(v map[string]*string) *CreateKxClusterInput
SetTags sets the Tags field's value.
func (s *CreateKxClusterInput) SetTickerplantLogConfiguration(v *TickerplantLogConfiguration) *CreateKxClusterInput
SetTickerplantLogConfiguration sets the TickerplantLogConfiguration field's value.
func (s *CreateKxClusterInput) SetVpcConfiguration(v *VpcConfiguration) *CreateKxClusterInput
SetVpcConfiguration sets the VpcConfiguration field's value.
func (s CreateKxClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateKxClusterOutput struct { // The configuration based on which FinSpace will scale in or scale out nodes // in your cluster. AutoScalingConfiguration *AutoScalingConfiguration `locationName:"autoScalingConfiguration" type:"structure"` // The availability zone identifiers for the requested regions. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 *string `locationName:"azMode" type:"string" enum:"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 []*KxCacheStorageConfiguration `locationName:"cacheStorageConfigurations" type:"list"` // A structure for the metadata of a cluster. It includes information like the // CPUs needed, memory of instances, and number of instances. CapacityConfiguration *CapacityConfiguration `locationName:"capacityConfiguration" type:"structure"` // A description of the cluster. ClusterDescription *string `locationName:"clusterDescription" min:"1" type:"string"` // A unique name for the cluster. ClusterName *string `locationName:"clusterName" min:"3" type:"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 *string `locationName:"clusterType" type:"string" enum:"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 *CodeConfiguration `locationName:"code" type:"structure"` // Defines the key-value pairs to make them available inside the cluster. CommandLineArguments []*KxCommandLineArgument `locationName:"commandLineArguments" type:"list"` // 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 `locationName:"createdTimestamp" type:"timestamp"` // A list of databases that will be available for querying. Databases []*KxDatabaseConfiguration `locationName:"databases" type:"list"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"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 `locationName:"executionRole" min:"1" type:"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 `locationName:"initializationScript" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // A version of the FinSpace managed kdb to run. ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"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 *KxSavedownStorageConfiguration `locationName:"savedownStorageConfiguration" type:"structure"` // The structure that stores the configuration details of a scaling group. ScalingGroupConfiguration *KxScalingGroupConfiguration `locationName:"scalingGroupConfiguration" type:"structure"` // 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 *string `locationName:"status" type:"string" enum:"KxClusterStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"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 *TickerplantLogConfiguration `locationName:"tickerplantLogConfiguration" type:"structure"` // A list of volumes mounted on the cluster. Volumes []*Volume `locationName:"volumes" type:"list"` // Configuration details about the network where the Privatelink endpoint of // the cluster resides. VpcConfiguration *VpcConfiguration `locationName:"vpcConfiguration" type:"structure"` // contains filtered or unexported fields }
func (s CreateKxClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxClusterOutput) SetAutoScalingConfiguration(v *AutoScalingConfiguration) *CreateKxClusterOutput
SetAutoScalingConfiguration sets the AutoScalingConfiguration field's value.
func (s *CreateKxClusterOutput) SetAvailabilityZoneId(v string) *CreateKxClusterOutput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *CreateKxClusterOutput) SetAzMode(v string) *CreateKxClusterOutput
SetAzMode sets the AzMode field's value.
func (s *CreateKxClusterOutput) SetCacheStorageConfigurations(v []*KxCacheStorageConfiguration) *CreateKxClusterOutput
SetCacheStorageConfigurations sets the CacheStorageConfigurations field's value.
func (s *CreateKxClusterOutput) SetCapacityConfiguration(v *CapacityConfiguration) *CreateKxClusterOutput
SetCapacityConfiguration sets the CapacityConfiguration field's value.
func (s *CreateKxClusterOutput) SetClusterDescription(v string) *CreateKxClusterOutput
SetClusterDescription sets the ClusterDescription field's value.
func (s *CreateKxClusterOutput) SetClusterName(v string) *CreateKxClusterOutput
SetClusterName sets the ClusterName field's value.
func (s *CreateKxClusterOutput) SetClusterType(v string) *CreateKxClusterOutput
SetClusterType sets the ClusterType field's value.
func (s *CreateKxClusterOutput) SetCode(v *CodeConfiguration) *CreateKxClusterOutput
SetCode sets the Code field's value.
func (s *CreateKxClusterOutput) SetCommandLineArguments(v []*KxCommandLineArgument) *CreateKxClusterOutput
SetCommandLineArguments sets the CommandLineArguments field's value.
func (s *CreateKxClusterOutput) SetCreatedTimestamp(v time.Time) *CreateKxClusterOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *CreateKxClusterOutput) SetDatabases(v []*KxDatabaseConfiguration) *CreateKxClusterOutput
SetDatabases sets the Databases field's value.
func (s *CreateKxClusterOutput) SetEnvironmentId(v string) *CreateKxClusterOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxClusterOutput) SetExecutionRole(v string) *CreateKxClusterOutput
SetExecutionRole sets the ExecutionRole field's value.
func (s *CreateKxClusterOutput) SetInitializationScript(v string) *CreateKxClusterOutput
SetInitializationScript sets the InitializationScript field's value.
func (s *CreateKxClusterOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxClusterOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *CreateKxClusterOutput) SetReleaseLabel(v string) *CreateKxClusterOutput
SetReleaseLabel sets the ReleaseLabel field's value.
func (s *CreateKxClusterOutput) SetSavedownStorageConfiguration(v *KxSavedownStorageConfiguration) *CreateKxClusterOutput
SetSavedownStorageConfiguration sets the SavedownStorageConfiguration field's value.
func (s *CreateKxClusterOutput) SetScalingGroupConfiguration(v *KxScalingGroupConfiguration) *CreateKxClusterOutput
SetScalingGroupConfiguration sets the ScalingGroupConfiguration field's value.
func (s *CreateKxClusterOutput) SetStatus(v string) *CreateKxClusterOutput
SetStatus sets the Status field's value.
func (s *CreateKxClusterOutput) SetStatusReason(v string) *CreateKxClusterOutput
SetStatusReason sets the StatusReason field's value.
func (s *CreateKxClusterOutput) SetTickerplantLogConfiguration(v *TickerplantLogConfiguration) *CreateKxClusterOutput
SetTickerplantLogConfiguration sets the TickerplantLogConfiguration field's value.
func (s *CreateKxClusterOutput) SetVolumes(v []*Volume) *CreateKxClusterOutput
SetVolumes sets the Volumes field's value.
func (s *CreateKxClusterOutput) SetVpcConfiguration(v *VpcConfiguration) *CreateKxClusterOutput
SetVpcConfiguration sets the VpcConfiguration field's value.
func (s CreateKxClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateKxDatabaseInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the kdb database. // // DatabaseName is a required field DatabaseName *string `locationName:"databaseName" min:"3" type:"string" required:"true"` // A description of the database. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // 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 `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateKxDatabaseInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxDatabaseInput) SetClientToken(v string) *CreateKxDatabaseInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxDatabaseInput) SetDatabaseName(v string) *CreateKxDatabaseInput
SetDatabaseName sets the DatabaseName field's value.
func (s *CreateKxDatabaseInput) SetDescription(v string) *CreateKxDatabaseInput
SetDescription sets the Description field's value.
func (s *CreateKxDatabaseInput) SetEnvironmentId(v string) *CreateKxDatabaseInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxDatabaseInput) SetTags(v map[string]*string) *CreateKxDatabaseInput
SetTags sets the Tags field's value.
func (s CreateKxDatabaseInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 `locationName:"createdTimestamp" type:"timestamp"` // The ARN identifier of the database. DatabaseArn *string `locationName:"databaseArn" type:"string"` // The name of the kdb database. DatabaseName *string `locationName:"databaseName" min:"3" type:"string"` // A description of the database. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // contains filtered or unexported fields }
func (s CreateKxDatabaseOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxDatabaseOutput) SetCreatedTimestamp(v time.Time) *CreateKxDatabaseOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *CreateKxDatabaseOutput) SetDatabaseArn(v string) *CreateKxDatabaseOutput
SetDatabaseArn sets the DatabaseArn field's value.
func (s *CreateKxDatabaseOutput) SetDatabaseName(v string) *CreateKxDatabaseOutput
SetDatabaseName sets the DatabaseName field's value.
func (s *CreateKxDatabaseOutput) SetDescription(v string) *CreateKxDatabaseOutput
SetDescription sets the Description field's value.
func (s *CreateKxDatabaseOutput) SetEnvironmentId(v string) *CreateKxDatabaseOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxDatabaseOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxDatabaseOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s CreateKxDatabaseOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateKxDataviewInput struct { // 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 `locationName:"autoUpdate" type:"boolean"` // The identifier of the availability zones. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 is a required field AzMode *string `locationName:"azMode" type:"string" required:"true" enum:"KxAzMode"` // A unique identifier of the changeset that you want to use to ingest data. ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the database where you want to create a dataview. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier for the dataview. // // DataviewName is a required field DataviewName *string `locationName:"dataviewName" min:"3" type:"string" required:"true"` // A description of the dataview. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment, where you want to create the // dataview. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // 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 `locationName:"readWrite" type:"boolean"` // 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 []*KxDataviewSegmentConfiguration `locationName:"segmentConfigurations" type:"list"` // A list of key-value pairs to label the dataview. You can add up to 50 tags // to a dataview. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateKxDataviewInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxDataviewInput) SetAutoUpdate(v bool) *CreateKxDataviewInput
SetAutoUpdate sets the AutoUpdate field's value.
func (s *CreateKxDataviewInput) SetAvailabilityZoneId(v string) *CreateKxDataviewInput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *CreateKxDataviewInput) SetAzMode(v string) *CreateKxDataviewInput
SetAzMode sets the AzMode field's value.
func (s *CreateKxDataviewInput) SetChangesetId(v string) *CreateKxDataviewInput
SetChangesetId sets the ChangesetId field's value.
func (s *CreateKxDataviewInput) SetClientToken(v string) *CreateKxDataviewInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxDataviewInput) SetDatabaseName(v string) *CreateKxDataviewInput
SetDatabaseName sets the DatabaseName field's value.
func (s *CreateKxDataviewInput) SetDataviewName(v string) *CreateKxDataviewInput
SetDataviewName sets the DataviewName field's value.
func (s *CreateKxDataviewInput) SetDescription(v string) *CreateKxDataviewInput
SetDescription sets the Description field's value.
func (s *CreateKxDataviewInput) SetEnvironmentId(v string) *CreateKxDataviewInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxDataviewInput) SetReadWrite(v bool) *CreateKxDataviewInput
SetReadWrite sets the ReadWrite field's value.
func (s *CreateKxDataviewInput) SetSegmentConfigurations(v []*KxDataviewSegmentConfiguration) *CreateKxDataviewInput
SetSegmentConfigurations sets the SegmentConfigurations field's value.
func (s *CreateKxDataviewInput) SetTags(v map[string]*string) *CreateKxDataviewInput
SetTags sets the Tags field's value.
func (s CreateKxDataviewInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxDataviewInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 `locationName:"autoUpdate" type:"boolean"` // The identifier of the availability zones. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 *string `locationName:"azMode" type:"string" enum:"KxAzMode"` // A unique identifier for the changeset. ChangesetId *string `locationName:"changesetId" min:"1" type:"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 `locationName:"createdTimestamp" type:"timestamp"` // The name of the database where you want to create a dataview. DatabaseName *string `locationName:"databaseName" min:"3" type:"string"` // A unique identifier for the dataview. DataviewName *string `locationName:"dataviewName" min:"3" type:"string"` // A description of the dataview. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment, where you want to create the // dataview. EnvironmentId *string `locationName:"environmentId" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // Returns True if the dataview is created as writeable and False otherwise. ReadWrite *bool `locationName:"readWrite" type:"boolean"` // 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 []*KxDataviewSegmentConfiguration `locationName:"segmentConfigurations" type:"list"` // 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 *string `locationName:"status" type:"string" enum:"KxDataviewStatus"` // contains filtered or unexported fields }
func (s CreateKxDataviewOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxDataviewOutput) SetAutoUpdate(v bool) *CreateKxDataviewOutput
SetAutoUpdate sets the AutoUpdate field's value.
func (s *CreateKxDataviewOutput) SetAvailabilityZoneId(v string) *CreateKxDataviewOutput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *CreateKxDataviewOutput) SetAzMode(v string) *CreateKxDataviewOutput
SetAzMode sets the AzMode field's value.
func (s *CreateKxDataviewOutput) SetChangesetId(v string) *CreateKxDataviewOutput
SetChangesetId sets the ChangesetId field's value.
func (s *CreateKxDataviewOutput) SetCreatedTimestamp(v time.Time) *CreateKxDataviewOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *CreateKxDataviewOutput) SetDatabaseName(v string) *CreateKxDataviewOutput
SetDatabaseName sets the DatabaseName field's value.
func (s *CreateKxDataviewOutput) SetDataviewName(v string) *CreateKxDataviewOutput
SetDataviewName sets the DataviewName field's value.
func (s *CreateKxDataviewOutput) SetDescription(v string) *CreateKxDataviewOutput
SetDescription sets the Description field's value.
func (s *CreateKxDataviewOutput) SetEnvironmentId(v string) *CreateKxDataviewOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxDataviewOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxDataviewOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *CreateKxDataviewOutput) SetReadWrite(v bool) *CreateKxDataviewOutput
SetReadWrite sets the ReadWrite field's value.
func (s *CreateKxDataviewOutput) SetSegmentConfigurations(v []*KxDataviewSegmentConfiguration) *CreateKxDataviewOutput
SetSegmentConfigurations sets the SegmentConfigurations field's value.
func (s *CreateKxDataviewOutput) SetStatus(v string) *CreateKxDataviewOutput
SetStatus sets the Status field's value.
func (s CreateKxDataviewOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateKxEnvironmentInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A description for the kdb environment. Description *string `locationName:"description" min:"1" type:"string"` // The KMS key ID to encrypt your data in the FinSpace environment. // // KmsKeyId is a required field KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string" required:"true"` // The name of the kdb environment that you want to create. // // Name is a required field Name *string `locationName:"name" min:"3" type:"string" required:"true"` // 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 `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateKxEnvironmentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxEnvironmentInput) SetClientToken(v string) *CreateKxEnvironmentInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxEnvironmentInput) SetDescription(v string) *CreateKxEnvironmentInput
SetDescription sets the Description field's value.
func (s *CreateKxEnvironmentInput) SetKmsKeyId(v string) *CreateKxEnvironmentInput
SetKmsKeyId sets the KmsKeyId field's value.
func (s *CreateKxEnvironmentInput) SetName(v string) *CreateKxEnvironmentInput
SetName sets the Name field's value.
func (s *CreateKxEnvironmentInput) SetTags(v map[string]*string) *CreateKxEnvironmentInput
SetTags sets the Tags field's value.
func (s CreateKxEnvironmentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateKxEnvironmentOutput struct { // The timestamp at which the kdb environment was created in FinSpace. CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"` // A description for the kdb environment. Description *string `locationName:"description" min:"1" type:"string"` // The ARN identifier of the environment. EnvironmentArn *string `locationName:"environmentArn" min:"20" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The KMS key ID to encrypt your data in the FinSpace environment. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` // The name of the kdb environment. Name *string `locationName:"name" min:"3" type:"string"` // The status of the kdb environment. Status *string `locationName:"status" type:"string" enum:"EnvironmentStatus"` // contains filtered or unexported fields }
func (s CreateKxEnvironmentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxEnvironmentOutput) SetCreationTimestamp(v time.Time) *CreateKxEnvironmentOutput
SetCreationTimestamp sets the CreationTimestamp field's value.
func (s *CreateKxEnvironmentOutput) SetDescription(v string) *CreateKxEnvironmentOutput
SetDescription sets the Description field's value.
func (s *CreateKxEnvironmentOutput) SetEnvironmentArn(v string) *CreateKxEnvironmentOutput
SetEnvironmentArn sets the EnvironmentArn field's value.
func (s *CreateKxEnvironmentOutput) SetEnvironmentId(v string) *CreateKxEnvironmentOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxEnvironmentOutput) SetKmsKeyId(v string) *CreateKxEnvironmentOutput
SetKmsKeyId sets the KmsKeyId field's value.
func (s *CreateKxEnvironmentOutput) SetName(v string) *CreateKxEnvironmentOutput
SetName sets the Name field's value.
func (s *CreateKxEnvironmentOutput) SetStatus(v string) *CreateKxEnvironmentOutput
SetStatus sets the Status field's value.
func (s CreateKxEnvironmentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateKxScalingGroupInput struct { // The identifier of the availability zones. // // AvailabilityZoneId is a required field AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"string" required:"true"` // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A unique identifier for the kdb environment, where you want to create the // scaling group. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // 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. // // HostType is a required field HostType *string `locationName:"hostType" min:"1" type:"string" required:"true"` // A unique identifier for the kdb scaling group. // // ScalingGroupName is a required field ScalingGroupName *string `locationName:"scalingGroupName" min:"3" type:"string" required:"true"` // 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 `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateKxScalingGroupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxScalingGroupInput) SetAvailabilityZoneId(v string) *CreateKxScalingGroupInput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *CreateKxScalingGroupInput) SetClientToken(v string) *CreateKxScalingGroupInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxScalingGroupInput) SetEnvironmentId(v string) *CreateKxScalingGroupInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxScalingGroupInput) SetHostType(v string) *CreateKxScalingGroupInput
SetHostType sets the HostType field's value.
func (s *CreateKxScalingGroupInput) SetScalingGroupName(v string) *CreateKxScalingGroupInput
SetScalingGroupName sets the ScalingGroupName field's value.
func (s *CreateKxScalingGroupInput) SetTags(v map[string]*string) *CreateKxScalingGroupInput
SetTags sets the Tags field's value.
func (s CreateKxScalingGroupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxScalingGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateKxScalingGroupOutput struct { // The identifier of the availability zones. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 `locationName:"createdTimestamp" type:"timestamp"` // A unique identifier for the kdb environment, where you create the scaling // group. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The memory and CPU capabilities of the scaling group host on which FinSpace // Managed kdb clusters will be placed. HostType *string `locationName:"hostType" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // A unique identifier for the kdb scaling group. ScalingGroupName *string `locationName:"scalingGroupName" min:"3" type:"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 *string `locationName:"status" type:"string" enum:"KxScalingGroupStatus"` // contains filtered or unexported fields }
func (s CreateKxScalingGroupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxScalingGroupOutput) SetAvailabilityZoneId(v string) *CreateKxScalingGroupOutput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *CreateKxScalingGroupOutput) SetCreatedTimestamp(v time.Time) *CreateKxScalingGroupOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *CreateKxScalingGroupOutput) SetEnvironmentId(v string) *CreateKxScalingGroupOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxScalingGroupOutput) SetHostType(v string) *CreateKxScalingGroupOutput
SetHostType sets the HostType field's value.
func (s *CreateKxScalingGroupOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxScalingGroupOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *CreateKxScalingGroupOutput) SetScalingGroupName(v string) *CreateKxScalingGroupOutput
SetScalingGroupName sets the ScalingGroupName field's value.
func (s *CreateKxScalingGroupOutput) SetStatus(v string) *CreateKxScalingGroupOutput
SetStatus sets the Status field's value.
func (s CreateKxScalingGroupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateKxUserInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A unique identifier for the kdb environment where you want to create a user. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The IAM role ARN that will be associated with the user. // // IamRole is a required field IamRole *string `locationName:"iamRole" min:"20" type:"string" required:"true"` // A list of key-value pairs to label the user. You can add up to 50 tags to // a user. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // A unique identifier for the user. // // UserName is a required field UserName *string `locationName:"userName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateKxUserInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxUserInput) SetClientToken(v string) *CreateKxUserInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxUserInput) SetEnvironmentId(v string) *CreateKxUserInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxUserInput) SetIamRole(v string) *CreateKxUserInput
SetIamRole sets the IamRole field's value.
func (s *CreateKxUserInput) SetTags(v map[string]*string) *CreateKxUserInput
SetTags sets the Tags field's value.
func (s *CreateKxUserInput) SetUserName(v string) *CreateKxUserInput
SetUserName sets the UserName field's value.
func (s CreateKxUserInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateKxUserOutput struct { // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The IAM role ARN that will be associated with the user. IamRole *string `locationName:"iamRole" min:"20" type:"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 `locationName:"userArn" min:"20" type:"string"` // A unique identifier for the user. UserName *string `locationName:"userName" min:"1" type:"string"` // contains filtered or unexported fields }
func (s CreateKxUserOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxUserOutput) SetEnvironmentId(v string) *CreateKxUserOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxUserOutput) SetIamRole(v string) *CreateKxUserOutput
SetIamRole sets the IamRole field's value.
func (s *CreateKxUserOutput) SetUserArn(v string) *CreateKxUserOutput
SetUserArn sets the UserArn field's value.
func (s *CreateKxUserOutput) SetUserName(v string) *CreateKxUserOutput
SetUserName sets the UserName field's value.
func (s CreateKxUserOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateKxVolumeInput struct { // The identifier of the availability zones. // // AvailabilityZoneIds is a required field AvailabilityZoneIds []*string `locationName:"availabilityZoneIds" type:"list" required:"true"` // 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 is a required field AzMode *string `locationName:"azMode" type:"string" required:"true" enum:"KxAzMode"` // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A description of the volume. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment, whose clusters can attach to // the volume. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // 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 *KxNAS1Configuration `locationName:"nas1Configuration" type:"structure"` // A list of key-value pairs to label the volume. You can add up to 50 tags // to a volume. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // A unique identifier for the volume. // // VolumeName is a required field VolumeName *string `locationName:"volumeName" min:"3" type:"string" required:"true"` // 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. // // VolumeType is a required field VolumeType *string `locationName:"volumeType" type:"string" required:"true" enum:"KxVolumeType"` // contains filtered or unexported fields }
func (s CreateKxVolumeInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxVolumeInput) SetAvailabilityZoneIds(v []*string) *CreateKxVolumeInput
SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.
func (s *CreateKxVolumeInput) SetAzMode(v string) *CreateKxVolumeInput
SetAzMode sets the AzMode field's value.
func (s *CreateKxVolumeInput) SetClientToken(v string) *CreateKxVolumeInput
SetClientToken sets the ClientToken field's value.
func (s *CreateKxVolumeInput) SetDescription(v string) *CreateKxVolumeInput
SetDescription sets the Description field's value.
func (s *CreateKxVolumeInput) SetEnvironmentId(v string) *CreateKxVolumeInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxVolumeInput) SetNas1Configuration(v *KxNAS1Configuration) *CreateKxVolumeInput
SetNas1Configuration sets the Nas1Configuration field's value.
func (s *CreateKxVolumeInput) SetTags(v map[string]*string) *CreateKxVolumeInput
SetTags sets the Tags field's value.
func (s *CreateKxVolumeInput) SetVolumeName(v string) *CreateKxVolumeInput
SetVolumeName sets the VolumeName field's value.
func (s *CreateKxVolumeInput) SetVolumeType(v string) *CreateKxVolumeInput
SetVolumeType sets the VolumeType field's value.
func (s CreateKxVolumeInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxVolumeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateKxVolumeOutput struct { // The identifier of the availability zones. AvailabilityZoneIds []*string `locationName:"availabilityZoneIds" type:"list"` // 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 *string `locationName:"azMode" type:"string" enum:"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 `locationName:"createdTimestamp" type:"timestamp"` // A description of the volume. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment, whose clusters can attach to // the volume. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // Specifies the configuration for the Network attached storage (NAS_1) file // system volume. Nas1Configuration *KxNAS1Configuration `locationName:"nas1Configuration" type:"structure"` // 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 *string `locationName:"status" type:"string" enum:"KxVolumeStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // The ARN identifier of the volume. VolumeArn *string `locationName:"volumeArn" min:"20" type:"string"` // A unique identifier for the volume. VolumeName *string `locationName:"volumeName" min:"3" type:"string"` // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType *string `locationName:"volumeType" type:"string" enum:"KxVolumeType"` // contains filtered or unexported fields }
func (s CreateKxVolumeOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateKxVolumeOutput) SetAvailabilityZoneIds(v []*string) *CreateKxVolumeOutput
SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.
func (s *CreateKxVolumeOutput) SetAzMode(v string) *CreateKxVolumeOutput
SetAzMode sets the AzMode field's value.
func (s *CreateKxVolumeOutput) SetCreatedTimestamp(v time.Time) *CreateKxVolumeOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *CreateKxVolumeOutput) SetDescription(v string) *CreateKxVolumeOutput
SetDescription sets the Description field's value.
func (s *CreateKxVolumeOutput) SetEnvironmentId(v string) *CreateKxVolumeOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *CreateKxVolumeOutput) SetNas1Configuration(v *KxNAS1Configuration) *CreateKxVolumeOutput
SetNas1Configuration sets the Nas1Configuration field's value.
func (s *CreateKxVolumeOutput) SetStatus(v string) *CreateKxVolumeOutput
SetStatus sets the Status field's value.
func (s *CreateKxVolumeOutput) SetStatusReason(v string) *CreateKxVolumeOutput
SetStatusReason sets the StatusReason field's value.
func (s *CreateKxVolumeOutput) SetVolumeArn(v string) *CreateKxVolumeOutput
SetVolumeArn sets the VolumeArn field's value.
func (s *CreateKxVolumeOutput) SetVolumeName(v string) *CreateKxVolumeOutput
SetVolumeName sets the VolumeName field's value.
func (s *CreateKxVolumeOutput) SetVolumeType(v string) *CreateKxVolumeOutput
SetVolumeType sets the VolumeType field's value.
func (s CreateKxVolumeOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CustomDNSServer struct { // The IP address of the DNS server. // // CustomDNSServerIP is a required field CustomDNSServerIP *string `locationName:"customDNSServerIP" type:"string" required:"true"` // The name of the DNS server. // // CustomDNSServerName is a required field CustomDNSServerName *string `locationName:"customDNSServerName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
func (s CustomDNSServer) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CustomDNSServer) SetCustomDNSServerIP(v string) *CustomDNSServer
SetCustomDNSServerIP sets the CustomDNSServerIP field's value.
func (s *CustomDNSServer) SetCustomDNSServerName(v string) *CustomDNSServer
SetCustomDNSServerName sets the CustomDNSServerName field's value.
func (s CustomDNSServer) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CustomDNSServer) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEnvironmentInput struct { // The identifier for the FinSpace environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteEnvironmentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteEnvironmentInput) SetEnvironmentId(v string) *DeleteEnvironmentInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s DeleteEnvironmentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEnvironmentOutput struct {
// contains filtered or unexported fields
}
func (s DeleteEnvironmentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteEnvironmentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxClusterInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the cluster that you want to delete. // // ClusterName is a required field ClusterName *string `location:"uri" locationName:"clusterName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxClusterInput) SetClientToken(v string) *DeleteKxClusterInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteKxClusterInput) SetClusterName(v string) *DeleteKxClusterInput
SetClusterName sets the ClusterName field's value.
func (s *DeleteKxClusterInput) SetEnvironmentId(v string) *DeleteKxClusterInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s DeleteKxClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxClusterNodeInput struct { // The name of the cluster, for which you want to delete the nodes. // // ClusterName is a required field ClusterName *string `location:"uri" locationName:"clusterName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // A unique identifier for the node that you want to delete. // // NodeId is a required field NodeId *string `location:"uri" locationName:"nodeId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxClusterNodeInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxClusterNodeInput) SetClusterName(v string) *DeleteKxClusterNodeInput
SetClusterName sets the ClusterName field's value.
func (s *DeleteKxClusterNodeInput) SetEnvironmentId(v string) *DeleteKxClusterNodeInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *DeleteKxClusterNodeInput) SetNodeId(v string) *DeleteKxClusterNodeInput
SetNodeId sets the NodeId field's value.
func (s DeleteKxClusterNodeInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxClusterNodeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxClusterNodeOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxClusterNodeOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxClusterNodeOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxClusterOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxDatabaseInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the kdb database that you want to delete. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxDatabaseInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxDatabaseInput) SetClientToken(v string) *DeleteKxDatabaseInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteKxDatabaseInput) SetDatabaseName(v string) *DeleteKxDatabaseInput
SetDatabaseName sets the DatabaseName field's value.
func (s *DeleteKxDatabaseInput) SetEnvironmentId(v string) *DeleteKxDatabaseInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s DeleteKxDatabaseInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxDatabaseOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxDatabaseOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxDatabaseOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxDataviewInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the database whose dataview you want to delete. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // The name of the dataview that you want to delete. // // DataviewName is a required field DataviewName *string `location:"uri" locationName:"dataviewName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment, from where you want to delete // the dataview. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxDataviewInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxDataviewInput) SetClientToken(v string) *DeleteKxDataviewInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteKxDataviewInput) SetDatabaseName(v string) *DeleteKxDataviewInput
SetDatabaseName sets the DatabaseName field's value.
func (s *DeleteKxDataviewInput) SetDataviewName(v string) *DeleteKxDataviewInput
SetDataviewName sets the DataviewName field's value.
func (s *DeleteKxDataviewInput) SetEnvironmentId(v string) *DeleteKxDataviewInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s DeleteKxDataviewInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxDataviewInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxDataviewOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxDataviewOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxDataviewOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxEnvironmentInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxEnvironmentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxEnvironmentInput) SetClientToken(v string) *DeleteKxEnvironmentInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteKxEnvironmentInput) SetEnvironmentId(v string) *DeleteKxEnvironmentInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s DeleteKxEnvironmentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxEnvironmentOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxEnvironmentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxEnvironmentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxScalingGroupInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A unique identifier for the kdb environment, from where you want to delete // the dataview. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // A unique identifier for the kdb scaling group. // // ScalingGroupName is a required field ScalingGroupName *string `location:"uri" locationName:"scalingGroupName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxScalingGroupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxScalingGroupInput) SetClientToken(v string) *DeleteKxScalingGroupInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteKxScalingGroupInput) SetEnvironmentId(v string) *DeleteKxScalingGroupInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *DeleteKxScalingGroupInput) SetScalingGroupName(v string) *DeleteKxScalingGroupInput
SetScalingGroupName sets the ScalingGroupName field's value.
func (s DeleteKxScalingGroupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxScalingGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxScalingGroupOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxScalingGroupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxScalingGroupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxUserInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // A unique identifier for the user that you want to delete. // // UserName is a required field UserName *string `location:"uri" locationName:"userName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxUserInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxUserInput) SetClientToken(v string) *DeleteKxUserInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteKxUserInput) SetEnvironmentId(v string) *DeleteKxUserInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *DeleteKxUserInput) SetUserName(v string) *DeleteKxUserInput
SetUserName sets the UserName field's value.
func (s DeleteKxUserInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxUserOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxUserOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxUserOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteKxVolumeInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A unique identifier for the kdb environment, whose clusters can attach to // the volume. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The name of the volume that you want to delete. // // VolumeName is a required field VolumeName *string `location:"uri" locationName:"volumeName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteKxVolumeInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxVolumeInput) SetClientToken(v string) *DeleteKxVolumeInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteKxVolumeInput) SetEnvironmentId(v string) *DeleteKxVolumeInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *DeleteKxVolumeInput) SetVolumeName(v string) *DeleteKxVolumeInput
SetVolumeName sets the VolumeName field's value.
func (s DeleteKxVolumeInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteKxVolumeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteKxVolumeOutput struct {
// contains filtered or unexported fields
}
func (s DeleteKxVolumeOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteKxVolumeOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Environment struct { // The ID of the AWS account in which the FinSpace environment is created. AwsAccountId *string `locationName:"awsAccountId" min:"1" type:"string"` // The AWS account ID of the dedicated service account associated with your // FinSpace environment. DedicatedServiceAccountId *string `locationName:"dedicatedServiceAccountId" min:"1" type:"string"` // The description of the FinSpace environment. Description *string `locationName:"description" min:"1" type:"string"` // The Amazon Resource Name (ARN) of your FinSpace environment. EnvironmentArn *string `locationName:"environmentArn" min:"20" type:"string"` // The identifier of the FinSpace environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The sign-in URL for the web application of your FinSpace environment. EnvironmentUrl *string `locationName:"environmentUrl" min:"1" type:"string"` // The authentication mode for the environment. FederationMode *string `locationName:"federationMode" type:"string" enum:"FederationMode"` // Configuration information when authentication mode is FEDERATED. FederationParameters *FederationParameters `locationName:"federationParameters" type:"structure"` // The KMS key id used to encrypt in the FinSpace environment. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` // The name of the FinSpace environment. Name *string `locationName:"name" min:"1" type:"string"` // The URL of the integrated FinSpace notebook environment in your web application. SageMakerStudioDomainUrl *string `locationName:"sageMakerStudioDomainUrl" min:"1" type:"string"` // The current status of creation of the FinSpace environment. Status *string `locationName:"status" type:"string" enum:"EnvironmentStatus"` // contains filtered or unexported fields }
Represents an FinSpace environment.
func (s Environment) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Environment) SetAwsAccountId(v string) *Environment
SetAwsAccountId sets the AwsAccountId field's value.
func (s *Environment) SetDedicatedServiceAccountId(v string) *Environment
SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.
func (s *Environment) SetDescription(v string) *Environment
SetDescription sets the Description field's value.
func (s *Environment) SetEnvironmentArn(v string) *Environment
SetEnvironmentArn sets the EnvironmentArn field's value.
func (s *Environment) SetEnvironmentId(v string) *Environment
SetEnvironmentId sets the EnvironmentId field's value.
func (s *Environment) SetEnvironmentUrl(v string) *Environment
SetEnvironmentUrl sets the EnvironmentUrl field's value.
func (s *Environment) SetFederationMode(v string) *Environment
SetFederationMode sets the FederationMode field's value.
func (s *Environment) SetFederationParameters(v *FederationParameters) *Environment
SetFederationParameters sets the FederationParameters field's value.
func (s *Environment) SetKmsKeyId(v string) *Environment
SetKmsKeyId sets the KmsKeyId field's value.
func (s *Environment) SetName(v string) *Environment
SetName sets the Name field's value.
func (s *Environment) SetSageMakerStudioDomainUrl(v string) *Environment
SetSageMakerStudioDomainUrl sets the SageMakerStudioDomainUrl field's value.
func (s *Environment) SetStatus(v string) *Environment
SetStatus sets the Status field's value.
func (s Environment) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ErrorInfo struct { // Specifies the error message that appears if a flow fails. ErrorMessage *string `locationName:"errorMessage" type:"string"` // Specifies the type of error. ErrorType *string `locationName:"errorType" type:"string" enum:"ErrorDetails"` // contains filtered or unexported fields }
Provides details in the event of a failed flow, including the error type and the related error message.
func (s ErrorInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ErrorInfo) SetErrorMessage(v string) *ErrorInfo
SetErrorMessage sets the ErrorMessage field's value.
func (s *ErrorInfo) SetErrorType(v string) *ErrorInfo
SetErrorType sets the ErrorType field's value.
func (s ErrorInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type FederationParameters struct { // The redirect or sign-in URL that should be entered into the SAML 2.0 compliant // identity provider configuration (IdP). ApplicationCallBackURL *string `locationName:"applicationCallBackURL" min:"1" type:"string"` // SAML attribute name and value. The name must always be Email and the value // should be set to the attribute definition in which user email is set. For // example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. // Please check your SAML 2.0 compliant identity provider (IdP) documentation // for details. AttributeMap map[string]*string `locationName:"attributeMap" type:"map"` // Name of the identity provider (IdP). FederationProviderName *string `locationName:"federationProviderName" min:"1" type:"string"` // The Uniform Resource Name (URN). Also referred as Service Provider URN or // Audience URI or Service Provider Entity ID. FederationURN *string `locationName:"federationURN" min:"1" type:"string"` // SAML 2.0 Metadata document from identity provider (IdP). SamlMetadataDocument *string `locationName:"samlMetadataDocument" min:"1000" type:"string"` // Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP). SamlMetadataURL *string `locationName:"samlMetadataURL" min:"1" type:"string"` // contains filtered or unexported fields }
Configuration information when authentication mode is FEDERATED.
func (s FederationParameters) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *FederationParameters) SetApplicationCallBackURL(v string) *FederationParameters
SetApplicationCallBackURL sets the ApplicationCallBackURL field's value.
func (s *FederationParameters) SetAttributeMap(v map[string]*string) *FederationParameters
SetAttributeMap sets the AttributeMap field's value.
func (s *FederationParameters) SetFederationProviderName(v string) *FederationParameters
SetFederationProviderName sets the FederationProviderName field's value.
func (s *FederationParameters) SetFederationURN(v string) *FederationParameters
SetFederationURN sets the FederationURN field's value.
func (s *FederationParameters) SetSamlMetadataDocument(v string) *FederationParameters
SetSamlMetadataDocument sets the SamlMetadataDocument field's value.
func (s *FederationParameters) SetSamlMetadataURL(v string) *FederationParameters
SetSamlMetadataURL sets the SamlMetadataURL field's value.
func (s FederationParameters) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *FederationParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Finspace struct { *client.Client }
Finspace provides the API operation methods for making requests to FinSpace User Environment Management service. See this package's package overview docs for details on the service.
Finspace methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Finspace
New creates a new instance of the Finspace client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a Finspace client from just a session. svc := finspace.New(mySession) // Create a Finspace client with additional configuration svc := finspace.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *Finspace) CreateEnvironment(input *CreateEnvironmentInput) (*CreateEnvironmentOutput, error)
CreateEnvironment API operation for FinSpace User Environment Management service.
Create a new FinSpace environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateEnvironment for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
LimitExceededException A service limit or quota is exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) CreateEnvironmentRequest(input *CreateEnvironmentInput) (req *request.Request, output *CreateEnvironmentOutput)
CreateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the CreateEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateEnvironment for more information on using the CreateEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateEnvironmentRequest method. req, resp := client.CreateEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) CreateEnvironmentWithContext(ctx aws.Context, input *CreateEnvironmentInput, opts ...request.Option) (*CreateEnvironmentOutput, error)
CreateEnvironmentWithContext is the same as CreateEnvironment with the addition of the ability to pass a context and additional request options.
See CreateEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
Deprecated: This method will be discontinued.
func (c *Finspace) CreateKxChangeset(input *CreateKxChangesetInput) (*CreateKxChangesetOutput, error)
CreateKxChangeset API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxChangeset for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ConflictException There was a conflict with this action, and it could not be completed.
LimitExceededException A service limit or quota is exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxChangeset
func (c *Finspace) CreateKxChangesetRequest(input *CreateKxChangesetInput) (req *request.Request, output *CreateKxChangesetOutput)
CreateKxChangesetRequest generates a "aws/request.Request" representing the client's request for the CreateKxChangeset operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxChangeset for more information on using the CreateKxChangeset API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxChangesetRequest method. req, resp := client.CreateKxChangesetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxChangeset
func (c *Finspace) CreateKxChangesetWithContext(ctx aws.Context, input *CreateKxChangesetInput, opts ...request.Option) (*CreateKxChangesetOutput, error)
CreateKxChangesetWithContext is the same as CreateKxChangeset with the addition of the ability to pass a context and additional request options.
See CreateKxChangeset for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) CreateKxCluster(input *CreateKxClusterInput) (*CreateKxClusterOutput, error)
CreateKxCluster API operation for FinSpace User Environment Management service.
Creates a new kdb cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxCluster for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxCluster
func (c *Finspace) CreateKxClusterRequest(input *CreateKxClusterInput) (req *request.Request, output *CreateKxClusterOutput)
CreateKxClusterRequest generates a "aws/request.Request" representing the client's request for the CreateKxCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxCluster for more information on using the CreateKxCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxClusterRequest method. req, resp := client.CreateKxClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxCluster
func (c *Finspace) CreateKxClusterWithContext(ctx aws.Context, input *CreateKxClusterInput, opts ...request.Option) (*CreateKxClusterOutput, error)
CreateKxClusterWithContext is the same as CreateKxCluster with the addition of the ability to pass a context and additional request options.
See CreateKxCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) CreateKxDatabase(input *CreateKxDatabaseInput) (*CreateKxDatabaseOutput, error)
CreateKxDatabase API operation for FinSpace User Environment Management service.
Creates a new kdb database in the environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxDatabase for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceAlreadyExistsException The specified resource group already exists.
ResourceNotFoundException One or more resources can't be found.
LimitExceededException A service limit or quota is exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDatabase
func (c *Finspace) CreateKxDatabaseRequest(input *CreateKxDatabaseInput) (req *request.Request, output *CreateKxDatabaseOutput)
CreateKxDatabaseRequest generates a "aws/request.Request" representing the client's request for the CreateKxDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxDatabase for more information on using the CreateKxDatabase API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxDatabaseRequest method. req, resp := client.CreateKxDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDatabase
func (c *Finspace) CreateKxDatabaseWithContext(ctx aws.Context, input *CreateKxDatabaseInput, opts ...request.Option) (*CreateKxDatabaseOutput, error)
CreateKxDatabaseWithContext is the same as CreateKxDatabase with the addition of the ability to pass a context and additional request options.
See CreateKxDatabase for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) CreateKxDataview(input *CreateKxDataviewInput) (*CreateKxDataviewOutput, error)
CreateKxDataview API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxDataview for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ConflictException There was a conflict with this action, and it could not be completed.
LimitExceededException A service limit or quota is exceeded.
ResourceAlreadyExistsException The specified resource group already exists.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDataview
func (c *Finspace) CreateKxDataviewRequest(input *CreateKxDataviewInput) (req *request.Request, output *CreateKxDataviewOutput)
CreateKxDataviewRequest generates a "aws/request.Request" representing the client's request for the CreateKxDataview operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxDataview for more information on using the CreateKxDataview API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxDataviewRequest method. req, resp := client.CreateKxDataviewRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDataview
func (c *Finspace) CreateKxDataviewWithContext(ctx aws.Context, input *CreateKxDataviewInput, opts ...request.Option) (*CreateKxDataviewOutput, error)
CreateKxDataviewWithContext is the same as CreateKxDataview with the addition of the ability to pass a context and additional request options.
See CreateKxDataview for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) CreateKxEnvironment(input *CreateKxEnvironmentInput) (*CreateKxEnvironmentOutput, error)
CreateKxEnvironment API operation for FinSpace User Environment Management service.
Creates a managed kdb environment for the account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxEnvironment for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxEnvironment
func (c *Finspace) CreateKxEnvironmentRequest(input *CreateKxEnvironmentInput) (req *request.Request, output *CreateKxEnvironmentOutput)
CreateKxEnvironmentRequest generates a "aws/request.Request" representing the client's request for the CreateKxEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxEnvironment for more information on using the CreateKxEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxEnvironmentRequest method. req, resp := client.CreateKxEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxEnvironment
func (c *Finspace) CreateKxEnvironmentWithContext(ctx aws.Context, input *CreateKxEnvironmentInput, opts ...request.Option) (*CreateKxEnvironmentOutput, error)
CreateKxEnvironmentWithContext is the same as CreateKxEnvironment with the addition of the ability to pass a context and additional request options.
See CreateKxEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) CreateKxScalingGroup(input *CreateKxScalingGroupInput) (*CreateKxScalingGroupOutput, error)
CreateKxScalingGroup API operation for FinSpace User Environment Management service.
Creates a new scaling group.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxScalingGroup for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxScalingGroup
func (c *Finspace) CreateKxScalingGroupRequest(input *CreateKxScalingGroupInput) (req *request.Request, output *CreateKxScalingGroupOutput)
CreateKxScalingGroupRequest generates a "aws/request.Request" representing the client's request for the CreateKxScalingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxScalingGroup for more information on using the CreateKxScalingGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxScalingGroupRequest method. req, resp := client.CreateKxScalingGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxScalingGroup
func (c *Finspace) CreateKxScalingGroupWithContext(ctx aws.Context, input *CreateKxScalingGroupInput, opts ...request.Option) (*CreateKxScalingGroupOutput, error)
CreateKxScalingGroupWithContext is the same as CreateKxScalingGroup with the addition of the ability to pass a context and additional request options.
See CreateKxScalingGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) CreateKxUser(input *CreateKxUserInput) (*CreateKxUserOutput, error)
CreateKxUser API operation for FinSpace User Environment Management service.
Creates a user in FinSpace kdb environment with an associated IAM role.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxUser for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ResourceAlreadyExistsException The specified resource group already exists.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxUser
func (c *Finspace) CreateKxUserRequest(input *CreateKxUserInput) (req *request.Request, output *CreateKxUserOutput)
CreateKxUserRequest generates a "aws/request.Request" representing the client's request for the CreateKxUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxUser for more information on using the CreateKxUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxUserRequest method. req, resp := client.CreateKxUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxUser
func (c *Finspace) CreateKxUserWithContext(ctx aws.Context, input *CreateKxUserInput, opts ...request.Option) (*CreateKxUserOutput, error)
CreateKxUserWithContext is the same as CreateKxUser with the addition of the ability to pass a context and additional request options.
See CreateKxUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) CreateKxVolume(input *CreateKxVolumeInput) (*CreateKxVolumeOutput, error)
CreateKxVolume API operation for FinSpace User Environment Management service.
Creates a new volume with a specific amount of throughput and storage capacity.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation CreateKxVolume for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
ResourceAlreadyExistsException The specified resource group already exists.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxVolume
func (c *Finspace) CreateKxVolumeRequest(input *CreateKxVolumeInput) (req *request.Request, output *CreateKxVolumeOutput)
CreateKxVolumeRequest generates a "aws/request.Request" representing the client's request for the CreateKxVolume operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateKxVolume for more information on using the CreateKxVolume API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateKxVolumeRequest method. req, resp := client.CreateKxVolumeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxVolume
func (c *Finspace) CreateKxVolumeWithContext(ctx aws.Context, input *CreateKxVolumeInput, opts ...request.Option) (*CreateKxVolumeOutput, error)
CreateKxVolumeWithContext is the same as CreateKxVolume with the addition of the ability to pass a context and additional request options.
See CreateKxVolume for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteEnvironment(input *DeleteEnvironmentInput) (*DeleteEnvironmentOutput, error)
DeleteEnvironment API operation for FinSpace User Environment Management service.
Delete an FinSpace environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteEnvironment for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req *request.Request, output *DeleteEnvironmentOutput)
DeleteEnvironmentRequest generates a "aws/request.Request" representing the client's request for the DeleteEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteEnvironment for more information on using the DeleteEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteEnvironmentRequest method. req, resp := client.DeleteEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) DeleteEnvironmentWithContext(ctx aws.Context, input *DeleteEnvironmentInput, opts ...request.Option) (*DeleteEnvironmentOutput, error)
DeleteEnvironmentWithContext is the same as DeleteEnvironment with the addition of the ability to pass a context and additional request options.
See DeleteEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
Deprecated: This method will be discontinued.
func (c *Finspace) DeleteKxCluster(input *DeleteKxClusterInput) (*DeleteKxClusterOutput, error)
DeleteKxCluster API operation for FinSpace User Environment Management service.
Deletes a kdb cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxCluster for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxCluster
func (c *Finspace) DeleteKxClusterNode(input *DeleteKxClusterNodeInput) (*DeleteKxClusterNodeOutput, error)
DeleteKxClusterNode API operation for FinSpace User Environment Management service.
Deletes the specified nodes from a cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxClusterNode for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxClusterNode
func (c *Finspace) DeleteKxClusterNodeRequest(input *DeleteKxClusterNodeInput) (req *request.Request, output *DeleteKxClusterNodeOutput)
DeleteKxClusterNodeRequest generates a "aws/request.Request" representing the client's request for the DeleteKxClusterNode operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxClusterNode for more information on using the DeleteKxClusterNode API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxClusterNodeRequest method. req, resp := client.DeleteKxClusterNodeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxClusterNode
func (c *Finspace) DeleteKxClusterNodeWithContext(ctx aws.Context, input *DeleteKxClusterNodeInput, opts ...request.Option) (*DeleteKxClusterNodeOutput, error)
DeleteKxClusterNodeWithContext is the same as DeleteKxClusterNode with the addition of the ability to pass a context and additional request options.
See DeleteKxClusterNode for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteKxClusterRequest(input *DeleteKxClusterInput) (req *request.Request, output *DeleteKxClusterOutput)
DeleteKxClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteKxCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxCluster for more information on using the DeleteKxCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxClusterRequest method. req, resp := client.DeleteKxClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxCluster
func (c *Finspace) DeleteKxClusterWithContext(ctx aws.Context, input *DeleteKxClusterInput, opts ...request.Option) (*DeleteKxClusterOutput, error)
DeleteKxClusterWithContext is the same as DeleteKxCluster with the addition of the ability to pass a context and additional request options.
See DeleteKxCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteKxDatabase(input *DeleteKxDatabaseInput) (*DeleteKxDatabaseOutput, error)
DeleteKxDatabase API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxDatabase for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDatabase
func (c *Finspace) DeleteKxDatabaseRequest(input *DeleteKxDatabaseInput) (req *request.Request, output *DeleteKxDatabaseOutput)
DeleteKxDatabaseRequest generates a "aws/request.Request" representing the client's request for the DeleteKxDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxDatabase for more information on using the DeleteKxDatabase API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxDatabaseRequest method. req, resp := client.DeleteKxDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDatabase
func (c *Finspace) DeleteKxDatabaseWithContext(ctx aws.Context, input *DeleteKxDatabaseInput, opts ...request.Option) (*DeleteKxDatabaseOutput, error)
DeleteKxDatabaseWithContext is the same as DeleteKxDatabase with the addition of the ability to pass a context and additional request options.
See DeleteKxDatabase for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteKxDataview(input *DeleteKxDataviewInput) (*DeleteKxDataviewOutput, error)
DeleteKxDataview API operation for FinSpace User Environment Management service.
Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxDataview for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDataview
func (c *Finspace) DeleteKxDataviewRequest(input *DeleteKxDataviewInput) (req *request.Request, output *DeleteKxDataviewOutput)
DeleteKxDataviewRequest generates a "aws/request.Request" representing the client's request for the DeleteKxDataview operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxDataview for more information on using the DeleteKxDataview API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxDataviewRequest method. req, resp := client.DeleteKxDataviewRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDataview
func (c *Finspace) DeleteKxDataviewWithContext(ctx aws.Context, input *DeleteKxDataviewInput, opts ...request.Option) (*DeleteKxDataviewOutput, error)
DeleteKxDataviewWithContext is the same as DeleteKxDataview with the addition of the ability to pass a context and additional request options.
See DeleteKxDataview for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteKxEnvironment(input *DeleteKxEnvironmentInput) (*DeleteKxEnvironmentOutput, error)
DeleteKxEnvironment API operation for FinSpace User Environment Management service.
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxEnvironment for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironment
func (c *Finspace) DeleteKxEnvironmentRequest(input *DeleteKxEnvironmentInput) (req *request.Request, output *DeleteKxEnvironmentOutput)
DeleteKxEnvironmentRequest generates a "aws/request.Request" representing the client's request for the DeleteKxEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxEnvironment for more information on using the DeleteKxEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxEnvironmentRequest method. req, resp := client.DeleteKxEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironment
func (c *Finspace) DeleteKxEnvironmentWithContext(ctx aws.Context, input *DeleteKxEnvironmentInput, opts ...request.Option) (*DeleteKxEnvironmentOutput, error)
DeleteKxEnvironmentWithContext is the same as DeleteKxEnvironment with the addition of the ability to pass a context and additional request options.
See DeleteKxEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteKxScalingGroup(input *DeleteKxScalingGroupInput) (*DeleteKxScalingGroupOutput, error)
DeleteKxScalingGroup API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxScalingGroup for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxScalingGroup
func (c *Finspace) DeleteKxScalingGroupRequest(input *DeleteKxScalingGroupInput) (req *request.Request, output *DeleteKxScalingGroupOutput)
DeleteKxScalingGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteKxScalingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxScalingGroup for more information on using the DeleteKxScalingGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxScalingGroupRequest method. req, resp := client.DeleteKxScalingGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxScalingGroup
func (c *Finspace) DeleteKxScalingGroupWithContext(ctx aws.Context, input *DeleteKxScalingGroupInput, opts ...request.Option) (*DeleteKxScalingGroupOutput, error)
DeleteKxScalingGroupWithContext is the same as DeleteKxScalingGroup with the addition of the ability to pass a context and additional request options.
See DeleteKxScalingGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteKxUser(input *DeleteKxUserInput) (*DeleteKxUserOutput, error)
DeleteKxUser API operation for FinSpace User Environment Management service.
Deletes a user in the specified kdb environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxUser for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUser
func (c *Finspace) DeleteKxUserRequest(input *DeleteKxUserInput) (req *request.Request, output *DeleteKxUserOutput)
DeleteKxUserRequest generates a "aws/request.Request" representing the client's request for the DeleteKxUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxUser for more information on using the DeleteKxUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxUserRequest method. req, resp := client.DeleteKxUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUser
func (c *Finspace) DeleteKxUserWithContext(ctx aws.Context, input *DeleteKxUserInput, opts ...request.Option) (*DeleteKxUserOutput, error)
DeleteKxUserWithContext is the same as DeleteKxUser with the addition of the ability to pass a context and additional request options.
See DeleteKxUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) DeleteKxVolume(input *DeleteKxVolumeInput) (*DeleteKxVolumeOutput, error)
DeleteKxVolume API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation DeleteKxVolume for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxVolume
func (c *Finspace) DeleteKxVolumeRequest(input *DeleteKxVolumeInput) (req *request.Request, output *DeleteKxVolumeOutput)
DeleteKxVolumeRequest generates a "aws/request.Request" representing the client's request for the DeleteKxVolume operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteKxVolume for more information on using the DeleteKxVolume API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteKxVolumeRequest method. req, resp := client.DeleteKxVolumeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxVolume
func (c *Finspace) DeleteKxVolumeWithContext(ctx aws.Context, input *DeleteKxVolumeInput, opts ...request.Option) (*DeleteKxVolumeOutput, error)
DeleteKxVolumeWithContext is the same as DeleteKxVolume with the addition of the ability to pass a context and additional request options.
See DeleteKxVolume for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetEnvironment(input *GetEnvironmentInput) (*GetEnvironmentOutput, error)
GetEnvironment API operation for FinSpace User Environment Management service.
Returns the FinSpace environment object.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetEnvironment for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) GetEnvironmentRequest(input *GetEnvironmentInput) (req *request.Request, output *GetEnvironmentOutput)
GetEnvironmentRequest generates a "aws/request.Request" representing the client's request for the GetEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetEnvironment for more information on using the GetEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetEnvironmentRequest method. req, resp := client.GetEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) GetEnvironmentWithContext(ctx aws.Context, input *GetEnvironmentInput, opts ...request.Option) (*GetEnvironmentOutput, error)
GetEnvironmentWithContext is the same as GetEnvironment with the addition of the ability to pass a context and additional request options.
See GetEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
Deprecated: This method will be discontinued.
func (c *Finspace) GetKxChangeset(input *GetKxChangesetInput) (*GetKxChangesetOutput, error)
GetKxChangeset API operation for FinSpace User Environment Management service.
Returns information about a kdb changeset.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxChangeset for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxChangeset
func (c *Finspace) GetKxChangesetRequest(input *GetKxChangesetInput) (req *request.Request, output *GetKxChangesetOutput)
GetKxChangesetRequest generates a "aws/request.Request" representing the client's request for the GetKxChangeset operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxChangeset for more information on using the GetKxChangeset API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxChangesetRequest method. req, resp := client.GetKxChangesetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxChangeset
func (c *Finspace) GetKxChangesetWithContext(ctx aws.Context, input *GetKxChangesetInput, opts ...request.Option) (*GetKxChangesetOutput, error)
GetKxChangesetWithContext is the same as GetKxChangeset with the addition of the ability to pass a context and additional request options.
See GetKxChangeset for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxCluster(input *GetKxClusterInput) (*GetKxClusterOutput, error)
GetKxCluster API operation for FinSpace User Environment Management service.
Retrieves information about a kdb cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxCluster for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxCluster
func (c *Finspace) GetKxClusterRequest(input *GetKxClusterInput) (req *request.Request, output *GetKxClusterOutput)
GetKxClusterRequest generates a "aws/request.Request" representing the client's request for the GetKxCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxCluster for more information on using the GetKxCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxClusterRequest method. req, resp := client.GetKxClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxCluster
func (c *Finspace) GetKxClusterWithContext(ctx aws.Context, input *GetKxClusterInput, opts ...request.Option) (*GetKxClusterOutput, error)
GetKxClusterWithContext is the same as GetKxCluster with the addition of the ability to pass a context and additional request options.
See GetKxCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxConnectionString(input *GetKxConnectionStringInput) (*GetKxConnectionStringOutput, error)
GetKxConnectionString API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxConnectionString for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxConnectionString
func (c *Finspace) GetKxConnectionStringRequest(input *GetKxConnectionStringInput) (req *request.Request, output *GetKxConnectionStringOutput)
GetKxConnectionStringRequest generates a "aws/request.Request" representing the client's request for the GetKxConnectionString operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxConnectionString for more information on using the GetKxConnectionString API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxConnectionStringRequest method. req, resp := client.GetKxConnectionStringRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxConnectionString
func (c *Finspace) GetKxConnectionStringWithContext(ctx aws.Context, input *GetKxConnectionStringInput, opts ...request.Option) (*GetKxConnectionStringOutput, error)
GetKxConnectionStringWithContext is the same as GetKxConnectionString with the addition of the ability to pass a context and additional request options.
See GetKxConnectionString for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxDatabase(input *GetKxDatabaseInput) (*GetKxDatabaseOutput, error)
GetKxDatabase API operation for FinSpace User Environment Management service.
Returns database information for the specified environment ID.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxDatabase for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDatabase
func (c *Finspace) GetKxDatabaseRequest(input *GetKxDatabaseInput) (req *request.Request, output *GetKxDatabaseOutput)
GetKxDatabaseRequest generates a "aws/request.Request" representing the client's request for the GetKxDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxDatabase for more information on using the GetKxDatabase API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxDatabaseRequest method. req, resp := client.GetKxDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDatabase
func (c *Finspace) GetKxDatabaseWithContext(ctx aws.Context, input *GetKxDatabaseInput, opts ...request.Option) (*GetKxDatabaseOutput, error)
GetKxDatabaseWithContext is the same as GetKxDatabase with the addition of the ability to pass a context and additional request options.
See GetKxDatabase for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxDataview(input *GetKxDataviewInput) (*GetKxDataviewOutput, error)
GetKxDataview API operation for FinSpace User Environment Management service.
Retrieves details of the dataview.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxDataview for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDataview
func (c *Finspace) GetKxDataviewRequest(input *GetKxDataviewInput) (req *request.Request, output *GetKxDataviewOutput)
GetKxDataviewRequest generates a "aws/request.Request" representing the client's request for the GetKxDataview operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxDataview for more information on using the GetKxDataview API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxDataviewRequest method. req, resp := client.GetKxDataviewRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDataview
func (c *Finspace) GetKxDataviewWithContext(ctx aws.Context, input *GetKxDataviewInput, opts ...request.Option) (*GetKxDataviewOutput, error)
GetKxDataviewWithContext is the same as GetKxDataview with the addition of the ability to pass a context and additional request options.
See GetKxDataview for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxEnvironment(input *GetKxEnvironmentInput) (*GetKxEnvironmentOutput, error)
GetKxEnvironment API operation for FinSpace User Environment Management service.
Retrieves all the information for the specified kdb environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxEnvironment for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxEnvironment
func (c *Finspace) GetKxEnvironmentRequest(input *GetKxEnvironmentInput) (req *request.Request, output *GetKxEnvironmentOutput)
GetKxEnvironmentRequest generates a "aws/request.Request" representing the client's request for the GetKxEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxEnvironment for more information on using the GetKxEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxEnvironmentRequest method. req, resp := client.GetKxEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxEnvironment
func (c *Finspace) GetKxEnvironmentWithContext(ctx aws.Context, input *GetKxEnvironmentInput, opts ...request.Option) (*GetKxEnvironmentOutput, error)
GetKxEnvironmentWithContext is the same as GetKxEnvironment with the addition of the ability to pass a context and additional request options.
See GetKxEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxScalingGroup(input *GetKxScalingGroupInput) (*GetKxScalingGroupOutput, error)
GetKxScalingGroup API operation for FinSpace User Environment Management service.
Retrieves details of a scaling group.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxScalingGroup for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxScalingGroup
func (c *Finspace) GetKxScalingGroupRequest(input *GetKxScalingGroupInput) (req *request.Request, output *GetKxScalingGroupOutput)
GetKxScalingGroupRequest generates a "aws/request.Request" representing the client's request for the GetKxScalingGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxScalingGroup for more information on using the GetKxScalingGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxScalingGroupRequest method. req, resp := client.GetKxScalingGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxScalingGroup
func (c *Finspace) GetKxScalingGroupWithContext(ctx aws.Context, input *GetKxScalingGroupInput, opts ...request.Option) (*GetKxScalingGroupOutput, error)
GetKxScalingGroupWithContext is the same as GetKxScalingGroup with the addition of the ability to pass a context and additional request options.
See GetKxScalingGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxUser(input *GetKxUserInput) (*GetKxUserOutput, error)
GetKxUser API operation for FinSpace User Environment Management service.
Retrieves information about the specified kdb user.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxUser for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxUser
func (c *Finspace) GetKxUserRequest(input *GetKxUserInput) (req *request.Request, output *GetKxUserOutput)
GetKxUserRequest generates a "aws/request.Request" representing the client's request for the GetKxUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxUser for more information on using the GetKxUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxUserRequest method. req, resp := client.GetKxUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxUser
func (c *Finspace) GetKxUserWithContext(ctx aws.Context, input *GetKxUserInput, opts ...request.Option) (*GetKxUserOutput, error)
GetKxUserWithContext is the same as GetKxUser with the addition of the ability to pass a context and additional request options.
See GetKxUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) GetKxVolume(input *GetKxVolumeInput) (*GetKxVolumeOutput, error)
GetKxVolume API operation for FinSpace User Environment Management service.
Retrieves the information about the volume.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation GetKxVolume for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxVolume
func (c *Finspace) GetKxVolumeRequest(input *GetKxVolumeInput) (req *request.Request, output *GetKxVolumeOutput)
GetKxVolumeRequest generates a "aws/request.Request" representing the client's request for the GetKxVolume operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetKxVolume for more information on using the GetKxVolume API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetKxVolumeRequest method. req, resp := client.GetKxVolumeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxVolume
func (c *Finspace) GetKxVolumeWithContext(ctx aws.Context, input *GetKxVolumeInput, opts ...request.Option) (*GetKxVolumeOutput, error)
GetKxVolumeWithContext is the same as GetKxVolume with the addition of the ability to pass a context and additional request options.
See GetKxVolume for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListEnvironments(input *ListEnvironmentsInput) (*ListEnvironmentsOutput, error)
ListEnvironments API operation for FinSpace User Environment Management service.
A list of all of your FinSpace environments.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListEnvironments for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments
Deprecated: This method will be discontinued.
func (c *Finspace) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req *request.Request, output *ListEnvironmentsOutput)
ListEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the ListEnvironments operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListEnvironments for more information on using the ListEnvironments API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListEnvironmentsRequest method. req, resp := client.ListEnvironmentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments
Deprecated: This method will be discontinued.
func (c *Finspace) ListEnvironmentsWithContext(ctx aws.Context, input *ListEnvironmentsInput, opts ...request.Option) (*ListEnvironmentsOutput, error)
ListEnvironmentsWithContext is the same as ListEnvironments with the addition of the ability to pass a context and additional request options.
See ListEnvironments for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
Deprecated: This method will be discontinued.
func (c *Finspace) ListKxChangesets(input *ListKxChangesetsInput) (*ListKxChangesetsOutput, error)
ListKxChangesets API operation for FinSpace User Environment Management service.
Returns a list of all the changesets for a database.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxChangesets for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxChangesets
func (c *Finspace) ListKxChangesetsPages(input *ListKxChangesetsInput, fn func(*ListKxChangesetsOutput, bool) bool) error
ListKxChangesetsPages iterates over the pages of a ListKxChangesets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKxChangesets method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKxChangesets operation. pageNum := 0 err := client.ListKxChangesetsPages(params, func(page *finspace.ListKxChangesetsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Finspace) ListKxChangesetsPagesWithContext(ctx aws.Context, input *ListKxChangesetsInput, fn func(*ListKxChangesetsOutput, bool) bool, opts ...request.Option) error
ListKxChangesetsPagesWithContext same as ListKxChangesetsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxChangesetsRequest(input *ListKxChangesetsInput) (req *request.Request, output *ListKxChangesetsOutput)
ListKxChangesetsRequest generates a "aws/request.Request" representing the client's request for the ListKxChangesets operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxChangesets for more information on using the ListKxChangesets API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxChangesetsRequest method. req, resp := client.ListKxChangesetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxChangesets
func (c *Finspace) ListKxChangesetsWithContext(ctx aws.Context, input *ListKxChangesetsInput, opts ...request.Option) (*ListKxChangesetsOutput, error)
ListKxChangesetsWithContext is the same as ListKxChangesets with the addition of the ability to pass a context and additional request options.
See ListKxChangesets for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxClusterNodes(input *ListKxClusterNodesInput) (*ListKxClusterNodesOutput, error)
ListKxClusterNodes API operation for FinSpace User Environment Management service.
Lists all the nodes in a kdb cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxClusterNodes for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusterNodes
func (c *Finspace) ListKxClusterNodesPages(input *ListKxClusterNodesInput, fn func(*ListKxClusterNodesOutput, bool) bool) error
ListKxClusterNodesPages iterates over the pages of a ListKxClusterNodes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKxClusterNodes method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKxClusterNodes operation. pageNum := 0 err := client.ListKxClusterNodesPages(params, func(page *finspace.ListKxClusterNodesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Finspace) ListKxClusterNodesPagesWithContext(ctx aws.Context, input *ListKxClusterNodesInput, fn func(*ListKxClusterNodesOutput, bool) bool, opts ...request.Option) error
ListKxClusterNodesPagesWithContext same as ListKxClusterNodesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxClusterNodesRequest(input *ListKxClusterNodesInput) (req *request.Request, output *ListKxClusterNodesOutput)
ListKxClusterNodesRequest generates a "aws/request.Request" representing the client's request for the ListKxClusterNodes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxClusterNodes for more information on using the ListKxClusterNodes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxClusterNodesRequest method. req, resp := client.ListKxClusterNodesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusterNodes
func (c *Finspace) ListKxClusterNodesWithContext(ctx aws.Context, input *ListKxClusterNodesInput, opts ...request.Option) (*ListKxClusterNodesOutput, error)
ListKxClusterNodesWithContext is the same as ListKxClusterNodes with the addition of the ability to pass a context and additional request options.
See ListKxClusterNodes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxClusters(input *ListKxClustersInput) (*ListKxClustersOutput, error)
ListKxClusters API operation for FinSpace User Environment Management service.
Returns a list of clusters.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxClusters for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusters
func (c *Finspace) ListKxClustersRequest(input *ListKxClustersInput) (req *request.Request, output *ListKxClustersOutput)
ListKxClustersRequest generates a "aws/request.Request" representing the client's request for the ListKxClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxClusters for more information on using the ListKxClusters API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxClustersRequest method. req, resp := client.ListKxClustersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusters
func (c *Finspace) ListKxClustersWithContext(ctx aws.Context, input *ListKxClustersInput, opts ...request.Option) (*ListKxClustersOutput, error)
ListKxClustersWithContext is the same as ListKxClusters with the addition of the ability to pass a context and additional request options.
See ListKxClusters for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxDatabases(input *ListKxDatabasesInput) (*ListKxDatabasesOutput, error)
ListKxDatabases API operation for FinSpace User Environment Management service.
Returns a list of all the databases in the kdb environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxDatabases for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDatabases
func (c *Finspace) ListKxDatabasesPages(input *ListKxDatabasesInput, fn func(*ListKxDatabasesOutput, bool) bool) error
ListKxDatabasesPages iterates over the pages of a ListKxDatabases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKxDatabases method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKxDatabases operation. pageNum := 0 err := client.ListKxDatabasesPages(params, func(page *finspace.ListKxDatabasesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Finspace) ListKxDatabasesPagesWithContext(ctx aws.Context, input *ListKxDatabasesInput, fn func(*ListKxDatabasesOutput, bool) bool, opts ...request.Option) error
ListKxDatabasesPagesWithContext same as ListKxDatabasesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxDatabasesRequest(input *ListKxDatabasesInput) (req *request.Request, output *ListKxDatabasesOutput)
ListKxDatabasesRequest generates a "aws/request.Request" representing the client's request for the ListKxDatabases operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxDatabases for more information on using the ListKxDatabases API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxDatabasesRequest method. req, resp := client.ListKxDatabasesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDatabases
func (c *Finspace) ListKxDatabasesWithContext(ctx aws.Context, input *ListKxDatabasesInput, opts ...request.Option) (*ListKxDatabasesOutput, error)
ListKxDatabasesWithContext is the same as ListKxDatabases with the addition of the ability to pass a context and additional request options.
See ListKxDatabases for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxDataviews(input *ListKxDataviewsInput) (*ListKxDataviewsOutput, error)
ListKxDataviews API operation for FinSpace User Environment Management service.
Returns a list of all the dataviews in the database.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxDataviews for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDataviews
func (c *Finspace) ListKxDataviewsPages(input *ListKxDataviewsInput, fn func(*ListKxDataviewsOutput, bool) bool) error
ListKxDataviewsPages iterates over the pages of a ListKxDataviews operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKxDataviews method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKxDataviews operation. pageNum := 0 err := client.ListKxDataviewsPages(params, func(page *finspace.ListKxDataviewsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Finspace) ListKxDataviewsPagesWithContext(ctx aws.Context, input *ListKxDataviewsInput, fn func(*ListKxDataviewsOutput, bool) bool, opts ...request.Option) error
ListKxDataviewsPagesWithContext same as ListKxDataviewsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxDataviewsRequest(input *ListKxDataviewsInput) (req *request.Request, output *ListKxDataviewsOutput)
ListKxDataviewsRequest generates a "aws/request.Request" representing the client's request for the ListKxDataviews operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxDataviews for more information on using the ListKxDataviews API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxDataviewsRequest method. req, resp := client.ListKxDataviewsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDataviews
func (c *Finspace) ListKxDataviewsWithContext(ctx aws.Context, input *ListKxDataviewsInput, opts ...request.Option) (*ListKxDataviewsOutput, error)
ListKxDataviewsWithContext is the same as ListKxDataviews with the addition of the ability to pass a context and additional request options.
See ListKxDataviews for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxEnvironments(input *ListKxEnvironmentsInput) (*ListKxEnvironmentsOutput, error)
ListKxEnvironments API operation for FinSpace User Environment Management service.
Returns a list of kdb environments created in an account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxEnvironments for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
AccessDeniedException You do not have sufficient access to perform this action.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironments
func (c *Finspace) ListKxEnvironmentsPages(input *ListKxEnvironmentsInput, fn func(*ListKxEnvironmentsOutput, bool) bool) error
ListKxEnvironmentsPages iterates over the pages of a ListKxEnvironments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKxEnvironments method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKxEnvironments operation. pageNum := 0 err := client.ListKxEnvironmentsPages(params, func(page *finspace.ListKxEnvironmentsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Finspace) ListKxEnvironmentsPagesWithContext(ctx aws.Context, input *ListKxEnvironmentsInput, fn func(*ListKxEnvironmentsOutput, bool) bool, opts ...request.Option) error
ListKxEnvironmentsPagesWithContext same as ListKxEnvironmentsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxEnvironmentsRequest(input *ListKxEnvironmentsInput) (req *request.Request, output *ListKxEnvironmentsOutput)
ListKxEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the ListKxEnvironments operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxEnvironments for more information on using the ListKxEnvironments API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxEnvironmentsRequest method. req, resp := client.ListKxEnvironmentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironments
func (c *Finspace) ListKxEnvironmentsWithContext(ctx aws.Context, input *ListKxEnvironmentsInput, opts ...request.Option) (*ListKxEnvironmentsOutput, error)
ListKxEnvironmentsWithContext is the same as ListKxEnvironments with the addition of the ability to pass a context and additional request options.
See ListKxEnvironments for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxScalingGroups(input *ListKxScalingGroupsInput) (*ListKxScalingGroupsOutput, error)
ListKxScalingGroups API operation for FinSpace User Environment Management service.
Returns a list of scaling groups in a kdb environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxScalingGroups for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxScalingGroups
func (c *Finspace) ListKxScalingGroupsPages(input *ListKxScalingGroupsInput, fn func(*ListKxScalingGroupsOutput, bool) bool) error
ListKxScalingGroupsPages iterates over the pages of a ListKxScalingGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKxScalingGroups method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKxScalingGroups operation. pageNum := 0 err := client.ListKxScalingGroupsPages(params, func(page *finspace.ListKxScalingGroupsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Finspace) ListKxScalingGroupsPagesWithContext(ctx aws.Context, input *ListKxScalingGroupsInput, fn func(*ListKxScalingGroupsOutput, bool) bool, opts ...request.Option) error
ListKxScalingGroupsPagesWithContext same as ListKxScalingGroupsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxScalingGroupsRequest(input *ListKxScalingGroupsInput) (req *request.Request, output *ListKxScalingGroupsOutput)
ListKxScalingGroupsRequest generates a "aws/request.Request" representing the client's request for the ListKxScalingGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxScalingGroups for more information on using the ListKxScalingGroups API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxScalingGroupsRequest method. req, resp := client.ListKxScalingGroupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxScalingGroups
func (c *Finspace) ListKxScalingGroupsWithContext(ctx aws.Context, input *ListKxScalingGroupsInput, opts ...request.Option) (*ListKxScalingGroupsOutput, error)
ListKxScalingGroupsWithContext is the same as ListKxScalingGroups with the addition of the ability to pass a context and additional request options.
See ListKxScalingGroups for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxUsers(input *ListKxUsersInput) (*ListKxUsersOutput, error)
ListKxUsers API operation for FinSpace User Environment Management service.
Lists all the users in a kdb environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxUsers for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsers
func (c *Finspace) ListKxUsersRequest(input *ListKxUsersInput) (req *request.Request, output *ListKxUsersOutput)
ListKxUsersRequest generates a "aws/request.Request" representing the client's request for the ListKxUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxUsers for more information on using the ListKxUsers API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxUsersRequest method. req, resp := client.ListKxUsersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsers
func (c *Finspace) ListKxUsersWithContext(ctx aws.Context, input *ListKxUsersInput, opts ...request.Option) (*ListKxUsersOutput, error)
ListKxUsersWithContext is the same as ListKxUsers with the addition of the ability to pass a context and additional request options.
See ListKxUsers for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListKxVolumes(input *ListKxVolumesInput) (*ListKxVolumesOutput, error)
ListKxVolumes API operation for FinSpace User Environment Management service.
Lists all the volumes in a kdb environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListKxVolumes for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxVolumes
func (c *Finspace) ListKxVolumesRequest(input *ListKxVolumesInput) (req *request.Request, output *ListKxVolumesOutput)
ListKxVolumesRequest generates a "aws/request.Request" representing the client's request for the ListKxVolumes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKxVolumes for more information on using the ListKxVolumes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKxVolumesRequest method. req, resp := client.ListKxVolumesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxVolumes
func (c *Finspace) ListKxVolumesWithContext(ctx aws.Context, input *ListKxVolumesInput, opts ...request.Option) (*ListKxVolumesOutput, error)
ListKxVolumesWithContext is the same as ListKxVolumes with the addition of the ability to pass a context and additional request options.
See ListKxVolumes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for FinSpace User Environment Management service.
A list of all tags for a resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation ListTagsForResource for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException The request is invalid. Something is wrong with the input to the request.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListTagsForResource
func (c *Finspace) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListTagsForResource
func (c *Finspace) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for FinSpace User Environment Management service.
Adds metadata tags to a FinSpace resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation TagResource for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException The request is invalid. Something is wrong with the input to the request.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TagResource
func (c *Finspace) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagResource for more information on using the TagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TagResource
func (c *Finspace) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for FinSpace User Environment Management service.
Removes metadata tags from a FinSpace resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UntagResource for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException The request is invalid. Something is wrong with the input to the request.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UntagResource
func (c *Finspace) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagResource for more information on using the UntagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UntagResource
func (c *Finspace) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateEnvironment(input *UpdateEnvironmentInput) (*UpdateEnvironmentOutput, error)
UpdateEnvironment API operation for FinSpace User Environment Management service.
Update your FinSpace environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateEnvironment for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) (req *request.Request, output *UpdateEnvironmentOutput)
UpdateEnvironmentRequest generates a "aws/request.Request" representing the client's request for the UpdateEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateEnvironment for more information on using the UpdateEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateEnvironmentRequest method. req, resp := client.UpdateEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateEnvironment
Deprecated: This method will be discontinued.
func (c *Finspace) UpdateEnvironmentWithContext(ctx aws.Context, input *UpdateEnvironmentInput, opts ...request.Option) (*UpdateEnvironmentOutput, error)
UpdateEnvironmentWithContext is the same as UpdateEnvironment with the addition of the ability to pass a context and additional request options.
See UpdateEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
Deprecated: This method will be discontinued.
func (c *Finspace) UpdateKxClusterCodeConfiguration(input *UpdateKxClusterCodeConfigurationInput) (*UpdateKxClusterCodeConfigurationOutput, error)
UpdateKxClusterCodeConfiguration API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxClusterCodeConfiguration for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterCodeConfiguration
func (c *Finspace) UpdateKxClusterCodeConfigurationRequest(input *UpdateKxClusterCodeConfigurationInput) (req *request.Request, output *UpdateKxClusterCodeConfigurationOutput)
UpdateKxClusterCodeConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateKxClusterCodeConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxClusterCodeConfiguration for more information on using the UpdateKxClusterCodeConfiguration API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxClusterCodeConfigurationRequest method. req, resp := client.UpdateKxClusterCodeConfigurationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterCodeConfiguration
func (c *Finspace) UpdateKxClusterCodeConfigurationWithContext(ctx aws.Context, input *UpdateKxClusterCodeConfigurationInput, opts ...request.Option) (*UpdateKxClusterCodeConfigurationOutput, error)
UpdateKxClusterCodeConfigurationWithContext is the same as UpdateKxClusterCodeConfiguration with the addition of the ability to pass a context and additional request options.
See UpdateKxClusterCodeConfiguration for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateKxClusterDatabases(input *UpdateKxClusterDatabasesInput) (*UpdateKxClusterDatabasesOutput, error)
UpdateKxClusterDatabases API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxClusterDatabases for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterDatabases
func (c *Finspace) UpdateKxClusterDatabasesRequest(input *UpdateKxClusterDatabasesInput) (req *request.Request, output *UpdateKxClusterDatabasesOutput)
UpdateKxClusterDatabasesRequest generates a "aws/request.Request" representing the client's request for the UpdateKxClusterDatabases operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxClusterDatabases for more information on using the UpdateKxClusterDatabases API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxClusterDatabasesRequest method. req, resp := client.UpdateKxClusterDatabasesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterDatabases
func (c *Finspace) UpdateKxClusterDatabasesWithContext(ctx aws.Context, input *UpdateKxClusterDatabasesInput, opts ...request.Option) (*UpdateKxClusterDatabasesOutput, error)
UpdateKxClusterDatabasesWithContext is the same as UpdateKxClusterDatabases with the addition of the ability to pass a context and additional request options.
See UpdateKxClusterDatabases for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateKxDatabase(input *UpdateKxDatabaseInput) (*UpdateKxDatabaseOutput, error)
UpdateKxDatabase API operation for FinSpace User Environment Management service.
Updates information for the given kdb database.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxDatabase for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDatabase
func (c *Finspace) UpdateKxDatabaseRequest(input *UpdateKxDatabaseInput) (req *request.Request, output *UpdateKxDatabaseOutput)
UpdateKxDatabaseRequest generates a "aws/request.Request" representing the client's request for the UpdateKxDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxDatabase for more information on using the UpdateKxDatabase API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxDatabaseRequest method. req, resp := client.UpdateKxDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDatabase
func (c *Finspace) UpdateKxDatabaseWithContext(ctx aws.Context, input *UpdateKxDatabaseInput, opts ...request.Option) (*UpdateKxDatabaseOutput, error)
UpdateKxDatabaseWithContext is the same as UpdateKxDatabase with the addition of the ability to pass a context and additional request options.
See UpdateKxDatabase for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateKxDataview(input *UpdateKxDataviewInput) (*UpdateKxDataviewOutput, error)
UpdateKxDataview API operation for FinSpace User Environment Management service.
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
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxDataview for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceAlreadyExistsException The specified resource group already exists.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDataview
func (c *Finspace) UpdateKxDataviewRequest(input *UpdateKxDataviewInput) (req *request.Request, output *UpdateKxDataviewOutput)
UpdateKxDataviewRequest generates a "aws/request.Request" representing the client's request for the UpdateKxDataview operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxDataview for more information on using the UpdateKxDataview API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxDataviewRequest method. req, resp := client.UpdateKxDataviewRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDataview
func (c *Finspace) UpdateKxDataviewWithContext(ctx aws.Context, input *UpdateKxDataviewInput, opts ...request.Option) (*UpdateKxDataviewOutput, error)
UpdateKxDataviewWithContext is the same as UpdateKxDataview with the addition of the ability to pass a context and additional request options.
See UpdateKxDataview for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateKxEnvironment(input *UpdateKxEnvironmentInput) (*UpdateKxEnvironmentOutput, error)
UpdateKxEnvironment API operation for FinSpace User Environment Management service.
Updates information for the given kdb environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxEnvironment for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironment
func (c *Finspace) UpdateKxEnvironmentNetwork(input *UpdateKxEnvironmentNetworkInput) (*UpdateKxEnvironmentNetworkOutput, error)
UpdateKxEnvironmentNetwork API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxEnvironmentNetwork for usage and error information.
Returned Error Types:
ResourceNotFoundException One or more resources can't be found.
InternalServerException The request processing has failed because of an unknown error, exception or failure.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentNetwork
func (c *Finspace) UpdateKxEnvironmentNetworkRequest(input *UpdateKxEnvironmentNetworkInput) (req *request.Request, output *UpdateKxEnvironmentNetworkOutput)
UpdateKxEnvironmentNetworkRequest generates a "aws/request.Request" representing the client's request for the UpdateKxEnvironmentNetwork operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxEnvironmentNetwork for more information on using the UpdateKxEnvironmentNetwork API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxEnvironmentNetworkRequest method. req, resp := client.UpdateKxEnvironmentNetworkRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentNetwork
func (c *Finspace) UpdateKxEnvironmentNetworkWithContext(ctx aws.Context, input *UpdateKxEnvironmentNetworkInput, opts ...request.Option) (*UpdateKxEnvironmentNetworkOutput, error)
UpdateKxEnvironmentNetworkWithContext is the same as UpdateKxEnvironmentNetwork with the addition of the ability to pass a context and additional request options.
See UpdateKxEnvironmentNetwork for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateKxEnvironmentRequest(input *UpdateKxEnvironmentInput) (req *request.Request, output *UpdateKxEnvironmentOutput)
UpdateKxEnvironmentRequest generates a "aws/request.Request" representing the client's request for the UpdateKxEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxEnvironment for more information on using the UpdateKxEnvironment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxEnvironmentRequest method. req, resp := client.UpdateKxEnvironmentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironment
func (c *Finspace) UpdateKxEnvironmentWithContext(ctx aws.Context, input *UpdateKxEnvironmentInput, opts ...request.Option) (*UpdateKxEnvironmentOutput, error)
UpdateKxEnvironmentWithContext is the same as UpdateKxEnvironment with the addition of the ability to pass a context and additional request options.
See UpdateKxEnvironment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateKxUser(input *UpdateKxUserInput) (*UpdateKxUserOutput, error)
UpdateKxUser API operation for FinSpace User Environment Management service.
Updates the user details. You can only update the IAM role associated with a user.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxUser for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException One or more resources can't be found.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
LimitExceededException A service limit or quota is exceeded.
ConflictException There was a conflict with this action, and it could not be completed.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxUser
func (c *Finspace) UpdateKxUserRequest(input *UpdateKxUserInput) (req *request.Request, output *UpdateKxUserOutput)
UpdateKxUserRequest generates a "aws/request.Request" representing the client's request for the UpdateKxUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxUser for more information on using the UpdateKxUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxUserRequest method. req, resp := client.UpdateKxUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxUser
func (c *Finspace) UpdateKxUserWithContext(ctx aws.Context, input *UpdateKxUserInput, opts ...request.Option) (*UpdateKxUserOutput, error)
UpdateKxUserWithContext is the same as UpdateKxUser with the addition of the ability to pass a context and additional request options.
See UpdateKxUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Finspace) UpdateKxVolume(input *UpdateKxVolumeInput) (*UpdateKxVolumeOutput, error)
UpdateKxVolume API operation for FinSpace User Environment Management service.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for FinSpace User Environment Management service's API operation UpdateKxVolume for usage and error information.
Returned Error Types:
InternalServerException The request processing has failed because of an unknown error, exception or failure.
ThrottlingException The request was denied due to request throttling.
AccessDeniedException You do not have sufficient access to perform this action.
LimitExceededException A service limit or quota is exceeded.
ValidationException The input fails to satisfy the constraints specified by an AWS service.
ConflictException There was a conflict with this action, and it could not be completed.
ResourceNotFoundException One or more resources can't be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxVolume
func (c *Finspace) UpdateKxVolumeRequest(input *UpdateKxVolumeInput) (req *request.Request, output *UpdateKxVolumeOutput)
UpdateKxVolumeRequest generates a "aws/request.Request" representing the client's request for the UpdateKxVolume operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateKxVolume for more information on using the UpdateKxVolume API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateKxVolumeRequest method. req, resp := client.UpdateKxVolumeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxVolume
func (c *Finspace) UpdateKxVolumeWithContext(ctx aws.Context, input *UpdateKxVolumeInput, opts ...request.Option) (*UpdateKxVolumeOutput, error)
UpdateKxVolumeWithContext is the same as UpdateKxVolume with the addition of the ability to pass a context and additional request options.
See UpdateKxVolume for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type GetEnvironmentInput struct { // The identifier of the FinSpace environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetEnvironmentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetEnvironmentInput) SetEnvironmentId(v string) *GetEnvironmentInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s GetEnvironmentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEnvironmentOutput struct { // The name of the FinSpace environment. Environment *Environment `locationName:"environment" type:"structure"` // contains filtered or unexported fields }
func (s GetEnvironmentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetEnvironmentOutput) SetEnvironment(v *Environment) *GetEnvironmentOutput
SetEnvironment sets the Environment field's value.
func (s GetEnvironmentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxChangesetInput struct { // A unique identifier of the changeset for which you want to retrieve data. // // ChangesetId is a required field ChangesetId *string `location:"uri" locationName:"changesetId" min:"1" type:"string" required:"true"` // The name of the kdb database. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxChangesetInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxChangesetInput) SetChangesetId(v string) *GetKxChangesetInput
SetChangesetId sets the ChangesetId field's value.
func (s *GetKxChangesetInput) SetDatabaseName(v string) *GetKxChangesetInput
SetDatabaseName sets the DatabaseName field's value.
func (s *GetKxChangesetInput) SetEnvironmentId(v string) *GetKxChangesetInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s GetKxChangesetInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxChangesetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 `locationName:"activeFromTimestamp" type:"timestamp"` // A list of change request objects that are run in order. ChangeRequests []*ChangeRequest `locationName:"changeRequests" min:"1" type:"list"` // A unique identifier for the changeset. ChangesetId *string `locationName:"changesetId" min:"1" type:"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 `locationName:"createdTimestamp" type:"timestamp"` // The name of the kdb database. DatabaseName *string `locationName:"databaseName" min:"3" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // Provides details in the event of a failed flow, including the error type // and the related error message. ErrorInfo *ErrorInfo `locationName:"errorInfo" type:"structure"` // 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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // 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 *string `locationName:"status" type:"string" enum:"ChangesetStatus"` // contains filtered or unexported fields }
func (s GetKxChangesetOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxChangesetOutput) SetActiveFromTimestamp(v time.Time) *GetKxChangesetOutput
SetActiveFromTimestamp sets the ActiveFromTimestamp field's value.
func (s *GetKxChangesetOutput) SetChangeRequests(v []*ChangeRequest) *GetKxChangesetOutput
SetChangeRequests sets the ChangeRequests field's value.
func (s *GetKxChangesetOutput) SetChangesetId(v string) *GetKxChangesetOutput
SetChangesetId sets the ChangesetId field's value.
func (s *GetKxChangesetOutput) SetCreatedTimestamp(v time.Time) *GetKxChangesetOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *GetKxChangesetOutput) SetDatabaseName(v string) *GetKxChangesetOutput
SetDatabaseName sets the DatabaseName field's value.
func (s *GetKxChangesetOutput) SetEnvironmentId(v string) *GetKxChangesetOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxChangesetOutput) SetErrorInfo(v *ErrorInfo) *GetKxChangesetOutput
SetErrorInfo sets the ErrorInfo field's value.
func (s *GetKxChangesetOutput) SetLastModifiedTimestamp(v time.Time) *GetKxChangesetOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *GetKxChangesetOutput) SetStatus(v string) *GetKxChangesetOutput
SetStatus sets the Status field's value.
func (s GetKxChangesetOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxClusterInput struct { // The name of the cluster that you want to retrieve. // // ClusterName is a required field ClusterName *string `location:"uri" locationName:"clusterName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxClusterInput) SetClusterName(v string) *GetKxClusterInput
SetClusterName sets the ClusterName field's value.
func (s *GetKxClusterInput) SetEnvironmentId(v string) *GetKxClusterInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s GetKxClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKxClusterOutput struct { // The configuration based on which FinSpace will scale in or scale out nodes // in your cluster. AutoScalingConfiguration *AutoScalingConfiguration `locationName:"autoScalingConfiguration" type:"structure"` // The availability zone identifiers for the requested regions. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 *string `locationName:"azMode" type:"string" enum:"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 []*KxCacheStorageConfiguration `locationName:"cacheStorageConfigurations" type:"list"` // A structure for the metadata of a cluster. It includes information like the // CPUs needed, memory of instances, and number of instances. CapacityConfiguration *CapacityConfiguration `locationName:"capacityConfiguration" type:"structure"` // A description of the cluster. ClusterDescription *string `locationName:"clusterDescription" min:"1" type:"string"` // A unique name for the cluster. ClusterName *string `locationName:"clusterName" min:"3" type:"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 *string `locationName:"clusterType" type:"string" enum:"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 *CodeConfiguration `locationName:"code" type:"structure"` // Defines key-value pairs to make them available inside the cluster. CommandLineArguments []*KxCommandLineArgument `locationName:"commandLineArguments" type:"list"` // 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 `locationName:"createdTimestamp" type:"timestamp"` // A list of databases mounted on the cluster. Databases []*KxDatabaseConfiguration `locationName:"databases" type:"list"` // 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 `locationName:"executionRole" min:"1" type:"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 `locationName:"initializationScript" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // The version of FinSpace managed kdb to run. ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"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 *KxSavedownStorageConfiguration `locationName:"savedownStorageConfiguration" type:"structure"` // The structure that stores the capacity configuration details of a scaling // group. ScalingGroupConfiguration *KxScalingGroupConfiguration `locationName:"scalingGroupConfiguration" type:"structure"` // 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 *string `locationName:"status" type:"string" enum:"KxClusterStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"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 *TickerplantLogConfiguration `locationName:"tickerplantLogConfiguration" type:"structure"` // A list of volumes attached to the cluster. Volumes []*Volume `locationName:"volumes" type:"list"` // Configuration details about the network where the Privatelink endpoint of // the cluster resides. VpcConfiguration *VpcConfiguration `locationName:"vpcConfiguration" type:"structure"` // contains filtered or unexported fields }
func (s GetKxClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxClusterOutput) SetAutoScalingConfiguration(v *AutoScalingConfiguration) *GetKxClusterOutput
SetAutoScalingConfiguration sets the AutoScalingConfiguration field's value.
func (s *GetKxClusterOutput) SetAvailabilityZoneId(v string) *GetKxClusterOutput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *GetKxClusterOutput) SetAzMode(v string) *GetKxClusterOutput
SetAzMode sets the AzMode field's value.
func (s *GetKxClusterOutput) SetCacheStorageConfigurations(v []*KxCacheStorageConfiguration) *GetKxClusterOutput
SetCacheStorageConfigurations sets the CacheStorageConfigurations field's value.
func (s *GetKxClusterOutput) SetCapacityConfiguration(v *CapacityConfiguration) *GetKxClusterOutput
SetCapacityConfiguration sets the CapacityConfiguration field's value.
func (s *GetKxClusterOutput) SetClusterDescription(v string) *GetKxClusterOutput
SetClusterDescription sets the ClusterDescription field's value.
func (s *GetKxClusterOutput) SetClusterName(v string) *GetKxClusterOutput
SetClusterName sets the ClusterName field's value.
func (s *GetKxClusterOutput) SetClusterType(v string) *GetKxClusterOutput
SetClusterType sets the ClusterType field's value.
func (s *GetKxClusterOutput) SetCode(v *CodeConfiguration) *GetKxClusterOutput
SetCode sets the Code field's value.
func (s *GetKxClusterOutput) SetCommandLineArguments(v []*KxCommandLineArgument) *GetKxClusterOutput
SetCommandLineArguments sets the CommandLineArguments field's value.
func (s *GetKxClusterOutput) SetCreatedTimestamp(v time.Time) *GetKxClusterOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *GetKxClusterOutput) SetDatabases(v []*KxDatabaseConfiguration) *GetKxClusterOutput
SetDatabases sets the Databases field's value.
func (s *GetKxClusterOutput) SetExecutionRole(v string) *GetKxClusterOutput
SetExecutionRole sets the ExecutionRole field's value.
func (s *GetKxClusterOutput) SetInitializationScript(v string) *GetKxClusterOutput
SetInitializationScript sets the InitializationScript field's value.
func (s *GetKxClusterOutput) SetLastModifiedTimestamp(v time.Time) *GetKxClusterOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *GetKxClusterOutput) SetReleaseLabel(v string) *GetKxClusterOutput
SetReleaseLabel sets the ReleaseLabel field's value.
func (s *GetKxClusterOutput) SetSavedownStorageConfiguration(v *KxSavedownStorageConfiguration) *GetKxClusterOutput
SetSavedownStorageConfiguration sets the SavedownStorageConfiguration field's value.
func (s *GetKxClusterOutput) SetScalingGroupConfiguration(v *KxScalingGroupConfiguration) *GetKxClusterOutput
SetScalingGroupConfiguration sets the ScalingGroupConfiguration field's value.
func (s *GetKxClusterOutput) SetStatus(v string) *GetKxClusterOutput
SetStatus sets the Status field's value.
func (s *GetKxClusterOutput) SetStatusReason(v string) *GetKxClusterOutput
SetStatusReason sets the StatusReason field's value.
func (s *GetKxClusterOutput) SetTickerplantLogConfiguration(v *TickerplantLogConfiguration) *GetKxClusterOutput
SetTickerplantLogConfiguration sets the TickerplantLogConfiguration field's value.
func (s *GetKxClusterOutput) SetVolumes(v []*Volume) *GetKxClusterOutput
SetVolumes sets the Volumes field's value.
func (s *GetKxClusterOutput) SetVpcConfiguration(v *VpcConfiguration) *GetKxClusterOutput
SetVpcConfiguration sets the VpcConfiguration field's value.
func (s GetKxClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxConnectionStringInput struct { // A name of the kdb cluster. // // ClusterName is a required field ClusterName *string `location:"querystring" locationName:"clusterName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // 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 is a required field UserArn *string `location:"querystring" locationName:"userArn" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxConnectionStringInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxConnectionStringInput) SetClusterName(v string) *GetKxConnectionStringInput
SetClusterName sets the ClusterName field's value.
func (s *GetKxConnectionStringInput) SetEnvironmentId(v string) *GetKxConnectionStringInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxConnectionStringInput) SetUserArn(v string) *GetKxConnectionStringInput
SetUserArn sets the UserArn field's value.
func (s GetKxConnectionStringInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxConnectionStringInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKxConnectionStringOutput struct { // The signed connection string that you can use to connect to clusters. // // SignedConnectionString is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by GetKxConnectionStringOutput's // String and GoString methods. SignedConnectionString *string `locationName:"signedConnectionString" min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
func (s GetKxConnectionStringOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxConnectionStringOutput) SetSignedConnectionString(v string) *GetKxConnectionStringOutput
SetSignedConnectionString sets the SignedConnectionString field's value.
func (s GetKxConnectionStringOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxDatabaseInput struct { // The name of the kdb database. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxDatabaseInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxDatabaseInput) SetDatabaseName(v string) *GetKxDatabaseInput
SetDatabaseName sets the DatabaseName field's value.
func (s *GetKxDatabaseInput) SetEnvironmentId(v string) *GetKxDatabaseInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s GetKxDatabaseInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 `locationName:"createdTimestamp" type:"timestamp"` // The ARN identifier of the database. DatabaseArn *string `locationName:"databaseArn" type:"string"` // The name of the kdb database for which the information is retrieved. DatabaseName *string `locationName:"databaseName" min:"3" type:"string"` // A description of the database. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // A unique identifier for the changeset. LastCompletedChangesetId *string `locationName:"lastCompletedChangesetId" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // The total number of bytes in the database. NumBytes *int64 `locationName:"numBytes" type:"long"` // The total number of changesets in the database. NumChangesets *int64 `locationName:"numChangesets" type:"integer"` // The total number of files in the database. NumFiles *int64 `locationName:"numFiles" type:"integer"` // contains filtered or unexported fields }
func (s GetKxDatabaseOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxDatabaseOutput) SetCreatedTimestamp(v time.Time) *GetKxDatabaseOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *GetKxDatabaseOutput) SetDatabaseArn(v string) *GetKxDatabaseOutput
SetDatabaseArn sets the DatabaseArn field's value.
func (s *GetKxDatabaseOutput) SetDatabaseName(v string) *GetKxDatabaseOutput
SetDatabaseName sets the DatabaseName field's value.
func (s *GetKxDatabaseOutput) SetDescription(v string) *GetKxDatabaseOutput
SetDescription sets the Description field's value.
func (s *GetKxDatabaseOutput) SetEnvironmentId(v string) *GetKxDatabaseOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxDatabaseOutput) SetLastCompletedChangesetId(v string) *GetKxDatabaseOutput
SetLastCompletedChangesetId sets the LastCompletedChangesetId field's value.
func (s *GetKxDatabaseOutput) SetLastModifiedTimestamp(v time.Time) *GetKxDatabaseOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *GetKxDatabaseOutput) SetNumBytes(v int64) *GetKxDatabaseOutput
SetNumBytes sets the NumBytes field's value.
func (s *GetKxDatabaseOutput) SetNumChangesets(v int64) *GetKxDatabaseOutput
SetNumChangesets sets the NumChangesets field's value.
func (s *GetKxDatabaseOutput) SetNumFiles(v int64) *GetKxDatabaseOutput
SetNumFiles sets the NumFiles field's value.
func (s GetKxDatabaseOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxDataviewInput struct { // The name of the database where you created the dataview. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier for the dataview. // // DataviewName is a required field DataviewName *string `location:"uri" locationName:"dataviewName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment, from where you want to retrieve // the dataview details. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxDataviewInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxDataviewInput) SetDatabaseName(v string) *GetKxDataviewInput
SetDatabaseName sets the DatabaseName field's value.
func (s *GetKxDataviewInput) SetDataviewName(v string) *GetKxDataviewInput
SetDataviewName sets the DataviewName field's value.
func (s *GetKxDataviewInput) SetEnvironmentId(v string) *GetKxDataviewInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s GetKxDataviewInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxDataviewInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKxDataviewOutput struct { // The current active changeset versions of the database on the given dataview. ActiveVersions []*KxDataviewActiveVersion `locationName:"activeVersions" type:"list"` // 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 `locationName:"autoUpdate" type:"boolean"` // The identifier of the availability zones. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 *string `locationName:"azMode" type:"string" enum:"KxAzMode"` // A unique identifier of the changeset that you want to use to ingest data. ChangesetId *string `locationName:"changesetId" min:"1" type:"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 `locationName:"createdTimestamp" type:"timestamp"` // The name of the database where you created the dataview. DatabaseName *string `locationName:"databaseName" min:"3" type:"string"` // A unique identifier for the dataview. DataviewName *string `locationName:"dataviewName" min:"3" type:"string"` // A description of the dataview. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment, from where you want to retrieve // the dataview details. EnvironmentId *string `locationName:"environmentId" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // Returns True if the dataview is created as writeable and False otherwise. ReadWrite *bool `locationName:"readWrite" type:"boolean"` // 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 []*KxDataviewSegmentConfiguration `locationName:"segmentConfigurations" type:"list"` // 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 *string `locationName:"status" type:"string" enum:"KxDataviewStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetKxDataviewOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxDataviewOutput) SetActiveVersions(v []*KxDataviewActiveVersion) *GetKxDataviewOutput
SetActiveVersions sets the ActiveVersions field's value.
func (s *GetKxDataviewOutput) SetAutoUpdate(v bool) *GetKxDataviewOutput
SetAutoUpdate sets the AutoUpdate field's value.
func (s *GetKxDataviewOutput) SetAvailabilityZoneId(v string) *GetKxDataviewOutput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *GetKxDataviewOutput) SetAzMode(v string) *GetKxDataviewOutput
SetAzMode sets the AzMode field's value.
func (s *GetKxDataviewOutput) SetChangesetId(v string) *GetKxDataviewOutput
SetChangesetId sets the ChangesetId field's value.
func (s *GetKxDataviewOutput) SetCreatedTimestamp(v time.Time) *GetKxDataviewOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *GetKxDataviewOutput) SetDatabaseName(v string) *GetKxDataviewOutput
SetDatabaseName sets the DatabaseName field's value.
func (s *GetKxDataviewOutput) SetDataviewName(v string) *GetKxDataviewOutput
SetDataviewName sets the DataviewName field's value.
func (s *GetKxDataviewOutput) SetDescription(v string) *GetKxDataviewOutput
SetDescription sets the Description field's value.
func (s *GetKxDataviewOutput) SetEnvironmentId(v string) *GetKxDataviewOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxDataviewOutput) SetLastModifiedTimestamp(v time.Time) *GetKxDataviewOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *GetKxDataviewOutput) SetReadWrite(v bool) *GetKxDataviewOutput
SetReadWrite sets the ReadWrite field's value.
func (s *GetKxDataviewOutput) SetSegmentConfigurations(v []*KxDataviewSegmentConfiguration) *GetKxDataviewOutput
SetSegmentConfigurations sets the SegmentConfigurations field's value.
func (s *GetKxDataviewOutput) SetStatus(v string) *GetKxDataviewOutput
SetStatus sets the Status field's value.
func (s *GetKxDataviewOutput) SetStatusReason(v string) *GetKxDataviewOutput
SetStatusReason sets the StatusReason field's value.
func (s GetKxDataviewOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxEnvironmentInput struct { // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxEnvironmentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxEnvironmentInput) SetEnvironmentId(v string) *GetKxEnvironmentInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s GetKxEnvironmentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKxEnvironmentOutput struct { // The identifier of the availability zones where subnets for the environment // are created. AvailabilityZoneIds []*string `locationName:"availabilityZoneIds" type:"list"` // The unique identifier of the AWS account that is used to create the kdb environment. AwsAccountId *string `locationName:"awsAccountId" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the certificate authority of the kdb environment. CertificateAuthorityArn *string `locationName:"certificateAuthorityArn" min:"1" type:"string"` // The timestamp at which the kdb environment was created in FinSpace. CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"` // A list of DNS server name and server IP. This is used to set up Route-53 // outbound resolvers. CustomDNSConfiguration []*CustomDNSServer `locationName:"customDNSConfiguration" type:"list"` // A unique identifier for the AWS environment infrastructure account. DedicatedServiceAccountId *string `locationName:"dedicatedServiceAccountId" min:"1" type:"string"` // A description for the kdb environment. Description *string `locationName:"description" min:"1" type:"string"` // The status of DNS configuration. DnsStatus *string `locationName:"dnsStatus" type:"string" enum:"DnsStatus"` // The ARN identifier of the environment. EnvironmentArn *string `locationName:"environmentArn" min:"20" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // Specifies the error message that appears if a flow fails. ErrorMessage *string `locationName:"errorMessage" type:"string"` // The KMS key ID to encrypt your data in the FinSpace environment. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` // The name of the kdb environment. Name *string `locationName:"name" min:"3" type:"string"` // The status of the kdb environment. Status *string `locationName:"status" type:"string" enum:"EnvironmentStatus"` // The status of the network configuration. TgwStatus *string `locationName:"tgwStatus" type:"string" enum:"TgwStatus"` // The structure of the transit gateway and network configuration that is used // to connect the kdb environment to an internal network. TransitGatewayConfiguration *TransitGatewayConfiguration `locationName:"transitGatewayConfiguration" type:"structure"` // The timestamp at which the kdb environment was updated. UpdateTimestamp *time.Time `locationName:"updateTimestamp" type:"timestamp"` // contains filtered or unexported fields }
func (s GetKxEnvironmentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxEnvironmentOutput) SetAvailabilityZoneIds(v []*string) *GetKxEnvironmentOutput
SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.
func (s *GetKxEnvironmentOutput) SetAwsAccountId(v string) *GetKxEnvironmentOutput
SetAwsAccountId sets the AwsAccountId field's value.
func (s *GetKxEnvironmentOutput) SetCertificateAuthorityArn(v string) *GetKxEnvironmentOutput
SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.
func (s *GetKxEnvironmentOutput) SetCreationTimestamp(v time.Time) *GetKxEnvironmentOutput
SetCreationTimestamp sets the CreationTimestamp field's value.
func (s *GetKxEnvironmentOutput) SetCustomDNSConfiguration(v []*CustomDNSServer) *GetKxEnvironmentOutput
SetCustomDNSConfiguration sets the CustomDNSConfiguration field's value.
func (s *GetKxEnvironmentOutput) SetDedicatedServiceAccountId(v string) *GetKxEnvironmentOutput
SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.
func (s *GetKxEnvironmentOutput) SetDescription(v string) *GetKxEnvironmentOutput
SetDescription sets the Description field's value.
func (s *GetKxEnvironmentOutput) SetDnsStatus(v string) *GetKxEnvironmentOutput
SetDnsStatus sets the DnsStatus field's value.
func (s *GetKxEnvironmentOutput) SetEnvironmentArn(v string) *GetKxEnvironmentOutput
SetEnvironmentArn sets the EnvironmentArn field's value.
func (s *GetKxEnvironmentOutput) SetEnvironmentId(v string) *GetKxEnvironmentOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxEnvironmentOutput) SetErrorMessage(v string) *GetKxEnvironmentOutput
SetErrorMessage sets the ErrorMessage field's value.
func (s *GetKxEnvironmentOutput) SetKmsKeyId(v string) *GetKxEnvironmentOutput
SetKmsKeyId sets the KmsKeyId field's value.
func (s *GetKxEnvironmentOutput) SetName(v string) *GetKxEnvironmentOutput
SetName sets the Name field's value.
func (s *GetKxEnvironmentOutput) SetStatus(v string) *GetKxEnvironmentOutput
SetStatus sets the Status field's value.
func (s *GetKxEnvironmentOutput) SetTgwStatus(v string) *GetKxEnvironmentOutput
SetTgwStatus sets the TgwStatus field's value.
func (s *GetKxEnvironmentOutput) SetTransitGatewayConfiguration(v *TransitGatewayConfiguration) *GetKxEnvironmentOutput
SetTransitGatewayConfiguration sets the TransitGatewayConfiguration field's value.
func (s *GetKxEnvironmentOutput) SetUpdateTimestamp(v time.Time) *GetKxEnvironmentOutput
SetUpdateTimestamp sets the UpdateTimestamp field's value.
func (s GetKxEnvironmentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxScalingGroupInput struct { // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // A unique identifier for the kdb scaling group. // // ScalingGroupName is a required field ScalingGroupName *string `location:"uri" locationName:"scalingGroupName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxScalingGroupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxScalingGroupInput) SetEnvironmentId(v string) *GetKxScalingGroupInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxScalingGroupInput) SetScalingGroupName(v string) *GetKxScalingGroupInput
SetScalingGroupName sets the ScalingGroupName field's value.
func (s GetKxScalingGroupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxScalingGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKxScalingGroupOutput struct { // The identifier of the availability zones. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"string"` // The list of Managed kdb clusters that are currently active in the given scaling // group. Clusters []*string `locationName:"clusters" type:"list"` // 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 `locationName:"createdTimestamp" type:"timestamp"` // 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 `locationName:"hostType" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // The ARN identifier for the scaling group. ScalingGroupArn *string `locationName:"scalingGroupArn" min:"20" type:"string"` // A unique identifier for the kdb scaling group. ScalingGroupName *string `locationName:"scalingGroupName" min:"3" type:"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 *string `locationName:"status" type:"string" enum:"KxScalingGroupStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetKxScalingGroupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxScalingGroupOutput) SetAvailabilityZoneId(v string) *GetKxScalingGroupOutput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *GetKxScalingGroupOutput) SetClusters(v []*string) *GetKxScalingGroupOutput
SetClusters sets the Clusters field's value.
func (s *GetKxScalingGroupOutput) SetCreatedTimestamp(v time.Time) *GetKxScalingGroupOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *GetKxScalingGroupOutput) SetHostType(v string) *GetKxScalingGroupOutput
SetHostType sets the HostType field's value.
func (s *GetKxScalingGroupOutput) SetLastModifiedTimestamp(v time.Time) *GetKxScalingGroupOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *GetKxScalingGroupOutput) SetScalingGroupArn(v string) *GetKxScalingGroupOutput
SetScalingGroupArn sets the ScalingGroupArn field's value.
func (s *GetKxScalingGroupOutput) SetScalingGroupName(v string) *GetKxScalingGroupOutput
SetScalingGroupName sets the ScalingGroupName field's value.
func (s *GetKxScalingGroupOutput) SetStatus(v string) *GetKxScalingGroupOutput
SetStatus sets the Status field's value.
func (s *GetKxScalingGroupOutput) SetStatusReason(v string) *GetKxScalingGroupOutput
SetStatusReason sets the StatusReason field's value.
func (s GetKxScalingGroupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxUserInput struct { // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // A unique identifier for the user. // // UserName is a required field UserName *string `location:"uri" locationName:"userName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxUserInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxUserInput) SetEnvironmentId(v string) *GetKxUserInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxUserInput) SetUserName(v string) *GetKxUserInput
SetUserName sets the UserName field's value.
func (s GetKxUserInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKxUserOutput struct { // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The IAM role ARN that is associated with the user. IamRole *string `locationName:"iamRole" min:"20" type:"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 `locationName:"userArn" min:"20" type:"string"` // A unique identifier for the user. UserName *string `locationName:"userName" min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetKxUserOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxUserOutput) SetEnvironmentId(v string) *GetKxUserOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxUserOutput) SetIamRole(v string) *GetKxUserOutput
SetIamRole sets the IamRole field's value.
func (s *GetKxUserOutput) SetUserArn(v string) *GetKxUserOutput
SetUserArn sets the UserArn field's value.
func (s *GetKxUserOutput) SetUserName(v string) *GetKxUserOutput
SetUserName sets the UserName field's value.
func (s GetKxUserOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetKxVolumeInput struct { // A unique identifier for the kdb environment, whose clusters can attach to // the volume. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // A unique identifier for the volume. // // VolumeName is a required field VolumeName *string `location:"uri" locationName:"volumeName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetKxVolumeInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxVolumeInput) SetEnvironmentId(v string) *GetKxVolumeInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxVolumeInput) SetVolumeName(v string) *GetKxVolumeInput
SetVolumeName sets the VolumeName field's value.
func (s GetKxVolumeInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxVolumeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKxVolumeOutput struct { // A list of cluster identifiers that a volume is attached to. AttachedClusters []*KxAttachedCluster `locationName:"attachedClusters" type:"list"` // The identifier of the availability zones. AvailabilityZoneIds []*string `locationName:"availabilityZoneIds" type:"list"` // 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 *string `locationName:"azMode" type:"string" enum:"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 `locationName:"createdTimestamp" type:"timestamp"` // A description of the volume. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment, whose clusters can attach to // the volume. EnvironmentId *string `locationName:"environmentId" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // Specifies the configuration for the Network attached storage (NAS_1) file // system volume. Nas1Configuration *KxNAS1Configuration `locationName:"nas1Configuration" type:"structure"` // 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 *string `locationName:"status" type:"string" enum:"KxVolumeStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // The ARN identifier of the volume. VolumeArn *string `locationName:"volumeArn" min:"20" type:"string"` // A unique identifier for the volume. VolumeName *string `locationName:"volumeName" min:"3" type:"string"` // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType *string `locationName:"volumeType" type:"string" enum:"KxVolumeType"` // contains filtered or unexported fields }
func (s GetKxVolumeOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetKxVolumeOutput) SetAttachedClusters(v []*KxAttachedCluster) *GetKxVolumeOutput
SetAttachedClusters sets the AttachedClusters field's value.
func (s *GetKxVolumeOutput) SetAvailabilityZoneIds(v []*string) *GetKxVolumeOutput
SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.
func (s *GetKxVolumeOutput) SetAzMode(v string) *GetKxVolumeOutput
SetAzMode sets the AzMode field's value.
func (s *GetKxVolumeOutput) SetCreatedTimestamp(v time.Time) *GetKxVolumeOutput
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *GetKxVolumeOutput) SetDescription(v string) *GetKxVolumeOutput
SetDescription sets the Description field's value.
func (s *GetKxVolumeOutput) SetEnvironmentId(v string) *GetKxVolumeOutput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *GetKxVolumeOutput) SetLastModifiedTimestamp(v time.Time) *GetKxVolumeOutput
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *GetKxVolumeOutput) SetNas1Configuration(v *KxNAS1Configuration) *GetKxVolumeOutput
SetNas1Configuration sets the Nas1Configuration field's value.
func (s *GetKxVolumeOutput) SetStatus(v string) *GetKxVolumeOutput
SetStatus sets the Status field's value.
func (s *GetKxVolumeOutput) SetStatusReason(v string) *GetKxVolumeOutput
SetStatusReason sets the StatusReason field's value.
func (s *GetKxVolumeOutput) SetVolumeArn(v string) *GetKxVolumeOutput
SetVolumeArn sets the VolumeArn field's value.
func (s *GetKxVolumeOutput) SetVolumeName(v string) *GetKxVolumeOutput
SetVolumeName sets the VolumeName field's value.
func (s *GetKxVolumeOutput) SetVolumeType(v string) *GetKxVolumeOutput
SetVolumeType sets the VolumeType field's value.
func (s GetKxVolumeOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type IcmpTypeCode struct { // The ICMP code. A value of -1 means all codes for the specified ICMP type. // // Code is a required field Code *int64 `locationName:"code" type:"integer" required:"true"` // The ICMP type. A value of -1 means all types. // // Type is a required field Type *int64 `locationName:"type" type:"integer" required:"true"` // contains filtered or unexported fields }
Defines the ICMP protocol that consists of the ICMP type and code.
func (s IcmpTypeCode) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IcmpTypeCode) SetCode(v int64) *IcmpTypeCode
SetCode sets the Code field's value.
func (s *IcmpTypeCode) SetType(v int64) *IcmpTypeCode
SetType sets the Type field's value.
func (s IcmpTypeCode) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IcmpTypeCode) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InternalServerException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The request processing has failed because of an unknown error, exception or failure.
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidRequestException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The request is invalid. Something is wrong with the input to the request.
func (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
func (s InvalidRequestException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidRequestException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxAttachedCluster struct { // A unique name for the attached cluster. ClusterName *string `locationName:"clusterName" min:"3" type:"string"` // The status of the attached cluster. // // * 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. ClusterStatus *string `locationName:"clusterStatus" type:"string" enum:"KxClusterStatus"` // Specifies the type of cluster. The volume for TP and RDB cluster types will // be used for TP logs. ClusterType *string `locationName:"clusterType" type:"string" enum:"KxClusterType"` // contains filtered or unexported fields }
The structure containing the metadata of the attached clusters.
func (s KxAttachedCluster) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxAttachedCluster) SetClusterName(v string) *KxAttachedCluster
SetClusterName sets the ClusterName field's value.
func (s *KxAttachedCluster) SetClusterStatus(v string) *KxAttachedCluster
SetClusterStatus sets the ClusterStatus field's value.
func (s *KxAttachedCluster) SetClusterType(v string) *KxAttachedCluster
SetClusterType sets the ClusterType field's value.
func (s KxAttachedCluster) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxCacheStorageConfiguration struct { // The size of cache in Gigabytes. // // Size is a required field Size *int64 `locationName:"size" type:"integer" required:"true"` // The type of cache storage. The valid values are: // // * CACHE_1000 – This type provides at least 1000 MB/s disk access throughput. // // * CACHE_250 – This type provides at least 250 MB/s disk access throughput. // // * CACHE_12 – This type provides at least 12 MB/s disk access throughput. // // For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 // GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache // size in increments of 6000 GB. // // Type is a required field Type *string `locationName:"type" min:"8" type:"string" required:"true"` // contains filtered or unexported fields }
The configuration for read only disk cache associated with a cluster.
func (s KxCacheStorageConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxCacheStorageConfiguration) SetSize(v int64) *KxCacheStorageConfiguration
SetSize sets the Size field's value.
func (s *KxCacheStorageConfiguration) SetType(v string) *KxCacheStorageConfiguration
SetType sets the Type field's value.
func (s KxCacheStorageConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxCacheStorageConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxChangesetListEntry 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 `locationName:"activeFromTimestamp" type:"timestamp"` // A unique identifier for the changeset. ChangesetId *string `locationName:"changesetId" min:"1" type:"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 `locationName:"createdTimestamp" type:"timestamp"` // The timestamp at which the changeset 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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // Status of the changeset. // // * Pending – Changeset creation is pending. // // * Processing – Changeset creation is running. // // * Failed – Changeset creation has failed. // // * Complete – Changeset creation has succeeded. Status *string `locationName:"status" type:"string" enum:"ChangesetStatus"` // contains filtered or unexported fields }
Details of changeset.
func (s KxChangesetListEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxChangesetListEntry) SetActiveFromTimestamp(v time.Time) *KxChangesetListEntry
SetActiveFromTimestamp sets the ActiveFromTimestamp field's value.
func (s *KxChangesetListEntry) SetChangesetId(v string) *KxChangesetListEntry
SetChangesetId sets the ChangesetId field's value.
func (s *KxChangesetListEntry) SetCreatedTimestamp(v time.Time) *KxChangesetListEntry
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *KxChangesetListEntry) SetLastModifiedTimestamp(v time.Time) *KxChangesetListEntry
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *KxChangesetListEntry) SetStatus(v string) *KxChangesetListEntry
SetStatus sets the Status field's value.
func (s KxChangesetListEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxCluster struct { // The availability zone identifiers for the requested regions. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"string"` // The number of availability zones assigned 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 *string `locationName:"azMode" type:"string" enum:"KxAzMode"` // A description of the cluster. ClusterDescription *string `locationName:"clusterDescription" min:"1" type:"string"` // A unique name for the cluster. ClusterName *string `locationName:"clusterName" min:"3" type:"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 *string `locationName:"clusterType" type:"string" enum:"KxClusterType"` // 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 `locationName:"createdTimestamp" type:"timestamp"` // 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 `locationName:"executionRole" min:"1" type:"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 `locationName:"initializationScript" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // A version of the FinSpace managed kdb to run. ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"string"` // The status of a cluster. // // * 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 *string `locationName:"status" type:"string" enum:"KxClusterStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // A list of volumes attached to the cluster. Volumes []*Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
The details of a kdb cluster.
func (s KxCluster) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxCluster) SetAvailabilityZoneId(v string) *KxCluster
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *KxCluster) SetAzMode(v string) *KxCluster
SetAzMode sets the AzMode field's value.
func (s *KxCluster) SetClusterDescription(v string) *KxCluster
SetClusterDescription sets the ClusterDescription field's value.
func (s *KxCluster) SetClusterName(v string) *KxCluster
SetClusterName sets the ClusterName field's value.
func (s *KxCluster) SetClusterType(v string) *KxCluster
SetClusterType sets the ClusterType field's value.
func (s *KxCluster) SetCreatedTimestamp(v time.Time) *KxCluster
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *KxCluster) SetExecutionRole(v string) *KxCluster
SetExecutionRole sets the ExecutionRole field's value.
func (s *KxCluster) SetInitializationScript(v string) *KxCluster
SetInitializationScript sets the InitializationScript field's value.
func (s *KxCluster) SetLastModifiedTimestamp(v time.Time) *KxCluster
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *KxCluster) SetReleaseLabel(v string) *KxCluster
SetReleaseLabel sets the ReleaseLabel field's value.
func (s *KxCluster) SetStatus(v string) *KxCluster
SetStatus sets the Status field's value.
func (s *KxCluster) SetStatusReason(v string) *KxCluster
SetStatusReason sets the StatusReason field's value.
func (s *KxCluster) SetVolumes(v []*Volume) *KxCluster
SetVolumes sets the Volumes field's value.
func (s KxCluster) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxClusterCodeDeploymentConfiguration struct { // The type of deployment that you want on a cluster. // // * ROLLING – This options updates the cluster by stopping the exiting // q process and starting a new q process with updated configuration. // // * NO_RESTART – This option updates the cluster without stopping the // running q process. It is only available for GP type cluster. This option // is quicker as it reduces the turn around time to update configuration // on a cluster. With this deployment mode, you cannot update the initializationScript // and commandLineArguments parameters. // // * FORCE – This option updates the cluster by immediately stopping all // the running processes before starting up new ones with the updated configuration. // // DeploymentStrategy is a required field DeploymentStrategy *string `locationName:"deploymentStrategy" type:"string" required:"true" enum:"KxClusterCodeDeploymentStrategy"` // contains filtered or unexported fields }
The configuration that allows you to choose how you want to update code on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.
func (s KxClusterCodeDeploymentConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxClusterCodeDeploymentConfiguration) SetDeploymentStrategy(v string) *KxClusterCodeDeploymentConfiguration
SetDeploymentStrategy sets the DeploymentStrategy field's value.
func (s KxClusterCodeDeploymentConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxClusterCodeDeploymentConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxCommandLineArgument struct { // The name of the key. Key *string `locationName:"key" min:"1" type:"string"` // The value of the key. Value *string `locationName:"value" min:"1" type:"string"` // contains filtered or unexported fields }
Defines the key-value pairs to make them available inside the cluster.
func (s KxCommandLineArgument) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxCommandLineArgument) SetKey(v string) *KxCommandLineArgument
SetKey sets the Key field's value.
func (s *KxCommandLineArgument) SetValue(v string) *KxCommandLineArgument
SetValue sets the Value field's value.
func (s KxCommandLineArgument) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxCommandLineArgument) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxDatabaseCacheConfiguration struct { // The type of disk cache. This parameter is used to map the database path to // cache storage. The valid values are: // // * CACHE_1000 – This type provides at least 1000 MB/s disk access throughput. // // CacheType is a required field CacheType *string `locationName:"cacheType" min:"8" type:"string" required:"true"` // The name of the dataview to be used for caching historical data on disk. DataviewName *string `locationName:"dataviewName" min:"3" type:"string"` // Specifies the portions of database that will be loaded into the cache for // access. // // DbPaths is a required field DbPaths []*string `locationName:"dbPaths" type:"list" required:"true"` // contains filtered or unexported fields }
The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
func (s KxDatabaseCacheConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDatabaseCacheConfiguration) SetCacheType(v string) *KxDatabaseCacheConfiguration
SetCacheType sets the CacheType field's value.
func (s *KxDatabaseCacheConfiguration) SetDataviewName(v string) *KxDatabaseCacheConfiguration
SetDataviewName sets the DataviewName field's value.
func (s *KxDatabaseCacheConfiguration) SetDbPaths(v []*string) *KxDatabaseCacheConfiguration
SetDbPaths sets the DbPaths field's value.
func (s KxDatabaseCacheConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDatabaseCacheConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxDatabaseConfiguration struct { // Configuration details for the disk cache used to increase performance reading // from a kdb database mounted to the cluster. CacheConfigurations []*KxDatabaseCacheConfiguration `locationName:"cacheConfigurations" type:"list"` // A unique identifier of the changeset that is associated with the cluster. ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` // The name of the kdb database. When this parameter is specified in the structure, // S3 with the whole database is included by default. // // DatabaseName is a required field DatabaseName *string `locationName:"databaseName" min:"3" type:"string" required:"true"` // The configuration of the dataview to be used with specified cluster. DataviewConfiguration *KxDataviewConfiguration `locationName:"dataviewConfiguration" type:"structure"` // The name of the dataview to be used for caching historical data on disk. DataviewName *string `locationName:"dataviewName" min:"3" type:"string"` // contains filtered or unexported fields }
The configuration of data that is available for querying from this database.
func (s KxDatabaseConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDatabaseConfiguration) SetCacheConfigurations(v []*KxDatabaseCacheConfiguration) *KxDatabaseConfiguration
SetCacheConfigurations sets the CacheConfigurations field's value.
func (s *KxDatabaseConfiguration) SetChangesetId(v string) *KxDatabaseConfiguration
SetChangesetId sets the ChangesetId field's value.
func (s *KxDatabaseConfiguration) SetDatabaseName(v string) *KxDatabaseConfiguration
SetDatabaseName sets the DatabaseName field's value.
func (s *KxDatabaseConfiguration) SetDataviewConfiguration(v *KxDataviewConfiguration) *KxDatabaseConfiguration
SetDataviewConfiguration sets the DataviewConfiguration field's value.
func (s *KxDatabaseConfiguration) SetDataviewName(v string) *KxDatabaseConfiguration
SetDataviewName sets the DataviewName field's value.
func (s KxDatabaseConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDatabaseConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxDatabaseListEntry struct { // The timestamp at which the database 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 `locationName:"createdTimestamp" type:"timestamp"` // The name of the kdb database. DatabaseName *string `locationName:"databaseName" min:"3" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // contains filtered or unexported fields }
Details about a FinSpace managed kdb database
func (s KxDatabaseListEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDatabaseListEntry) SetCreatedTimestamp(v time.Time) *KxDatabaseListEntry
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *KxDatabaseListEntry) SetDatabaseName(v string) *KxDatabaseListEntry
SetDatabaseName sets the DatabaseName field's value.
func (s *KxDatabaseListEntry) SetLastModifiedTimestamp(v time.Time) *KxDatabaseListEntry
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s KxDatabaseListEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxDataviewActiveVersion struct { // The list of clusters that are currently using this dataview. AttachedClusters []*string `locationName:"attachedClusters" type:"list"` // A unique identifier for the changeset. ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` // The timestamp at which the dataview version was 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. CreatedTimestamp *time.Time `locationName:"createdTimestamp" type:"timestamp"` // 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 []*KxDataviewSegmentConfiguration `locationName:"segmentConfigurations" type:"list"` // A unique identifier of the active version. VersionId *string `locationName:"versionId" min:"1" type:"string"` // contains filtered or unexported fields }
The active version of the dataview that is currently in use by this cluster.
func (s KxDataviewActiveVersion) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDataviewActiveVersion) SetAttachedClusters(v []*string) *KxDataviewActiveVersion
SetAttachedClusters sets the AttachedClusters field's value.
func (s *KxDataviewActiveVersion) SetChangesetId(v string) *KxDataviewActiveVersion
SetChangesetId sets the ChangesetId field's value.
func (s *KxDataviewActiveVersion) SetCreatedTimestamp(v time.Time) *KxDataviewActiveVersion
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *KxDataviewActiveVersion) SetSegmentConfigurations(v []*KxDataviewSegmentConfiguration) *KxDataviewActiveVersion
SetSegmentConfigurations sets the SegmentConfigurations field's value.
func (s *KxDataviewActiveVersion) SetVersionId(v string) *KxDataviewActiveVersion
SetVersionId sets the VersionId field's value.
func (s KxDataviewActiveVersion) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxDataviewConfiguration struct { // A unique identifier for the changeset. ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` // The unique identifier of the dataview. DataviewName *string `locationName:"dataviewName" min:"3" type:"string"` // The version of the dataview corresponding to a given changeset. DataviewVersionId *string `locationName:"dataviewVersionId" min:"1" type:"string"` // The db path and volume configuration for the segmented database. SegmentConfigurations []*KxDataviewSegmentConfiguration `locationName:"segmentConfigurations" type:"list"` // contains filtered or unexported fields }
The structure that stores the configuration details of a dataview.
func (s KxDataviewConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDataviewConfiguration) SetChangesetId(v string) *KxDataviewConfiguration
SetChangesetId sets the ChangesetId field's value.
func (s *KxDataviewConfiguration) SetDataviewName(v string) *KxDataviewConfiguration
SetDataviewName sets the DataviewName field's value.
func (s *KxDataviewConfiguration) SetDataviewVersionId(v string) *KxDataviewConfiguration
SetDataviewVersionId sets the DataviewVersionId field's value.
func (s *KxDataviewConfiguration) SetSegmentConfigurations(v []*KxDataviewSegmentConfiguration) *KxDataviewConfiguration
SetSegmentConfigurations sets the SegmentConfigurations field's value.
func (s KxDataviewConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDataviewConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxDataviewListEntry struct { // The active changeset versions for the given dataview entry. ActiveVersions []*KxDataviewActiveVersion `locationName:"activeVersions" type:"list"` // 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 `locationName:"autoUpdate" type:"boolean"` // The identifier of the availability zones. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"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 *string `locationName:"azMode" type:"string" enum:"KxAzMode"` // A unique identifier for the changeset. ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` // The timestamp at which the dataview list entry 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 `locationName:"createdTimestamp" type:"timestamp"` // A unique identifier of the database. DatabaseName *string `locationName:"databaseName" min:"3" type:"string"` // A unique identifier of the dataview. DataviewName *string `locationName:"dataviewName" min:"3" type:"string"` // A description for the dataview list entry. Description *string `locationName:"description" min:"1" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // The last time that the dataview list 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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // Returns True if the dataview is created as writeable and False otherwise. ReadWrite *bool `locationName:"readWrite" type:"boolean"` // 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 []*KxDataviewSegmentConfiguration `locationName:"segmentConfigurations" type:"list"` // The status of a given dataview entry. Status *string `locationName:"status" type:"string" enum:"KxDataviewStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // contains filtered or unexported fields }
A collection of kdb dataview entries.
func (s KxDataviewListEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDataviewListEntry) SetActiveVersions(v []*KxDataviewActiveVersion) *KxDataviewListEntry
SetActiveVersions sets the ActiveVersions field's value.
func (s *KxDataviewListEntry) SetAutoUpdate(v bool) *KxDataviewListEntry
SetAutoUpdate sets the AutoUpdate field's value.
func (s *KxDataviewListEntry) SetAvailabilityZoneId(v string) *KxDataviewListEntry
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *KxDataviewListEntry) SetAzMode(v string) *KxDataviewListEntry
SetAzMode sets the AzMode field's value.
func (s *KxDataviewListEntry) SetChangesetId(v string) *KxDataviewListEntry
SetChangesetId sets the ChangesetId field's value.
func (s *KxDataviewListEntry) SetCreatedTimestamp(v time.Time) *KxDataviewListEntry
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *KxDataviewListEntry) SetDatabaseName(v string) *KxDataviewListEntry
SetDatabaseName sets the DatabaseName field's value.
func (s *KxDataviewListEntry) SetDataviewName(v string) *KxDataviewListEntry
SetDataviewName sets the DataviewName field's value.
func (s *KxDataviewListEntry) SetDescription(v string) *KxDataviewListEntry
SetDescription sets the Description field's value.
func (s *KxDataviewListEntry) SetEnvironmentId(v string) *KxDataviewListEntry
SetEnvironmentId sets the EnvironmentId field's value.
func (s *KxDataviewListEntry) SetLastModifiedTimestamp(v time.Time) *KxDataviewListEntry
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *KxDataviewListEntry) SetReadWrite(v bool) *KxDataviewListEntry
SetReadWrite sets the ReadWrite field's value.
func (s *KxDataviewListEntry) SetSegmentConfigurations(v []*KxDataviewSegmentConfiguration) *KxDataviewListEntry
SetSegmentConfigurations sets the SegmentConfigurations field's value.
func (s *KxDataviewListEntry) SetStatus(v string) *KxDataviewListEntry
SetStatus sets the Status field's value.
func (s *KxDataviewListEntry) SetStatusReason(v string) *KxDataviewListEntry
SetStatusReason sets the StatusReason field's value.
func (s KxDataviewListEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxDataviewSegmentConfiguration struct { // The database path of the data that you want to place on each selected volume // for the segment. Each segment must have a unique database path for each volume. // // DbPaths is a required field DbPaths []*string `locationName:"dbPaths" min:"1" type:"list" required:"true"` // Enables on-demand caching on the selected database path when a particular // file or a column of the database is accessed. When on demand caching is True, // dataviews perform minimal loading of files on the filesystem as needed. When // it is set to False, everything is cached. The default value is False. OnDemand *bool `locationName:"onDemand" type:"boolean"` // The name of the volume where you want to add data. // // VolumeName is a required field VolumeName *string `locationName:"volumeName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
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.
func (s KxDataviewSegmentConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDataviewSegmentConfiguration) SetDbPaths(v []*string) *KxDataviewSegmentConfiguration
SetDbPaths sets the DbPaths field's value.
func (s *KxDataviewSegmentConfiguration) SetOnDemand(v bool) *KxDataviewSegmentConfiguration
SetOnDemand sets the OnDemand field's value.
func (s *KxDataviewSegmentConfiguration) SetVolumeName(v string) *KxDataviewSegmentConfiguration
SetVolumeName sets the VolumeName field's value.
func (s KxDataviewSegmentConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDataviewSegmentConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxDeploymentConfiguration struct { // The type of deployment that you want on a cluster. // // * ROLLING – This options updates the cluster by stopping the exiting // q process and starting a new q process with updated configuration. // // * NO_RESTART – This option updates the cluster without stopping the // running q process. It is only available for HDB type cluster. This option // is quicker as it reduces the turn around time to update configuration // on a cluster. With this deployment mode, you cannot update the initializationScript // and commandLineArguments parameters. // // DeploymentStrategy is a required field DeploymentStrategy *string `locationName:"deploymentStrategy" type:"string" required:"true" enum:"KxDeploymentStrategy"` // contains filtered or unexported fields }
The configuration that allows you to choose how you want to update the databases on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.
func (s KxDeploymentConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDeploymentConfiguration) SetDeploymentStrategy(v string) *KxDeploymentConfiguration
SetDeploymentStrategy sets the DeploymentStrategy field's value.
func (s KxDeploymentConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxDeploymentConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxEnvironment struct { // The identifier of the availability zones where subnets for the environment // are created. AvailabilityZoneIds []*string `locationName:"availabilityZoneIds" type:"list"` // The unique identifier of the AWS account in which you create the kdb environment. AwsAccountId *string `locationName:"awsAccountId" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the certificate authority: CertificateAuthorityArn *string `locationName:"certificateAuthorityArn" min:"1" type:"string"` // The timestamp at which the kdb environment was created in FinSpace. The value // is determined as epoch time in milliseconds. For example, the value for Monday, // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"` // A list of DNS server name and server IP. This is used to set up Route-53 // outbound resolvers. CustomDNSConfiguration []*CustomDNSServer `locationName:"customDNSConfiguration" type:"list"` // A unique identifier for the AWS environment infrastructure account. DedicatedServiceAccountId *string `locationName:"dedicatedServiceAccountId" min:"1" type:"string"` // A description of the kdb environment. Description *string `locationName:"description" min:"1" type:"string"` // The status of DNS configuration. DnsStatus *string `locationName:"dnsStatus" type:"string" enum:"DnsStatus"` // The Amazon Resource Name (ARN) of your kdb environment. EnvironmentArn *string `locationName:"environmentArn" min:"20" type:"string"` // A unique identifier for the kdb environment. EnvironmentId *string `locationName:"environmentId" min:"1" type:"string"` // Specifies the error message that appears if a flow fails. ErrorMessage *string `locationName:"errorMessage" type:"string"` // The unique identifier of the KMS key. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` // The name of the kdb environment. Name *string `locationName:"name" min:"3" type:"string"` // The status of the environment creation. // // * CREATE_REQUESTED – Environment creation has been requested. // // * CREATING – Environment is in the process of being created. // // * FAILED_CREATION – Environment creation has failed. // // * CREATED – Environment is successfully created and is currently active. // // * DELETE REQUESTED – Environment deletion has been requested. // // * DELETING – Environment is in the process of being deleted. // // * RETRY_DELETION – Initial environment deletion failed, system is reattempting // delete. // // * DELETED – Environment has been deleted. // // * FAILED_DELETION – Environment deletion has failed. Status *string `locationName:"status" type:"string" enum:"EnvironmentStatus"` // The status of the network configuration. TgwStatus *string `locationName:"tgwStatus" type:"string" enum:"TgwStatus"` // Specifies the transit gateway and network configuration to connect the kdb // environment to an internal network. TransitGatewayConfiguration *TransitGatewayConfiguration `locationName:"transitGatewayConfiguration" type:"structure"` // The timestamp at which the kdb environment was modified in FinSpace. The // value is determined as epoch time in milliseconds. For example, the value // for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. UpdateTimestamp *time.Time `locationName:"updateTimestamp" type:"timestamp"` // contains filtered or unexported fields }
The details of a kdb environment.
func (s KxEnvironment) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxEnvironment) SetAvailabilityZoneIds(v []*string) *KxEnvironment
SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.
func (s *KxEnvironment) SetAwsAccountId(v string) *KxEnvironment
SetAwsAccountId sets the AwsAccountId field's value.
func (s *KxEnvironment) SetCertificateAuthorityArn(v string) *KxEnvironment
SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.
func (s *KxEnvironment) SetCreationTimestamp(v time.Time) *KxEnvironment
SetCreationTimestamp sets the CreationTimestamp field's value.
func (s *KxEnvironment) SetCustomDNSConfiguration(v []*CustomDNSServer) *KxEnvironment
SetCustomDNSConfiguration sets the CustomDNSConfiguration field's value.
func (s *KxEnvironment) SetDedicatedServiceAccountId(v string) *KxEnvironment
SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.
func (s *KxEnvironment) SetDescription(v string) *KxEnvironment
SetDescription sets the Description field's value.
func (s *KxEnvironment) SetDnsStatus(v string) *KxEnvironment
SetDnsStatus sets the DnsStatus field's value.
func (s *KxEnvironment) SetEnvironmentArn(v string) *KxEnvironment
SetEnvironmentArn sets the EnvironmentArn field's value.
func (s *KxEnvironment) SetEnvironmentId(v string) *KxEnvironment
SetEnvironmentId sets the EnvironmentId field's value.
func (s *KxEnvironment) SetErrorMessage(v string) *KxEnvironment
SetErrorMessage sets the ErrorMessage field's value.
func (s *KxEnvironment) SetKmsKeyId(v string) *KxEnvironment
SetKmsKeyId sets the KmsKeyId field's value.
func (s *KxEnvironment) SetName(v string) *KxEnvironment
SetName sets the Name field's value.
func (s *KxEnvironment) SetStatus(v string) *KxEnvironment
SetStatus sets the Status field's value.
func (s *KxEnvironment) SetTgwStatus(v string) *KxEnvironment
SetTgwStatus sets the TgwStatus field's value.
func (s *KxEnvironment) SetTransitGatewayConfiguration(v *TransitGatewayConfiguration) *KxEnvironment
SetTransitGatewayConfiguration sets the TransitGatewayConfiguration field's value.
func (s *KxEnvironment) SetUpdateTimestamp(v time.Time) *KxEnvironment
SetUpdateTimestamp sets the UpdateTimestamp field's value.
func (s KxEnvironment) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxNAS1Configuration struct { // The size of the network attached storage. For storage type SSD_1000 and SSD_250 // you can select the minimum size as 1200 GB or increments of 2400 GB. For // storage type HDD_12 you can select the minimum size as 6000 GB or increments // of 6000 GB. Size *int64 `locationName:"size" min:"1200" type:"integer"` // The type of the network attached storage. Type *string `locationName:"type" type:"string" enum:"KxNAS1Type"` // contains filtered or unexported fields }
The structure containing the size and type of the network attached storage (NAS_1) file system volume.
func (s KxNAS1Configuration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxNAS1Configuration) SetSize(v int64) *KxNAS1Configuration
SetSize sets the Size field's value.
func (s *KxNAS1Configuration) SetType(v string) *KxNAS1Configuration
SetType sets the Type field's value.
func (s KxNAS1Configuration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxNAS1Configuration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxNode struct { // The identifier of the availability zones where subnets for the environment // are created. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"string"` // The time when a particular node is started. 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. LaunchTime *time.Time `locationName:"launchTime" type:"timestamp"` // A unique identifier for the node. NodeId *string `locationName:"nodeId" min:"1" type:"string"` // Specifies the status of the cluster nodes. // // * RUNNING – The node is actively serving. // // * PROVISIONING – The node is being prepared. Status *string `locationName:"status" type:"string" enum:"KxNodeStatus"` // contains filtered or unexported fields }
A structure that stores metadata for a kdb node.
func (s KxNode) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxNode) SetAvailabilityZoneId(v string) *KxNode
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *KxNode) SetLaunchTime(v time.Time) *KxNode
SetLaunchTime sets the LaunchTime field's value.
func (s *KxNode) SetNodeId(v string) *KxNode
SetNodeId sets the NodeId field's value.
func (s *KxNode) SetStatus(v string) *KxNode
SetStatus sets the Status field's value.
func (s KxNode) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxSavedownStorageConfiguration struct { // The size of temporary storage in gibibytes. Size *int64 `locationName:"size" min:"10" type:"integer"` // The type of writeable storage space for temporarily storing your savedown // data. The valid values are: // // * SDS01 – This type represents 3000 IOPS and io2 ebs volume type. Type *string `locationName:"type" type:"string" enum:"KxSavedownStorageType"` // The name of the kdb volume that you want to use as writeable save-down storage // for clusters. VolumeName *string `locationName:"volumeName" min:"3" type:"string"` // contains filtered or unexported fields }
The size and type of temporary storage that is used to hold data during the savedown process. All the data written to this storage space is lost when the cluster node is restarted.
func (s KxSavedownStorageConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxSavedownStorageConfiguration) SetSize(v int64) *KxSavedownStorageConfiguration
SetSize sets the Size field's value.
func (s *KxSavedownStorageConfiguration) SetType(v string) *KxSavedownStorageConfiguration
SetType sets the Type field's value.
func (s *KxSavedownStorageConfiguration) SetVolumeName(v string) *KxSavedownStorageConfiguration
SetVolumeName sets the VolumeName field's value.
func (s KxSavedownStorageConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxSavedownStorageConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxScalingGroup struct { // The identifier of the availability zones. AvailabilityZoneId *string `locationName:"availabilityZoneId" min:"8" type:"string"` // The list of clusters currently active in a given scaling group. Clusters []*string `locationName:"clusters" type:"list"` // 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 `locationName:"createdTimestamp" type:"timestamp"` // 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. HostType *string `locationName:"hostType" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // A unique identifier for the kdb scaling group. ScalingGroupName *string `locationName:"scalingGroupName" min:"3" type:"string"` // The status of scaling groups. Status *string `locationName:"status" type:"string" enum:"KxScalingGroupStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // contains filtered or unexported fields }
A structure for storing metadata of scaling group.
func (s KxScalingGroup) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxScalingGroup) SetAvailabilityZoneId(v string) *KxScalingGroup
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (s *KxScalingGroup) SetClusters(v []*string) *KxScalingGroup
SetClusters sets the Clusters field's value.
func (s *KxScalingGroup) SetCreatedTimestamp(v time.Time) *KxScalingGroup
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *KxScalingGroup) SetHostType(v string) *KxScalingGroup
SetHostType sets the HostType field's value.
func (s *KxScalingGroup) SetLastModifiedTimestamp(v time.Time) *KxScalingGroup
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *KxScalingGroup) SetScalingGroupName(v string) *KxScalingGroup
SetScalingGroupName sets the ScalingGroupName field's value.
func (s *KxScalingGroup) SetStatus(v string) *KxScalingGroup
SetStatus sets the Status field's value.
func (s *KxScalingGroup) SetStatusReason(v string) *KxScalingGroup
SetStatusReason sets the StatusReason field's value.
func (s KxScalingGroup) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxScalingGroupConfiguration struct { // The number of vCPUs that you want to reserve for each node of this kdb cluster // on the scaling group host. Cpu *float64 `locationName:"cpu" min:"0.1" type:"double"` // An optional hard limit on the amount of memory a kdb cluster can use. MemoryLimit *int64 `locationName:"memoryLimit" min:"6" type:"integer"` // A reservation of the minimum amount of memory that should be available on // the scaling group for a kdb cluster to be successfully placed in a scaling // group. // // MemoryReservation is a required field MemoryReservation *int64 `locationName:"memoryReservation" min:"6" type:"integer" required:"true"` // The number of kdb cluster nodes. // // NodeCount is a required field NodeCount *int64 `locationName:"nodeCount" min:"1" type:"integer" required:"true"` // A unique identifier for the kdb scaling group. // // ScalingGroupName is a required field ScalingGroupName *string `locationName:"scalingGroupName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
The structure that stores the capacity configuration details of a scaling group.
func (s KxScalingGroupConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxScalingGroupConfiguration) SetCpu(v float64) *KxScalingGroupConfiguration
SetCpu sets the Cpu field's value.
func (s *KxScalingGroupConfiguration) SetMemoryLimit(v int64) *KxScalingGroupConfiguration
SetMemoryLimit sets the MemoryLimit field's value.
func (s *KxScalingGroupConfiguration) SetMemoryReservation(v int64) *KxScalingGroupConfiguration
SetMemoryReservation sets the MemoryReservation field's value.
func (s *KxScalingGroupConfiguration) SetNodeCount(v int64) *KxScalingGroupConfiguration
SetNodeCount sets the NodeCount field's value.
func (s *KxScalingGroupConfiguration) SetScalingGroupName(v string) *KxScalingGroupConfiguration
SetScalingGroupName sets the ScalingGroupName field's value.
func (s KxScalingGroupConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxScalingGroupConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KxUser struct { // The timestamp at which the kdb user was created. CreateTimestamp *time.Time `locationName:"createTimestamp" type:"timestamp"` // The IAM role ARN that is associated with the user. IamRole *string `locationName:"iamRole" min:"20" type:"string"` // The timestamp at which the kdb user was updated. UpdateTimestamp *time.Time `locationName:"updateTimestamp" type:"timestamp"` // 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 `locationName:"userArn" min:"20" type:"string"` // A unique identifier for the user. UserName *string `locationName:"userName" min:"1" type:"string"` // contains filtered or unexported fields }
A structure that stores metadata for a kdb user.
func (s KxUser) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxUser) SetCreateTimestamp(v time.Time) *KxUser
SetCreateTimestamp sets the CreateTimestamp field's value.
func (s *KxUser) SetIamRole(v string) *KxUser
SetIamRole sets the IamRole field's value.
func (s *KxUser) SetUpdateTimestamp(v time.Time) *KxUser
SetUpdateTimestamp sets the UpdateTimestamp field's value.
func (s *KxUser) SetUserArn(v string) *KxUser
SetUserArn sets the UserArn field's value.
func (s *KxUser) SetUserName(v string) *KxUser
SetUserName sets the UserName field's value.
func (s KxUser) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KxVolume struct { // The identifier of the availability zones. AvailabilityZoneIds []*string `locationName:"availabilityZoneIds" type:"list"` // 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 *string `locationName:"azMode" type:"string" enum:"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 `locationName:"createdTimestamp" type:"timestamp"` // A description of the volume. Description *string `locationName:"description" min:"1" type:"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 `locationName:"lastModifiedTimestamp" type:"timestamp"` // The status of 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 *string `locationName:"status" type:"string" enum:"KxVolumeStatus"` // The error message when a failed state occurs. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` // A unique identifier for the volume. VolumeName *string `locationName:"volumeName" min:"3" type:"string"` // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType *string `locationName:"volumeType" type:"string" enum:"KxVolumeType"` // contains filtered or unexported fields }
The structure that contains the metadata of the volume.
func (s KxVolume) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KxVolume) SetAvailabilityZoneIds(v []*string) *KxVolume
SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.
func (s *KxVolume) SetAzMode(v string) *KxVolume
SetAzMode sets the AzMode field's value.
func (s *KxVolume) SetCreatedTimestamp(v time.Time) *KxVolume
SetCreatedTimestamp sets the CreatedTimestamp field's value.
func (s *KxVolume) SetDescription(v string) *KxVolume
SetDescription sets the Description field's value.
func (s *KxVolume) SetLastModifiedTimestamp(v time.Time) *KxVolume
SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.
func (s *KxVolume) SetStatus(v string) *KxVolume
SetStatus sets the Status field's value.
func (s *KxVolume) SetStatusReason(v string) *KxVolume
SetStatusReason sets the StatusReason field's value.
func (s *KxVolume) SetVolumeName(v string) *KxVolume
SetVolumeName sets the VolumeName field's value.
func (s *KxVolume) SetVolumeType(v string) *KxVolume
SetVolumeType sets the VolumeType field's value.
func (s KxVolume) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
A service limit or quota is exceeded.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
func (s LimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s LimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListEnvironmentsInput struct { // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // 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 nextTokennextToken value from the response object of the previous page // call. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListEnvironmentsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListEnvironmentsInput) SetMaxResults(v int64) *ListEnvironmentsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListEnvironmentsInput) SetNextToken(v string) *ListEnvironmentsInput
SetNextToken sets the NextToken field's value.
func (s ListEnvironmentsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListEnvironmentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListEnvironmentsOutput struct { // A list of all of your FinSpace environments. Environments []*Environment `locationName:"environments" type:"list"` // A token that you can use in a subsequent call to retrieve the next set of // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListEnvironmentsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListEnvironmentsOutput) SetEnvironments(v []*Environment) *ListEnvironmentsOutput
SetEnvironments sets the Environments field's value.
func (s *ListEnvironmentsOutput) SetNextToken(v string) *ListEnvironmentsOutput
SetNextToken sets the NextToken field's value.
func (s ListEnvironmentsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxChangesetsInput struct { // The name of the kdb database. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxChangesetsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxChangesetsInput) SetDatabaseName(v string) *ListKxChangesetsInput
SetDatabaseName sets the DatabaseName field's value.
func (s *ListKxChangesetsInput) SetEnvironmentId(v string) *ListKxChangesetsInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxChangesetsInput) SetMaxResults(v int64) *ListKxChangesetsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxChangesetsInput) SetNextToken(v string) *ListKxChangesetsInput
SetNextToken sets the NextToken field's value.
func (s ListKxChangesetsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxChangesetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxChangesetsOutput struct { // A list of changesets for a database. KxChangesets []*KxChangesetListEntry `locationName:"kxChangesets" type:"list"` // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxChangesetsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxChangesetsOutput) SetKxChangesets(v []*KxChangesetListEntry) *ListKxChangesetsOutput
SetKxChangesets sets the KxChangesets field's value.
func (s *ListKxChangesetsOutput) SetNextToken(v string) *ListKxChangesetsOutput
SetNextToken sets the NextToken field's value.
func (s ListKxChangesetsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxClusterNodesInput struct { // A unique name for the cluster. // // ClusterName is a required field ClusterName *string `location:"uri" locationName:"clusterName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxClusterNodesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxClusterNodesInput) SetClusterName(v string) *ListKxClusterNodesInput
SetClusterName sets the ClusterName field's value.
func (s *ListKxClusterNodesInput) SetEnvironmentId(v string) *ListKxClusterNodesInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxClusterNodesInput) SetMaxResults(v int64) *ListKxClusterNodesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxClusterNodesInput) SetNextToken(v string) *ListKxClusterNodesInput
SetNextToken sets the NextToken field's value.
func (s ListKxClusterNodesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxClusterNodesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxClusterNodesOutput struct { // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A list of nodes associated with the cluster. Nodes []*KxNode `locationName:"nodes" type:"list"` // contains filtered or unexported fields }
func (s ListKxClusterNodesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxClusterNodesOutput) SetNextToken(v string) *ListKxClusterNodesOutput
SetNextToken sets the NextToken field's value.
func (s *ListKxClusterNodesOutput) SetNodes(v []*KxNode) *ListKxClusterNodesOutput
SetNodes sets the Nodes field's value.
func (s ListKxClusterNodesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxClustersInput struct { // 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 *string `location:"querystring" locationName:"clusterType" type:"string" enum:"KxClusterType"` // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxClustersInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxClustersInput) SetClusterType(v string) *ListKxClustersInput
SetClusterType sets the ClusterType field's value.
func (s *ListKxClustersInput) SetEnvironmentId(v string) *ListKxClustersInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxClustersInput) SetMaxResults(v int64) *ListKxClustersInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxClustersInput) SetNextToken(v string) *ListKxClustersInput
SetNextToken sets the NextToken field's value.
func (s ListKxClustersInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxClustersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxClustersOutput struct { // Lists the cluster details. KxClusterSummaries []*KxCluster `locationName:"kxClusterSummaries" type:"list"` // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxClustersOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxClustersOutput) SetKxClusterSummaries(v []*KxCluster) *ListKxClustersOutput
SetKxClusterSummaries sets the KxClusterSummaries field's value.
func (s *ListKxClustersOutput) SetNextToken(v string) *ListKxClustersOutput
SetNextToken sets the NextToken field's value.
func (s ListKxClustersOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxDatabasesInput struct { // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxDatabasesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxDatabasesInput) SetEnvironmentId(v string) *ListKxDatabasesInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxDatabasesInput) SetMaxResults(v int64) *ListKxDatabasesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxDatabasesInput) SetNextToken(v string) *ListKxDatabasesInput
SetNextToken sets the NextToken field's value.
func (s ListKxDatabasesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxDatabasesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxDatabasesOutput struct { // A list of databases in the kdb environment. KxDatabases []*KxDatabaseListEntry `locationName:"kxDatabases" type:"list"` // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxDatabasesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxDatabasesOutput) SetKxDatabases(v []*KxDatabaseListEntry) *ListKxDatabasesOutput
SetKxDatabases sets the KxDatabases field's value.
func (s *ListKxDatabasesOutput) SetNextToken(v string) *ListKxDatabasesOutput
SetNextToken sets the NextToken field's value.
func (s ListKxDatabasesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxDataviewsInput struct { // The name of the database where the dataviews were created. // // DatabaseName is a required field DatabaseName *string `location:"uri" locationName:"databaseName" min:"3" type:"string" required:"true"` // A unique identifier for the kdb environment, for which you want to retrieve // a list of dataviews. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxDataviewsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxDataviewsInput) SetDatabaseName(v string) *ListKxDataviewsInput
SetDatabaseName sets the DatabaseName field's value.
func (s *ListKxDataviewsInput) SetEnvironmentId(v string) *ListKxDataviewsInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxDataviewsInput) SetMaxResults(v int64) *ListKxDataviewsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxDataviewsInput) SetNextToken(v string) *ListKxDataviewsInput
SetNextToken sets the NextToken field's value.
func (s ListKxDataviewsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxDataviewsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxDataviewsOutput struct { // The list of kdb dataviews that are currently active for the given database. KxDataviews []*KxDataviewListEntry `locationName:"kxDataviews" type:"list"` // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxDataviewsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxDataviewsOutput) SetKxDataviews(v []*KxDataviewListEntry) *ListKxDataviewsOutput
SetKxDataviews sets the KxDataviews field's value.
func (s *ListKxDataviewsOutput) SetNextToken(v string) *ListKxDataviewsOutput
SetNextToken sets the NextToken field's value.
func (s ListKxDataviewsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxEnvironmentsInput struct { // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxEnvironmentsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxEnvironmentsInput) SetMaxResults(v int64) *ListKxEnvironmentsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxEnvironmentsInput) SetNextToken(v string) *ListKxEnvironmentsInput
SetNextToken sets the NextToken field's value.
func (s ListKxEnvironmentsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxEnvironmentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxEnvironmentsOutput struct { // A list of environments in an account. Environments []*KxEnvironment `locationName:"environments" type:"list"` // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxEnvironmentsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxEnvironmentsOutput) SetEnvironments(v []*KxEnvironment) *ListKxEnvironmentsOutput
SetEnvironments sets the Environments field's value.
func (s *ListKxEnvironmentsOutput) SetNextToken(v string) *ListKxEnvironmentsOutput
SetNextToken sets the NextToken field's value.
func (s ListKxEnvironmentsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxScalingGroupsInput struct { // A unique identifier for the kdb environment, for which you want to retrieve // a list of scaling groups. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxScalingGroupsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxScalingGroupsInput) SetEnvironmentId(v string) *ListKxScalingGroupsInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxScalingGroupsInput) SetMaxResults(v int64) *ListKxScalingGroupsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxScalingGroupsInput) SetNextToken(v string) *ListKxScalingGroupsInput
SetNextToken sets the NextToken field's value.
func (s ListKxScalingGroupsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxScalingGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxScalingGroupsOutput struct { // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A list of scaling groups available in a kdb environment. ScalingGroups []*KxScalingGroup `locationName:"scalingGroups" type:"list"` // contains filtered or unexported fields }
func (s ListKxScalingGroupsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxScalingGroupsOutput) SetNextToken(v string) *ListKxScalingGroupsOutput
SetNextToken sets the NextToken field's value.
func (s *ListKxScalingGroupsOutput) SetScalingGroups(v []*KxScalingGroup) *ListKxScalingGroupsOutput
SetScalingGroups sets the ScalingGroups field's value.
func (s ListKxScalingGroupsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxUsersInput struct { // A unique identifier for the kdb environment. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxUsersInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxUsersInput) SetEnvironmentId(v string) *ListKxUsersInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxUsersInput) SetMaxResults(v int64) *ListKxUsersInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxUsersInput) SetNextToken(v string) *ListKxUsersInput
SetNextToken sets the NextToken field's value.
func (s ListKxUsersInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxUsersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxUsersOutput struct { // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A list of users in a kdb environment. Users []*KxUser `locationName:"users" type:"list"` // contains filtered or unexported fields }
func (s ListKxUsersOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxUsersOutput) SetNextToken(v string) *ListKxUsersOutput
SetNextToken sets the NextToken field's value.
func (s *ListKxUsersOutput) SetUsers(v []*KxUser) *ListKxUsersOutput
SetUsers sets the Users field's value.
func (s ListKxUsersOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListKxVolumesInput struct { // A unique identifier for the kdb environment, whose clusters can attach to // the volume. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"` // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // A token that indicates where a results page should begin. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType *string `location:"querystring" locationName:"volumeType" type:"string" enum:"KxVolumeType"` // contains filtered or unexported fields }
func (s ListKxVolumesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxVolumesInput) SetEnvironmentId(v string) *ListKxVolumesInput
SetEnvironmentId sets the EnvironmentId field's value.
func (s *ListKxVolumesInput) SetMaxResults(v int64) *ListKxVolumesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListKxVolumesInput) SetNextToken(v string) *ListKxVolumesInput
SetNextToken sets the NextToken field's value.
func (s *ListKxVolumesInput) SetVolumeType(v string) *ListKxVolumesInput
SetVolumeType sets the VolumeType field's value.
func (s ListKxVolumesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxVolumesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKxVolumesOutput struct { // A summary of volumes. KxVolumeSummaries []*KxVolume `locationName:"kxVolumeSummaries" type:"list"` // A token that indicates where a results page should begin. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListKxVolumesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListKxVolumesOutput) SetKxVolumeSummaries(v []*KxVolume) *ListKxVolumesOutput
SetKxVolumeSummaries sets the KxVolumeSummaries field's value.
func (s *ListKxVolumesOutput) SetNextToken(v string) *ListKxVolumesOutput
SetNextToken sets the NextToken field's value.
func (s ListKxVolumesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsForResourceInput struct { // The Amazon Resource Name of the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s ListTagsForResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput struct { // A list of all tags for a resource. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (s ListTagsForResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type NetworkACLEntry struct { // The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. // We modify the specified CIDR block to its canonical form. For example, if // you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. // // CidrBlock is a required field CidrBlock *string `locationName:"cidrBlock" min:"1" type:"string" required:"true"` // Defines the ICMP protocol that consists of the ICMP type and code. IcmpTypeCode *IcmpTypeCode `locationName:"icmpTypeCode" type:"structure"` // The range of ports the rule applies to. PortRange *PortRange `locationName:"portRange" type:"structure"` // The protocol number. A value of -1 means all the protocols. // // Protocol is a required field Protocol *string `locationName:"protocol" min:"1" type:"string" required:"true"` // Indicates whether to allow or deny the traffic that matches the rule. // // RuleAction is a required field RuleAction *string `locationName:"ruleAction" type:"string" required:"true" enum:"RuleAction"` // The rule number for the entry. For example 100. All the network ACL entries // are processed in ascending order by rule number. // // RuleNumber is a required field RuleNumber *int64 `locationName:"ruleNumber" min:"1" type:"integer" required:"true"` // contains filtered or unexported fields }
The network access control list (ACL) is an optional layer of security for your VPC that acts as a firewall for controlling traffic in and out of one or more subnets. The entry is a set of numbered ingress and egress rules that determine whether a packet should be allowed in or out of a subnet associated with the ACL. We process the entries in the ACL according to the rule numbers, in ascending order.
func (s NetworkACLEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *NetworkACLEntry) SetCidrBlock(v string) *NetworkACLEntry
SetCidrBlock sets the CidrBlock field's value.
func (s *NetworkACLEntry) SetIcmpTypeCode(v *IcmpTypeCode) *NetworkACLEntry
SetIcmpTypeCode sets the IcmpTypeCode field's value.
func (s *NetworkACLEntry) SetPortRange(v *PortRange) *NetworkACLEntry
SetPortRange sets the PortRange field's value.
func (s *NetworkACLEntry) SetProtocol(v string) *NetworkACLEntry
SetProtocol sets the Protocol field's value.
func (s *NetworkACLEntry) SetRuleAction(v string) *NetworkACLEntry
SetRuleAction sets the RuleAction field's value.
func (s *NetworkACLEntry) SetRuleNumber(v int64) *NetworkACLEntry
SetRuleNumber sets the RuleNumber field's value.
func (s NetworkACLEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *NetworkACLEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PortRange struct { // The first port in the range. // // From is a required field From *int64 `locationName:"from" type:"integer" required:"true"` // The last port in the range. // // To is a required field To *int64 `locationName:"to" type:"integer" required:"true"` // contains filtered or unexported fields }
The range of ports the rule applies to.
func (s PortRange) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PortRange) SetFrom(v int64) *PortRange
SetFrom sets the From field's value.
func (s *PortRange) SetTo(v int64) *PortRange
SetTo sets the To field's value.
func (s PortRange) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PortRange) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResourceAlreadyExistsException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The specified resource group already exists.
func (s *ResourceAlreadyExistsException) Code() string
Code returns the exception type name.
func (s *ResourceAlreadyExistsException) Error() string
func (s ResourceAlreadyExistsException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceAlreadyExistsException) Message() string
Message returns the exception's message.
func (s *ResourceAlreadyExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceAlreadyExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceAlreadyExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceAlreadyExistsException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
One or more resources can't be found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceQuotaExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (s *ServiceQuotaExceededException) Error() string
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SuperuserParameters struct { // The email address of the superuser. // // EmailAddress is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SuperuserParameters's // String and GoString methods. // // EmailAddress is a required field EmailAddress *string `locationName:"emailAddress" min:"1" type:"string" required:"true" sensitive:"true"` // The first name of the superuser. // // FirstName is a required field FirstName *string `locationName:"firstName" min:"1" type:"string" required:"true"` // The last name of the superuser. // // LastName is a required field LastName *string `locationName:"lastName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Configuration information for the superuser.
func (s SuperuserParameters) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SuperuserParameters) SetEmailAddress(v string) *SuperuserParameters
SetEmailAddress sets the EmailAddress field's value.
func (s *SuperuserParameters) SetFirstName(v string) *SuperuserParameters
SetFirstName sets the FirstName field's value.
func (s *SuperuserParameters) SetLastName(v string) *SuperuserParameters
SetLastName sets the LastName field's value.
func (s SuperuserParameters) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SuperuserParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceInput struct { // The Amazon Resource Name (ARN) for the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // One or more tags to be assigned to the resource. // // Tags is a required field Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"` // contains filtered or unexported fields }
func (s TagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
func (s TagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (s TagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s TagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The request was denied due to request throttling.
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".