finspace

package
v1.45.2 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2023 License: Apache-2.0 Imports: 11 Imported by: 11

Documentation

Overview

Package finspace provides the client and types for making API requests to FinSpace User Environment Management service.

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

See https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12 for more information on this service.

See finspace package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/finspace/

Using the Client

To contact FinSpace User Environment Management service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the FinSpace User Environment Management service client Finspace for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/finspace/#New

Index

Constants

View Source 
const (
	// ChangeTypePut is a ChangeType enum value
	ChangeTypePut = "PUT"

	// ChangeTypeDelete is a ChangeType enum value
	ChangeTypeDelete = "DELETE"
)
View Source 
const (
	// ChangesetStatusPending is a ChangesetStatus enum value
	ChangesetStatusPending = "PENDING"

	// ChangesetStatusProcessing is a ChangesetStatus enum value
	ChangesetStatusProcessing = "PROCESSING"

	// ChangesetStatusFailed is a ChangesetStatus enum value
	ChangesetStatusFailed = "FAILED"

	// ChangesetStatusCompleted is a ChangesetStatus enum value
	ChangesetStatusCompleted = "COMPLETED"
)
View Source 
const (
	// DnsStatusNone is a DnsStatus enum value
	DnsStatusNone = "NONE"

	// DnsStatusUpdateRequested is a DnsStatus enum value
	DnsStatusUpdateRequested = "UPDATE_REQUESTED"

	// DnsStatusUpdating is a DnsStatus enum value
	DnsStatusUpdating = "UPDATING"

	// DnsStatusFailedUpdate is a DnsStatus enum value
	DnsStatusFailedUpdate = "FAILED_UPDATE"

	// DnsStatusSuccessfullyUpdated is a DnsStatus enum value
	DnsStatusSuccessfullyUpdated = "SUCCESSFULLY_UPDATED"
)
View Source 
const (
	// EnvironmentStatusCreateRequested is a EnvironmentStatus enum value
	EnvironmentStatusCreateRequested = "CREATE_REQUESTED"

	// EnvironmentStatusCreating is a EnvironmentStatus enum value
	EnvironmentStatusCreating = "CREATING"

	// EnvironmentStatusCreated is a EnvironmentStatus enum value
	EnvironmentStatusCreated = "CREATED"

	// EnvironmentStatusDeleteRequested is a EnvironmentStatus enum value
	EnvironmentStatusDeleteRequested = "DELETE_REQUESTED"

	// EnvironmentStatusDeleting is a EnvironmentStatus enum value
	EnvironmentStatusDeleting = "DELETING"

	// EnvironmentStatusDeleted is a EnvironmentStatus enum value
	EnvironmentStatusDeleted = "DELETED"

	// EnvironmentStatusFailedCreation is a EnvironmentStatus enum value
	EnvironmentStatusFailedCreation = "FAILED_CREATION"

	// EnvironmentStatusRetryDeletion is a EnvironmentStatus enum value
	EnvironmentStatusRetryDeletion = "RETRY_DELETION"

	// EnvironmentStatusFailedDeletion is a EnvironmentStatus enum value
	EnvironmentStatusFailedDeletion = "FAILED_DELETION"

	// EnvironmentStatusUpdateNetworkRequested is a EnvironmentStatus enum value
	EnvironmentStatusUpdateNetworkRequested = "UPDATE_NETWORK_REQUESTED"

	// EnvironmentStatusUpdatingNetwork is a EnvironmentStatus enum value
	EnvironmentStatusUpdatingNetwork = "UPDATING_NETWORK"

	// EnvironmentStatusFailedUpdatingNetwork is a EnvironmentStatus enum value
	EnvironmentStatusFailedUpdatingNetwork = "FAILED_UPDATING_NETWORK"

	// EnvironmentStatusSuspended is a EnvironmentStatus enum value
	EnvironmentStatusSuspended = "SUSPENDED"
)
View Source 
const (
	// ErrorDetailsTheinputstothisrequestareinvalid is a ErrorDetails enum value
	ErrorDetailsTheinputstothisrequestareinvalid = "The inputs to this request are invalid."

	// ErrorDetailsServicelimitshavebeenexceeded is a ErrorDetails enum value
	ErrorDetailsServicelimitshavebeenexceeded = "Service limits have been exceeded."

	// ErrorDetailsMissingrequiredpermissiontoperformthisrequest is a ErrorDetails enum value
	ErrorDetailsMissingrequiredpermissiontoperformthisrequest = "Missing required permission to perform this request."

	// ErrorDetailsOneormoreinputstothisrequestwerenotfound is a ErrorDetails enum value
	ErrorDetailsOneormoreinputstothisrequestwerenotfound = "One or more inputs to this request were not found."

	// ErrorDetailsThesystemtemporarilylackssufficientresourcestoprocesstherequest is a ErrorDetails enum value
	ErrorDetailsThesystemtemporarilylackssufficientresourcestoprocesstherequest = "The system temporarily lacks sufficient resources to process the request."

	// ErrorDetailsAninternalerrorhasoccurred is a ErrorDetails enum value
	ErrorDetailsAninternalerrorhasoccurred = "An internal error has occurred."

	// ErrorDetailsCancelled is a ErrorDetails enum value
	ErrorDetailsCancelled = "Cancelled"

	// ErrorDetailsAuserrecoverableerrorhasoccurred is a ErrorDetails enum value
	ErrorDetailsAuserrecoverableerrorhasoccurred = "A user recoverable error has occurred"
)
View Source 
const (
	// FederationModeFederated is a FederationMode enum value
	FederationModeFederated = "FEDERATED"

	// FederationModeLocal is a FederationMode enum value
	FederationModeLocal = "LOCAL"
)
View Source 
const (
	// KxAzModeSingle is a KxAzMode enum value
	KxAzModeSingle = "SINGLE"

	// KxAzModeMulti is a KxAzMode enum value
	KxAzModeMulti = "MULTI"
)
View Source 
const (
	// KxClusterStatusPending is a KxClusterStatus enum value
	KxClusterStatusPending = "PENDING"

	// KxClusterStatusCreating is a KxClusterStatus enum value
	KxClusterStatusCreating = "CREATING"

	// KxClusterStatusCreateFailed is a KxClusterStatus enum value
	KxClusterStatusCreateFailed = "CREATE_FAILED"

	// KxClusterStatusRunning is a KxClusterStatus enum value
	KxClusterStatusRunning = "RUNNING"

	// KxClusterStatusUpdating is a KxClusterStatus enum value
	KxClusterStatusUpdating = "UPDATING"

	// KxClusterStatusDeleting is a KxClusterStatus enum value
	KxClusterStatusDeleting = "DELETING"

	// KxClusterStatusDeleted is a KxClusterStatus enum value
	KxClusterStatusDeleted = "DELETED"

	// KxClusterStatusDeleteFailed is a KxClusterStatus enum value
	KxClusterStatusDeleteFailed = "DELETE_FAILED"
)
View Source 
const (
	// KxClusterTypeHdb is a KxClusterType enum value
	KxClusterTypeHdb = "HDB"

	// KxClusterTypeRdb is a KxClusterType enum value
	KxClusterTypeRdb = "RDB"

	// KxClusterTypeGateway is a KxClusterType enum value
	KxClusterTypeGateway = "GATEWAY"
)
View Source 
const (
	// KxDeploymentStrategyNoRestart is a KxDeploymentStrategy enum value
	KxDeploymentStrategyNoRestart = "NO_RESTART"

	// KxDeploymentStrategyRolling is a KxDeploymentStrategy enum value
	KxDeploymentStrategyRolling = "ROLLING"
)
View Source 
const (
	// RuleActionAllow is a RuleAction enum value
	RuleActionAllow = "allow"

	// RuleActionDeny is a RuleAction enum value
	RuleActionDeny = "deny"
)
View Source 
const (
	// TgwStatusNone is a TgwStatus enum value
	TgwStatusNone = "NONE"

	// TgwStatusUpdateRequested is a TgwStatus enum value
	TgwStatusUpdateRequested = "UPDATE_REQUESTED"

	// TgwStatusUpdating is a TgwStatus enum value
	TgwStatusUpdating = "UPDATING"

	// TgwStatusFailedUpdate is a TgwStatus enum value
	TgwStatusFailedUpdate = "FAILED_UPDATE"

	// TgwStatusSuccessfullyUpdated is a TgwStatus enum value
	TgwStatusSuccessfullyUpdated = "SUCCESSFULLY_UPDATED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// There was a conflict with this action, and it could not be completed.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request processing has failed because of an unknown error, exception
	// or failure.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is invalid. Something is wrong with the input to the request.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A service limit or quota is exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The specified resource group already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// One or more resources can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "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.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by an AWS service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "finspace"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "finspace"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// AutoScalingMetricCpuUtilizationPercentage is a AutoScalingMetric enum value
	AutoScalingMetricCpuUtilizationPercentage = "CPU_UTILIZATION_PERCENTAGE"
)
View Source 
const (
	// IPAddressTypeIpV4 is a IPAddressType enum value
	IPAddressTypeIpV4 = "IP_V4"
)
View Source 
const (
	// KxSavedownStorageTypeSds01 is a KxSavedownStorageType enum value
	KxSavedownStorageTypeSds01 = "SDS01"
)

Variables

This section is empty.

Functions

func AutoScalingMetric_Values added in v1.44.276 

func AutoScalingMetric_Values() []string

AutoScalingMetric_Values returns all elements of the AutoScalingMetric enum

func ChangeType_Values added in v1.44.276 

func ChangeType_Values() []string

ChangeType_Values returns all elements of the ChangeType enum

func ChangesetStatus_Values added in v1.44.276 

func ChangesetStatus_Values() []string

ChangesetStatus_Values returns all elements of the ChangesetStatus enum

func DnsStatus_Values added in v1.44.276 

func DnsStatus_Values() []string

DnsStatus_Values returns all elements of the DnsStatus enum

func EnvironmentStatus_Values 

func EnvironmentStatus_Values() []string

EnvironmentStatus_Values returns all elements of the EnvironmentStatus enum

func ErrorDetails_Values added in v1.44.276 

func ErrorDetails_Values() []string

ErrorDetails_Values returns all elements of the ErrorDetails enum

func FederationMode_Values 

func FederationMode_Values() []string

FederationMode_Values returns all elements of the FederationMode enum

func IPAddressType_Values added in v1.44.276 

func IPAddressType_Values() []string

IPAddressType_Values returns all elements of the IPAddressType enum

func KxAzMode_Values added in v1.44.276 

func KxAzMode_Values() []string

KxAzMode_Values returns all elements of the KxAzMode enum

func KxClusterStatus_Values added in v1.44.276 

func KxClusterStatus_Values() []string

KxClusterStatus_Values returns all elements of the KxClusterStatus enum

func KxClusterType_Values added in v1.44.276 

func KxClusterType_Values() []string

KxClusterType_Values returns all elements of the KxClusterType enum

func KxDeploymentStrategy_Values added in v1.44.328 

func KxDeploymentStrategy_Values() []string

KxDeploymentStrategy_Values returns all elements of the KxDeploymentStrategy enum

func KxSavedownStorageType_Values added in v1.44.276 

func KxSavedownStorageType_Values() []string

KxSavedownStorageType_Values returns all elements of the KxSavedownStorageType enum

func RuleAction_Values added in v1.44.328 

func RuleAction_Values() []string

RuleAction_Values returns all elements of the RuleAction enum

func TgwStatus_Values added in v1.44.276 

func TgwStatus_Values() []string

TgwStatus_Values returns all elements of the TgwStatus enum

Types

type AccessDeniedException 

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 (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

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 (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

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 added in v1.44.276 

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 (AutoScalingConfiguration) GoString added in v1.44.276 

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 (*AutoScalingConfiguration) SetAutoScalingMetric added in v1.44.276 

func (s *AutoScalingConfiguration) SetAutoScalingMetric(v string) *AutoScalingConfiguration

SetAutoScalingMetric sets the AutoScalingMetric field's value.

func (*AutoScalingConfiguration) SetMaxNodeCount added in v1.44.276 

func (s *AutoScalingConfiguration) SetMaxNodeCount(v int64) *AutoScalingConfiguration

SetMaxNodeCount sets the MaxNodeCount field's value.

func (*AutoScalingConfiguration) SetMetricTarget added in v1.44.276 

func (s *AutoScalingConfiguration) SetMetricTarget(v float64) *AutoScalingConfiguration

SetMetricTarget sets the MetricTarget field's value.

func (*AutoScalingConfiguration) SetMinNodeCount added in v1.44.276 

func (s *AutoScalingConfiguration) SetMinNodeCount(v int64) *AutoScalingConfiguration

SetMinNodeCount sets the MinNodeCount field's value.

func (*AutoScalingConfiguration) SetScaleInCooldownSeconds added in v1.44.276 

func (s *AutoScalingConfiguration) SetScaleInCooldownSeconds(v float64) *AutoScalingConfiguration

SetScaleInCooldownSeconds sets the ScaleInCooldownSeconds field's value.

func (*AutoScalingConfiguration) SetScaleOutCooldownSeconds added in v1.44.276 

func (s *AutoScalingConfiguration) SetScaleOutCooldownSeconds(v float64) *AutoScalingConfiguration

SetScaleOutCooldownSeconds sets the ScaleOutCooldownSeconds field's value.

func (AutoScalingConfiguration) String added in v1.44.276 

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 (*AutoScalingConfiguration) Validate added in v1.44.276 

func (s *AutoScalingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CapacityConfiguration added in v1.44.276 

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 (CapacityConfiguration) GoString added in v1.44.276 

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 (*CapacityConfiguration) SetNodeCount added in v1.44.276 

func (s *CapacityConfiguration) SetNodeCount(v int64) *CapacityConfiguration

SetNodeCount sets the NodeCount field's value.

func (*CapacityConfiguration) SetNodeType added in v1.44.276 

func (s *CapacityConfiguration) SetNodeType(v string) *CapacityConfiguration

SetNodeType sets the NodeType field's value.

func (CapacityConfiguration) String added in v1.44.276 

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 (*CapacityConfiguration) Validate added in v1.44.276 

func (s *CapacityConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ChangeRequest added in v1.44.276 

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 (ChangeRequest) GoString added in v1.44.276 

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 (*ChangeRequest) SetChangeType added in v1.44.276 

func (s *ChangeRequest) SetChangeType(v string) *ChangeRequest

SetChangeType sets the ChangeType field's value.

func (*ChangeRequest) SetDbPath added in v1.44.276 

func (s *ChangeRequest) SetDbPath(v string) *ChangeRequest

SetDbPath sets the DbPath field's value.

func (*ChangeRequest) SetS3Path added in v1.44.276 

func (s *ChangeRequest) SetS3Path(v string) *ChangeRequest

SetS3Path sets the S3Path field's value.

func (ChangeRequest) String added in v1.44.276 

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 (*ChangeRequest) Validate added in v1.44.276 

func (s *ChangeRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CodeConfiguration added in v1.44.276 

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 (CodeConfiguration) GoString added in v1.44.276 

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 (*CodeConfiguration) SetS3Bucket added in v1.44.276 

func (s *CodeConfiguration) SetS3Bucket(v string) *CodeConfiguration

SetS3Bucket sets the S3Bucket field's value.

func (*CodeConfiguration) SetS3Key added in v1.44.276 

func (s *CodeConfiguration) SetS3Key(v string) *CodeConfiguration

SetS3Key sets the S3Key field's value.

func (*CodeConfiguration) SetS3ObjectVersion added in v1.44.276 

func (s *CodeConfiguration) SetS3ObjectVersion(v string) *CodeConfiguration

SetS3ObjectVersion sets the S3ObjectVersion field's value.

func (CodeConfiguration) String added in v1.44.276 

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 (*CodeConfiguration) Validate added in v1.44.276 

func (s *CodeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException added in v1.44.276 

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 (*ConflictException) Code added in v1.44.276 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.44.276 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.44.276 

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 (*ConflictException) Message added in v1.44.276 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.44.276 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.44.276 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.44.276 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.44.276 

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 

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 (CreateEnvironmentInput) GoString 

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 (*CreateEnvironmentInput) SetDataBundles added in v1.41.17 

func (s *CreateEnvironmentInput) SetDataBundles(v []*string) *CreateEnvironmentInput

SetDataBundles sets the DataBundles field's value.

func (*CreateEnvironmentInput) SetDescription 

func (s *CreateEnvironmentInput) SetDescription(v string) *CreateEnvironmentInput

SetDescription sets the Description field's value.

func (*CreateEnvironmentInput) SetFederationMode 

func (s *CreateEnvironmentInput) SetFederationMode(v string) *CreateEnvironmentInput

SetFederationMode sets the FederationMode field's value.

func (*CreateEnvironmentInput) SetFederationParameters 

func (s *CreateEnvironmentInput) SetFederationParameters(v *FederationParameters) *CreateEnvironmentInput

SetFederationParameters sets the FederationParameters field's value.

func (*CreateEnvironmentInput) SetKmsKeyId 

func (s *CreateEnvironmentInput) SetKmsKeyId(v string) *CreateEnvironmentInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateEnvironmentInput) SetName 

func (s *CreateEnvironmentInput) SetName(v string) *CreateEnvironmentInput

SetName sets the Name field's value.

func (*CreateEnvironmentInput) SetSuperuserParameters added in v1.41.17 

func (s *CreateEnvironmentInput) SetSuperuserParameters(v *SuperuserParameters) *CreateEnvironmentInput

SetSuperuserParameters sets the SuperuserParameters field's value.

func (*CreateEnvironmentInput) SetTags 

func (s *CreateEnvironmentInput) SetTags(v map[string]*string) *CreateEnvironmentInput

SetTags sets the Tags field's value.

func (CreateEnvironmentInput) String 

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 (*CreateEnvironmentInput) Validate 

func (s *CreateEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEnvironmentOutput 

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 (CreateEnvironmentOutput) GoString 

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 (*CreateEnvironmentOutput) SetEnvironmentArn 

func (s *CreateEnvironmentOutput) SetEnvironmentArn(v string) *CreateEnvironmentOutput

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*CreateEnvironmentOutput) SetEnvironmentId 

func (s *CreateEnvironmentOutput) SetEnvironmentId(v string) *CreateEnvironmentOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateEnvironmentOutput) SetEnvironmentUrl 

func (s *CreateEnvironmentOutput) SetEnvironmentUrl(v string) *CreateEnvironmentOutput

SetEnvironmentUrl sets the EnvironmentUrl field's value.

func (CreateEnvironmentOutput) String 

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 added in v1.44.276 

type CreateKxChangesetInput struct {

	// A list of change request objects that are run in order. A change request
	// object consists of changeType , s3Path, and a dbPath. A changeType can has
	// 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. The s3Path attribute defines the
	// s3 source file path and is required for a PUT change type.
	//
	// Here is an example of how you can use the change request object:
	//
	// [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"},
	// { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType":
	// "DELETE", "dbPath": "/2020.01.01/"} ]
	//
	// In this example, the first request with PUT change type allows you to add
	// files in the given s3Path under the 2020.01.02 partition of the database.
	// The second request with PUT change type allows you to add a single sym file
	// at database root location. The last request with DELETE change type allows
	// you to delete the files under the 2020.01.01 partition of the database.
	//
	// 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 (CreateKxChangesetInput) GoString added in v1.44.276 

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 (*CreateKxChangesetInput) SetChangeRequests added in v1.44.276 

func (s *CreateKxChangesetInput) SetChangeRequests(v []*ChangeRequest) *CreateKxChangesetInput

SetChangeRequests sets the ChangeRequests field's value.

func (*CreateKxChangesetInput) SetClientToken added in v1.44.276 

func (s *CreateKxChangesetInput) SetClientToken(v string) *CreateKxChangesetInput

SetClientToken sets the ClientToken field's value.

func (*CreateKxChangesetInput) SetDatabaseName added in v1.44.276 

func (s *CreateKxChangesetInput) SetDatabaseName(v string) *CreateKxChangesetInput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateKxChangesetInput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxChangesetInput) SetEnvironmentId(v string) *CreateKxChangesetInput

SetEnvironmentId sets the EnvironmentId field's value.

func (CreateKxChangesetInput) String added in v1.44.276 

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 (*CreateKxChangesetInput) Validate added in v1.44.276 

func (s *CreateKxChangesetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKxChangesetOutput added in v1.44.276 

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 (CreateKxChangesetOutput) GoString added in v1.44.276 

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 (*CreateKxChangesetOutput) SetChangeRequests added in v1.44.276 

func (s *CreateKxChangesetOutput) SetChangeRequests(v []*ChangeRequest) *CreateKxChangesetOutput

SetChangeRequests sets the ChangeRequests field's value.

func (*CreateKxChangesetOutput) SetChangesetId added in v1.44.276 

func (s *CreateKxChangesetOutput) SetChangesetId(v string) *CreateKxChangesetOutput

SetChangesetId sets the ChangesetId field's value.

func (*CreateKxChangesetOutput) SetCreatedTimestamp added in v1.44.276 

func (s *CreateKxChangesetOutput) SetCreatedTimestamp(v time.Time) *CreateKxChangesetOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CreateKxChangesetOutput) SetDatabaseName added in v1.44.276 

func (s *CreateKxChangesetOutput) SetDatabaseName(v string) *CreateKxChangesetOutput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateKxChangesetOutput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxChangesetOutput) SetEnvironmentId(v string) *CreateKxChangesetOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxChangesetOutput) SetErrorInfo added in v1.44.276 

func (s *CreateKxChangesetOutput) SetErrorInfo(v *ErrorInfo) *CreateKxChangesetOutput

SetErrorInfo sets the ErrorInfo field's value.

func (*CreateKxChangesetOutput) SetLastModifiedTimestamp added in v1.44.276 

func (s *CreateKxChangesetOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxChangesetOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*CreateKxChangesetOutput) SetStatus added in v1.44.276 

func (s *CreateKxChangesetOutput) SetStatus(v string) *CreateKxChangesetOutput

SetStatus sets the Status field's value.

func (CreateKxChangesetOutput) String added in v1.44.276 

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 added in v1.44.276 

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" 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 is a required field
	CapacityConfiguration *CapacityConfiguration `locationName:"capacityConfiguration" type:"structure" required:"true"`

	// 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.
	//
	// 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"`

	// 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"`

	// 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 (CreateKxClusterInput) GoString added in v1.44.276 

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 (*CreateKxClusterInput) SetAutoScalingConfiguration added in v1.44.276 

func (s *CreateKxClusterInput) SetAutoScalingConfiguration(v *AutoScalingConfiguration) *CreateKxClusterInput

SetAutoScalingConfiguration sets the AutoScalingConfiguration field's value.

func (*CreateKxClusterInput) SetAvailabilityZoneId added in v1.44.276 

func (s *CreateKxClusterInput) SetAvailabilityZoneId(v string) *CreateKxClusterInput

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*CreateKxClusterInput) SetAzMode added in v1.44.276 

func (s *CreateKxClusterInput) SetAzMode(v string) *CreateKxClusterInput

SetAzMode sets the AzMode field's value.

func (*CreateKxClusterInput) SetCacheStorageConfigurations added in v1.44.276 

func (s *CreateKxClusterInput) SetCacheStorageConfigurations(v []*KxCacheStorageConfiguration) *CreateKxClusterInput

SetCacheStorageConfigurations sets the CacheStorageConfigurations field's value.

func (*CreateKxClusterInput) SetCapacityConfiguration added in v1.44.276 

func (s *CreateKxClusterInput) SetCapacityConfiguration(v *CapacityConfiguration) *CreateKxClusterInput

SetCapacityConfiguration sets the CapacityConfiguration field's value.

func (*CreateKxClusterInput) SetClientToken added in v1.44.276 

func (s *CreateKxClusterInput) SetClientToken(v string) *CreateKxClusterInput

SetClientToken sets the ClientToken field's value.

func (*CreateKxClusterInput) SetClusterDescription added in v1.44.276 

func (s *CreateKxClusterInput) SetClusterDescription(v string) *CreateKxClusterInput

SetClusterDescription sets the ClusterDescription field's value.

func (*CreateKxClusterInput) SetClusterName added in v1.44.276 

func (s *CreateKxClusterInput) SetClusterName(v string) *CreateKxClusterInput

SetClusterName sets the ClusterName field's value.

func (*CreateKxClusterInput) SetClusterType added in v1.44.276 

func (s *CreateKxClusterInput) SetClusterType(v string) *CreateKxClusterInput

SetClusterType sets the ClusterType field's value.

func (*CreateKxClusterInput) SetCode added in v1.44.276 

func (s *CreateKxClusterInput) SetCode(v *CodeConfiguration) *CreateKxClusterInput

SetCode sets the Code field's value.

func (*CreateKxClusterInput) SetCommandLineArguments added in v1.44.276 

func (s *CreateKxClusterInput) SetCommandLineArguments(v []*KxCommandLineArgument) *CreateKxClusterInput

SetCommandLineArguments sets the CommandLineArguments field's value.

func (*CreateKxClusterInput) SetDatabases added in v1.44.276 

func (s *CreateKxClusterInput) SetDatabases(v []*KxDatabaseConfiguration) *CreateKxClusterInput

SetDatabases sets the Databases field's value.

func (*CreateKxClusterInput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxClusterInput) SetEnvironmentId(v string) *CreateKxClusterInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxClusterInput) SetExecutionRole added in v1.44.276 

func (s *CreateKxClusterInput) SetExecutionRole(v string) *CreateKxClusterInput

SetExecutionRole sets the ExecutionRole field's value.

func (*CreateKxClusterInput) SetInitializationScript added in v1.44.276 

func (s *CreateKxClusterInput) SetInitializationScript(v string) *CreateKxClusterInput

SetInitializationScript sets the InitializationScript field's value.

func (*CreateKxClusterInput) SetReleaseLabel added in v1.44.276 

func (s *CreateKxClusterInput) SetReleaseLabel(v string) *CreateKxClusterInput

SetReleaseLabel sets the ReleaseLabel field's value.

func (*CreateKxClusterInput) SetSavedownStorageConfiguration added in v1.44.276 

func (s *CreateKxClusterInput) SetSavedownStorageConfiguration(v *KxSavedownStorageConfiguration) *CreateKxClusterInput

SetSavedownStorageConfiguration sets the SavedownStorageConfiguration field's value.

func (*CreateKxClusterInput) SetTags added in v1.44.276 

func (s *CreateKxClusterInput) SetTags(v map[string]*string) *CreateKxClusterInput

SetTags sets the Tags field's value.

func (*CreateKxClusterInput) SetVpcConfiguration added in v1.44.276 

func (s *CreateKxClusterInput) SetVpcConfiguration(v *VpcConfiguration) *CreateKxClusterInput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (CreateKxClusterInput) String added in v1.44.276 

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 (*CreateKxClusterInput) Validate added in v1.44.276 

func (s *CreateKxClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKxClusterOutput added in v1.44.276 

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" 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.
	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 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"`

	// 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 (CreateKxClusterOutput) GoString added in v1.44.276 

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 (*CreateKxClusterOutput) SetAutoScalingConfiguration added in v1.44.276 

func (s *CreateKxClusterOutput) SetAutoScalingConfiguration(v *AutoScalingConfiguration) *CreateKxClusterOutput

SetAutoScalingConfiguration sets the AutoScalingConfiguration field's value.

func (*CreateKxClusterOutput) SetAvailabilityZoneId added in v1.44.276 

func (s *CreateKxClusterOutput) SetAvailabilityZoneId(v string) *CreateKxClusterOutput

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*CreateKxClusterOutput) SetAzMode added in v1.44.276 

func (s *CreateKxClusterOutput) SetAzMode(v string) *CreateKxClusterOutput

SetAzMode sets the AzMode field's value.

func (*CreateKxClusterOutput) SetCacheStorageConfigurations added in v1.44.276 

func (s *CreateKxClusterOutput) SetCacheStorageConfigurations(v []*KxCacheStorageConfiguration) *CreateKxClusterOutput

SetCacheStorageConfigurations sets the CacheStorageConfigurations field's value.

func (*CreateKxClusterOutput) SetCapacityConfiguration added in v1.44.276 

func (s *CreateKxClusterOutput) SetCapacityConfiguration(v *CapacityConfiguration) *CreateKxClusterOutput

SetCapacityConfiguration sets the CapacityConfiguration field's value.

func (*CreateKxClusterOutput) SetClusterDescription added in v1.44.276 

func (s *CreateKxClusterOutput) SetClusterDescription(v string) *CreateKxClusterOutput

SetClusterDescription sets the ClusterDescription field's value.

func (*CreateKxClusterOutput) SetClusterName added in v1.44.276 

func (s *CreateKxClusterOutput) SetClusterName(v string) *CreateKxClusterOutput

SetClusterName sets the ClusterName field's value.

func (*CreateKxClusterOutput) SetClusterType added in v1.44.276 

func (s *CreateKxClusterOutput) SetClusterType(v string) *CreateKxClusterOutput

SetClusterType sets the ClusterType field's value.

func (*CreateKxClusterOutput) SetCode added in v1.44.276 

func (s *CreateKxClusterOutput) SetCode(v *CodeConfiguration) *CreateKxClusterOutput

SetCode sets the Code field's value.

func (*CreateKxClusterOutput) SetCommandLineArguments added in v1.44.276 

func (s *CreateKxClusterOutput) SetCommandLineArguments(v []*KxCommandLineArgument) *CreateKxClusterOutput

SetCommandLineArguments sets the CommandLineArguments field's value.

func (*CreateKxClusterOutput) SetCreatedTimestamp added in v1.44.276 

func (s *CreateKxClusterOutput) SetCreatedTimestamp(v time.Time) *CreateKxClusterOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CreateKxClusterOutput) SetDatabases added in v1.44.276 

func (s *CreateKxClusterOutput) SetDatabases(v []*KxDatabaseConfiguration) *CreateKxClusterOutput

SetDatabases sets the Databases field's value.

func (*CreateKxClusterOutput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxClusterOutput) SetEnvironmentId(v string) *CreateKxClusterOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxClusterOutput) SetExecutionRole added in v1.44.276 

func (s *CreateKxClusterOutput) SetExecutionRole(v string) *CreateKxClusterOutput

SetExecutionRole sets the ExecutionRole field's value.

func (*CreateKxClusterOutput) SetInitializationScript added in v1.44.276 

func (s *CreateKxClusterOutput) SetInitializationScript(v string) *CreateKxClusterOutput

SetInitializationScript sets the InitializationScript field's value.

func (*CreateKxClusterOutput) SetLastModifiedTimestamp added in v1.44.276 

func (s *CreateKxClusterOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxClusterOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*CreateKxClusterOutput) SetReleaseLabel added in v1.44.276 

func (s *CreateKxClusterOutput) SetReleaseLabel(v string) *CreateKxClusterOutput

SetReleaseLabel sets the ReleaseLabel field's value.

func (*CreateKxClusterOutput) SetSavedownStorageConfiguration added in v1.44.276 

func (s *CreateKxClusterOutput) SetSavedownStorageConfiguration(v *KxSavedownStorageConfiguration) *CreateKxClusterOutput

SetSavedownStorageConfiguration sets the SavedownStorageConfiguration field's value.

func (*CreateKxClusterOutput) SetStatus added in v1.44.276 

func (s *CreateKxClusterOutput) SetStatus(v string) *CreateKxClusterOutput

SetStatus sets the Status field's value.

func (*CreateKxClusterOutput) SetStatusReason added in v1.44.276 

func (s *CreateKxClusterOutput) SetStatusReason(v string) *CreateKxClusterOutput

SetStatusReason sets the StatusReason field's value.

func (*CreateKxClusterOutput) SetVpcConfiguration added in v1.44.276 

func (s *CreateKxClusterOutput) SetVpcConfiguration(v *VpcConfiguration) *CreateKxClusterOutput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (CreateKxClusterOutput) String added in v1.44.276 

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 added in v1.44.276 

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 (CreateKxDatabaseInput) GoString added in v1.44.276 

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 (*CreateKxDatabaseInput) SetClientToken added in v1.44.276 

func (s *CreateKxDatabaseInput) SetClientToken(v string) *CreateKxDatabaseInput

SetClientToken sets the ClientToken field's value.

func (*CreateKxDatabaseInput) SetDatabaseName added in v1.44.276 

func (s *CreateKxDatabaseInput) SetDatabaseName(v string) *CreateKxDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateKxDatabaseInput) SetDescription added in v1.44.276 

func (s *CreateKxDatabaseInput) SetDescription(v string) *CreateKxDatabaseInput

SetDescription sets the Description field's value.

func (*CreateKxDatabaseInput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxDatabaseInput) SetEnvironmentId(v string) *CreateKxDatabaseInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxDatabaseInput) SetTags added in v1.44.276 

func (s *CreateKxDatabaseInput) SetTags(v map[string]*string) *CreateKxDatabaseInput

SetTags sets the Tags field's value.

func (CreateKxDatabaseInput) String added in v1.44.276 

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 (*CreateKxDatabaseInput) Validate added in v1.44.276 

func (s *CreateKxDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKxDatabaseOutput added in v1.44.276 

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 (CreateKxDatabaseOutput) GoString added in v1.44.276 

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 (*CreateKxDatabaseOutput) SetCreatedTimestamp added in v1.44.276 

func (s *CreateKxDatabaseOutput) SetCreatedTimestamp(v time.Time) *CreateKxDatabaseOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CreateKxDatabaseOutput) SetDatabaseArn added in v1.44.276 

func (s *CreateKxDatabaseOutput) SetDatabaseArn(v string) *CreateKxDatabaseOutput

SetDatabaseArn sets the DatabaseArn field's value.

func (*CreateKxDatabaseOutput) SetDatabaseName added in v1.44.276 

func (s *CreateKxDatabaseOutput) SetDatabaseName(v string) *CreateKxDatabaseOutput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateKxDatabaseOutput) SetDescription added in v1.44.276 

func (s *CreateKxDatabaseOutput) SetDescription(v string) *CreateKxDatabaseOutput

SetDescription sets the Description field's value.

func (*CreateKxDatabaseOutput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxDatabaseOutput) SetEnvironmentId(v string) *CreateKxDatabaseOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxDatabaseOutput) SetLastModifiedTimestamp added in v1.44.276 

func (s *CreateKxDatabaseOutput) SetLastModifiedTimestamp(v time.Time) *CreateKxDatabaseOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (CreateKxDatabaseOutput) String added in v1.44.276 

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 CreateKxEnvironmentInput added in v1.44.276 

type CreateKxEnvironmentInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string"`

	// 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 (CreateKxEnvironmentInput) GoString added in v1.44.276 

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 (*CreateKxEnvironmentInput) SetClientToken added in v1.44.276 

func (s *CreateKxEnvironmentInput) SetClientToken(v string) *CreateKxEnvironmentInput

SetClientToken sets the ClientToken field's value.

func (*CreateKxEnvironmentInput) SetDescription added in v1.44.276 

func (s *CreateKxEnvironmentInput) SetDescription(v string) *CreateKxEnvironmentInput

SetDescription sets the Description field's value.

func (*CreateKxEnvironmentInput) SetKmsKeyId added in v1.44.276 

func (s *CreateKxEnvironmentInput) SetKmsKeyId(v string) *CreateKxEnvironmentInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateKxEnvironmentInput) SetName added in v1.44.276 

func (s *CreateKxEnvironmentInput) SetName(v string) *CreateKxEnvironmentInput

SetName sets the Name field's value.

func (*CreateKxEnvironmentInput) SetTags added in v1.44.276 

func (s *CreateKxEnvironmentInput) SetTags(v map[string]*string) *CreateKxEnvironmentInput

SetTags sets the Tags field's value.

func (CreateKxEnvironmentInput) String added in v1.44.276 

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 (*CreateKxEnvironmentInput) Validate added in v1.44.276 

func (s *CreateKxEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKxEnvironmentOutput added in v1.44.276 

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 (CreateKxEnvironmentOutput) GoString added in v1.44.276 

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 (*CreateKxEnvironmentOutput) SetCreationTimestamp added in v1.44.276 

func (s *CreateKxEnvironmentOutput) SetCreationTimestamp(v time.Time) *CreateKxEnvironmentOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*CreateKxEnvironmentOutput) SetDescription added in v1.44.276 

func (s *CreateKxEnvironmentOutput) SetDescription(v string) *CreateKxEnvironmentOutput

SetDescription sets the Description field's value.

func (*CreateKxEnvironmentOutput) SetEnvironmentArn added in v1.44.276 

func (s *CreateKxEnvironmentOutput) SetEnvironmentArn(v string) *CreateKxEnvironmentOutput

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*CreateKxEnvironmentOutput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxEnvironmentOutput) SetEnvironmentId(v string) *CreateKxEnvironmentOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxEnvironmentOutput) SetKmsKeyId added in v1.44.276 

func (s *CreateKxEnvironmentOutput) SetKmsKeyId(v string) *CreateKxEnvironmentOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateKxEnvironmentOutput) SetName added in v1.44.276 

func (s *CreateKxEnvironmentOutput) SetName(v string) *CreateKxEnvironmentOutput

SetName sets the Name field's value.

func (*CreateKxEnvironmentOutput) SetStatus added in v1.44.276 

func (s *CreateKxEnvironmentOutput) SetStatus(v string) *CreateKxEnvironmentOutput

SetStatus sets the Status field's value.

func (CreateKxEnvironmentOutput) String added in v1.44.276 

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 CreateKxUserInput added in v1.44.276 

type CreateKxUserInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string"`

	// 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 (CreateKxUserInput) GoString added in v1.44.276 

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 (*CreateKxUserInput) SetClientToken added in v1.44.276 

func (s *CreateKxUserInput) SetClientToken(v string) *CreateKxUserInput

SetClientToken sets the ClientToken field's value.

func (*CreateKxUserInput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxUserInput) SetEnvironmentId(v string) *CreateKxUserInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxUserInput) SetIamRole added in v1.44.276 

func (s *CreateKxUserInput) SetIamRole(v string) *CreateKxUserInput

SetIamRole sets the IamRole field's value.

func (*CreateKxUserInput) SetTags added in v1.44.276 

func (s *CreateKxUserInput) SetTags(v map[string]*string) *CreateKxUserInput

SetTags sets the Tags field's value.

func (*CreateKxUserInput) SetUserName added in v1.44.276 

func (s *CreateKxUserInput) SetUserName(v string) *CreateKxUserInput

SetUserName sets the UserName field's value.

func (CreateKxUserInput) String added in v1.44.276 

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 (*CreateKxUserInput) Validate added in v1.44.276 

func (s *CreateKxUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKxUserOutput added in v1.44.276 

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 (CreateKxUserOutput) GoString added in v1.44.276 

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 (*CreateKxUserOutput) SetEnvironmentId added in v1.44.276 

func (s *CreateKxUserOutput) SetEnvironmentId(v string) *CreateKxUserOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*CreateKxUserOutput) SetIamRole added in v1.44.276 

func (s *CreateKxUserOutput) SetIamRole(v string) *CreateKxUserOutput

SetIamRole sets the IamRole field's value.

func (*CreateKxUserOutput) SetUserArn added in v1.44.276 

func (s *CreateKxUserOutput) SetUserArn(v string) *CreateKxUserOutput

SetUserArn sets the UserArn field's value.

func (*CreateKxUserOutput) SetUserName added in v1.44.276 

func (s *CreateKxUserOutput) SetUserName(v string) *CreateKxUserOutput

SetUserName sets the UserName field's value.

func (CreateKxUserOutput) String added in v1.44.276 

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 CustomDNSServer added in v1.44.276 

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 (CustomDNSServer) GoString added in v1.44.276 

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 (*CustomDNSServer) SetCustomDNSServerIP added in v1.44.276 

func (s *CustomDNSServer) SetCustomDNSServerIP(v string) *CustomDNSServer

SetCustomDNSServerIP sets the CustomDNSServerIP field's value.

func (*CustomDNSServer) SetCustomDNSServerName added in v1.44.276 

func (s *CustomDNSServer) SetCustomDNSServerName(v string) *CustomDNSServer

SetCustomDNSServerName sets the CustomDNSServerName field's value.

func (CustomDNSServer) String added in v1.44.276 

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 (*CustomDNSServer) Validate added in v1.44.276 

func (s *CustomDNSServer) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEnvironmentInput 

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 (DeleteEnvironmentInput) GoString 

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 (*DeleteEnvironmentInput) SetEnvironmentId 

func (s *DeleteEnvironmentInput) SetEnvironmentId(v string) *DeleteEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (DeleteEnvironmentInput) String 

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 (*DeleteEnvironmentInput) Validate 

func (s *DeleteEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEnvironmentOutput 

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

func (DeleteEnvironmentOutput) GoString 

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 (DeleteEnvironmentOutput) String 

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 added in v1.44.276 

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 (DeleteKxClusterInput) GoString added in v1.44.276 

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 (*DeleteKxClusterInput) SetClientToken added in v1.44.276 

func (s *DeleteKxClusterInput) SetClientToken(v string) *DeleteKxClusterInput

SetClientToken sets the ClientToken field's value.

func (*DeleteKxClusterInput) SetClusterName added in v1.44.276 

func (s *DeleteKxClusterInput) SetClusterName(v string) *DeleteKxClusterInput

SetClusterName sets the ClusterName field's value.

func (*DeleteKxClusterInput) SetEnvironmentId added in v1.44.276 

func (s *DeleteKxClusterInput) SetEnvironmentId(v string) *DeleteKxClusterInput

SetEnvironmentId sets the EnvironmentId field's value.

func (DeleteKxClusterInput) String added in v1.44.276 

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 (*DeleteKxClusterInput) Validate added in v1.44.276 

func (s *DeleteKxClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKxClusterOutput added in v1.44.276 

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

func (DeleteKxClusterOutput) GoString added in v1.44.276 

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 (DeleteKxClusterOutput) String added in v1.44.276 

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 added in v1.44.276 

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 (DeleteKxDatabaseInput) GoString added in v1.44.276 

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 (*DeleteKxDatabaseInput) SetClientToken added in v1.44.276 

func (s *DeleteKxDatabaseInput) SetClientToken(v string) *DeleteKxDatabaseInput

SetClientToken sets the ClientToken field's value.

func (*DeleteKxDatabaseInput) SetDatabaseName added in v1.44.276 

func (s *DeleteKxDatabaseInput) SetDatabaseName(v string) *DeleteKxDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (*DeleteKxDatabaseInput) SetEnvironmentId added in v1.44.276 

func (s *DeleteKxDatabaseInput) SetEnvironmentId(v string) *DeleteKxDatabaseInput

SetEnvironmentId sets the EnvironmentId field's value.

func (DeleteKxDatabaseInput) String added in v1.44.276 

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 (*DeleteKxDatabaseInput) Validate added in v1.44.276 

func (s *DeleteKxDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKxDatabaseOutput added in v1.44.276 

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

func (DeleteKxDatabaseOutput) GoString added in v1.44.276 

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 (DeleteKxDatabaseOutput) String added in v1.44.276 

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 DeleteKxEnvironmentInput added in v1.44.276 

type DeleteKxEnvironmentInput 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 (DeleteKxEnvironmentInput) GoString added in v1.44.276 

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 (*DeleteKxEnvironmentInput) SetEnvironmentId added in v1.44.276 

func (s *DeleteKxEnvironmentInput) SetEnvironmentId(v string) *DeleteKxEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (DeleteKxEnvironmentInput) String added in v1.44.276 

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 (*DeleteKxEnvironmentInput) Validate added in v1.44.276 

func (s *DeleteKxEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKxEnvironmentOutput added in v1.44.276 

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

func (DeleteKxEnvironmentOutput) GoString added in v1.44.276 

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 (DeleteKxEnvironmentOutput) String added in v1.44.276 

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 DeleteKxUserInput added in v1.44.276 

type DeleteKxUserInput 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 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 (DeleteKxUserInput) GoString added in v1.44.276 

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 (*DeleteKxUserInput) SetEnvironmentId added in v1.44.276 

func (s *DeleteKxUserInput) SetEnvironmentId(v string) *DeleteKxUserInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*DeleteKxUserInput) SetUserName added in v1.44.276 

func (s *DeleteKxUserInput) SetUserName(v string) *DeleteKxUserInput

SetUserName sets the UserName field's value.

func (DeleteKxUserInput) String added in v1.44.276 

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 (*DeleteKxUserInput) Validate added in v1.44.276 

func (s *DeleteKxUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKxUserOutput added in v1.44.276 

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

func (DeleteKxUserOutput) GoString added in v1.44.276 

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 (DeleteKxUserOutput) String added in v1.44.276 

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 Environment 

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 (Environment) GoString 

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 (*Environment) SetAwsAccountId 

func (s *Environment) SetAwsAccountId(v string) *Environment

SetAwsAccountId sets the AwsAccountId field's value.

func (*Environment) SetDedicatedServiceAccountId 

func (s *Environment) SetDedicatedServiceAccountId(v string) *Environment

SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.

func (*Environment) SetDescription 

func (s *Environment) SetDescription(v string) *Environment

SetDescription sets the Description field's value.

func (*Environment) SetEnvironmentArn 

func (s *Environment) SetEnvironmentArn(v string) *Environment

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*Environment) SetEnvironmentId 

func (s *Environment) SetEnvironmentId(v string) *Environment

SetEnvironmentId sets the EnvironmentId field's value.

func (*Environment) SetEnvironmentUrl 

func (s *Environment) SetEnvironmentUrl(v string) *Environment

SetEnvironmentUrl sets the EnvironmentUrl field's value.

func (*Environment) SetFederationMode 

func (s *Environment) SetFederationMode(v string) *Environment

SetFederationMode sets the FederationMode field's value.

func (*Environment) SetFederationParameters 

func (s *Environment) SetFederationParameters(v *FederationParameters) *Environment

SetFederationParameters sets the FederationParameters field's value.

func (*Environment) SetKmsKeyId 

func (s *Environment) SetKmsKeyId(v string) *Environment

SetKmsKeyId sets the KmsKeyId field's value.

func (*Environment) SetName 

func (s *Environment) SetName(v string) *Environment

SetName sets the Name field's value.

func (*Environment) SetSageMakerStudioDomainUrl 

func (s *Environment) SetSageMakerStudioDomainUrl(v string) *Environment

SetSageMakerStudioDomainUrl sets the SageMakerStudioDomainUrl field's value.

func (*Environment) SetStatus 

func (s *Environment) SetStatus(v string) *Environment

SetStatus sets the Status field's value.

func (Environment) String 

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 added in v1.44.276 

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 (ErrorInfo) GoString added in v1.44.276 

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 (*ErrorInfo) SetErrorMessage added in v1.44.276 

func (s *ErrorInfo) SetErrorMessage(v string) *ErrorInfo

SetErrorMessage sets the ErrorMessage field's value.

func (*ErrorInfo) SetErrorType added in v1.44.276 

func (s *ErrorInfo) SetErrorType(v string) *ErrorInfo

SetErrorType sets the ErrorType field's value.

func (ErrorInfo) String added in v1.44.276 

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 

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 (FederationParameters) GoString 

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 (*FederationParameters) SetApplicationCallBackURL 

func (s *FederationParameters) SetApplicationCallBackURL(v string) *FederationParameters

SetApplicationCallBackURL sets the ApplicationCallBackURL field's value.

func (*FederationParameters) SetAttributeMap 

func (s *FederationParameters) SetAttributeMap(v map[string]*string) *FederationParameters

SetAttributeMap sets the AttributeMap field's value.

func (*FederationParameters) SetFederationProviderName 

func (s *FederationParameters) SetFederationProviderName(v string) *FederationParameters

SetFederationProviderName sets the FederationProviderName field's value.

func (*FederationParameters) SetFederationURN 

func (s *FederationParameters) SetFederationURN(v string) *FederationParameters

SetFederationURN sets the FederationURN field's value.

func (*FederationParameters) SetSamlMetadataDocument 

func (s *FederationParameters) SetSamlMetadataDocument(v string) *FederationParameters

SetSamlMetadataDocument sets the SamlMetadataDocument field's value.

func (*FederationParameters) SetSamlMetadataURL 

func (s *FederationParameters) SetSamlMetadataURL(v string) *FederationParameters

SetSamlMetadataURL sets the SamlMetadataURL field's value.

func (FederationParameters) String 

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 (*FederationParameters) Validate 

func (s *FederationParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Finspace 

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 

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 (*Finspace) CreateEnvironment 

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

func (*Finspace) CreateEnvironmentRequest 

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

func (*Finspace) CreateEnvironmentWithContext 

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.

func (*Finspace) CreateKxChangeset added in v1.44.276 

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 (*Finspace) CreateKxChangesetRequest added in v1.44.276 

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 (*Finspace) CreateKxChangesetWithContext added in v1.44.276 

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 (*Finspace) CreateKxCluster added in v1.44.276 

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 (*Finspace) CreateKxClusterRequest added in v1.44.276 

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 (*Finspace) CreateKxClusterWithContext added in v1.44.276 

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 (*Finspace) CreateKxDatabase added in v1.44.276 

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 (*Finspace) CreateKxDatabaseRequest added in v1.44.276 

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 (*Finspace) CreateKxDatabaseWithContext added in v1.44.276 

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 (*Finspace) CreateKxEnvironment added in v1.44.276 

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 (*Finspace) CreateKxEnvironmentRequest added in v1.44.276 

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 (*Finspace) CreateKxEnvironmentWithContext added in v1.44.276 

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 (*Finspace) CreateKxUser added in v1.44.276 

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 (*Finspace) CreateKxUserRequest added in v1.44.276 

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 (*Finspace) CreateKxUserWithContext added in v1.44.276 

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 (*Finspace) DeleteEnvironment 

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

func (*Finspace) DeleteEnvironmentRequest 

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

func (*Finspace) DeleteEnvironmentWithContext 

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.

func (*Finspace) DeleteKxCluster added in v1.44.276 

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 (*Finspace) DeleteKxClusterRequest added in v1.44.276 

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 (*Finspace) DeleteKxClusterWithContext added in v1.44.276 

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 (*Finspace) DeleteKxDatabase added in v1.44.276 

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 (*Finspace) DeleteKxDatabaseRequest added in v1.44.276 

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 (*Finspace) DeleteKxDatabaseWithContext added in v1.44.276 

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 (*Finspace) DeleteKxEnvironment added in v1.44.276 

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironment

func (*Finspace) DeleteKxEnvironmentRequest added in v1.44.276 

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 (*Finspace) DeleteKxEnvironmentWithContext added in v1.44.276 

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 (*Finspace) DeleteKxUser added in v1.44.276 

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUser

func (*Finspace) DeleteKxUserRequest added in v1.44.276 

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 (*Finspace) DeleteKxUserWithContext added in v1.44.276 

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 (*Finspace) GetEnvironment 

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

func (*Finspace) GetEnvironmentRequest 

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

func (*Finspace) GetEnvironmentWithContext 

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.

func (*Finspace) GetKxChangeset added in v1.44.276 

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 (*Finspace) GetKxChangesetRequest added in v1.44.276 

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 (*Finspace) GetKxChangesetWithContext added in v1.44.276 

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 (*Finspace) GetKxCluster added in v1.44.276 

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 (*Finspace) GetKxClusterRequest added in v1.44.276 

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 (*Finspace) GetKxClusterWithContext added in v1.44.276 

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 (*Finspace) GetKxConnectionString added in v1.44.276 

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 (*Finspace) GetKxConnectionStringRequest added in v1.44.276 

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 (*Finspace) GetKxConnectionStringWithContext added in v1.44.276 

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 (*Finspace) GetKxDatabase added in v1.44.276 

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 (*Finspace) GetKxDatabaseRequest added in v1.44.276 

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 (*Finspace) GetKxDatabaseWithContext added in v1.44.276 

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 (*Finspace) GetKxEnvironment added in v1.44.276 

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxEnvironment

func (*Finspace) GetKxEnvironmentRequest added in v1.44.276 

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 (*Finspace) GetKxEnvironmentWithContext added in v1.44.276 

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 (*Finspace) GetKxUser added in v1.44.276 

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 (*Finspace) GetKxUserRequest added in v1.44.276 

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 (*Finspace) GetKxUserWithContext added in v1.44.276 

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 (*Finspace) ListEnvironments 

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments

func (*Finspace) ListEnvironmentsRequest 

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

func (*Finspace) ListEnvironmentsWithContext 

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.

func (*Finspace) ListKxChangesets added in v1.44.276 

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 (*Finspace) ListKxChangesetsPages added in v1.44.276 

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 (*Finspace) ListKxChangesetsPagesWithContext added in v1.44.276 

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 (*Finspace) ListKxChangesetsRequest added in v1.44.276 

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 (*Finspace) ListKxChangesetsWithContext added in v1.44.276 

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 (*Finspace) ListKxClusterNodes added in v1.44.276 

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 (*Finspace) ListKxClusterNodesPages added in v1.44.276 

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 (*Finspace) ListKxClusterNodesPagesWithContext added in v1.44.276 

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 (*Finspace) ListKxClusterNodesRequest added in v1.44.276 

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 (*Finspace) ListKxClusterNodesWithContext added in v1.44.276 

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 (*Finspace) ListKxClusters added in v1.44.276 

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 (*Finspace) ListKxClustersRequest added in v1.44.276 

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 (*Finspace) ListKxClustersWithContext added in v1.44.276 

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 (*Finspace) ListKxDatabases added in v1.44.276 

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 (*Finspace) ListKxDatabasesPages added in v1.44.276 

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 (*Finspace) ListKxDatabasesPagesWithContext added in v1.44.276 

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 (*Finspace) ListKxDatabasesRequest added in v1.44.276 

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 (*Finspace) ListKxDatabasesWithContext added in v1.44.276 

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 (*Finspace) ListKxEnvironments added in v1.44.276 

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.

  • 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 (*Finspace) ListKxEnvironmentsPages added in v1.44.276 

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 (*Finspace) ListKxEnvironmentsPagesWithContext added in v1.44.276 

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 (*Finspace) ListKxEnvironmentsRequest added in v1.44.276 

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 (*Finspace) ListKxEnvironmentsWithContext added in v1.44.276 

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 (*Finspace) ListKxUsers added in v1.44.276 

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 (*Finspace) ListKxUsersRequest added in v1.44.276 

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 (*Finspace) ListKxUsersWithContext added in v1.44.276 

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 (*Finspace) ListTagsForResource 

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 (*Finspace) ListTagsForResourceRequest 

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 (*Finspace) ListTagsForResourceWithContext 

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 (*Finspace) TagResource 

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 (*Finspace) TagResourceRequest 

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 (*Finspace) TagResourceWithContext 

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 (*Finspace) UntagResource 

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 (*Finspace) UntagResourceRequest 

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 (*Finspace) UntagResourceWithContext 

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 (*Finspace) UpdateEnvironment 

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

func (*Finspace) UpdateEnvironmentRequest 

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

func (*Finspace) UpdateEnvironmentWithContext 

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.

func (*Finspace) UpdateKxClusterDatabases added in v1.44.276 

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 (*Finspace) UpdateKxClusterDatabasesRequest added in v1.44.276 

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 (*Finspace) UpdateKxClusterDatabasesWithContext added in v1.44.276 

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 (*Finspace) UpdateKxDatabase added in v1.44.276 

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 (*Finspace) UpdateKxDatabaseRequest added in v1.44.276 

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 (*Finspace) UpdateKxDatabaseWithContext added in v1.44.276 

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 (*Finspace) UpdateKxEnvironment added in v1.44.276 

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 (*Finspace) UpdateKxEnvironmentNetwork added in v1.44.276 

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 (*Finspace) UpdateKxEnvironmentNetworkRequest added in v1.44.276 

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 (*Finspace) UpdateKxEnvironmentNetworkWithContext added in v1.44.276 

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 (*Finspace) UpdateKxEnvironmentRequest added in v1.44.276 

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 (*Finspace) UpdateKxEnvironmentWithContext added in v1.44.276 

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 (*Finspace) UpdateKxUser added in v1.44.276 

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 (*Finspace) UpdateKxUserRequest added in v1.44.276 

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 (*Finspace) UpdateKxUserWithContext added in v1.44.276 

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.

type GetEnvironmentInput 

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 (GetEnvironmentInput) GoString 

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 (*GetEnvironmentInput) SetEnvironmentId 

func (s *GetEnvironmentInput) SetEnvironmentId(v string) *GetEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (GetEnvironmentInput) String 

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 (*GetEnvironmentInput) Validate 

func (s *GetEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEnvironmentOutput 

type GetEnvironmentOutput struct {

	// The name of the FinSpace environment.
	Environment *Environment `locationName:"environment" type:"structure"`
	// contains filtered or unexported fields
}

func (GetEnvironmentOutput) GoString 

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 (*GetEnvironmentOutput) SetEnvironment 

func (s *GetEnvironmentOutput) SetEnvironment(v *Environment) *GetEnvironmentOutput

SetEnvironment sets the Environment field's value.

func (GetEnvironmentOutput) String 

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 added in v1.44.276 

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 (GetKxChangesetInput) GoString added in v1.44.276 

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 (*GetKxChangesetInput) SetChangesetId added in v1.44.276 

func (s *GetKxChangesetInput) SetChangesetId(v string) *GetKxChangesetInput

SetChangesetId sets the ChangesetId field's value.

func (*GetKxChangesetInput) SetDatabaseName added in v1.44.276 

func (s *GetKxChangesetInput) SetDatabaseName(v string) *GetKxChangesetInput

SetDatabaseName sets the DatabaseName field's value.

func (*GetKxChangesetInput) SetEnvironmentId added in v1.44.276 

func (s *GetKxChangesetInput) SetEnvironmentId(v string) *GetKxChangesetInput

SetEnvironmentId sets the EnvironmentId field's value.

func (GetKxChangesetInput) String added in v1.44.276 

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 (*GetKxChangesetInput) Validate added in v1.44.276 

func (s *GetKxChangesetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKxChangesetOutput added in v1.44.276 

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 (GetKxChangesetOutput) GoString added in v1.44.276 

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 (*GetKxChangesetOutput) SetActiveFromTimestamp added in v1.44.276 

func (s *GetKxChangesetOutput) SetActiveFromTimestamp(v time.Time) *GetKxChangesetOutput

SetActiveFromTimestamp sets the ActiveFromTimestamp field's value.

func (*GetKxChangesetOutput) SetChangeRequests added in v1.44.276 

func (s *GetKxChangesetOutput) SetChangeRequests(v []*ChangeRequest) *GetKxChangesetOutput

SetChangeRequests sets the ChangeRequests field's value.

func (*GetKxChangesetOutput) SetChangesetId added in v1.44.276 

func (s *GetKxChangesetOutput) SetChangesetId(v string) *GetKxChangesetOutput

SetChangesetId sets the ChangesetId field's value.

func (*GetKxChangesetOutput) SetCreatedTimestamp added in v1.44.276 

func (s *GetKxChangesetOutput) SetCreatedTimestamp(v time.Time) *GetKxChangesetOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*GetKxChangesetOutput) SetDatabaseName added in v1.44.276 

func (s *GetKxChangesetOutput) SetDatabaseName(v string) *GetKxChangesetOutput

SetDatabaseName sets the DatabaseName field's value.

func (*GetKxChangesetOutput) SetEnvironmentId added in v1.44.276 

func (s *GetKxChangesetOutput) SetEnvironmentId(v string) *GetKxChangesetOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*GetKxChangesetOutput) SetErrorInfo added in v1.44.276 

func (s *GetKxChangesetOutput) SetErrorInfo(v *ErrorInfo) *GetKxChangesetOutput

SetErrorInfo sets the ErrorInfo field's value.

func (*GetKxChangesetOutput) SetLastModifiedTimestamp added in v1.44.276 

func (s *GetKxChangesetOutput) SetLastModifiedTimestamp(v time.Time) *GetKxChangesetOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*GetKxChangesetOutput) SetStatus added in v1.44.276 

func (s *GetKxChangesetOutput) SetStatus(v string) *GetKxChangesetOutput

SetStatus sets the Status field's value.

func (GetKxChangesetOutput) String added in v1.44.276 

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 added in v1.44.276 

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 (GetKxClusterInput) GoString added in v1.44.276 

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 (*GetKxClusterInput) SetClusterName added in v1.44.276 

func (s *GetKxClusterInput) SetClusterName(v string) *GetKxClusterInput

SetClusterName sets the ClusterName field's value.

func (*GetKxClusterInput) SetEnvironmentId added in v1.44.276 

func (s *GetKxClusterInput) SetEnvironmentId(v string) *GetKxClusterInput

SetEnvironmentId sets the EnvironmentId field's value.

func (GetKxClusterInput) String added in v1.44.276 

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 (*GetKxClusterInput) Validate added in v1.44.276 

func (s *GetKxClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKxClusterOutput added in v1.44.276 

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" 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.
	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 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"`

	// 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 (GetKxClusterOutput) GoString added in v1.44.276 

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 (*GetKxClusterOutput) SetAutoScalingConfiguration added in v1.44.276 

func (s *GetKxClusterOutput) SetAutoScalingConfiguration(v *AutoScalingConfiguration) *GetKxClusterOutput

SetAutoScalingConfiguration sets the AutoScalingConfiguration field's value.

func (*GetKxClusterOutput) SetAvailabilityZoneId added in v1.44.276 

func (s *GetKxClusterOutput) SetAvailabilityZoneId(v string) *GetKxClusterOutput

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*GetKxClusterOutput) SetAzMode added in v1.44.276 

func (s *GetKxClusterOutput) SetAzMode(v string) *GetKxClusterOutput

SetAzMode sets the AzMode field's value.

func (*GetKxClusterOutput) SetCacheStorageConfigurations added in v1.44.276 

func (s *GetKxClusterOutput) SetCacheStorageConfigurations(v []*KxCacheStorageConfiguration) *GetKxClusterOutput

SetCacheStorageConfigurations sets the CacheStorageConfigurations field's value.

func (*GetKxClusterOutput) SetCapacityConfiguration added in v1.44.276 

func (s *GetKxClusterOutput) SetCapacityConfiguration(v *CapacityConfiguration) *GetKxClusterOutput

SetCapacityConfiguration sets the CapacityConfiguration field's value.

func (*GetKxClusterOutput) SetClusterDescription added in v1.44.276 

func (s *GetKxClusterOutput) SetClusterDescription(v string) *GetKxClusterOutput

SetClusterDescription sets the ClusterDescription field's value.

func (*GetKxClusterOutput) SetClusterName added in v1.44.276 

func (s *GetKxClusterOutput) SetClusterName(v string) *GetKxClusterOutput

SetClusterName sets the ClusterName field's value.

func (*GetKxClusterOutput) SetClusterType added in v1.44.276 

func (s *GetKxClusterOutput) SetClusterType(v string) *GetKxClusterOutput

SetClusterType sets the ClusterType field's value.

func (*GetKxClusterOutput) SetCode added in v1.44.276 

func (s *GetKxClusterOutput) SetCode(v *CodeConfiguration) *GetKxClusterOutput

SetCode sets the Code field's value.

func (*GetKxClusterOutput) SetCommandLineArguments added in v1.44.276 

func (s *GetKxClusterOutput) SetCommandLineArguments(v []*KxCommandLineArgument) *GetKxClusterOutput

SetCommandLineArguments sets the CommandLineArguments field's value.

func (*GetKxClusterOutput) SetCreatedTimestamp added in v1.44.276 

func (s *GetKxClusterOutput) SetCreatedTimestamp(v time.Time) *GetKxClusterOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*GetKxClusterOutput) SetDatabases added in v1.44.276 

func (s *GetKxClusterOutput) SetDatabases(v []*KxDatabaseConfiguration) *GetKxClusterOutput

SetDatabases sets the Databases field's value.

func (*GetKxClusterOutput) SetExecutionRole added in v1.44.276 

func (s *GetKxClusterOutput) SetExecutionRole(v string) *GetKxClusterOutput

SetExecutionRole sets the ExecutionRole field's value.

func (*GetKxClusterOutput) SetInitializationScript added in v1.44.276 

func (s *GetKxClusterOutput) SetInitializationScript(v string) *GetKxClusterOutput

SetInitializationScript sets the InitializationScript field's value.

func (*GetKxClusterOutput) SetLastModifiedTimestamp added in v1.44.276 

func (s *GetKxClusterOutput) SetLastModifiedTimestamp(v time.Time) *GetKxClusterOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*GetKxClusterOutput) SetReleaseLabel added in v1.44.276 

func (s *GetKxClusterOutput) SetReleaseLabel(v string) *GetKxClusterOutput

SetReleaseLabel sets the ReleaseLabel field's value.

func (*GetKxClusterOutput) SetSavedownStorageConfiguration added in v1.44.276 

func (s *GetKxClusterOutput) SetSavedownStorageConfiguration(v *KxSavedownStorageConfiguration) *GetKxClusterOutput

SetSavedownStorageConfiguration sets the SavedownStorageConfiguration field's value.

func (*GetKxClusterOutput) SetStatus added in v1.44.276 

func (s *GetKxClusterOutput) SetStatus(v string) *GetKxClusterOutput

SetStatus sets the Status field's value.

func (*GetKxClusterOutput) SetStatusReason added in v1.44.276 

func (s *GetKxClusterOutput) SetStatusReason(v string) *GetKxClusterOutput

SetStatusReason sets the StatusReason field's value.

func (*GetKxClusterOutput) SetVpcConfiguration added in v1.44.276 

func (s *GetKxClusterOutput) SetVpcConfiguration(v *VpcConfiguration) *GetKxClusterOutput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (GetKxClusterOutput) String added in v1.44.276 

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 added in v1.44.276 

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 (GetKxConnectionStringInput) GoString added in v1.44.276 

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 (*GetKxConnectionStringInput) SetClusterName added in v1.44.276 

func (s *GetKxConnectionStringInput) SetClusterName(v string) *GetKxConnectionStringInput

SetClusterName sets the ClusterName field's value.

func (*GetKxConnectionStringInput) SetEnvironmentId added in v1.44.276 

func (s *GetKxConnectionStringInput) SetEnvironmentId(v string) *GetKxConnectionStringInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*GetKxConnectionStringInput) SetUserArn added in v1.44.276 

func (s *GetKxConnectionStringInput) SetUserArn(v string) *GetKxConnectionStringInput

SetUserArn sets the UserArn field's value.

func (GetKxConnectionStringInput) String added in v1.44.276 

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 (*GetKxConnectionStringInput) Validate added in v1.44.276 

func (s *GetKxConnectionStringInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKxConnectionStringOutput added in v1.44.276 

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 (GetKxConnectionStringOutput) GoString added in v1.44.276 

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 (*GetKxConnectionStringOutput) SetSignedConnectionString added in v1.44.276 

func (s *GetKxConnectionStringOutput) SetSignedConnectionString(v string) *GetKxConnectionStringOutput

SetSignedConnectionString sets the SignedConnectionString field's value.

func (GetKxConnectionStringOutput) String added in v1.44.276 

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 added in v1.44.276 

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 (GetKxDatabaseInput) GoString added in v1.44.276 

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 (*GetKxDatabaseInput) SetDatabaseName added in v1.44.276 

func (s *GetKxDatabaseInput) SetDatabaseName(v string) *GetKxDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (*GetKxDatabaseInput) SetEnvironmentId added in v1.44.276 

func (s *GetKxDatabaseInput) SetEnvironmentId(v string) *GetKxDatabaseInput

SetEnvironmentId sets the EnvironmentId field's value.

func (GetKxDatabaseInput) String added in v1.44.276 

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 (*GetKxDatabaseInput) Validate added in v1.44.276 

func (s *GetKxDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKxDatabaseOutput added in v1.44.276 

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 (GetKxDatabaseOutput) GoString added in v1.44.276 

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 (*GetKxDatabaseOutput) SetCreatedTimestamp added in v1.44.276 

func (s *GetKxDatabaseOutput) SetCreatedTimestamp(v time.Time) *GetKxDatabaseOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*GetKxDatabaseOutput) SetDatabaseArn added in v1.44.276 

func (s *GetKxDatabaseOutput) SetDatabaseArn(v string) *GetKxDatabaseOutput

SetDatabaseArn sets the DatabaseArn field's value.

func (*GetKxDatabaseOutput) SetDatabaseName added in v1.44.276 

func (s *GetKxDatabaseOutput) SetDatabaseName(v string) *GetKxDatabaseOutput

SetDatabaseName sets the DatabaseName field's value.

func (*GetKxDatabaseOutput) SetDescription added in v1.44.276 

func (s *GetKxDatabaseOutput) SetDescription(v string) *GetKxDatabaseOutput

SetDescription sets the Description field's value.

func (*GetKxDatabaseOutput) SetEnvironmentId added in v1.44.276 

func (s *GetKxDatabaseOutput) SetEnvironmentId(v string) *GetKxDatabaseOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*GetKxDatabaseOutput) SetLastCompletedChangesetId added in v1.44.276 

func (s *GetKxDatabaseOutput) SetLastCompletedChangesetId(v string) *GetKxDatabaseOutput

SetLastCompletedChangesetId sets the LastCompletedChangesetId field's value.

func (*GetKxDatabaseOutput) SetLastModifiedTimestamp added in v1.44.276 

func (s *GetKxDatabaseOutput) SetLastModifiedTimestamp(v time.Time) *GetKxDatabaseOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*GetKxDatabaseOutput) SetNumBytes added in v1.44.276 

func (s *GetKxDatabaseOutput) SetNumBytes(v int64) *GetKxDatabaseOutput

SetNumBytes sets the NumBytes field's value.

func (*GetKxDatabaseOutput) SetNumChangesets added in v1.44.276 

func (s *GetKxDatabaseOutput) SetNumChangesets(v int64) *GetKxDatabaseOutput

SetNumChangesets sets the NumChangesets field's value.

func (*GetKxDatabaseOutput) SetNumFiles added in v1.44.276 

func (s *GetKxDatabaseOutput) SetNumFiles(v int64) *GetKxDatabaseOutput

SetNumFiles sets the NumFiles field's value.

func (GetKxDatabaseOutput) String added in v1.44.276 

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 GetKxEnvironmentInput added in v1.44.276 

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 (GetKxEnvironmentInput) GoString added in v1.44.276 

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 (*GetKxEnvironmentInput) SetEnvironmentId added in v1.44.276 

func (s *GetKxEnvironmentInput) SetEnvironmentId(v string) *GetKxEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (GetKxEnvironmentInput) String added in v1.44.276 

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 (*GetKxEnvironmentInput) Validate added in v1.44.276 

func (s *GetKxEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKxEnvironmentOutput added in v1.44.276 

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 (GetKxEnvironmentOutput) GoString added in v1.44.276 

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 (*GetKxEnvironmentOutput) SetAvailabilityZoneIds added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetAvailabilityZoneIds(v []*string) *GetKxEnvironmentOutput

SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.

func (*GetKxEnvironmentOutput) SetAwsAccountId added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetAwsAccountId(v string) *GetKxEnvironmentOutput

SetAwsAccountId sets the AwsAccountId field's value.

func (*GetKxEnvironmentOutput) SetCertificateAuthorityArn added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetCertificateAuthorityArn(v string) *GetKxEnvironmentOutput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*GetKxEnvironmentOutput) SetCreationTimestamp added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetCreationTimestamp(v time.Time) *GetKxEnvironmentOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*GetKxEnvironmentOutput) SetCustomDNSConfiguration added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetCustomDNSConfiguration(v []*CustomDNSServer) *GetKxEnvironmentOutput

SetCustomDNSConfiguration sets the CustomDNSConfiguration field's value.

func (*GetKxEnvironmentOutput) SetDedicatedServiceAccountId added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetDedicatedServiceAccountId(v string) *GetKxEnvironmentOutput

SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.

func (*GetKxEnvironmentOutput) SetDescription added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetDescription(v string) *GetKxEnvironmentOutput

SetDescription sets the Description field's value.

func (*GetKxEnvironmentOutput) SetDnsStatus added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetDnsStatus(v string) *GetKxEnvironmentOutput

SetDnsStatus sets the DnsStatus field's value.

func (*GetKxEnvironmentOutput) SetEnvironmentArn added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetEnvironmentArn(v string) *GetKxEnvironmentOutput

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*GetKxEnvironmentOutput) SetEnvironmentId added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetEnvironmentId(v string) *GetKxEnvironmentOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*GetKxEnvironmentOutput) SetErrorMessage added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetErrorMessage(v string) *GetKxEnvironmentOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*GetKxEnvironmentOutput) SetKmsKeyId added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetKmsKeyId(v string) *GetKxEnvironmentOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*GetKxEnvironmentOutput) SetName added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetName(v string) *GetKxEnvironmentOutput

SetName sets the Name field's value.

func (*GetKxEnvironmentOutput) SetStatus added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetStatus(v string) *GetKxEnvironmentOutput

SetStatus sets the Status field's value.

func (*GetKxEnvironmentOutput) SetTgwStatus added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetTgwStatus(v string) *GetKxEnvironmentOutput

SetTgwStatus sets the TgwStatus field's value.

func (*GetKxEnvironmentOutput) SetTransitGatewayConfiguration added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetTransitGatewayConfiguration(v *TransitGatewayConfiguration) *GetKxEnvironmentOutput

SetTransitGatewayConfiguration sets the TransitGatewayConfiguration field's value.

func (*GetKxEnvironmentOutput) SetUpdateTimestamp added in v1.44.276 

func (s *GetKxEnvironmentOutput) SetUpdateTimestamp(v time.Time) *GetKxEnvironmentOutput

SetUpdateTimestamp sets the UpdateTimestamp field's value.

func (GetKxEnvironmentOutput) String added in v1.44.276 

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 GetKxUserInput added in v1.44.276 

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 (GetKxUserInput) GoString added in v1.44.276 

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 (*GetKxUserInput) SetEnvironmentId added in v1.44.276 

func (s *GetKxUserInput) SetEnvironmentId(v string) *GetKxUserInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*GetKxUserInput) SetUserName added in v1.44.276 

func (s *GetKxUserInput) SetUserName(v string) *GetKxUserInput

SetUserName sets the UserName field's value.

func (GetKxUserInput) String added in v1.44.276 

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 (*GetKxUserInput) Validate added in v1.44.276 

func (s *GetKxUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKxUserOutput added in v1.44.276 

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 (GetKxUserOutput) GoString added in v1.44.276 

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 (*GetKxUserOutput) SetEnvironmentId added in v1.44.276 

func (s *GetKxUserOutput) SetEnvironmentId(v string) *GetKxUserOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*GetKxUserOutput) SetIamRole added in v1.44.276 

func (s *GetKxUserOutput) SetIamRole(v string) *GetKxUserOutput

SetIamRole sets the IamRole field's value.

func (*GetKxUserOutput) SetUserArn added in v1.44.276 

func (s *GetKxUserOutput) SetUserArn(v string) *GetKxUserOutput

SetUserArn sets the UserArn field's value.

func (*GetKxUserOutput) SetUserName added in v1.44.276 

func (s *GetKxUserOutput) SetUserName(v string) *GetKxUserOutput

SetUserName sets the UserName field's value.

func (GetKxUserOutput) String added in v1.44.276 

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 IcmpTypeCode added in v1.44.328 

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 (IcmpTypeCode) GoString added in v1.44.328 

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 (*IcmpTypeCode) SetCode added in v1.44.328 

func (s *IcmpTypeCode) SetCode(v int64) *IcmpTypeCode

SetCode sets the Code field's value.

func (*IcmpTypeCode) SetType added in v1.44.328 

func (s *IcmpTypeCode) SetType(v int64) *IcmpTypeCode

SetType sets the Type field's value.

func (IcmpTypeCode) String added in v1.44.328 

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 (*IcmpTypeCode) Validate added in v1.44.328 

func (s *IcmpTypeCode) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServerException 

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 (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

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 (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

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 

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 (*InvalidRequestException) Code 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString 

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 (*InvalidRequestException) Message 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String 

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 KxCacheStorageConfiguration added in v1.44.276 

type KxCacheStorageConfiguration struct {

	// The size of cache in Gigabytes.
	//
	// Size is a required field
	Size *int64 `locationName:"size" min:"1200" 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.
	//
	// 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 (KxCacheStorageConfiguration) GoString added in v1.44.276 

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 (*KxCacheStorageConfiguration) SetSize added in v1.44.276 

func (s *KxCacheStorageConfiguration) SetSize(v int64) *KxCacheStorageConfiguration

SetSize sets the Size field's value.

func (*KxCacheStorageConfiguration) SetType added in v1.44.276 

func (s *KxCacheStorageConfiguration) SetType(v string) *KxCacheStorageConfiguration

SetType sets the Type field's value.

func (KxCacheStorageConfiguration) String added in v1.44.276 

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 (*KxCacheStorageConfiguration) Validate added in v1.44.276 

func (s *KxCacheStorageConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KxChangesetListEntry added in v1.44.276 

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 (KxChangesetListEntry) GoString added in v1.44.276 

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 (*KxChangesetListEntry) SetActiveFromTimestamp added in v1.44.276 

func (s *KxChangesetListEntry) SetActiveFromTimestamp(v time.Time) *KxChangesetListEntry

SetActiveFromTimestamp sets the ActiveFromTimestamp field's value.

func (*KxChangesetListEntry) SetChangesetId added in v1.44.276 

func (s *KxChangesetListEntry) SetChangesetId(v string) *KxChangesetListEntry

SetChangesetId sets the ChangesetId field's value.

func (*KxChangesetListEntry) SetCreatedTimestamp added in v1.44.276 

func (s *KxChangesetListEntry) SetCreatedTimestamp(v time.Time) *KxChangesetListEntry

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*KxChangesetListEntry) SetLastModifiedTimestamp added in v1.44.276 

func (s *KxChangesetListEntry) SetLastModifiedTimestamp(v time.Time) *KxChangesetListEntry

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*KxChangesetListEntry) SetStatus added in v1.44.276 

func (s *KxChangesetListEntry) SetStatus(v string) *KxChangesetListEntry

SetStatus sets the Status field's value.

func (KxChangesetListEntry) String added in v1.44.276 

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 added in v1.44.276 

type KxCluster struct {

	// The availability zone identifiers for the requested regions.
	AvailabilityZoneId *string `locationName:"availabilityZoneId" 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.
	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"`
	// contains filtered or unexported fields
}

The details of a kdb cluster.

func (KxCluster) GoString added in v1.44.276 

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 (*KxCluster) SetAvailabilityZoneId added in v1.44.276 

func (s *KxCluster) SetAvailabilityZoneId(v string) *KxCluster

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*KxCluster) SetAzMode added in v1.44.276 

func (s *KxCluster) SetAzMode(v string) *KxCluster

SetAzMode sets the AzMode field's value.

func (*KxCluster) SetClusterDescription added in v1.44.276 

func (s *KxCluster) SetClusterDescription(v string) *KxCluster

SetClusterDescription sets the ClusterDescription field's value.

func (*KxCluster) SetClusterName added in v1.44.276 

func (s *KxCluster) SetClusterName(v string) *KxCluster

SetClusterName sets the ClusterName field's value.

func (*KxCluster) SetClusterType added in v1.44.276 

func (s *KxCluster) SetClusterType(v string) *KxCluster

SetClusterType sets the ClusterType field's value.

func (*KxCluster) SetCreatedTimestamp added in v1.44.276 

func (s *KxCluster) SetCreatedTimestamp(v time.Time) *KxCluster

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*KxCluster) SetExecutionRole added in v1.44.276 

func (s *KxCluster) SetExecutionRole(v string) *KxCluster

SetExecutionRole sets the ExecutionRole field's value.

func (*KxCluster) SetInitializationScript added in v1.44.276 

func (s *KxCluster) SetInitializationScript(v string) *KxCluster

SetInitializationScript sets the InitializationScript field's value.

func (*KxCluster) SetLastModifiedTimestamp added in v1.44.276 

func (s *KxCluster) SetLastModifiedTimestamp(v time.Time) *KxCluster

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*KxCluster) SetReleaseLabel added in v1.44.276 

func (s *KxCluster) SetReleaseLabel(v string) *KxCluster

SetReleaseLabel sets the ReleaseLabel field's value.

func (*KxCluster) SetStatus added in v1.44.276 

func (s *KxCluster) SetStatus(v string) *KxCluster

SetStatus sets the Status field's value.

func (*KxCluster) SetStatusReason added in v1.44.276 

func (s *KxCluster) SetStatusReason(v string) *KxCluster

SetStatusReason sets the StatusReason field's value.

func (KxCluster) String added in v1.44.276 

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 KxCommandLineArgument added in v1.44.276 

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 (KxCommandLineArgument) GoString added in v1.44.276 

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 (*KxCommandLineArgument) SetKey added in v1.44.276 

func (s *KxCommandLineArgument) SetKey(v string) *KxCommandLineArgument

SetKey sets the Key field's value.

func (*KxCommandLineArgument) SetValue added in v1.44.276 

func (s *KxCommandLineArgument) SetValue(v string) *KxCommandLineArgument

SetValue sets the Value field's value.

func (KxCommandLineArgument) String added in v1.44.276 

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 (*KxCommandLineArgument) Validate added in v1.44.276 

func (s *KxCommandLineArgument) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KxDatabaseCacheConfiguration added in v1.44.276 

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"`

	// 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 (KxDatabaseCacheConfiguration) GoString added in v1.44.276 

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 (*KxDatabaseCacheConfiguration) SetCacheType added in v1.44.276 

func (s *KxDatabaseCacheConfiguration) SetCacheType(v string) *KxDatabaseCacheConfiguration

SetCacheType sets the CacheType field's value.

func (*KxDatabaseCacheConfiguration) SetDbPaths added in v1.44.276 

func (s *KxDatabaseCacheConfiguration) SetDbPaths(v []*string) *KxDatabaseCacheConfiguration

SetDbPaths sets the DbPaths field's value.

func (KxDatabaseCacheConfiguration) String added in v1.44.276 

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 (*KxDatabaseCacheConfiguration) Validate added in v1.44.276 

func (s *KxDatabaseCacheConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KxDatabaseConfiguration added in v1.44.276 

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"`
	// contains filtered or unexported fields
}

The configuration of data that is available for querying from this database.

func (KxDatabaseConfiguration) GoString added in v1.44.276 

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 (*KxDatabaseConfiguration) SetCacheConfigurations added in v1.44.276 

func (s *KxDatabaseConfiguration) SetCacheConfigurations(v []*KxDatabaseCacheConfiguration) *KxDatabaseConfiguration

SetCacheConfigurations sets the CacheConfigurations field's value.

func (*KxDatabaseConfiguration) SetChangesetId added in v1.44.276 

func (s *KxDatabaseConfiguration) SetChangesetId(v string) *KxDatabaseConfiguration

SetChangesetId sets the ChangesetId field's value.

func (*KxDatabaseConfiguration) SetDatabaseName added in v1.44.276 

func (s *KxDatabaseConfiguration) SetDatabaseName(v string) *KxDatabaseConfiguration

SetDatabaseName sets the DatabaseName field's value.

func (KxDatabaseConfiguration) String added in v1.44.276 

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 (*KxDatabaseConfiguration) Validate added in v1.44.276 

func (s *KxDatabaseConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KxDatabaseListEntry added in v1.44.276 

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 (KxDatabaseListEntry) GoString added in v1.44.276 

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 (*KxDatabaseListEntry) SetCreatedTimestamp added in v1.44.276 

func (s *KxDatabaseListEntry) SetCreatedTimestamp(v time.Time) *KxDatabaseListEntry

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*KxDatabaseListEntry) SetDatabaseName added in v1.44.276 

func (s *KxDatabaseListEntry) SetDatabaseName(v string) *KxDatabaseListEntry

SetDatabaseName sets the DatabaseName field's value.

func (*KxDatabaseListEntry) SetLastModifiedTimestamp added in v1.44.276 

func (s *KxDatabaseListEntry) SetLastModifiedTimestamp(v time.Time) *KxDatabaseListEntry

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (KxDatabaseListEntry) String added in v1.44.276 

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 KxDeploymentConfiguration added in v1.44.328 

type KxDeploymentConfiguration struct {

	// The type of deployment that you want on a cluster.
	//
	//    * ROLLING – This options loads the updated database by stopping the
	//    exiting q process and starting a new q process with updated configuration.
	//
	//    * NO_RESTART – This option loads the updated database on the running
	//    q process without stopping it. This option is quicker as it reduces the
	//    turn around time to update a kdb database changeset configuration on a
	//    cluster.
	//
	// 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 database changesets on to a cluster.

func (KxDeploymentConfiguration) GoString added in v1.44.328 

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 (*KxDeploymentConfiguration) SetDeploymentStrategy added in v1.44.328 

func (s *KxDeploymentConfiguration) SetDeploymentStrategy(v string) *KxDeploymentConfiguration

SetDeploymentStrategy sets the DeploymentStrategy field's value.

func (KxDeploymentConfiguration) String added in v1.44.328 

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 (*KxDeploymentConfiguration) Validate added in v1.44.328 

func (s *KxDeploymentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KxEnvironment added in v1.44.276 

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 (KxEnvironment) GoString added in v1.44.276 

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 (*KxEnvironment) SetAvailabilityZoneIds added in v1.44.276 

func (s *KxEnvironment) SetAvailabilityZoneIds(v []*string) *KxEnvironment

SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.

func (*KxEnvironment) SetAwsAccountId added in v1.44.276 

func (s *KxEnvironment) SetAwsAccountId(v string) *KxEnvironment

SetAwsAccountId sets the AwsAccountId field's value.

func (*KxEnvironment) SetCertificateAuthorityArn added in v1.44.276 

func (s *KxEnvironment) SetCertificateAuthorityArn(v string) *KxEnvironment

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*KxEnvironment) SetCreationTimestamp added in v1.44.276 

func (s *KxEnvironment) SetCreationTimestamp(v time.Time) *KxEnvironment

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*KxEnvironment) SetCustomDNSConfiguration added in v1.44.276 

func (s *KxEnvironment) SetCustomDNSConfiguration(v []*CustomDNSServer) *KxEnvironment

SetCustomDNSConfiguration sets the CustomDNSConfiguration field's value.

func (*KxEnvironment) SetDedicatedServiceAccountId added in v1.44.276 

func (s *KxEnvironment) SetDedicatedServiceAccountId(v string) *KxEnvironment

SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.

func (*KxEnvironment) SetDescription added in v1.44.276 

func (s *KxEnvironment) SetDescription(v string) *KxEnvironment

SetDescription sets the Description field's value.

func (*KxEnvironment) SetDnsStatus added in v1.44.276 

func (s *KxEnvironment) SetDnsStatus(v string) *KxEnvironment

SetDnsStatus sets the DnsStatus field's value.

func (*KxEnvironment) SetEnvironmentArn added in v1.44.276 

func (s *KxEnvironment) SetEnvironmentArn(v string) *KxEnvironment

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*KxEnvironment) SetEnvironmentId added in v1.44.276 

func (s *KxEnvironment) SetEnvironmentId(v string) *KxEnvironment

SetEnvironmentId sets the EnvironmentId field's value.

func (*KxEnvironment) SetErrorMessage added in v1.44.276 

func (s *KxEnvironment) SetErrorMessage(v string) *KxEnvironment

SetErrorMessage sets the ErrorMessage field's value.

func (*KxEnvironment) SetKmsKeyId added in v1.44.276 

func (s *KxEnvironment) SetKmsKeyId(v string) *KxEnvironment

SetKmsKeyId sets the KmsKeyId field's value.

func (*KxEnvironment) SetName added in v1.44.276 

func (s *KxEnvironment) SetName(v string) *KxEnvironment

SetName sets the Name field's value.

func (*KxEnvironment) SetStatus added in v1.44.276 

func (s *KxEnvironment) SetStatus(v string) *KxEnvironment

SetStatus sets the Status field's value.

func (*KxEnvironment) SetTgwStatus added in v1.44.276 

func (s *KxEnvironment) SetTgwStatus(v string) *KxEnvironment

SetTgwStatus sets the TgwStatus field's value.

func (*KxEnvironment) SetTransitGatewayConfiguration added in v1.44.276 

func (s *KxEnvironment) SetTransitGatewayConfiguration(v *TransitGatewayConfiguration) *KxEnvironment

SetTransitGatewayConfiguration sets the TransitGatewayConfiguration field's value.

func (*KxEnvironment) SetUpdateTimestamp added in v1.44.276 

func (s *KxEnvironment) SetUpdateTimestamp(v time.Time) *KxEnvironment

SetUpdateTimestamp sets the UpdateTimestamp field's value.

func (KxEnvironment) String added in v1.44.276 

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 KxNode added in v1.44.276 

type KxNode struct {

	// The identifier of the availability zones where subnets for the environment
	// are created.
	AvailabilityZoneId *string `locationName:"availabilityZoneId" 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"`
	// contains filtered or unexported fields
}

A structure that stores metadata for a kdb node.

func (KxNode) GoString added in v1.44.276 

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 (*KxNode) SetAvailabilityZoneId added in v1.44.276 

func (s *KxNode) SetAvailabilityZoneId(v string) *KxNode

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*KxNode) SetLaunchTime added in v1.44.276 

func (s *KxNode) SetLaunchTime(v time.Time) *KxNode

SetLaunchTime sets the LaunchTime field's value.

func (*KxNode) SetNodeId added in v1.44.276 

func (s *KxNode) SetNodeId(v string) *KxNode

SetNodeId sets the NodeId field's value.

func (KxNode) String added in v1.44.276 

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 added in v1.44.276 

type KxSavedownStorageConfiguration struct {

	// The size of temporary storage in gibibytes.
	//
	// Size is a required field
	Size *int64 `locationName:"size" min:"4" type:"integer" required:"true"`

	// 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 is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"KxSavedownStorageType"`
	// 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 (KxSavedownStorageConfiguration) GoString added in v1.44.276 

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 (*KxSavedownStorageConfiguration) SetSize added in v1.44.276 

func (s *KxSavedownStorageConfiguration) SetSize(v int64) *KxSavedownStorageConfiguration

SetSize sets the Size field's value.

func (*KxSavedownStorageConfiguration) SetType added in v1.44.276 

func (s *KxSavedownStorageConfiguration) SetType(v string) *KxSavedownStorageConfiguration

SetType sets the Type field's value.

func (KxSavedownStorageConfiguration) String added in v1.44.276 

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 (*KxSavedownStorageConfiguration) Validate added in v1.44.276 

func (s *KxSavedownStorageConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KxUser added in v1.44.276 

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 (KxUser) GoString added in v1.44.276 

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 (*KxUser) SetCreateTimestamp added in v1.44.276 

func (s *KxUser) SetCreateTimestamp(v time.Time) *KxUser

SetCreateTimestamp sets the CreateTimestamp field's value.

func (*KxUser) SetIamRole added in v1.44.276 

func (s *KxUser) SetIamRole(v string) *KxUser

SetIamRole sets the IamRole field's value.

func (*KxUser) SetUpdateTimestamp added in v1.44.276 

func (s *KxUser) SetUpdateTimestamp(v time.Time) *KxUser

SetUpdateTimestamp sets the UpdateTimestamp field's value.

func (*KxUser) SetUserArn added in v1.44.276 

func (s *KxUser) SetUserArn(v string) *KxUser

SetUserArn sets the UserArn field's value.

func (*KxUser) SetUserName added in v1.44.276 

func (s *KxUser) SetUserName(v string) *KxUser

SetUserName sets the UserName field's value.

func (KxUser) String added in v1.44.276 

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 LimitExceededException 

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 (*LimitExceededException) Code 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

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 (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String 

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 

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 (ListEnvironmentsInput) GoString 

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 (*ListEnvironmentsInput) SetMaxResults 

func (s *ListEnvironmentsInput) SetMaxResults(v int64) *ListEnvironmentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEnvironmentsInput) SetNextToken 

func (s *ListEnvironmentsInput) SetNextToken(v string) *ListEnvironmentsInput

SetNextToken sets the NextToken field's value.

func (ListEnvironmentsInput) String 

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 (*ListEnvironmentsInput) Validate 

func (s *ListEnvironmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEnvironmentsOutput 

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 (ListEnvironmentsOutput) GoString 

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 (*ListEnvironmentsOutput) SetEnvironments 

func (s *ListEnvironmentsOutput) SetEnvironments(v []*Environment) *ListEnvironmentsOutput

SetEnvironments sets the Environments field's value.

func (*ListEnvironmentsOutput) SetNextToken 

func (s *ListEnvironmentsOutput) SetNextToken(v string) *ListEnvironmentsOutput

SetNextToken sets the NextToken field's value.

func (ListEnvironmentsOutput) String 

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 added in v1.44.276 

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 (ListKxChangesetsInput) GoString added in v1.44.276 

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 (*ListKxChangesetsInput) SetDatabaseName added in v1.44.276 

func (s *ListKxChangesetsInput) SetDatabaseName(v string) *ListKxChangesetsInput

SetDatabaseName sets the DatabaseName field's value.

func (*ListKxChangesetsInput) SetEnvironmentId added in v1.44.276 

func (s *ListKxChangesetsInput) SetEnvironmentId(v string) *ListKxChangesetsInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*ListKxChangesetsInput) SetMaxResults added in v1.44.276 

func (s *ListKxChangesetsInput) SetMaxResults(v int64) *ListKxChangesetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListKxChangesetsInput) SetNextToken added in v1.44.276 

func (s *ListKxChangesetsInput) SetNextToken(v string) *ListKxChangesetsInput

SetNextToken sets the NextToken field's value.

func (ListKxChangesetsInput) String added in v1.44.276 

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 (*ListKxChangesetsInput) Validate added in v1.44.276 

func (s *ListKxChangesetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKxChangesetsOutput added in v1.44.276 

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 (ListKxChangesetsOutput) GoString added in v1.44.276 

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 (*ListKxChangesetsOutput) SetKxChangesets added in v1.44.276 

func (s *ListKxChangesetsOutput) SetKxChangesets(v []*KxChangesetListEntry) *ListKxChangesetsOutput

SetKxChangesets sets the KxChangesets field's value.

func (*ListKxChangesetsOutput) SetNextToken added in v1.44.276 

func (s *ListKxChangesetsOutput) SetNextToken(v string) *ListKxChangesetsOutput

SetNextToken sets the NextToken field's value.

func (ListKxChangesetsOutput) String added in v1.44.276 

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 added in v1.44.276 

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 (ListKxClusterNodesInput) GoString added in v1.44.276 

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 (*ListKxClusterNodesInput) SetClusterName added in v1.44.276 

func (s *ListKxClusterNodesInput) SetClusterName(v string) *ListKxClusterNodesInput

SetClusterName sets the ClusterName field's value.

func (*ListKxClusterNodesInput) SetEnvironmentId added in v1.44.276 

func (s *ListKxClusterNodesInput) SetEnvironmentId(v string) *ListKxClusterNodesInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*ListKxClusterNodesInput) SetMaxResults added in v1.44.276 

func (s *ListKxClusterNodesInput) SetMaxResults(v int64) *ListKxClusterNodesInput

SetMaxResults sets the MaxResults field's value.

func (*ListKxClusterNodesInput) SetNextToken added in v1.44.276 

func (s *ListKxClusterNodesInput) SetNextToken(v string) *ListKxClusterNodesInput

SetNextToken sets the NextToken field's value.

func (ListKxClusterNodesInput) String added in v1.44.276 

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 (*ListKxClusterNodesInput) Validate added in v1.44.276 

func (s *ListKxClusterNodesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKxClusterNodesOutput added in v1.44.276 

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 (ListKxClusterNodesOutput) GoString added in v1.44.276 

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 (*ListKxClusterNodesOutput) SetNextToken added in v1.44.276 

func (s *ListKxClusterNodesOutput) SetNextToken(v string) *ListKxClusterNodesOutput

SetNextToken sets the NextToken field's value.

func (*ListKxClusterNodesOutput) SetNodes added in v1.44.276 

func (s *ListKxClusterNodesOutput) SetNodes(v []*KxNode) *ListKxClusterNodesOutput

SetNodes sets the Nodes field's value.

func (ListKxClusterNodesOutput) String added in v1.44.276 

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 added in v1.44.276 

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.
	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 (ListKxClustersInput) GoString added in v1.44.276 

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 (*ListKxClustersInput) SetClusterType added in v1.44.276 

func (s *ListKxClustersInput) SetClusterType(v string) *ListKxClustersInput

SetClusterType sets the ClusterType field's value.

func (*ListKxClustersInput) SetEnvironmentId added in v1.44.276 

func (s *ListKxClustersInput) SetEnvironmentId(v string) *ListKxClustersInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*ListKxClustersInput) SetMaxResults added in v1.44.276 

func (s *ListKxClustersInput) SetMaxResults(v int64) *ListKxClustersInput

SetMaxResults sets the MaxResults field's value.

func (*ListKxClustersInput) SetNextToken added in v1.44.276 

func (s *ListKxClustersInput) SetNextToken(v string) *ListKxClustersInput

SetNextToken sets the NextToken field's value.

func (ListKxClustersInput) String added in v1.44.276 

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 (*ListKxClustersInput) Validate added in v1.44.276 

func (s *ListKxClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKxClustersOutput added in v1.44.276 

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 (ListKxClustersOutput) GoString added in v1.44.276 

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 (*ListKxClustersOutput) SetKxClusterSummaries added in v1.44.276 

func (s *ListKxClustersOutput) SetKxClusterSummaries(v []*KxCluster) *ListKxClustersOutput

SetKxClusterSummaries sets the KxClusterSummaries field's value.

func (*ListKxClustersOutput) SetNextToken added in v1.44.276 

func (s *ListKxClustersOutput) SetNextToken(v string) *ListKxClustersOutput

SetNextToken sets the NextToken field's value.

func (ListKxClustersOutput) String added in v1.44.276 

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 added in v1.44.276 

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 (ListKxDatabasesInput) GoString added in v1.44.276 

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 (*ListKxDatabasesInput) SetEnvironmentId added in v1.44.276 

func (s *ListKxDatabasesInput) SetEnvironmentId(v string) *ListKxDatabasesInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*ListKxDatabasesInput) SetMaxResults added in v1.44.276 

func (s *ListKxDatabasesInput) SetMaxResults(v int64) *ListKxDatabasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListKxDatabasesInput) SetNextToken added in v1.44.276 

func (s *ListKxDatabasesInput) SetNextToken(v string) *ListKxDatabasesInput

SetNextToken sets the NextToken field's value.

func (ListKxDatabasesInput) String added in v1.44.276 

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 (*ListKxDatabasesInput) Validate added in v1.44.276 

func (s *ListKxDatabasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKxDatabasesOutput added in v1.44.276 

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 (ListKxDatabasesOutput) GoString added in v1.44.276 

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 (*ListKxDatabasesOutput) SetKxDatabases added in v1.44.276 

func (s *ListKxDatabasesOutput) SetKxDatabases(v []*KxDatabaseListEntry) *ListKxDatabasesOutput

SetKxDatabases sets the KxDatabases field's value.

func (*ListKxDatabasesOutput) SetNextToken added in v1.44.276 

func (s *ListKxDatabasesOutput) SetNextToken(v string) *ListKxDatabasesOutput

SetNextToken sets the NextToken field's value.

func (ListKxDatabasesOutput) String added in v1.44.276 

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 ListKxEnvironmentsInput added in v1.44.276 

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 (ListKxEnvironmentsInput) GoString added in v1.44.276 

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 (*ListKxEnvironmentsInput) SetMaxResults added in v1.44.276 

func (s *ListKxEnvironmentsInput) SetMaxResults(v int64) *ListKxEnvironmentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListKxEnvironmentsInput) SetNextToken added in v1.44.276 

func (s *ListKxEnvironmentsInput) SetNextToken(v string) *ListKxEnvironmentsInput

SetNextToken sets the NextToken field's value.

func (ListKxEnvironmentsInput) String added in v1.44.276 

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 (*ListKxEnvironmentsInput) Validate added in v1.44.276 

func (s *ListKxEnvironmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKxEnvironmentsOutput added in v1.44.276 

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 (ListKxEnvironmentsOutput) GoString added in v1.44.276 

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 (*ListKxEnvironmentsOutput) SetEnvironments added in v1.44.276 

func (s *ListKxEnvironmentsOutput) SetEnvironments(v []*KxEnvironment) *ListKxEnvironmentsOutput

SetEnvironments sets the Environments field's value.

func (*ListKxEnvironmentsOutput) SetNextToken added in v1.44.276 

func (s *ListKxEnvironmentsOutput) SetNextToken(v string) *ListKxEnvironmentsOutput

SetNextToken sets the NextToken field's value.

func (ListKxEnvironmentsOutput) String added in v1.44.276 

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 ListKxUsersInput added in v1.44.276 

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 (ListKxUsersInput) GoString added in v1.44.276 

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 (*ListKxUsersInput) SetEnvironmentId added in v1.44.276 

func (s *ListKxUsersInput) SetEnvironmentId(v string) *ListKxUsersInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*ListKxUsersInput) SetMaxResults added in v1.44.276 

func (s *ListKxUsersInput) SetMaxResults(v int64) *ListKxUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListKxUsersInput) SetNextToken added in v1.44.276 

func (s *ListKxUsersInput) SetNextToken(v string) *ListKxUsersInput

SetNextToken sets the NextToken field's value.

func (ListKxUsersInput) String added in v1.44.276 

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 (*ListKxUsersInput) Validate added in v1.44.276 

func (s *ListKxUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKxUsersOutput added in v1.44.276 

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 (ListKxUsersOutput) GoString added in v1.44.276 

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 (*ListKxUsersOutput) SetNextToken added in v1.44.276 

func (s *ListKxUsersOutput) SetNextToken(v string) *ListKxUsersOutput

SetNextToken sets the NextToken field's value.

func (*ListKxUsersOutput) SetUsers added in v1.44.276 

func (s *ListKxUsersOutput) SetUsers(v []*KxUser) *ListKxUsersOutput

SetUsers sets the Users field's value.

func (ListKxUsersOutput) String added in v1.44.276 

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 ListTagsForResourceInput 

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 (ListTagsForResourceInput) GoString 

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 (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

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 (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

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 (ListTagsForResourceOutput) GoString 

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 (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

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 added in v1.44.328 

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 (NetworkACLEntry) GoString added in v1.44.328 

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 (*NetworkACLEntry) SetCidrBlock added in v1.44.328 

func (s *NetworkACLEntry) SetCidrBlock(v string) *NetworkACLEntry

SetCidrBlock sets the CidrBlock field's value.

func (*NetworkACLEntry) SetIcmpTypeCode added in v1.44.328 

func (s *NetworkACLEntry) SetIcmpTypeCode(v *IcmpTypeCode) *NetworkACLEntry

SetIcmpTypeCode sets the IcmpTypeCode field's value.

func (*NetworkACLEntry) SetPortRange added in v1.44.328 

func (s *NetworkACLEntry) SetPortRange(v *PortRange) *NetworkACLEntry

SetPortRange sets the PortRange field's value.

func (*NetworkACLEntry) SetProtocol added in v1.44.328 

func (s *NetworkACLEntry) SetProtocol(v string) *NetworkACLEntry

SetProtocol sets the Protocol field's value.

func (*NetworkACLEntry) SetRuleAction added in v1.44.328 

func (s *NetworkACLEntry) SetRuleAction(v string) *NetworkACLEntry

SetRuleAction sets the RuleAction field's value.

func (*NetworkACLEntry) SetRuleNumber added in v1.44.328 

func (s *NetworkACLEntry) SetRuleNumber(v int64) *NetworkACLEntry

SetRuleNumber sets the RuleNumber field's value.

func (NetworkACLEntry) String added in v1.44.328 

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 (*NetworkACLEntry) Validate added in v1.44.328 

func (s *NetworkACLEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PortRange added in v1.44.328 

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 (PortRange) GoString added in v1.44.328 

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 (*PortRange) SetFrom added in v1.44.328 

func (s *PortRange) SetFrom(v int64) *PortRange

SetFrom sets the From field's value.

func (*PortRange) SetTo added in v1.44.328 

func (s *PortRange) SetTo(v int64) *PortRange

SetTo sets the To field's value.

func (PortRange) String added in v1.44.328 

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 (*PortRange) Validate added in v1.44.328 

func (s *PortRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceAlreadyExistsException added in v1.44.276 

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 (*ResourceAlreadyExistsException) Code added in v1.44.276 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.44.276 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString added in v1.44.276 

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 (*ResourceAlreadyExistsException) Message added in v1.44.276 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.44.276 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.44.276 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.44.276 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.44.276 

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 

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 (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

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 (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

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 

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 (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

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 (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

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 added in v1.41.17 

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 (SuperuserParameters) GoString added in v1.41.17 

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 (*SuperuserParameters) SetEmailAddress added in v1.41.17 

func (s *SuperuserParameters) SetEmailAddress(v string) *SuperuserParameters

SetEmailAddress sets the EmailAddress field's value.

func (*SuperuserParameters) SetFirstName added in v1.41.17 

func (s *SuperuserParameters) SetFirstName(v string) *SuperuserParameters

SetFirstName sets the FirstName field's value.

func (*SuperuserParameters) SetLastName added in v1.41.17 

func (s *SuperuserParameters) SetLastName(v string) *SuperuserParameters

SetLastName sets the LastName field's value.

func (SuperuserParameters) String added in v1.41.17 

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 (*SuperuserParameters) Validate added in v1.41.17 

func (s *SuperuserParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

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 (TagResourceInput) GoString 

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 (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

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 (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

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 (TagResourceOutput) String 

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 

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 (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

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".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) 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 TransitGatewayConfiguration added in v1.44.276 

type TransitGatewayConfiguration struct {

	// The rules that define how you manage the outbound traffic from kdb network
	// to your internal network.
	AttachmentNetworkAclConfiguration []*NetworkACLEntry `locationName:"attachmentNetworkAclConfiguration" min:"1" type:"list"`

	// The routing CIDR on behalf of kdb environment. It could be any "/26 range
	// in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's
	// transit gateway routing table so that the traffics could be routed to kdb
	// network.
	//
	// RoutableCIDRSpace is a required field
	RoutableCIDRSpace *string `locationName:"routableCIDRSpace" type:"string" required:"true"`

	// The identifier of the transit gateway created by the customer to connect
	// outbound traffics from kdb network to your internal network.
	//
	// TransitGatewayID is a required field
	TransitGatewayID *string `locationName:"transitGatewayID" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (TransitGatewayConfiguration) GoString added in v1.44.276 

func (s TransitGatewayConfiguration) 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 (*TransitGatewayConfiguration) SetAttachmentNetworkAclConfiguration added in v1.44.328 

func (s *TransitGatewayConfiguration) SetAttachmentNetworkAclConfiguration(v []*NetworkACLEntry) *TransitGatewayConfiguration

SetAttachmentNetworkAclConfiguration sets the AttachmentNetworkAclConfiguration field's value.

func (*TransitGatewayConfiguration) SetRoutableCIDRSpace added in v1.44.276 

func (s *TransitGatewayConfiguration) SetRoutableCIDRSpace(v string) *TransitGatewayConfiguration

SetRoutableCIDRSpace sets the RoutableCIDRSpace field's value.

func (*TransitGatewayConfiguration) SetTransitGatewayID added in v1.44.276 

func (s *TransitGatewayConfiguration) SetTransitGatewayID(v string) *TransitGatewayConfiguration

SetTransitGatewayID sets the TransitGatewayID field's value.

func (TransitGatewayConfiguration) String added in v1.44.276 

func (s TransitGatewayConfiguration) 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 (*TransitGatewayConfiguration) Validate added in v1.44.276 

func (s *TransitGatewayConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceInput 

type UntagResourceInput struct {

	// A FinSpace resource from which you want to remove a tag or tags. The value
	// for this parameter is an Amazon Resource Name (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The tag keys (names) of one or more tags to be removed.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) 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 (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) 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 (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) 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 (UntagResourceOutput) String 

func (s UntagResourceOutput) 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 UpdateEnvironmentInput 

type UpdateEnvironmentInput struct {

	// The description of the environment.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The identifier of the FinSpace environment.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"`

	// 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 name of the environment.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateEnvironmentInput) GoString 

func (s UpdateEnvironmentInput) 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 (*UpdateEnvironmentInput) SetDescription 

func (s *UpdateEnvironmentInput) SetDescription(v string) *UpdateEnvironmentInput

SetDescription sets the Description field's value.

func (*UpdateEnvironmentInput) SetEnvironmentId 

func (s *UpdateEnvironmentInput) SetEnvironmentId(v string) *UpdateEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateEnvironmentInput) SetFederationMode 

func (s *UpdateEnvironmentInput) SetFederationMode(v string) *UpdateEnvironmentInput

SetFederationMode sets the FederationMode field's value.

func (*UpdateEnvironmentInput) SetFederationParameters 

func (s *UpdateEnvironmentInput) SetFederationParameters(v *FederationParameters) *UpdateEnvironmentInput

SetFederationParameters sets the FederationParameters field's value.

func (*UpdateEnvironmentInput) SetName 

func (s *UpdateEnvironmentInput) SetName(v string) *UpdateEnvironmentInput

SetName sets the Name field's value.

func (UpdateEnvironmentInput) String 

func (s UpdateEnvironmentInput) 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 (*UpdateEnvironmentInput) Validate 

func (s *UpdateEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEnvironmentOutput 

type UpdateEnvironmentOutput struct {

	// Returns the FinSpace environment object.
	Environment *Environment `locationName:"environment" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateEnvironmentOutput) GoString 

func (s UpdateEnvironmentOutput) 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 (*UpdateEnvironmentOutput) SetEnvironment 

func (s *UpdateEnvironmentOutput) SetEnvironment(v *Environment) *UpdateEnvironmentOutput

SetEnvironment sets the Environment field's value.

func (UpdateEnvironmentOutput) String 

func (s UpdateEnvironmentOutput) 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 UpdateKxClusterDatabasesInput added in v1.44.276 

type UpdateKxClusterDatabasesInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A unique name for the cluster that you want to modify.
	//
	// ClusterName is a required field
	ClusterName *string `location:"uri" locationName:"clusterName" min:"3" type:"string" required:"true"`

	// The structure of databases mounted on the cluster.
	//
	// Databases is a required field
	Databases []*KxDatabaseConfiguration `locationName:"databases" type:"list" required:"true"`

	// The configuration that allows you to choose how you want to update the databases
	// on a cluster.
	DeploymentConfiguration *KxDeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"`

	// The unique identifier of a 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 (UpdateKxClusterDatabasesInput) GoString added in v1.44.276 

func (s UpdateKxClusterDatabasesInput) 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 (*UpdateKxClusterDatabasesInput) SetClientToken added in v1.44.276 

func (s *UpdateKxClusterDatabasesInput) SetClientToken(v string) *UpdateKxClusterDatabasesInput

SetClientToken sets the ClientToken field's value.

func (*UpdateKxClusterDatabasesInput) SetClusterName added in v1.44.276 

func (s *UpdateKxClusterDatabasesInput) SetClusterName(v string) *UpdateKxClusterDatabasesInput

SetClusterName sets the ClusterName field's value.

func (*UpdateKxClusterDatabasesInput) SetDatabases added in v1.44.276 

func (s *UpdateKxClusterDatabasesInput) SetDatabases(v []*KxDatabaseConfiguration) *UpdateKxClusterDatabasesInput

SetDatabases sets the Databases field's value.

func (*UpdateKxClusterDatabasesInput) SetDeploymentConfiguration added in v1.44.328 

func (s *UpdateKxClusterDatabasesInput) SetDeploymentConfiguration(v *KxDeploymentConfiguration) *UpdateKxClusterDatabasesInput

SetDeploymentConfiguration sets the DeploymentConfiguration field's value.

func (*UpdateKxClusterDatabasesInput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxClusterDatabasesInput) SetEnvironmentId(v string) *UpdateKxClusterDatabasesInput

SetEnvironmentId sets the EnvironmentId field's value.

func (UpdateKxClusterDatabasesInput) String added in v1.44.276 

func (s UpdateKxClusterDatabasesInput) 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 (*UpdateKxClusterDatabasesInput) Validate added in v1.44.276 

func (s *UpdateKxClusterDatabasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateKxClusterDatabasesOutput added in v1.44.276 

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

func (UpdateKxClusterDatabasesOutput) GoString added in v1.44.276 

func (s UpdateKxClusterDatabasesOutput) 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 (UpdateKxClusterDatabasesOutput) String added in v1.44.276 

func (s UpdateKxClusterDatabasesOutput) 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 UpdateKxDatabaseInput added in v1.44.276 

type UpdateKxDatabaseInput 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 `location:"uri" 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"`
	// contains filtered or unexported fields
}

func (UpdateKxDatabaseInput) GoString added in v1.44.276 

func (s UpdateKxDatabaseInput) 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 (*UpdateKxDatabaseInput) SetClientToken added in v1.44.276 

func (s *UpdateKxDatabaseInput) SetClientToken(v string) *UpdateKxDatabaseInput

SetClientToken sets the ClientToken field's value.

func (*UpdateKxDatabaseInput) SetDatabaseName added in v1.44.276 

func (s *UpdateKxDatabaseInput) SetDatabaseName(v string) *UpdateKxDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (*UpdateKxDatabaseInput) SetDescription added in v1.44.276 

func (s *UpdateKxDatabaseInput) SetDescription(v string) *UpdateKxDatabaseInput

SetDescription sets the Description field's value.

func (*UpdateKxDatabaseInput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxDatabaseInput) SetEnvironmentId(v string) *UpdateKxDatabaseInput

SetEnvironmentId sets the EnvironmentId field's value.

func (UpdateKxDatabaseInput) String added in v1.44.276 

func (s UpdateKxDatabaseInput) 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 (*UpdateKxDatabaseInput) Validate added in v1.44.276 

func (s *UpdateKxDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateKxDatabaseOutput added in v1.44.276 

type UpdateKxDatabaseOutput struct {

	// 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 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
}

func (UpdateKxDatabaseOutput) GoString added in v1.44.276 

func (s UpdateKxDatabaseOutput) 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 (*UpdateKxDatabaseOutput) SetDatabaseName added in v1.44.276 

func (s *UpdateKxDatabaseOutput) SetDatabaseName(v string) *UpdateKxDatabaseOutput

SetDatabaseName sets the DatabaseName field's value.

func (*UpdateKxDatabaseOutput) SetDescription added in v1.44.276 

func (s *UpdateKxDatabaseOutput) SetDescription(v string) *UpdateKxDatabaseOutput

SetDescription sets the Description field's value.

func (*UpdateKxDatabaseOutput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxDatabaseOutput) SetEnvironmentId(v string) *UpdateKxDatabaseOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateKxDatabaseOutput) SetLastModifiedTimestamp added in v1.44.276 

func (s *UpdateKxDatabaseOutput) SetLastModifiedTimestamp(v time.Time) *UpdateKxDatabaseOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (UpdateKxDatabaseOutput) String added in v1.44.276 

func (s UpdateKxDatabaseOutput) 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 UpdateKxEnvironmentInput added in v1.44.276 

type UpdateKxEnvironmentInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string"`

	// A description of the kdb environment.
	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"`

	// The name of the kdb environment.
	Name *string `locationName:"name" min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateKxEnvironmentInput) GoString added in v1.44.276 

func (s UpdateKxEnvironmentInput) 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 (*UpdateKxEnvironmentInput) SetClientToken added in v1.44.276 

func (s *UpdateKxEnvironmentInput) SetClientToken(v string) *UpdateKxEnvironmentInput

SetClientToken sets the ClientToken field's value.

func (*UpdateKxEnvironmentInput) SetDescription added in v1.44.276 

func (s *UpdateKxEnvironmentInput) SetDescription(v string) *UpdateKxEnvironmentInput

SetDescription sets the Description field's value.

func (*UpdateKxEnvironmentInput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxEnvironmentInput) SetEnvironmentId(v string) *UpdateKxEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateKxEnvironmentInput) SetName added in v1.44.276 

func (s *UpdateKxEnvironmentInput) SetName(v string) *UpdateKxEnvironmentInput

SetName sets the Name field's value.

func (UpdateKxEnvironmentInput) String added in v1.44.276 

func (s UpdateKxEnvironmentInput) 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 (*UpdateKxEnvironmentInput) Validate added in v1.44.276 

func (s *UpdateKxEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateKxEnvironmentNetworkInput added in v1.44.276 

type UpdateKxEnvironmentNetworkInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string"`

	// 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 kdb environment.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `location:"uri" locationName:"environmentId" min:"1" type:"string" required:"true"`

	// Specifies the transit gateway and network configuration to connect the kdb
	// environment to an internal network.
	TransitGatewayConfiguration *TransitGatewayConfiguration `locationName:"transitGatewayConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateKxEnvironmentNetworkInput) GoString added in v1.44.276 

func (s UpdateKxEnvironmentNetworkInput) 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 (*UpdateKxEnvironmentNetworkInput) SetClientToken added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkInput) SetClientToken(v string) *UpdateKxEnvironmentNetworkInput

SetClientToken sets the ClientToken field's value.

func (*UpdateKxEnvironmentNetworkInput) SetCustomDNSConfiguration added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkInput) SetCustomDNSConfiguration(v []*CustomDNSServer) *UpdateKxEnvironmentNetworkInput

SetCustomDNSConfiguration sets the CustomDNSConfiguration field's value.

func (*UpdateKxEnvironmentNetworkInput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkInput) SetEnvironmentId(v string) *UpdateKxEnvironmentNetworkInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateKxEnvironmentNetworkInput) SetTransitGatewayConfiguration added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkInput) SetTransitGatewayConfiguration(v *TransitGatewayConfiguration) *UpdateKxEnvironmentNetworkInput

SetTransitGatewayConfiguration sets the TransitGatewayConfiguration field's value.

func (UpdateKxEnvironmentNetworkInput) String added in v1.44.276 

func (s UpdateKxEnvironmentNetworkInput) 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 (*UpdateKxEnvironmentNetworkInput) Validate added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateKxEnvironmentNetworkOutput added in v1.44.276 

type UpdateKxEnvironmentNetworkOutput 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 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"`

	// The description of the 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 (UpdateKxEnvironmentNetworkOutput) GoString added in v1.44.276 

func (s UpdateKxEnvironmentNetworkOutput) 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 (*UpdateKxEnvironmentNetworkOutput) SetAvailabilityZoneIds added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetAvailabilityZoneIds(v []*string) *UpdateKxEnvironmentNetworkOutput

SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetAwsAccountId added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetAwsAccountId(v string) *UpdateKxEnvironmentNetworkOutput

SetAwsAccountId sets the AwsAccountId field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetCreationTimestamp added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetCreationTimestamp(v time.Time) *UpdateKxEnvironmentNetworkOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetCustomDNSConfiguration added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetCustomDNSConfiguration(v []*CustomDNSServer) *UpdateKxEnvironmentNetworkOutput

SetCustomDNSConfiguration sets the CustomDNSConfiguration field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetDedicatedServiceAccountId added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetDedicatedServiceAccountId(v string) *UpdateKxEnvironmentNetworkOutput

SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetDescription added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetDescription(v string) *UpdateKxEnvironmentNetworkOutput

SetDescription sets the Description field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetDnsStatus added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetDnsStatus(v string) *UpdateKxEnvironmentNetworkOutput

SetDnsStatus sets the DnsStatus field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetEnvironmentArn added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetEnvironmentArn(v string) *UpdateKxEnvironmentNetworkOutput

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetEnvironmentId(v string) *UpdateKxEnvironmentNetworkOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetErrorMessage added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetErrorMessage(v string) *UpdateKxEnvironmentNetworkOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetKmsKeyId added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetKmsKeyId(v string) *UpdateKxEnvironmentNetworkOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetName added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetName(v string) *UpdateKxEnvironmentNetworkOutput

SetName sets the Name field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetStatus added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetStatus(v string) *UpdateKxEnvironmentNetworkOutput

SetStatus sets the Status field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetTgwStatus added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetTgwStatus(v string) *UpdateKxEnvironmentNetworkOutput

SetTgwStatus sets the TgwStatus field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetTransitGatewayConfiguration added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetTransitGatewayConfiguration(v *TransitGatewayConfiguration) *UpdateKxEnvironmentNetworkOutput

SetTransitGatewayConfiguration sets the TransitGatewayConfiguration field's value.

func (*UpdateKxEnvironmentNetworkOutput) SetUpdateTimestamp added in v1.44.276 

func (s *UpdateKxEnvironmentNetworkOutput) SetUpdateTimestamp(v time.Time) *UpdateKxEnvironmentNetworkOutput

SetUpdateTimestamp sets the UpdateTimestamp field's value.

func (UpdateKxEnvironmentNetworkOutput) String added in v1.44.276 

func (s UpdateKxEnvironmentNetworkOutput) 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 UpdateKxEnvironmentOutput added in v1.44.276 

type UpdateKxEnvironmentOutput 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 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"`

	// The description of the 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 (UpdateKxEnvironmentOutput) GoString added in v1.44.276 

func (s UpdateKxEnvironmentOutput) 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 (*UpdateKxEnvironmentOutput) SetAvailabilityZoneIds added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetAvailabilityZoneIds(v []*string) *UpdateKxEnvironmentOutput

SetAvailabilityZoneIds sets the AvailabilityZoneIds field's value.

func (*UpdateKxEnvironmentOutput) SetAwsAccountId added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetAwsAccountId(v string) *UpdateKxEnvironmentOutput

SetAwsAccountId sets the AwsAccountId field's value.

func (*UpdateKxEnvironmentOutput) SetCreationTimestamp added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetCreationTimestamp(v time.Time) *UpdateKxEnvironmentOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*UpdateKxEnvironmentOutput) SetCustomDNSConfiguration added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetCustomDNSConfiguration(v []*CustomDNSServer) *UpdateKxEnvironmentOutput

SetCustomDNSConfiguration sets the CustomDNSConfiguration field's value.

func (*UpdateKxEnvironmentOutput) SetDedicatedServiceAccountId added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetDedicatedServiceAccountId(v string) *UpdateKxEnvironmentOutput

SetDedicatedServiceAccountId sets the DedicatedServiceAccountId field's value.

func (*UpdateKxEnvironmentOutput) SetDescription added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetDescription(v string) *UpdateKxEnvironmentOutput

SetDescription sets the Description field's value.

func (*UpdateKxEnvironmentOutput) SetDnsStatus added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetDnsStatus(v string) *UpdateKxEnvironmentOutput

SetDnsStatus sets the DnsStatus field's value.

func (*UpdateKxEnvironmentOutput) SetEnvironmentArn added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetEnvironmentArn(v string) *UpdateKxEnvironmentOutput

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*UpdateKxEnvironmentOutput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetEnvironmentId(v string) *UpdateKxEnvironmentOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateKxEnvironmentOutput) SetErrorMessage added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetErrorMessage(v string) *UpdateKxEnvironmentOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*UpdateKxEnvironmentOutput) SetKmsKeyId added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetKmsKeyId(v string) *UpdateKxEnvironmentOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*UpdateKxEnvironmentOutput) SetName added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetName(v string) *UpdateKxEnvironmentOutput

SetName sets the Name field's value.

func (*UpdateKxEnvironmentOutput) SetStatus added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetStatus(v string) *UpdateKxEnvironmentOutput

SetStatus sets the Status field's value.

func (*UpdateKxEnvironmentOutput) SetTgwStatus added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetTgwStatus(v string) *UpdateKxEnvironmentOutput

SetTgwStatus sets the TgwStatus field's value.

func (*UpdateKxEnvironmentOutput) SetTransitGatewayConfiguration added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetTransitGatewayConfiguration(v *TransitGatewayConfiguration) *UpdateKxEnvironmentOutput

SetTransitGatewayConfiguration sets the TransitGatewayConfiguration field's value.

func (*UpdateKxEnvironmentOutput) SetUpdateTimestamp added in v1.44.276 

func (s *UpdateKxEnvironmentOutput) SetUpdateTimestamp(v time.Time) *UpdateKxEnvironmentOutput

SetUpdateTimestamp sets the UpdateTimestamp field's value.

func (UpdateKxEnvironmentOutput) String added in v1.44.276 

func (s UpdateKxEnvironmentOutput) 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 UpdateKxUserInput added in v1.44.276 

type UpdateKxUserInput struct {

	// A token that ensures idempotency. This token expires in 10 minutes.
	ClientToken *string `locationName:"clientToken" 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"`

	// The IAM role ARN that is associated with the user.
	//
	// IamRole is a required field
	IamRole *string `locationName:"iamRole" min:"20" 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 (UpdateKxUserInput) GoString added in v1.44.276 

func (s UpdateKxUserInput) 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 (*UpdateKxUserInput) SetClientToken added in v1.44.276 

func (s *UpdateKxUserInput) SetClientToken(v string) *UpdateKxUserInput

SetClientToken sets the ClientToken field's value.

func (*UpdateKxUserInput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxUserInput) SetEnvironmentId(v string) *UpdateKxUserInput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateKxUserInput) SetIamRole added in v1.44.276 

func (s *UpdateKxUserInput) SetIamRole(v string) *UpdateKxUserInput

SetIamRole sets the IamRole field's value.

func (*UpdateKxUserInput) SetUserName added in v1.44.276 

func (s *UpdateKxUserInput) SetUserName(v string) *UpdateKxUserInput

SetUserName sets the UserName field's value.

func (UpdateKxUserInput) String added in v1.44.276 

func (s UpdateKxUserInput) 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 (*UpdateKxUserInput) Validate added in v1.44.276 

func (s *UpdateKxUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateKxUserOutput added in v1.44.276 

type UpdateKxUserOutput 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 (UpdateKxUserOutput) GoString added in v1.44.276 

func (s UpdateKxUserOutput) 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 (*UpdateKxUserOutput) SetEnvironmentId added in v1.44.276 

func (s *UpdateKxUserOutput) SetEnvironmentId(v string) *UpdateKxUserOutput

SetEnvironmentId sets the EnvironmentId field's value.

func (*UpdateKxUserOutput) SetIamRole added in v1.44.276 

func (s *UpdateKxUserOutput) SetIamRole(v string) *UpdateKxUserOutput

SetIamRole sets the IamRole field's value.

func (*UpdateKxUserOutput) SetUserArn added in v1.44.276 

func (s *UpdateKxUserOutput) SetUserArn(v string) *UpdateKxUserOutput

SetUserArn sets the UserArn field's value.

func (*UpdateKxUserOutput) SetUserName added in v1.44.276 

func (s *UpdateKxUserOutput) SetUserName(v string) *UpdateKxUserOutput

SetUserName sets the UserName field's value.

func (UpdateKxUserOutput) String added in v1.44.276 

func (s UpdateKxUserOutput) 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 ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) 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 (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) 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 VpcConfiguration added in v1.44.276 

type VpcConfiguration struct {

	// The IP address type for cluster network configuration parameters. The following
	// type is available:
	//
	//    * IP_V4 – IP address version 4
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IPAddressType"`

	// The unique identifier of the VPC security group applied to the VPC endpoint
	// ENI for the cluster.
	SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list"`

	// The identifier of the subnet that the Privatelink VPC endpoint uses to connect
	// to the cluster.
	SubnetIds []*string `locationName:"subnetIds" type:"list"`

	// The identifier of the VPC endpoint.
	VpcId *string `locationName:"vpcId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Configuration details about the network where the Privatelink endpoint of the cluster resides.

func (VpcConfiguration) GoString added in v1.44.276 

func (s VpcConfiguration) 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 (*VpcConfiguration) SetIpAddressType added in v1.44.276 

func (s *VpcConfiguration) SetIpAddressType(v string) *VpcConfiguration

SetIpAddressType sets the IpAddressType field's value.

func (*VpcConfiguration) SetSecurityGroupIds added in v1.44.276 

func (s *VpcConfiguration) SetSecurityGroupIds(v []*string) *VpcConfiguration

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfiguration) SetSubnetIds added in v1.44.276 

func (s *VpcConfiguration) SetSubnetIds(v []*string) *VpcConfiguration

SetSubnetIds sets the SubnetIds field's value.

func (*VpcConfiguration) SetVpcId added in v1.44.276 

func (s *VpcConfiguration) SetVpcId(v string) *VpcConfiguration

SetVpcId sets the VpcId field's value.

func (VpcConfiguration) String added in v1.44.276 

func (s VpcConfiguration) 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 (*VpcConfiguration) Validate added in v1.44.276 

func (s *VpcConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package finspaceiface provides an interface to enable mocking the FinSpace User Environment Management service service client for testing your code.
 Package finspaceiface provides an interface to enable mocking the FinSpace User Environment Management service service client for testing your code.

Jump to

Keyboard shortcuts

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