finspacedata

package
v1.44.278 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2023 License: Apache-2.0 Imports: 10 Imported by: 9

Documentation

Overview

Package finspacedata provides the client and types for making API requests to FinSpace Public API.

The FinSpace APIs let you take actions inside the FinSpace.

See https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13 for more information on this service.

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

Using the Client

To contact FinSpace Public API 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 Public API client FinSpaceData for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/finspacedata/#New

Index

Constants

View Source 
const (
	// ApiAccessEnabled is a ApiAccess enum value
	ApiAccessEnabled = "ENABLED"

	// ApiAccessDisabled is a ApiAccess enum value
	ApiAccessDisabled = "DISABLED"
)
View Source 
const (
	// ApplicationPermissionCreateDataset is a ApplicationPermission enum value
	ApplicationPermissionCreateDataset = "CreateDataset"

	// ApplicationPermissionManageClusters is a ApplicationPermission enum value
	ApplicationPermissionManageClusters = "ManageClusters"

	// ApplicationPermissionManageUsersAndGroups is a ApplicationPermission enum value
	ApplicationPermissionManageUsersAndGroups = "ManageUsersAndGroups"

	// ApplicationPermissionManageAttributeSets is a ApplicationPermission enum value
	ApplicationPermissionManageAttributeSets = "ManageAttributeSets"

	// ApplicationPermissionViewAuditData is a ApplicationPermission enum value
	ApplicationPermissionViewAuditData = "ViewAuditData"

	// ApplicationPermissionAccessNotebooks is a ApplicationPermission enum value
	ApplicationPermissionAccessNotebooks = "AccessNotebooks"

	// ApplicationPermissionGetTemporaryCredentials is a ApplicationPermission enum value
	ApplicationPermissionGetTemporaryCredentials = "GetTemporaryCredentials"
)
View Source 
const (
	// ChangeTypeReplace is a ChangeType enum value
	ChangeTypeReplace = "REPLACE"

	// ChangeTypeAppend is a ChangeType enum value
	ChangeTypeAppend = "APPEND"

	// ChangeTypeModify is a ChangeType enum value
	ChangeTypeModify = "MODIFY"
)

Indicates how the given change will be applied to the dataset.

View Source 
const (
	// ColumnDataTypeString is a ColumnDataType enum value
	ColumnDataTypeString = "STRING"

	// ColumnDataTypeChar is a ColumnDataType enum value
	ColumnDataTypeChar = "CHAR"

	// ColumnDataTypeInteger is a ColumnDataType enum value
	ColumnDataTypeInteger = "INTEGER"

	// ColumnDataTypeTinyint is a ColumnDataType enum value
	ColumnDataTypeTinyint = "TINYINT"

	// ColumnDataTypeSmallint is a ColumnDataType enum value
	ColumnDataTypeSmallint = "SMALLINT"

	// ColumnDataTypeBigint is a ColumnDataType enum value
	ColumnDataTypeBigint = "BIGINT"

	// ColumnDataTypeFloat is a ColumnDataType enum value
	ColumnDataTypeFloat = "FLOAT"

	// ColumnDataTypeDouble is a ColumnDataType enum value
	ColumnDataTypeDouble = "DOUBLE"

	// ColumnDataTypeDate is a ColumnDataType enum value
	ColumnDataTypeDate = "DATE"

	// ColumnDataTypeDatetime is a ColumnDataType enum value
	ColumnDataTypeDatetime = "DATETIME"

	// ColumnDataTypeBoolean is a ColumnDataType enum value
	ColumnDataTypeBoolean = "BOOLEAN"

	// ColumnDataTypeBinary is a ColumnDataType enum value
	ColumnDataTypeBinary = "BINARY"
)

Data type of a column.

View Source 
const (
	// DataViewStatusRunning is a DataViewStatus enum value
	DataViewStatusRunning = "RUNNING"

	// DataViewStatusStarting is a DataViewStatus enum value
	DataViewStatusStarting = "STARTING"

	// DataViewStatusFailed is a DataViewStatus enum value
	DataViewStatusFailed = "FAILED"

	// DataViewStatusCancelled is a DataViewStatus enum value
	DataViewStatusCancelled = "CANCELLED"

	// DataViewStatusTimeout is a DataViewStatus enum value
	DataViewStatusTimeout = "TIMEOUT"

	// DataViewStatusSuccess is a DataViewStatus enum value
	DataViewStatusSuccess = "SUCCESS"

	// DataViewStatusPending is a DataViewStatus enum value
	DataViewStatusPending = "PENDING"

	// DataViewStatusFailedCleanupFailed is a DataViewStatus enum value
	DataViewStatusFailedCleanupFailed = "FAILED_CLEANUP_FAILED"
)

Status of a DataView

View Source 
const (
	// DatasetKindTabular is a DatasetKind enum value
	DatasetKindTabular = "TABULAR"

	// DatasetKindNonTabular is a DatasetKind enum value
	DatasetKindNonTabular = "NON_TABULAR"
)

Dataset Kind

View Source 
const (
	// DatasetStatusPending is a DatasetStatus enum value
	DatasetStatusPending = "PENDING"

	// DatasetStatusFailed is a DatasetStatus enum value
	DatasetStatusFailed = "FAILED"

	// DatasetStatusSuccess is a DatasetStatus enum value
	DatasetStatusSuccess = "SUCCESS"

	// DatasetStatusRunning is a DatasetStatus enum value
	DatasetStatusRunning = "RUNNING"
)

Status of the dataset process returned from scheduler service.

View Source 
const (
	// ErrorCategoryValidation is a ErrorCategory enum value
	ErrorCategoryValidation = "VALIDATION"

	// ErrorCategoryServiceQuotaExceeded is a ErrorCategory enum value
	ErrorCategoryServiceQuotaExceeded = "SERVICE_QUOTA_EXCEEDED"

	// ErrorCategoryAccessDenied is a ErrorCategory enum value
	ErrorCategoryAccessDenied = "ACCESS_DENIED"

	// ErrorCategoryResourceNotFound is a ErrorCategory enum value
	ErrorCategoryResourceNotFound = "RESOURCE_NOT_FOUND"

	// ErrorCategoryThrottling is a ErrorCategory enum value
	ErrorCategoryThrottling = "THROTTLING"

	// ErrorCategoryInternalServiceException is a ErrorCategory enum value
	ErrorCategoryInternalServiceException = "INTERNAL_SERVICE_EXCEPTION"

	// ErrorCategoryCancelled is a ErrorCategory enum value
	ErrorCategoryCancelled = "CANCELLED"

	// ErrorCategoryUserRecoverable is a ErrorCategory enum value
	ErrorCategoryUserRecoverable = "USER_RECOVERABLE"
)

Changeset Error Category

View Source 
const (
	// ExportFileFormatParquet is a ExportFileFormat enum value
	ExportFileFormatParquet = "PARQUET"

	// ExportFileFormatDelimitedText is a ExportFileFormat enum value
	ExportFileFormatDelimitedText = "DELIMITED_TEXT"
)

Data View Export File Format

View Source 
const (
	// IngestionStatusPending is a IngestionStatus enum value
	IngestionStatusPending = "PENDING"

	// IngestionStatusFailed is a IngestionStatus enum value
	IngestionStatusFailed = "FAILED"

	// IngestionStatusSuccess is a IngestionStatus enum value
	IngestionStatusSuccess = "SUCCESS"

	// IngestionStatusRunning is a IngestionStatus enum value
	IngestionStatusRunning = "RUNNING"

	// IngestionStatusStopRequested is a IngestionStatus enum value
	IngestionStatusStopRequested = "STOP_REQUESTED"
)

Status of the ingestion process returned from scheduler service.

View Source 
const (
	// LocationTypeIngestion is a LocationType enum value
	LocationTypeIngestion = "INGESTION"

	// LocationTypeSagemaker is a LocationType enum value
	LocationTypeSagemaker = "SAGEMAKER"
)
View Source 
const (
	// PermissionGroupMembershipStatusAdditionInProgress is a PermissionGroupMembershipStatus enum value
	PermissionGroupMembershipStatusAdditionInProgress = "ADDITION_IN_PROGRESS"

	// PermissionGroupMembershipStatusAdditionSuccess is a PermissionGroupMembershipStatus enum value
	PermissionGroupMembershipStatusAdditionSuccess = "ADDITION_SUCCESS"

	// PermissionGroupMembershipStatusRemovalInProgress is a PermissionGroupMembershipStatus enum value
	PermissionGroupMembershipStatusRemovalInProgress = "REMOVAL_IN_PROGRESS"
)
View Source 
const (
	// UserStatusCreating is a UserStatus enum value
	UserStatusCreating = "CREATING"

	// UserStatusEnabled is a UserStatus enum value
	UserStatusEnabled = "ENABLED"

	// UserStatusDisabled is a UserStatus enum value
	UserStatusDisabled = "DISABLED"
)
View Source 
const (
	// UserTypeSuperUser is a UserType enum value
	UserTypeSuperUser = "SUPER_USER"

	// UserTypeAppUser is a UserType enum value
	UserTypeAppUser = "APP_USER"
)
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".
	//
	// The request conflicts with an existing resource.
	ErrCodeConflictException = "ConflictException"

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

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A limit has exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

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

	// 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 data" // Name of service.
	EndpointsID = "finspace-api"  // ID to lookup a service endpoint with.
	ServiceID   = "finspace data" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ApiAccess_Values added in v1.43.8 

func ApiAccess_Values() []string

ApiAccess_Values returns all elements of the ApiAccess enum

func ApplicationPermission_Values added in v1.43.8 

func ApplicationPermission_Values() []string

ApplicationPermission_Values returns all elements of the ApplicationPermission enum

func ChangeType_Values 

func ChangeType_Values() []string

ChangeType_Values returns all elements of the ChangeType enum

func ColumnDataType_Values added in v1.42.10 

func ColumnDataType_Values() []string

ColumnDataType_Values returns all elements of the ColumnDataType enum

func DataViewStatus_Values added in v1.42.10 

func DataViewStatus_Values() []string

DataViewStatus_Values returns all elements of the DataViewStatus enum

func DatasetKind_Values added in v1.42.10 

func DatasetKind_Values() []string

DatasetKind_Values returns all elements of the DatasetKind enum

func DatasetStatus_Values added in v1.42.10 

func DatasetStatus_Values() []string

DatasetStatus_Values returns all elements of the DatasetStatus enum

func ErrorCategory_Values 

func ErrorCategory_Values() []string

ErrorCategory_Values returns all elements of the ErrorCategory enum

func ExportFileFormat_Values added in v1.42.24 

func ExportFileFormat_Values() []string

ExportFileFormat_Values returns all elements of the ExportFileFormat enum

func IngestionStatus_Values added in v1.42.10 

func IngestionStatus_Values() []string

IngestionStatus_Values returns all elements of the IngestionStatus enum

func LocationType_Values 

func LocationType_Values() []string

LocationType_Values returns all elements of the LocationType enum

func PermissionGroupMembershipStatus_Values added in v1.44.35 

func PermissionGroupMembershipStatus_Values() []string

PermissionGroupMembershipStatus_Values returns all elements of the PermissionGroupMembershipStatus enum

func UserStatus_Values added in v1.43.8 

func UserStatus_Values() []string

UserStatus_Values returns all elements of the UserStatus enum

func UserType_Values added in v1.43.8 

func UserType_Values() []string

UserType_Values returns all elements of the UserType 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 AssociateUserToPermissionGroupInput added in v1.44.35 

type AssociateUserToPermissionGroupInput struct {

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

	// The unique identifier for the permission group.
	//
	// PermissionGroupId is a required field
	PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"`

	// The unique identifier for the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateUserToPermissionGroupInput) GoString added in v1.44.35 

func (s AssociateUserToPermissionGroupInput) 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 (*AssociateUserToPermissionGroupInput) SetClientToken added in v1.44.35 

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

SetClientToken sets the ClientToken field's value.

func (*AssociateUserToPermissionGroupInput) SetPermissionGroupId added in v1.44.35 

func (s *AssociateUserToPermissionGroupInput) SetPermissionGroupId(v string) *AssociateUserToPermissionGroupInput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (*AssociateUserToPermissionGroupInput) SetUserId added in v1.44.35 

func (s *AssociateUserToPermissionGroupInput) SetUserId(v string) *AssociateUserToPermissionGroupInput

SetUserId sets the UserId field's value.

func (AssociateUserToPermissionGroupInput) String added in v1.44.35 

func (s AssociateUserToPermissionGroupInput) 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 (*AssociateUserToPermissionGroupInput) Validate added in v1.44.35 

func (s *AssociateUserToPermissionGroupInput) Validate() error

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

type AssociateUserToPermissionGroupOutput added in v1.44.35 

type AssociateUserToPermissionGroupOutput struct {

	// The returned status code of the response.
	StatusCode *int64 `location:"statusCode" locationName:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (AssociateUserToPermissionGroupOutput) GoString added in v1.44.35 

func (s AssociateUserToPermissionGroupOutput) 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 (*AssociateUserToPermissionGroupOutput) SetStatusCode added in v1.44.35 

func (s *AssociateUserToPermissionGroupOutput) SetStatusCode(v int64) *AssociateUserToPermissionGroupOutput

SetStatusCode sets the StatusCode field's value.

func (AssociateUserToPermissionGroupOutput) String added in v1.44.35 

func (s AssociateUserToPermissionGroupOutput) 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 AwsCredentials added in v1.44.44 

type AwsCredentials struct {

	// The unique identifier for the security credentials.
	AccessKeyId *string `locationName:"accessKeyId" min:"1" type:"string"`

	// The Epoch time when the current credentials expire.
	Expiration *int64 `locationName:"expiration" type:"long"`

	// The secret access key that can be used to sign requests.
	//
	// SecretAccessKey is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AwsCredentials's
	// String and GoString methods.
	SecretAccessKey *string `locationName:"secretAccessKey" min:"1" type:"string" sensitive:"true"`

	// The token that users must pass to use the credentials.
	//
	// SessionToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AwsCredentials's
	// String and GoString methods.
	SessionToken *string `locationName:"sessionToken" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The credentials required to access the external Dataview from the S3 location.

func (AwsCredentials) GoString added in v1.44.44 

func (s AwsCredentials) 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 (*AwsCredentials) SetAccessKeyId added in v1.44.44 

func (s *AwsCredentials) SetAccessKeyId(v string) *AwsCredentials

SetAccessKeyId sets the AccessKeyId field's value.

func (*AwsCredentials) SetExpiration added in v1.44.44 

func (s *AwsCredentials) SetExpiration(v int64) *AwsCredentials

SetExpiration sets the Expiration field's value.

func (*AwsCredentials) SetSecretAccessKey added in v1.44.44 

func (s *AwsCredentials) SetSecretAccessKey(v string) *AwsCredentials

SetSecretAccessKey sets the SecretAccessKey field's value.

func (*AwsCredentials) SetSessionToken added in v1.44.44 

func (s *AwsCredentials) SetSessionToken(v string) *AwsCredentials

SetSessionToken sets the SessionToken field's value.

func (AwsCredentials) String added in v1.44.44 

func (s AwsCredentials) 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 ChangesetErrorInfo added in v1.42.10 

type ChangesetErrorInfo struct {

	// The category of the error.
	//
	//    * VALIDATION – The inputs to this request are invalid.
	//
	//    * SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please
	//    contact AWS support to increase quotas.
	//
	//    * ACCESS_DENIED – Missing required permission to perform this request.
	//
	//    * RESOURCE_NOT_FOUND – One or more inputs to this request were not found.
	//
	//    * THROTTLING – The system temporarily lacks sufficient resources to
	//    process the request.
	//
	//    * INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.
	//
	//    * CANCELLED – Cancelled.
	//
	//    * USER_RECOVERABLE – A user recoverable error has occurred.
	ErrorCategory *string `locationName:"errorCategory" type:"string" enum:"ErrorCategory"`

	// The text of the error message.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`
	// contains filtered or unexported fields
}

The structure with error messages.

func (ChangesetErrorInfo) GoString added in v1.42.10 

func (s ChangesetErrorInfo) 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 (*ChangesetErrorInfo) SetErrorCategory added in v1.42.10 

func (s *ChangesetErrorInfo) SetErrorCategory(v string) *ChangesetErrorInfo

SetErrorCategory sets the ErrorCategory field's value.

func (*ChangesetErrorInfo) SetErrorMessage added in v1.42.10 

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

SetErrorMessage sets the ErrorMessage field's value.

func (ChangesetErrorInfo) String added in v1.42.10 

func (s ChangesetErrorInfo) 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 ChangesetSummary added in v1.42.10 

type ChangesetSummary 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 *int64 `locationName:"activeFromTimestamp" type:"long"`

	// Time until 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.
	ActiveUntilTimestamp *int64 `locationName:"activeUntilTimestamp" type:"long"`

	// Type that indicates how a Changeset is applied to a Dataset.
	//
	//    * REPLACE – Changeset is considered as a replacement to all prior loaded
	//    Changesets.
	//
	//    * APPEND – Changeset is considered as an addition to the end of all
	//    prior loaded Changesets.
	//
	//    * MODIFY – Changeset is considered as a replacement to a specific prior
	//    ingested Changeset.
	ChangeType *string `locationName:"changeType" type:"string" enum:"ChangeType"`

	// The ARN identifier of the Changeset.
	ChangesetArn *string `locationName:"changesetArn" type:"string"`

	// The unique identifier for a 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.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The unique identifier for the FinSpace Dataset in which the Changeset is
	// created.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`

	// The structure with error messages.
	ErrorInfo *ChangesetErrorInfo `locationName:"errorInfo" type:"structure"`

	// Options that define the structure of the source file(s).
	FormatParams map[string]*string `locationName:"formatParams" type:"map"`

	// Options that define the location of the data being ingested.
	SourceParams map[string]*string `locationName:"sourceParams" type:"map"`

	// Status of the Changeset ingestion.
	//
	//    * PENDING – Changeset is pending creation.
	//
	//    * FAILED – Changeset creation has failed.
	//
	//    * SUCCESS – Changeset creation has succeeded.
	//
	//    * RUNNING – Changeset creation is running.
	//
	//    * STOP_REQUESTED – User requested Changeset creation to stop.
	Status *string `locationName:"status" type:"string" enum:"IngestionStatus"`

	// The unique identifier of the updated Changeset.
	UpdatedByChangesetId *string `locationName:"updatedByChangesetId" min:"1" type:"string"`

	// The unique identifier of the Changeset that is updated.
	UpdatesChangesetId *string `locationName:"updatesChangesetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A Changeset is unit of data in a Dataset.

func (ChangesetSummary) GoString added in v1.42.10 

func (s ChangesetSummary) 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 (*ChangesetSummary) SetActiveFromTimestamp added in v1.42.24 

func (s *ChangesetSummary) SetActiveFromTimestamp(v int64) *ChangesetSummary

SetActiveFromTimestamp sets the ActiveFromTimestamp field's value.

func (*ChangesetSummary) SetActiveUntilTimestamp added in v1.42.10 

func (s *ChangesetSummary) SetActiveUntilTimestamp(v int64) *ChangesetSummary

SetActiveUntilTimestamp sets the ActiveUntilTimestamp field's value.

func (*ChangesetSummary) SetChangeType added in v1.42.10 

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

SetChangeType sets the ChangeType field's value.

func (*ChangesetSummary) SetChangesetArn added in v1.42.10 

func (s *ChangesetSummary) SetChangesetArn(v string) *ChangesetSummary

SetChangesetArn sets the ChangesetArn field's value.

func (*ChangesetSummary) SetChangesetId added in v1.42.10 

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

SetChangesetId sets the ChangesetId field's value.

func (*ChangesetSummary) SetCreateTime added in v1.42.10 

func (s *ChangesetSummary) SetCreateTime(v int64) *ChangesetSummary

SetCreateTime sets the CreateTime field's value.

func (*ChangesetSummary) SetDatasetId added in v1.42.10 

func (s *ChangesetSummary) SetDatasetId(v string) *ChangesetSummary

SetDatasetId sets the DatasetId field's value.

func (*ChangesetSummary) SetErrorInfo added in v1.42.10 

func (s *ChangesetSummary) SetErrorInfo(v *ChangesetErrorInfo) *ChangesetSummary

SetErrorInfo sets the ErrorInfo field's value.

func (*ChangesetSummary) SetFormatParams added in v1.42.10 

func (s *ChangesetSummary) SetFormatParams(v map[string]*string) *ChangesetSummary

SetFormatParams sets the FormatParams field's value.

func (*ChangesetSummary) SetSourceParams added in v1.42.10 

func (s *ChangesetSummary) SetSourceParams(v map[string]*string) *ChangesetSummary

SetSourceParams sets the SourceParams field's value.

func (*ChangesetSummary) SetStatus added in v1.42.10 

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

SetStatus sets the Status field's value.

func (*ChangesetSummary) SetUpdatedByChangesetId added in v1.42.10 

func (s *ChangesetSummary) SetUpdatedByChangesetId(v string) *ChangesetSummary

SetUpdatedByChangesetId sets the UpdatedByChangesetId field's value.

func (*ChangesetSummary) SetUpdatesChangesetId added in v1.42.10 

func (s *ChangesetSummary) SetUpdatesChangesetId(v string) *ChangesetSummary

SetUpdatesChangesetId sets the UpdatesChangesetId field's value.

func (ChangesetSummary) String added in v1.42.10 

func (s ChangesetSummary) 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 ColumnDefinition added in v1.42.10 

type ColumnDefinition struct {

	// Description for a column.
	ColumnDescription *string `locationName:"columnDescription" type:"string"`

	// The name of a column.
	ColumnName *string `locationName:"columnName" type:"string"`

	// Data type of a column.
	//
	//    * STRING – A String data type. CHAR – A char data type. INTEGER –
	//    An integer data type. TINYINT – A tinyint data type. SMALLINT – A
	//    smallint data type. BIGINT – A bigint data type. FLOAT – A float data
	//    type. DOUBLE – A double data type. DATE – A date data type. DATETIME
	//    – A datetime data type. BOOLEAN – A boolean data type. BINARY –
	//    A binary data type.
	DataType *string `locationName:"dataType" type:"string" enum:"ColumnDataType"`
	// contains filtered or unexported fields
}

The definition of a column in a tabular Dataset.

func (ColumnDefinition) GoString added in v1.42.10 

func (s ColumnDefinition) 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 (*ColumnDefinition) SetColumnDescription added in v1.42.10 

func (s *ColumnDefinition) SetColumnDescription(v string) *ColumnDefinition

SetColumnDescription sets the ColumnDescription field's value.

func (*ColumnDefinition) SetColumnName added in v1.42.10 

func (s *ColumnDefinition) SetColumnName(v string) *ColumnDefinition

SetColumnName sets the ColumnName field's value.

func (*ColumnDefinition) SetDataType added in v1.42.10 

func (s *ColumnDefinition) SetDataType(v string) *ColumnDefinition

SetDataType sets the DataType field's value.

func (ColumnDefinition) String added in v1.42.10 

func (s ColumnDefinition) 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 ConflictException added in v1.42.10 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

The request conflicts with an existing resource.

func (*ConflictException) Code added in v1.42.10 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.42.10 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.42.10 

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

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.42.10 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.42.10 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.42.10 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String added in v1.42.10 

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 CreateChangesetInput 

type CreateChangesetInput struct {

	// The option to indicate how a Changeset will be applied to a Dataset.
	//
	//    * REPLACE – Changeset will be considered as a replacement to all prior
	//    loaded Changesets.
	//
	//    * APPEND – Changeset will be considered as an addition to the end of
	//    all prior loaded Changesets.
	//
	//    * MODIFY – Changeset is considered as a replacement to a specific prior
	//    ingested Changeset.
	//
	// ChangeType is a required field
	ChangeType *string `locationName:"changeType" type:"string" required:"true" enum:"ChangeType"`

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

	// The unique identifier for the FinSpace Dataset where the Changeset will be
	// created.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`

	// Options that define the structure of the source file(s) including the format
	// type (formatType), header row (withHeader), data separation character (separator)
	// and the type of compression (compression).
	//
	// formatType is a required attribute and can have the following values:
	//
	//    * PARQUET – Parquet source file format.
	//
	//    * CSV – CSV source file format.
	//
	//    * JSON – JSON source file format.
	//
	//    * XML – XML source file format.
	//
	// Here is an example of how you could specify the formatParams:
	//
	// "formatParams": { "formatType": "CSV", "withHeader": "true", "separator":
	// ",", "compression":"None" }
	//
	// Note that if you only provide formatType as CSV, the rest of the attributes
	// will automatically default to CSV values as following:
	//
	// { "withHeader": "true", "separator": "," }
	//
	// For more information about supported file formats, see Supported Data Types
	// and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html)
	// in the FinSpace User Guide.
	//
	// FormatParams is a required field
	FormatParams map[string]*string `locationName:"formatParams" type:"map" required:"true"`

	// Options that define the location of the data being ingested (s3SourcePath)
	// and the source of the changeset (sourceType).
	//
	// Both s3SourcePath and sourceType are required attributes.
	//
	// Here is an example of how you could specify the sourceParams:
	//
	// "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
	// "sourceType": "S3" }
	//
	// The S3 path that you specify must allow the FinSpace role access. To do that,
	// you first need to configure the IAM policy on S3 bucket. For more information,
	// see Loading data from an Amazon S3 Bucket using the FinSpace API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets)
	// section.
	//
	// SourceParams is a required field
	SourceParams map[string]*string `locationName:"sourceParams" type:"map" required:"true"`
	// contains filtered or unexported fields
}

The request for a CreateChangeset operation.

func (CreateChangesetInput) GoString 

func (s CreateChangesetInput) 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 (*CreateChangesetInput) SetChangeType 

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

SetChangeType sets the ChangeType field's value.

func (*CreateChangesetInput) SetClientToken added in v1.42.10 

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

SetClientToken sets the ClientToken field's value.

func (*CreateChangesetInput) SetDatasetId 

func (s *CreateChangesetInput) SetDatasetId(v string) *CreateChangesetInput

SetDatasetId sets the DatasetId field's value.

func (*CreateChangesetInput) SetFormatParams 

func (s *CreateChangesetInput) SetFormatParams(v map[string]*string) *CreateChangesetInput

SetFormatParams sets the FormatParams field's value.

func (*CreateChangesetInput) SetSourceParams 

func (s *CreateChangesetInput) SetSourceParams(v map[string]*string) *CreateChangesetInput

SetSourceParams sets the SourceParams field's value.

func (CreateChangesetInput) String 

func (s CreateChangesetInput) 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 (*CreateChangesetInput) Validate 

func (s *CreateChangesetInput) Validate() error

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

type CreateChangesetOutput 

type CreateChangesetOutput struct {

	// The unique identifier of the Changeset that is created.
	ChangesetId *string `locationName:"changesetId" min:"1" type:"string"`

	// The unique identifier for the FinSpace Dataset where the Changeset is created.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from a CreateChangeset operation.

func (CreateChangesetOutput) GoString 

func (s CreateChangesetOutput) 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 (*CreateChangesetOutput) SetChangesetId added in v1.42.10 

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

SetChangesetId sets the ChangesetId field's value.

func (*CreateChangesetOutput) SetDatasetId added in v1.42.10 

func (s *CreateChangesetOutput) SetDatasetId(v string) *CreateChangesetOutput

SetDatasetId sets the DatasetId field's value.

func (CreateChangesetOutput) String 

func (s CreateChangesetOutput) 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 CreateDataViewInput added in v1.42.10 

type CreateDataViewInput struct {

	// Beginning time to use for the Dataview. 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.
	AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"`

	// Flag to indicate Dataview should be updated automatically.
	AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"`

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

	// The unique Dataset identifier that is used to create a Dataview.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`

	// Options that define the destination type for the Dataview.
	//
	// DestinationTypeParams is a required field
	DestinationTypeParams *DataViewDestinationTypeParams `locationName:"destinationTypeParams" type:"structure" required:"true"`

	// Ordered set of column names used to partition data.
	PartitionColumns []*string `locationName:"partitionColumns" type:"list"`

	// Columns to be used for sorting the data.
	SortColumns []*string `locationName:"sortColumns" type:"list"`
	// contains filtered or unexported fields
}

Request for creating a data view.

func (CreateDataViewInput) GoString added in v1.42.10 

func (s CreateDataViewInput) 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 (*CreateDataViewInput) SetAsOfTimestamp added in v1.42.10 

func (s *CreateDataViewInput) SetAsOfTimestamp(v int64) *CreateDataViewInput

SetAsOfTimestamp sets the AsOfTimestamp field's value.

func (*CreateDataViewInput) SetAutoUpdate added in v1.42.10 

func (s *CreateDataViewInput) SetAutoUpdate(v bool) *CreateDataViewInput

SetAutoUpdate sets the AutoUpdate field's value.

func (*CreateDataViewInput) SetClientToken added in v1.42.10 

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

SetClientToken sets the ClientToken field's value.

func (*CreateDataViewInput) SetDatasetId added in v1.42.10 

func (s *CreateDataViewInput) SetDatasetId(v string) *CreateDataViewInput

SetDatasetId sets the DatasetId field's value.

func (*CreateDataViewInput) SetDestinationTypeParams added in v1.42.10 

func (s *CreateDataViewInput) SetDestinationTypeParams(v *DataViewDestinationTypeParams) *CreateDataViewInput

SetDestinationTypeParams sets the DestinationTypeParams field's value.

func (*CreateDataViewInput) SetPartitionColumns added in v1.42.10 

func (s *CreateDataViewInput) SetPartitionColumns(v []*string) *CreateDataViewInput

SetPartitionColumns sets the PartitionColumns field's value.

func (*CreateDataViewInput) SetSortColumns added in v1.42.10 

func (s *CreateDataViewInput) SetSortColumns(v []*string) *CreateDataViewInput

SetSortColumns sets the SortColumns field's value.

func (CreateDataViewInput) String added in v1.42.10 

func (s CreateDataViewInput) 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 (*CreateDataViewInput) Validate added in v1.42.10 

func (s *CreateDataViewInput) Validate() error

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

type CreateDataViewOutput added in v1.42.10 

type CreateDataViewOutput struct {

	// The unique identifier for the created Dataview.
	DataViewId *string `locationName:"dataViewId" min:"1" type:"string"`

	// The unique identifier of the Dataset used for the Dataview.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Response for creating a data view.

func (CreateDataViewOutput) GoString added in v1.42.10 

func (s CreateDataViewOutput) 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 (*CreateDataViewOutput) SetDataViewId added in v1.42.10 

func (s *CreateDataViewOutput) SetDataViewId(v string) *CreateDataViewOutput

SetDataViewId sets the DataViewId field's value.

func (*CreateDataViewOutput) SetDatasetId added in v1.42.10 

func (s *CreateDataViewOutput) SetDatasetId(v string) *CreateDataViewOutput

SetDatasetId sets the DatasetId field's value.

func (CreateDataViewOutput) String added in v1.42.10 

func (s CreateDataViewOutput) 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 CreateDatasetInput added in v1.42.10 

type CreateDatasetInput struct {

	// The unique resource identifier for a Dataset.
	Alias *string `locationName:"alias" min:"1" type:"string"`

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

	// Description of a Dataset.
	DatasetDescription *string `locationName:"datasetDescription" type:"string"`

	// Display title for a FinSpace Dataset.
	//
	// DatasetTitle is a required field
	DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string" required:"true"`

	// The format in which Dataset data is structured.
	//
	//    * TABULAR – Data is structured in a tabular format.
	//
	//    * NON_TABULAR – Data is structured in a non-tabular format.
	//
	// Kind is a required field
	Kind *string `locationName:"kind" type:"string" required:"true" enum:"DatasetKind"`

	// Contact information for a Dataset owner.
	OwnerInfo *DatasetOwnerInfo `locationName:"ownerInfo" type:"structure"`

	// Permission group parameters for Dataset permissions.
	//
	// PermissionGroupParams is a required field
	PermissionGroupParams *PermissionGroupParams `locationName:"permissionGroupParams" type:"structure" required:"true"`

	// Definition for a schema on a tabular Dataset.
	SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"`
	// contains filtered or unexported fields
}

The request for a CreateDataset operation

func (CreateDatasetInput) GoString added in v1.42.10 

func (s CreateDatasetInput) 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 (*CreateDatasetInput) SetAlias added in v1.42.10 

func (s *CreateDatasetInput) SetAlias(v string) *CreateDatasetInput

SetAlias sets the Alias field's value.

func (*CreateDatasetInput) SetClientToken added in v1.42.10 

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

SetClientToken sets the ClientToken field's value.

func (*CreateDatasetInput) SetDatasetDescription added in v1.42.10 

func (s *CreateDatasetInput) SetDatasetDescription(v string) *CreateDatasetInput

SetDatasetDescription sets the DatasetDescription field's value.

func (*CreateDatasetInput) SetDatasetTitle added in v1.42.10 

func (s *CreateDatasetInput) SetDatasetTitle(v string) *CreateDatasetInput

SetDatasetTitle sets the DatasetTitle field's value.

func (*CreateDatasetInput) SetKind added in v1.42.10 

func (s *CreateDatasetInput) SetKind(v string) *CreateDatasetInput

SetKind sets the Kind field's value.

func (*CreateDatasetInput) SetOwnerInfo added in v1.42.10 

func (s *CreateDatasetInput) SetOwnerInfo(v *DatasetOwnerInfo) *CreateDatasetInput

SetOwnerInfo sets the OwnerInfo field's value.

func (*CreateDatasetInput) SetPermissionGroupParams added in v1.42.10 

func (s *CreateDatasetInput) SetPermissionGroupParams(v *PermissionGroupParams) *CreateDatasetInput

SetPermissionGroupParams sets the PermissionGroupParams field's value.

func (*CreateDatasetInput) SetSchemaDefinition added in v1.42.10 

func (s *CreateDatasetInput) SetSchemaDefinition(v *SchemaUnion) *CreateDatasetInput

SetSchemaDefinition sets the SchemaDefinition field's value.

func (CreateDatasetInput) String added in v1.42.10 

func (s CreateDatasetInput) 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 (*CreateDatasetInput) Validate added in v1.42.10 

func (s *CreateDatasetInput) Validate() error

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

type CreateDatasetOutput added in v1.42.10 

type CreateDatasetOutput struct {

	// The unique identifier for the created Dataset.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from a CreateDataset operation

func (CreateDatasetOutput) GoString added in v1.42.10 

func (s CreateDatasetOutput) 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 (*CreateDatasetOutput) SetDatasetId added in v1.42.10 

func (s *CreateDatasetOutput) SetDatasetId(v string) *CreateDatasetOutput

SetDatasetId sets the DatasetId field's value.

func (CreateDatasetOutput) String added in v1.42.10 

func (s CreateDatasetOutput) 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 CreatePermissionGroupInput added in v1.43.8 

type CreatePermissionGroupInput struct {

	// The option to indicate FinSpace application permissions that are granted
	// to a specific group.
	//
	// When assigning application permissions, be aware that the permission ManageUsersAndGroups
	// allows users to grant themselves or others access to any functionality in
	// their FinSpace environment's application. It should only be granted to trusted
	// users.
	//
	//    * CreateDataset – Group members can create new datasets.
	//
	//    * ManageClusters – Group members can manage Apache Spark clusters from
	//    FinSpace notebooks.
	//
	//    * ManageUsersAndGroups – Group members can manage users and permission
	//    groups. This is a privileged permission that allows users to grant themselves
	//    or others access to any functionality in the application. It should only
	//    be granted to trusted users.
	//
	//    * ManageAttributeSets – Group members can manage attribute sets.
	//
	//    * ViewAuditData – Group members can view audit data.
	//
	//    * AccessNotebooks – Group members will have access to FinSpace notebooks.
	//
	//    * GetTemporaryCredentials – Group members can get temporary API credentials.
	//
	// ApplicationPermissions is a required field
	ApplicationPermissions []*string `locationName:"applicationPermissions" type:"list" required:"true" enum:"ApplicationPermission"`

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

	// A brief description for the permission group.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePermissionGroupInput's
	// String and GoString methods.
	Description *string `locationName:"description" min:"1" type:"string" sensitive:"true"`

	// The name of the permission group.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePermissionGroupInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreatePermissionGroupInput) GoString added in v1.43.8 

func (s CreatePermissionGroupInput) 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 (*CreatePermissionGroupInput) SetApplicationPermissions added in v1.43.8 

func (s *CreatePermissionGroupInput) SetApplicationPermissions(v []*string) *CreatePermissionGroupInput

SetApplicationPermissions sets the ApplicationPermissions field's value.

func (*CreatePermissionGroupInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*CreatePermissionGroupInput) SetDescription added in v1.43.8 

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

SetDescription sets the Description field's value.

func (*CreatePermissionGroupInput) SetName added in v1.43.8 

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

SetName sets the Name field's value.

func (CreatePermissionGroupInput) String added in v1.43.8 

func (s CreatePermissionGroupInput) 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 (*CreatePermissionGroupInput) Validate added in v1.43.8 

func (s *CreatePermissionGroupInput) Validate() error

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

type CreatePermissionGroupOutput added in v1.43.8 

type CreatePermissionGroupOutput struct {

	// The unique identifier for the permission group.
	PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreatePermissionGroupOutput) GoString added in v1.43.8 

func (s CreatePermissionGroupOutput) 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 (*CreatePermissionGroupOutput) SetPermissionGroupId added in v1.43.8 

func (s *CreatePermissionGroupOutput) SetPermissionGroupId(v string) *CreatePermissionGroupOutput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (CreatePermissionGroupOutput) String added in v1.43.8 

func (s CreatePermissionGroupOutput) 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 CreateUserInput added in v1.43.8 

type CreateUserInput struct {

	// The option to indicate whether the user can use the GetProgrammaticAccessCredentials
	// API to obtain credentials that can then be used to access other FinSpace
	// Data API operations.
	//
	//    * ENABLED – The user has permissions to use the APIs.
	//
	//    * DISABLED – The user does not have permissions to use any APIs.
	ApiAccess *string `type:"string" enum:"ApiAccess"`

	// The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
	// API to obtain a credentials token for a specific FinSpace user. This must
	// be an IAM role within your FinSpace account.
	ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"`

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

	// The email address of the user that you want to register. The email address
	// serves as a uniquer identifier for each user and cannot be changed after
	// it's created.
	//
	// EmailAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	//
	// EmailAddress is a required field
	EmailAddress *string `locationName:"emailAddress" min:"4" type:"string" required:"true" sensitive:"true"`

	// The first name of the user that you want to register.
	//
	// FirstName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"`

	// The last name of the user that you want to register.
	//
	// LastName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"`

	// The option to indicate the type of user. Use one of the following options
	// to specify this parameter:
	//
	//    * SUPER_USER – A user with permission to all the functionality and data
	//    in FinSpace.
	//
	//    * APP_USER – A user with specific permissions in FinSpace. The users
	//    are assigned permissions by adding them to a permission group.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"UserType"`
	// contains filtered or unexported fields
}

func (CreateUserInput) GoString added in v1.43.8 

func (s CreateUserInput) 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 (*CreateUserInput) SetApiAccess added in v1.43.8 

func (s *CreateUserInput) SetApiAccess(v string) *CreateUserInput

SetApiAccess sets the ApiAccess field's value.

func (*CreateUserInput) SetApiAccessPrincipalArn added in v1.43.8 

func (s *CreateUserInput) SetApiAccessPrincipalArn(v string) *CreateUserInput

SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value.

func (*CreateUserInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*CreateUserInput) SetEmailAddress added in v1.43.8 

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

SetEmailAddress sets the EmailAddress field's value.

func (*CreateUserInput) SetFirstName added in v1.43.8 

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

SetFirstName sets the FirstName field's value.

func (*CreateUserInput) SetLastName added in v1.43.8 

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

SetLastName sets the LastName field's value.

func (*CreateUserInput) SetType added in v1.43.8 

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

SetType sets the Type field's value.

func (CreateUserInput) String added in v1.43.8 

func (s CreateUserInput) 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 (*CreateUserInput) Validate added in v1.43.8 

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput added in v1.43.8 

type CreateUserOutput struct {

	// The unique identifier for the user.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateUserOutput) GoString added in v1.43.8 

func (s CreateUserOutput) 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 (*CreateUserOutput) SetUserId added in v1.43.8 

func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput

SetUserId sets the UserId field's value.

func (CreateUserOutput) String added in v1.43.8 

func (s CreateUserOutput) 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 Credentials 

type Credentials struct {

	// The access key identifier.
	AccessKeyId *string `locationName:"accessKeyId" min:"1" type:"string"`

	// The access key.
	SecretAccessKey *string `locationName:"secretAccessKey" type:"string"`

	// The session token.
	SessionToken *string `locationName:"sessionToken" type:"string"`
	// contains filtered or unexported fields
}

Short term API credentials.

func (Credentials) GoString 

func (s Credentials) 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 (*Credentials) SetAccessKeyId 

func (s *Credentials) SetAccessKeyId(v string) *Credentials

SetAccessKeyId sets the AccessKeyId field's value.

func (*Credentials) SetSecretAccessKey 

func (s *Credentials) SetSecretAccessKey(v string) *Credentials

SetSecretAccessKey sets the SecretAccessKey field's value.

func (*Credentials) SetSessionToken 

func (s *Credentials) SetSessionToken(v string) *Credentials

SetSessionToken sets the SessionToken field's value.

func (Credentials) String 

func (s Credentials) 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 DataViewDestinationTypeParams added in v1.42.10 

type DataViewDestinationTypeParams struct {

	// Destination type for a Dataview.
	//
	//    * GLUE_TABLE – Glue table destination type.
	//
	//    * S3 – S3 destination type.
	//
	// DestinationType is a required field
	DestinationType *string `locationName:"destinationType" type:"string" required:"true"`

	// Dataview export file format.
	//
	//    * PARQUET – Parquet export file format.
	//
	//    * DELIMITED_TEXT – Delimited text export file format.
	S3DestinationExportFileFormat *string `locationName:"s3DestinationExportFileFormat" type:"string" enum:"ExportFileFormat"`

	// Format Options for S3 Destination type.
	//
	// Here is an example of how you could specify the s3DestinationExportFileFormatOptions
	//
	// { "header": "true", "delimiter": ",", "compression": "gzip" }
	S3DestinationExportFileFormatOptions map[string]*string `locationName:"s3DestinationExportFileFormatOptions" type:"map"`
	// contains filtered or unexported fields
}

Structure for the Dataview destination type parameters.

func (DataViewDestinationTypeParams) GoString added in v1.42.10 

func (s DataViewDestinationTypeParams) 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 (*DataViewDestinationTypeParams) SetDestinationType added in v1.42.10 

func (s *DataViewDestinationTypeParams) SetDestinationType(v string) *DataViewDestinationTypeParams

SetDestinationType sets the DestinationType field's value.

func (*DataViewDestinationTypeParams) SetS3DestinationExportFileFormat added in v1.42.24 

func (s *DataViewDestinationTypeParams) SetS3DestinationExportFileFormat(v string) *DataViewDestinationTypeParams

SetS3DestinationExportFileFormat sets the S3DestinationExportFileFormat field's value.

func (*DataViewDestinationTypeParams) SetS3DestinationExportFileFormatOptions added in v1.42.24 

func (s *DataViewDestinationTypeParams) SetS3DestinationExportFileFormatOptions(v map[string]*string) *DataViewDestinationTypeParams

SetS3DestinationExportFileFormatOptions sets the S3DestinationExportFileFormatOptions field's value.

func (DataViewDestinationTypeParams) String added in v1.42.10 

func (s DataViewDestinationTypeParams) 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 (*DataViewDestinationTypeParams) Validate added in v1.42.10 

func (s *DataViewDestinationTypeParams) Validate() error

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

type DataViewErrorInfo added in v1.42.10 

type DataViewErrorInfo struct {

	// The category of the error.
	//
	//    * VALIDATION – The inputs to this request are invalid.
	//
	//    * SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please
	//    contact AWS support to increase quotas.
	//
	//    * ACCESS_DENIED – Missing required permission to perform this request.
	//
	//    * RESOURCE_NOT_FOUND – One or more inputs to this request were not found.
	//
	//    * THROTTLING – The system temporarily lacks sufficient resources to
	//    process the request.
	//
	//    * INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.
	//
	//    * CANCELLED – Cancelled.
	//
	//    * USER_RECOVERABLE – A user recoverable error has occurred.
	ErrorCategory *string `locationName:"errorCategory" type:"string" enum:"ErrorCategory"`

	// The text of the error message.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`
	// contains filtered or unexported fields
}

The structure with error messages.

func (DataViewErrorInfo) GoString added in v1.42.10 

func (s DataViewErrorInfo) 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 (*DataViewErrorInfo) SetErrorCategory added in v1.42.10 

func (s *DataViewErrorInfo) SetErrorCategory(v string) *DataViewErrorInfo

SetErrorCategory sets the ErrorCategory field's value.

func (*DataViewErrorInfo) SetErrorMessage added in v1.42.10 

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

SetErrorMessage sets the ErrorMessage field's value.

func (DataViewErrorInfo) String added in v1.42.10 

func (s DataViewErrorInfo) 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 DataViewSummary added in v1.42.10 

type DataViewSummary struct {

	// Time range to use for the Dataview. 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.
	AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"`

	// The flag to indicate Dataview should be updated automatically.
	AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"`

	// The timestamp at which the Dataview was created in FinSpace. The value is
	// determined as epoch time in milliseconds. For example, the value for Monday,
	// November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The ARN identifier of the Dataview.
	DataViewArn *string `locationName:"dataViewArn" type:"string"`

	// The unique identifier for the Dataview.
	DataViewId *string `locationName:"dataViewId" min:"1" type:"string"`

	// Th unique identifier for the Dataview Dataset.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`

	// Information about the Dataview destination.
	DestinationTypeProperties *DataViewDestinationTypeParams `locationName:"destinationTypeProperties" type:"structure"`

	// The structure with error messages.
	ErrorInfo *DataViewErrorInfo `locationName:"errorInfo" type:"structure"`

	// The last time that a Dataview 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.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// Ordered set of column names used to partition data.
	PartitionColumns []*string `locationName:"partitionColumns" type:"list"`

	// Columns to be used for sorting the data.
	SortColumns []*string `locationName:"sortColumns" type:"list"`

	// The status of a Dataview creation.
	//
	//    * RUNNING – Dataview creation is running.
	//
	//    * STARTING – Dataview creation is starting.
	//
	//    * FAILED – Dataview creation has failed.
	//
	//    * CANCELLED – Dataview creation has been cancelled.
	//
	//    * TIMEOUT – Dataview creation has timed out.
	//
	//    * SUCCESS – Dataview creation has succeeded.
	//
	//    * PENDING – Dataview creation is pending.
	//
	//    * FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup
	//    failed.
	Status *string `locationName:"status" type:"string" enum:"DataViewStatus"`
	// contains filtered or unexported fields
}

Structure for the summary of a Dataview.

func (DataViewSummary) GoString added in v1.42.10 

func (s DataViewSummary) 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 (*DataViewSummary) SetAsOfTimestamp added in v1.42.10 

func (s *DataViewSummary) SetAsOfTimestamp(v int64) *DataViewSummary

SetAsOfTimestamp sets the AsOfTimestamp field's value.

func (*DataViewSummary) SetAutoUpdate added in v1.42.10 

func (s *DataViewSummary) SetAutoUpdate(v bool) *DataViewSummary

SetAutoUpdate sets the AutoUpdate field's value.

func (*DataViewSummary) SetCreateTime added in v1.42.10 

func (s *DataViewSummary) SetCreateTime(v int64) *DataViewSummary

SetCreateTime sets the CreateTime field's value.

func (*DataViewSummary) SetDataViewArn added in v1.42.10 

func (s *DataViewSummary) SetDataViewArn(v string) *DataViewSummary

SetDataViewArn sets the DataViewArn field's value.

func (*DataViewSummary) SetDataViewId added in v1.42.10 

func (s *DataViewSummary) SetDataViewId(v string) *DataViewSummary

SetDataViewId sets the DataViewId field's value.

func (*DataViewSummary) SetDatasetId added in v1.42.10 

func (s *DataViewSummary) SetDatasetId(v string) *DataViewSummary

SetDatasetId sets the DatasetId field's value.

func (*DataViewSummary) SetDestinationTypeProperties added in v1.42.10 

func (s *DataViewSummary) SetDestinationTypeProperties(v *DataViewDestinationTypeParams) *DataViewSummary

SetDestinationTypeProperties sets the DestinationTypeProperties field's value.

func (*DataViewSummary) SetErrorInfo added in v1.42.10 

func (s *DataViewSummary) SetErrorInfo(v *DataViewErrorInfo) *DataViewSummary

SetErrorInfo sets the ErrorInfo field's value.

func (*DataViewSummary) SetLastModifiedTime added in v1.42.10 

func (s *DataViewSummary) SetLastModifiedTime(v int64) *DataViewSummary

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DataViewSummary) SetPartitionColumns added in v1.42.10 

func (s *DataViewSummary) SetPartitionColumns(v []*string) *DataViewSummary

SetPartitionColumns sets the PartitionColumns field's value.

func (*DataViewSummary) SetSortColumns added in v1.42.10 

func (s *DataViewSummary) SetSortColumns(v []*string) *DataViewSummary

SetSortColumns sets the SortColumns field's value.

func (*DataViewSummary) SetStatus added in v1.42.10 

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

SetStatus sets the Status field's value.

func (DataViewSummary) String added in v1.42.10 

func (s DataViewSummary) 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 Dataset added in v1.42.10 

type Dataset struct {

	// The unique resource identifier for a Dataset.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The timestamp at which the Dataset 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.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The ARN identifier of the Dataset.
	DatasetArn *string `locationName:"datasetArn" type:"string"`

	// Description for a Dataset.
	DatasetDescription *string `locationName:"datasetDescription" type:"string"`

	// An identifier for a Dataset.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`

	// Display title for a Dataset.
	DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string"`

	// The format in which Dataset data is structured.
	//
	//    * TABULAR – Data is structured in a tabular format.
	//
	//    * NON_TABULAR – Data is structured in a non-tabular format.
	Kind *string `locationName:"kind" type:"string" enum:"DatasetKind"`

	// The last time that the Dataset 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.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// Contact information for a Dataset owner.
	OwnerInfo *DatasetOwnerInfo `locationName:"ownerInfo" type:"structure"`

	// Definition for a schema on a tabular Dataset.
	SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"`
	// contains filtered or unexported fields
}

The structure for a Dataset.

func (Dataset) GoString added in v1.42.10 

func (s Dataset) 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 (*Dataset) SetAlias added in v1.42.10 

func (s *Dataset) SetAlias(v string) *Dataset

SetAlias sets the Alias field's value.

func (*Dataset) SetCreateTime added in v1.42.10 

func (s *Dataset) SetCreateTime(v int64) *Dataset

SetCreateTime sets the CreateTime field's value.

func (*Dataset) SetDatasetArn added in v1.42.10 

func (s *Dataset) SetDatasetArn(v string) *Dataset

SetDatasetArn sets the DatasetArn field's value.

func (*Dataset) SetDatasetDescription added in v1.42.10 

func (s *Dataset) SetDatasetDescription(v string) *Dataset

SetDatasetDescription sets the DatasetDescription field's value.

func (*Dataset) SetDatasetId added in v1.42.10 

func (s *Dataset) SetDatasetId(v string) *Dataset

SetDatasetId sets the DatasetId field's value.

func (*Dataset) SetDatasetTitle added in v1.42.10 

func (s *Dataset) SetDatasetTitle(v string) *Dataset

SetDatasetTitle sets the DatasetTitle field's value.

func (*Dataset) SetKind added in v1.42.10 

func (s *Dataset) SetKind(v string) *Dataset

SetKind sets the Kind field's value.

func (*Dataset) SetLastModifiedTime added in v1.42.10 

func (s *Dataset) SetLastModifiedTime(v int64) *Dataset

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*Dataset) SetOwnerInfo added in v1.42.10 

func (s *Dataset) SetOwnerInfo(v *DatasetOwnerInfo) *Dataset

SetOwnerInfo sets the OwnerInfo field's value.

func (*Dataset) SetSchemaDefinition added in v1.42.10 

func (s *Dataset) SetSchemaDefinition(v *SchemaUnion) *Dataset

SetSchemaDefinition sets the SchemaDefinition field's value.

func (Dataset) String added in v1.42.10 

func (s Dataset) 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 DatasetOwnerInfo added in v1.42.10 

type DatasetOwnerInfo struct {

	// Email address for the Dataset owner.
	//
	// Email is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DatasetOwnerInfo's
	// String and GoString methods.
	Email *string `locationName:"email" min:"4" type:"string" sensitive:"true"`

	// The name of the Dataset owner.
	Name *string `locationName:"name" min:"1" type:"string"`

	// Phone number for the Dataset owner.
	PhoneNumber *string `locationName:"phoneNumber" min:"10" type:"string"`
	// contains filtered or unexported fields
}

A structure for Dataset owner info.

func (DatasetOwnerInfo) GoString added in v1.42.10 

func (s DatasetOwnerInfo) 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 (*DatasetOwnerInfo) SetEmail added in v1.42.10 

func (s *DatasetOwnerInfo) SetEmail(v string) *DatasetOwnerInfo

SetEmail sets the Email field's value.

func (*DatasetOwnerInfo) SetName added in v1.42.10 

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

SetName sets the Name field's value.

func (*DatasetOwnerInfo) SetPhoneNumber added in v1.42.10 

func (s *DatasetOwnerInfo) SetPhoneNumber(v string) *DatasetOwnerInfo

SetPhoneNumber sets the PhoneNumber field's value.

func (DatasetOwnerInfo) String added in v1.42.10 

func (s DatasetOwnerInfo) 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 (*DatasetOwnerInfo) Validate added in v1.42.10 

func (s *DatasetOwnerInfo) Validate() error

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

type DeleteDatasetInput added in v1.42.10 

type DeleteDatasetInput 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 unique identifier of the Dataset to be deleted.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request for a DeleteDataset operation.

func (DeleteDatasetInput) GoString added in v1.42.10 

func (s DeleteDatasetInput) 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 (*DeleteDatasetInput) SetClientToken added in v1.42.10 

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

SetClientToken sets the ClientToken field's value.

func (*DeleteDatasetInput) SetDatasetId added in v1.42.10 

func (s *DeleteDatasetInput) SetDatasetId(v string) *DeleteDatasetInput

SetDatasetId sets the DatasetId field's value.

func (DeleteDatasetInput) String added in v1.42.10 

func (s DeleteDatasetInput) 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 (*DeleteDatasetInput) Validate added in v1.42.10 

func (s *DeleteDatasetInput) Validate() error

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

type DeleteDatasetOutput added in v1.42.10 

type DeleteDatasetOutput struct {

	// The unique identifier for the deleted Dataset.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from an DeleteDataset operation

func (DeleteDatasetOutput) GoString added in v1.42.10 

func (s DeleteDatasetOutput) 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 (*DeleteDatasetOutput) SetDatasetId added in v1.42.10 

func (s *DeleteDatasetOutput) SetDatasetId(v string) *DeleteDatasetOutput

SetDatasetId sets the DatasetId field's value.

func (DeleteDatasetOutput) String added in v1.42.10 

func (s DeleteDatasetOutput) 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 DeletePermissionGroupInput added in v1.43.8 

type DeletePermissionGroupInput 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 unique identifier for the permission group that you want to delete.
	//
	// PermissionGroupId is a required field
	PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePermissionGroupInput) GoString added in v1.43.8 

func (s DeletePermissionGroupInput) 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 (*DeletePermissionGroupInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*DeletePermissionGroupInput) SetPermissionGroupId added in v1.43.8 

func (s *DeletePermissionGroupInput) SetPermissionGroupId(v string) *DeletePermissionGroupInput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (DeletePermissionGroupInput) String added in v1.43.8 

func (s DeletePermissionGroupInput) 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 (*DeletePermissionGroupInput) Validate added in v1.43.8 

func (s *DeletePermissionGroupInput) Validate() error

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

type DeletePermissionGroupOutput added in v1.43.8 

type DeletePermissionGroupOutput struct {

	// The unique identifier for the deleted permission group.
	PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeletePermissionGroupOutput) GoString added in v1.43.8 

func (s DeletePermissionGroupOutput) 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 (*DeletePermissionGroupOutput) SetPermissionGroupId added in v1.43.8 

func (s *DeletePermissionGroupOutput) SetPermissionGroupId(v string) *DeletePermissionGroupOutput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (DeletePermissionGroupOutput) String added in v1.43.8 

func (s DeletePermissionGroupOutput) 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 DisableUserInput added in v1.43.8 

type DisableUserInput struct {

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

	// The unique identifier for the user account that you want to disable.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisableUserInput) GoString added in v1.43.8 

func (s DisableUserInput) 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 (*DisableUserInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*DisableUserInput) SetUserId added in v1.43.8 

func (s *DisableUserInput) SetUserId(v string) *DisableUserInput

SetUserId sets the UserId field's value.

func (DisableUserInput) String added in v1.43.8 

func (s DisableUserInput) 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 (*DisableUserInput) Validate added in v1.43.8 

func (s *DisableUserInput) Validate() error

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

type DisableUserOutput added in v1.43.8 

type DisableUserOutput struct {

	// The unique identifier for the disabled user account.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DisableUserOutput) GoString added in v1.43.8 

func (s DisableUserOutput) 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 (*DisableUserOutput) SetUserId added in v1.43.8 

func (s *DisableUserOutput) SetUserId(v string) *DisableUserOutput

SetUserId sets the UserId field's value.

func (DisableUserOutput) String added in v1.43.8 

func (s DisableUserOutput) 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 DisassociateUserFromPermissionGroupInput added in v1.44.35 

type DisassociateUserFromPermissionGroupInput 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 unique identifier for the permission group.
	//
	// PermissionGroupId is a required field
	PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"`

	// The unique identifier for the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateUserFromPermissionGroupInput) GoString added in v1.44.35 

func (s DisassociateUserFromPermissionGroupInput) 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 (*DisassociateUserFromPermissionGroupInput) SetClientToken added in v1.44.35 

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

SetClientToken sets the ClientToken field's value.

func (*DisassociateUserFromPermissionGroupInput) SetPermissionGroupId added in v1.44.35 

func (s *DisassociateUserFromPermissionGroupInput) SetPermissionGroupId(v string) *DisassociateUserFromPermissionGroupInput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (*DisassociateUserFromPermissionGroupInput) SetUserId added in v1.44.35 

func (s *DisassociateUserFromPermissionGroupInput) SetUserId(v string) *DisassociateUserFromPermissionGroupInput

SetUserId sets the UserId field's value.

func (DisassociateUserFromPermissionGroupInput) String added in v1.44.35 

func (s DisassociateUserFromPermissionGroupInput) 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 (*DisassociateUserFromPermissionGroupInput) Validate added in v1.44.35 

func (s *DisassociateUserFromPermissionGroupInput) Validate() error

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

type DisassociateUserFromPermissionGroupOutput added in v1.44.35 

type DisassociateUserFromPermissionGroupOutput struct {

	// The returned status code of the response.
	StatusCode *int64 `location:"statusCode" locationName:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (DisassociateUserFromPermissionGroupOutput) GoString added in v1.44.35 

func (s DisassociateUserFromPermissionGroupOutput) 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 (*DisassociateUserFromPermissionGroupOutput) SetStatusCode added in v1.44.35 

func (s *DisassociateUserFromPermissionGroupOutput) SetStatusCode(v int64) *DisassociateUserFromPermissionGroupOutput

SetStatusCode sets the StatusCode field's value.

func (DisassociateUserFromPermissionGroupOutput) String added in v1.44.35 

func (s DisassociateUserFromPermissionGroupOutput) 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 EnableUserInput added in v1.43.8 

type EnableUserInput struct {

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

	// The unique identifier for the user account that you want to enable.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EnableUserInput) GoString added in v1.43.8 

func (s EnableUserInput) 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 (*EnableUserInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*EnableUserInput) SetUserId added in v1.43.8 

func (s *EnableUserInput) SetUserId(v string) *EnableUserInput

SetUserId sets the UserId field's value.

func (EnableUserInput) String added in v1.43.8 

func (s EnableUserInput) 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 (*EnableUserInput) Validate added in v1.43.8 

func (s *EnableUserInput) Validate() error

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

type EnableUserOutput added in v1.43.8 

type EnableUserOutput struct {

	// The unique identifier for the enabled user account.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (EnableUserOutput) GoString added in v1.43.8 

func (s EnableUserOutput) 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 (*EnableUserOutput) SetUserId added in v1.43.8 

func (s *EnableUserOutput) SetUserId(v string) *EnableUserOutput

SetUserId sets the UserId field's value.

func (EnableUserOutput) String added in v1.43.8 

func (s EnableUserOutput) 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 FinSpaceData 

type FinSpaceData struct {
	*client.Client
}

FinSpaceData provides the API operation methods for making requests to FinSpace Public API. See this package's package overview docs for details on the service.

FinSpaceData 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) *FinSpaceData

New creates a new instance of the FinSpaceData 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 FinSpaceData client from just a session.
svc := finspacedata.New(mySession)

// Create a FinSpaceData client with additional configuration
svc := finspacedata.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*FinSpaceData) AssociateUserToPermissionGroup added in v1.44.35 

func (c *FinSpaceData) AssociateUserToPermissionGroup(input *AssociateUserToPermissionGroupInput) (*AssociateUserToPermissionGroupOutput, error)

AssociateUserToPermissionGroup API operation for FinSpace Public API.

Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.

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 Public API's API operation AssociateUserToPermissionGroup 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 The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AssociateUserToPermissionGroup

func (*FinSpaceData) AssociateUserToPermissionGroupRequest added in v1.44.35 

func (c *FinSpaceData) AssociateUserToPermissionGroupRequest(input *AssociateUserToPermissionGroupInput) (req *request.Request, output *AssociateUserToPermissionGroupOutput)

AssociateUserToPermissionGroupRequest generates a "aws/request.Request" representing the client's request for the AssociateUserToPermissionGroup 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 AssociateUserToPermissionGroup for more information on using the AssociateUserToPermissionGroup 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 AssociateUserToPermissionGroupRequest method.
req, resp := client.AssociateUserToPermissionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AssociateUserToPermissionGroup

func (*FinSpaceData) AssociateUserToPermissionGroupWithContext added in v1.44.35 

func (c *FinSpaceData) AssociateUserToPermissionGroupWithContext(ctx aws.Context, input *AssociateUserToPermissionGroupInput, opts ...request.Option) (*AssociateUserToPermissionGroupOutput, error)

AssociateUserToPermissionGroupWithContext is the same as AssociateUserToPermissionGroup with the addition of the ability to pass a context and additional request options.

See AssociateUserToPermissionGroup 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 (*FinSpaceData) CreateChangeset 

func (c *FinSpaceData) CreateChangeset(input *CreateChangesetInput) (*CreateChangesetOutput, error)

CreateChangeset API operation for FinSpace Public API.

Creates a new Changeset in a FinSpace Dataset.

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 Public API's API operation CreateChangeset 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.

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • LimitExceededException A limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangeset

func (*FinSpaceData) CreateChangesetRequest 

func (c *FinSpaceData) CreateChangesetRequest(input *CreateChangesetInput) (req *request.Request, output *CreateChangesetOutput)

CreateChangesetRequest generates a "aws/request.Request" representing the client's request for the CreateChangeset 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 CreateChangeset for more information on using the CreateChangeset 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 CreateChangesetRequest method.
req, resp := client.CreateChangesetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangeset

func (*FinSpaceData) CreateChangesetWithContext 

func (c *FinSpaceData) CreateChangesetWithContext(ctx aws.Context, input *CreateChangesetInput, opts ...request.Option) (*CreateChangesetOutput, error)

CreateChangesetWithContext is the same as CreateChangeset with the addition of the ability to pass a context and additional request options.

See CreateChangeset 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 (*FinSpaceData) CreateDataView added in v1.42.10 

func (c *FinSpaceData) CreateDataView(input *CreateDataViewInput) (*CreateDataViewOutput, error)

CreateDataView API operation for FinSpace Public API.

Creates a Dataview for a Dataset.

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 Public API's API operation CreateDataView 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.

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

  • LimitExceededException A limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

  • ResourceNotFoundException One or more resources can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataView

func (*FinSpaceData) CreateDataViewRequest added in v1.42.10 

func (c *FinSpaceData) CreateDataViewRequest(input *CreateDataViewInput) (req *request.Request, output *CreateDataViewOutput)

CreateDataViewRequest generates a "aws/request.Request" representing the client's request for the CreateDataView 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 CreateDataView for more information on using the CreateDataView 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 CreateDataViewRequest method.
req, resp := client.CreateDataViewRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataView

func (*FinSpaceData) CreateDataViewWithContext added in v1.42.10 

func (c *FinSpaceData) CreateDataViewWithContext(ctx aws.Context, input *CreateDataViewInput, opts ...request.Option) (*CreateDataViewOutput, error)

CreateDataViewWithContext is the same as CreateDataView with the addition of the ability to pass a context and additional request options.

See CreateDataView 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 (*FinSpaceData) CreateDataset added in v1.42.10 

func (c *FinSpaceData) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error)

CreateDataset API operation for FinSpace Public API.

Creates a new FinSpace Dataset.

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 Public API's API operation CreateDataset 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 limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

  • ResourceNotFoundException One or more resources can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataset

func (*FinSpaceData) CreateDatasetRequest added in v1.42.10 

func (c *FinSpaceData) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput)

CreateDatasetRequest generates a "aws/request.Request" representing the client's request for the CreateDataset 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 CreateDataset for more information on using the CreateDataset 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 CreateDatasetRequest method.
req, resp := client.CreateDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataset

func (*FinSpaceData) CreateDatasetWithContext added in v1.42.10 

func (c *FinSpaceData) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, error)

CreateDatasetWithContext is the same as CreateDataset with the addition of the ability to pass a context and additional request options.

See CreateDataset 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 (*FinSpaceData) CreatePermissionGroup added in v1.43.8 

func (c *FinSpaceData) CreatePermissionGroup(input *CreatePermissionGroupInput) (*CreatePermissionGroupOutput, error)

CreatePermissionGroup API operation for FinSpace Public API.

Creates a group of permissions for various actions that a user can perform in FinSpace.

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 Public API's API operation CreatePermissionGroup 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 limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroup

func (*FinSpaceData) CreatePermissionGroupRequest added in v1.43.8 

func (c *FinSpaceData) CreatePermissionGroupRequest(input *CreatePermissionGroupInput) (req *request.Request, output *CreatePermissionGroupOutput)

CreatePermissionGroupRequest generates a "aws/request.Request" representing the client's request for the CreatePermissionGroup 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 CreatePermissionGroup for more information on using the CreatePermissionGroup 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 CreatePermissionGroupRequest method.
req, resp := client.CreatePermissionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroup

func (*FinSpaceData) CreatePermissionGroupWithContext added in v1.43.8 

func (c *FinSpaceData) CreatePermissionGroupWithContext(ctx aws.Context, input *CreatePermissionGroupInput, opts ...request.Option) (*CreatePermissionGroupOutput, error)

CreatePermissionGroupWithContext is the same as CreatePermissionGroup with the addition of the ability to pass a context and additional request options.

See CreatePermissionGroup 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 (*FinSpaceData) CreateUser added in v1.43.8 

func (c *FinSpaceData) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for FinSpace Public API.

Creates a new user in FinSpace.

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 Public API's API operation CreateUser 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 limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUser

func (*FinSpaceData) CreateUserRequest added in v1.43.8 

func (c *FinSpaceData) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser 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 CreateUser for more information on using the CreateUser 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 CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUser

func (*FinSpaceData) CreateUserWithContext added in v1.43.8 

func (c *FinSpaceData) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser 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 (*FinSpaceData) DeleteDataset added in v1.42.10 

func (c *FinSpaceData) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error)

DeleteDataset API operation for FinSpace Public API.

Deletes a FinSpace Dataset.

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 Public API's API operation DeleteDataset 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.

  • LimitExceededException A limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDataset

func (*FinSpaceData) DeleteDatasetRequest added in v1.42.10 

func (c *FinSpaceData) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput)

DeleteDatasetRequest generates a "aws/request.Request" representing the client's request for the DeleteDataset 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 DeleteDataset for more information on using the DeleteDataset 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 DeleteDatasetRequest method.
req, resp := client.DeleteDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDataset

func (*FinSpaceData) DeleteDatasetWithContext added in v1.42.10 

func (c *FinSpaceData) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error)

DeleteDatasetWithContext is the same as DeleteDataset with the addition of the ability to pass a context and additional request options.

See DeleteDataset 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 (*FinSpaceData) DeletePermissionGroup added in v1.43.8 

func (c *FinSpaceData) DeletePermissionGroup(input *DeletePermissionGroupInput) (*DeletePermissionGroupOutput, error)

DeletePermissionGroup API operation for FinSpace Public API.

Deletes a permission group. This action is irreversible.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for FinSpace Public API's API operation DeletePermissionGroup 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.

  • LimitExceededException A limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroup

func (*FinSpaceData) DeletePermissionGroupRequest added in v1.43.8 

func (c *FinSpaceData) DeletePermissionGroupRequest(input *DeletePermissionGroupInput) (req *request.Request, output *DeletePermissionGroupOutput)

DeletePermissionGroupRequest generates a "aws/request.Request" representing the client's request for the DeletePermissionGroup 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 DeletePermissionGroup for more information on using the DeletePermissionGroup 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 DeletePermissionGroupRequest method.
req, resp := client.DeletePermissionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroup

func (*FinSpaceData) DeletePermissionGroupWithContext added in v1.43.8 

func (c *FinSpaceData) DeletePermissionGroupWithContext(ctx aws.Context, input *DeletePermissionGroupInput, opts ...request.Option) (*DeletePermissionGroupOutput, error)

DeletePermissionGroupWithContext is the same as DeletePermissionGroup with the addition of the ability to pass a context and additional request options.

See DeletePermissionGroup 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 (*FinSpaceData) DisableUser added in v1.43.8 

func (c *FinSpaceData) DisableUser(input *DisableUserInput) (*DisableUserOutput, error)

DisableUser API operation for FinSpace Public API.

Denies access to the FinSpace web application and API for the specified 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 Public API's API operation DisableUser 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 The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUser

func (*FinSpaceData) DisableUserRequest added in v1.43.8 

func (c *FinSpaceData) DisableUserRequest(input *DisableUserInput) (req *request.Request, output *DisableUserOutput)

DisableUserRequest generates a "aws/request.Request" representing the client's request for the DisableUser 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 DisableUser for more information on using the DisableUser 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 DisableUserRequest method.
req, resp := client.DisableUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUser

func (*FinSpaceData) DisableUserWithContext added in v1.43.8 

func (c *FinSpaceData) DisableUserWithContext(ctx aws.Context, input *DisableUserInput, opts ...request.Option) (*DisableUserOutput, error)

DisableUserWithContext is the same as DisableUser with the addition of the ability to pass a context and additional request options.

See DisableUser 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 (*FinSpaceData) DisassociateUserFromPermissionGroup added in v1.44.35 

func (c *FinSpaceData) DisassociateUserFromPermissionGroup(input *DisassociateUserFromPermissionGroupInput) (*DisassociateUserFromPermissionGroupOutput, error)

DisassociateUserFromPermissionGroup API operation for FinSpace Public API.

Removes a user account from a permission group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for FinSpace Public API's API operation DisassociateUserFromPermissionGroup 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 The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisassociateUserFromPermissionGroup

func (*FinSpaceData) DisassociateUserFromPermissionGroupRequest added in v1.44.35 

func (c *FinSpaceData) DisassociateUserFromPermissionGroupRequest(input *DisassociateUserFromPermissionGroupInput) (req *request.Request, output *DisassociateUserFromPermissionGroupOutput)

DisassociateUserFromPermissionGroupRequest generates a "aws/request.Request" representing the client's request for the DisassociateUserFromPermissionGroup 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 DisassociateUserFromPermissionGroup for more information on using the DisassociateUserFromPermissionGroup 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 DisassociateUserFromPermissionGroupRequest method.
req, resp := client.DisassociateUserFromPermissionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisassociateUserFromPermissionGroup

func (*FinSpaceData) DisassociateUserFromPermissionGroupWithContext added in v1.44.35 

func (c *FinSpaceData) DisassociateUserFromPermissionGroupWithContext(ctx aws.Context, input *DisassociateUserFromPermissionGroupInput, opts ...request.Option) (*DisassociateUserFromPermissionGroupOutput, error)

DisassociateUserFromPermissionGroupWithContext is the same as DisassociateUserFromPermissionGroup with the addition of the ability to pass a context and additional request options.

See DisassociateUserFromPermissionGroup 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 (*FinSpaceData) EnableUser added in v1.43.8 

func (c *FinSpaceData) EnableUser(input *EnableUserInput) (*EnableUserOutput, error)

EnableUser API operation for FinSpace Public API.

Allows the specified user to access the FinSpace web application and API.

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 Public API's API operation EnableUser 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.

  • LimitExceededException A limit has exceeded.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUser

func (*FinSpaceData) EnableUserRequest added in v1.43.8 

func (c *FinSpaceData) EnableUserRequest(input *EnableUserInput) (req *request.Request, output *EnableUserOutput)

EnableUserRequest generates a "aws/request.Request" representing the client's request for the EnableUser 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 EnableUser for more information on using the EnableUser 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 EnableUserRequest method.
req, resp := client.EnableUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUser

func (*FinSpaceData) EnableUserWithContext added in v1.43.8 

func (c *FinSpaceData) EnableUserWithContext(ctx aws.Context, input *EnableUserInput, opts ...request.Option) (*EnableUserOutput, error)

EnableUserWithContext is the same as EnableUser with the addition of the ability to pass a context and additional request options.

See EnableUser 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 (*FinSpaceData) GetChangeset added in v1.42.10 

func (c *FinSpaceData) GetChangeset(input *GetChangesetInput) (*GetChangesetOutput, error)

GetChangeset API operation for FinSpace Public API.

Get information about a 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 Public API's API operation GetChangeset 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.

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangeset

func (*FinSpaceData) GetChangesetRequest added in v1.42.10 

func (c *FinSpaceData) GetChangesetRequest(input *GetChangesetInput) (req *request.Request, output *GetChangesetOutput)

GetChangesetRequest generates a "aws/request.Request" representing the client's request for the GetChangeset 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 GetChangeset for more information on using the GetChangeset 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 GetChangesetRequest method.
req, resp := client.GetChangesetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangeset

func (*FinSpaceData) GetChangesetWithContext added in v1.42.10 

func (c *FinSpaceData) GetChangesetWithContext(ctx aws.Context, input *GetChangesetInput, opts ...request.Option) (*GetChangesetOutput, error)

GetChangesetWithContext is the same as GetChangeset with the addition of the ability to pass a context and additional request options.

See GetChangeset 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 (*FinSpaceData) GetDataView added in v1.42.10 

func (c *FinSpaceData) GetDataView(input *GetDataViewInput) (*GetDataViewOutput, error)

GetDataView API operation for FinSpace Public API.

Gets information about a Dataview.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for FinSpace Public API's API operation GetDataView 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.

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

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView

func (*FinSpaceData) GetDataViewRequest added in v1.42.10 

func (c *FinSpaceData) GetDataViewRequest(input *GetDataViewInput) (req *request.Request, output *GetDataViewOutput)

GetDataViewRequest generates a "aws/request.Request" representing the client's request for the GetDataView 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 GetDataView for more information on using the GetDataView 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 GetDataViewRequest method.
req, resp := client.GetDataViewRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView

func (*FinSpaceData) GetDataViewWithContext added in v1.42.10 

func (c *FinSpaceData) GetDataViewWithContext(ctx aws.Context, input *GetDataViewInput, opts ...request.Option) (*GetDataViewOutput, error)

GetDataViewWithContext is the same as GetDataView with the addition of the ability to pass a context and additional request options.

See GetDataView 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 (*FinSpaceData) GetDataset added in v1.42.10 

func (c *FinSpaceData) GetDataset(input *GetDatasetInput) (*GetDatasetOutput, error)

GetDataset API operation for FinSpace Public API.

Returns information about a Dataset.

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 Public API's API operation GetDataset 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 The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataset

func (*FinSpaceData) GetDatasetRequest added in v1.42.10 

func (c *FinSpaceData) GetDatasetRequest(input *GetDatasetInput) (req *request.Request, output *GetDatasetOutput)

GetDatasetRequest generates a "aws/request.Request" representing the client's request for the GetDataset 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 GetDataset for more information on using the GetDataset 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 GetDatasetRequest method.
req, resp := client.GetDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataset

func (*FinSpaceData) GetDatasetWithContext added in v1.42.10 

func (c *FinSpaceData) GetDatasetWithContext(ctx aws.Context, input *GetDatasetInput, opts ...request.Option) (*GetDatasetOutput, error)

GetDatasetWithContext is the same as GetDataset with the addition of the ability to pass a context and additional request options.

See GetDataset 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 (*FinSpaceData) GetExternalDataViewAccessDetails added in v1.44.44 

func (c *FinSpaceData) GetExternalDataViewAccessDetails(input *GetExternalDataViewAccessDetailsInput) (*GetExternalDataViewAccessDetailsOutput, error)

GetExternalDataViewAccessDetails API operation for FinSpace Public API.

Returns the credentials to access the external Dataview from an S3 location. To call this API:

  • You must retrieve the programmatic credentials.

  • You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

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 Public API's API operation GetExternalDataViewAccessDetails 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.

  • 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-2020-07-13/GetExternalDataViewAccessDetails

func (*FinSpaceData) GetExternalDataViewAccessDetailsRequest added in v1.44.44 

func (c *FinSpaceData) GetExternalDataViewAccessDetailsRequest(input *GetExternalDataViewAccessDetailsInput) (req *request.Request, output *GetExternalDataViewAccessDetailsOutput)

GetExternalDataViewAccessDetailsRequest generates a "aws/request.Request" representing the client's request for the GetExternalDataViewAccessDetails 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 GetExternalDataViewAccessDetails for more information on using the GetExternalDataViewAccessDetails 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 GetExternalDataViewAccessDetailsRequest method.
req, resp := client.GetExternalDataViewAccessDetailsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetails

func (*FinSpaceData) GetExternalDataViewAccessDetailsWithContext added in v1.44.44 

func (c *FinSpaceData) GetExternalDataViewAccessDetailsWithContext(ctx aws.Context, input *GetExternalDataViewAccessDetailsInput, opts ...request.Option) (*GetExternalDataViewAccessDetailsOutput, error)

GetExternalDataViewAccessDetailsWithContext is the same as GetExternalDataViewAccessDetails with the addition of the ability to pass a context and additional request options.

See GetExternalDataViewAccessDetails 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 (*FinSpaceData) GetPermissionGroup added in v1.44.35 

func (c *FinSpaceData) GetPermissionGroup(input *GetPermissionGroupInput) (*GetPermissionGroupOutput, error)

GetPermissionGroup API operation for FinSpace Public API.

Retrieves the details of a specific permission group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for FinSpace Public API's API operation GetPermissionGroup 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-2020-07-13/GetPermissionGroup

func (*FinSpaceData) GetPermissionGroupRequest added in v1.44.35 

func (c *FinSpaceData) GetPermissionGroupRequest(input *GetPermissionGroupInput) (req *request.Request, output *GetPermissionGroupOutput)

GetPermissionGroupRequest generates a "aws/request.Request" representing the client's request for the GetPermissionGroup 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 GetPermissionGroup for more information on using the GetPermissionGroup 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 GetPermissionGroupRequest method.
req, resp := client.GetPermissionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetPermissionGroup

func (*FinSpaceData) GetPermissionGroupWithContext added in v1.44.35 

func (c *FinSpaceData) GetPermissionGroupWithContext(ctx aws.Context, input *GetPermissionGroupInput, opts ...request.Option) (*GetPermissionGroupOutput, error)

GetPermissionGroupWithContext is the same as GetPermissionGroup with the addition of the ability to pass a context and additional request options.

See GetPermissionGroup 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 (*FinSpaceData) GetProgrammaticAccessCredentials 

func (c *FinSpaceData) GetProgrammaticAccessCredentials(input *GetProgrammaticAccessCredentialsInput) (*GetProgrammaticAccessCredentialsOutput, error)

GetProgrammaticAccessCredentials API operation for FinSpace Public API.

Request programmatic credentials to use with FinSpace SDK.

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 Public API's API operation GetProgrammaticAccessCredentials 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials

func (*FinSpaceData) GetProgrammaticAccessCredentialsRequest 

func (c *FinSpaceData) GetProgrammaticAccessCredentialsRequest(input *GetProgrammaticAccessCredentialsInput) (req *request.Request, output *GetProgrammaticAccessCredentialsOutput)

GetProgrammaticAccessCredentialsRequest generates a "aws/request.Request" representing the client's request for the GetProgrammaticAccessCredentials 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 GetProgrammaticAccessCredentials for more information on using the GetProgrammaticAccessCredentials 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 GetProgrammaticAccessCredentialsRequest method.
req, resp := client.GetProgrammaticAccessCredentialsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials

func (*FinSpaceData) GetProgrammaticAccessCredentialsWithContext 

func (c *FinSpaceData) GetProgrammaticAccessCredentialsWithContext(ctx aws.Context, input *GetProgrammaticAccessCredentialsInput, opts ...request.Option) (*GetProgrammaticAccessCredentialsOutput, error)

GetProgrammaticAccessCredentialsWithContext is the same as GetProgrammaticAccessCredentials with the addition of the ability to pass a context and additional request options.

See GetProgrammaticAccessCredentials 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 (*FinSpaceData) GetUser added in v1.43.8 

func (c *FinSpaceData) GetUser(input *GetUserInput) (*GetUserOutput, error)

GetUser API operation for FinSpace Public API.

Retrieves details for a specific 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 Public API's API operation GetUser 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-2020-07-13/GetUser

func (*FinSpaceData) GetUserRequest added in v1.43.8 

func (c *FinSpaceData) GetUserRequest(input *GetUserInput) (req *request.Request, output *GetUserOutput)

GetUserRequest generates a "aws/request.Request" representing the client's request for the GetUser 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 GetUser for more information on using the GetUser 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 GetUserRequest method.
req, resp := client.GetUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUser

func (*FinSpaceData) GetUserWithContext added in v1.43.8 

func (c *FinSpaceData) GetUserWithContext(ctx aws.Context, input *GetUserInput, opts ...request.Option) (*GetUserOutput, error)

GetUserWithContext is the same as GetUser with the addition of the ability to pass a context and additional request options.

See GetUser 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 (*FinSpaceData) GetWorkingLocation 

func (c *FinSpaceData) GetWorkingLocation(input *GetWorkingLocationInput) (*GetWorkingLocationOutput, error)

GetWorkingLocation API operation for FinSpace Public API.

A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.

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 Public API's API operation GetWorkingLocation for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • 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-2020-07-13/GetWorkingLocation

func (*FinSpaceData) GetWorkingLocationRequest 

func (c *FinSpaceData) GetWorkingLocationRequest(input *GetWorkingLocationInput) (req *request.Request, output *GetWorkingLocationOutput)

GetWorkingLocationRequest generates a "aws/request.Request" representing the client's request for the GetWorkingLocation 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 GetWorkingLocation for more information on using the GetWorkingLocation 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 GetWorkingLocationRequest method.
req, resp := client.GetWorkingLocationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocation

func (*FinSpaceData) GetWorkingLocationWithContext 

func (c *FinSpaceData) GetWorkingLocationWithContext(ctx aws.Context, input *GetWorkingLocationInput, opts ...request.Option) (*GetWorkingLocationOutput, error)

GetWorkingLocationWithContext is the same as GetWorkingLocation with the addition of the ability to pass a context and additional request options.

See GetWorkingLocation 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 (*FinSpaceData) ListChangesets added in v1.42.10 

func (c *FinSpaceData) ListChangesets(input *ListChangesetsInput) (*ListChangesetsOutput, error)

ListChangesets API operation for FinSpace Public API.

Lists the FinSpace Changesets for a Dataset.

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 Public API's API operation ListChangesets 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.

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesets

func (*FinSpaceData) ListChangesetsPages added in v1.42.10 

func (c *FinSpaceData) ListChangesetsPages(input *ListChangesetsInput, fn func(*ListChangesetsOutput, bool) bool) error

ListChangesetsPages iterates over the pages of a ListChangesets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListChangesets 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 ListChangesets operation.
pageNum := 0
err := client.ListChangesetsPages(params,
    func(page *finspacedata.ListChangesetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FinSpaceData) ListChangesetsPagesWithContext added in v1.42.10 

func (c *FinSpaceData) ListChangesetsPagesWithContext(ctx aws.Context, input *ListChangesetsInput, fn func(*ListChangesetsOutput, bool) bool, opts ...request.Option) error

ListChangesetsPagesWithContext same as ListChangesetsPages 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 (*FinSpaceData) ListChangesetsRequest added in v1.42.10 

func (c *FinSpaceData) ListChangesetsRequest(input *ListChangesetsInput) (req *request.Request, output *ListChangesetsOutput)

ListChangesetsRequest generates a "aws/request.Request" representing the client's request for the ListChangesets 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 ListChangesets for more information on using the ListChangesets 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 ListChangesetsRequest method.
req, resp := client.ListChangesetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesets

func (*FinSpaceData) ListChangesetsWithContext added in v1.42.10 

func (c *FinSpaceData) ListChangesetsWithContext(ctx aws.Context, input *ListChangesetsInput, opts ...request.Option) (*ListChangesetsOutput, error)

ListChangesetsWithContext is the same as ListChangesets with the addition of the ability to pass a context and additional request options.

See ListChangesets 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 (*FinSpaceData) ListDataViews added in v1.42.10 

func (c *FinSpaceData) ListDataViews(input *ListDataViewsInput) (*ListDataViewsOutput, error)

ListDataViews API operation for FinSpace Public API.

Lists all available Dataviews for a Dataset.

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 Public API's API operation ListDataViews 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.

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

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews

func (*FinSpaceData) ListDataViewsPages added in v1.42.10 

func (c *FinSpaceData) ListDataViewsPages(input *ListDataViewsInput, fn func(*ListDataViewsOutput, bool) bool) error

ListDataViewsPages iterates over the pages of a ListDataViews operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataViews 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 ListDataViews operation.
pageNum := 0
err := client.ListDataViewsPages(params,
    func(page *finspacedata.ListDataViewsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FinSpaceData) ListDataViewsPagesWithContext added in v1.42.10 

func (c *FinSpaceData) ListDataViewsPagesWithContext(ctx aws.Context, input *ListDataViewsInput, fn func(*ListDataViewsOutput, bool) bool, opts ...request.Option) error

ListDataViewsPagesWithContext same as ListDataViewsPages 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 (*FinSpaceData) ListDataViewsRequest added in v1.42.10 

func (c *FinSpaceData) ListDataViewsRequest(input *ListDataViewsInput) (req *request.Request, output *ListDataViewsOutput)

ListDataViewsRequest generates a "aws/request.Request" representing the client's request for the ListDataViews 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 ListDataViews for more information on using the ListDataViews 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 ListDataViewsRequest method.
req, resp := client.ListDataViewsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews

func (*FinSpaceData) ListDataViewsWithContext added in v1.42.10 

func (c *FinSpaceData) ListDataViewsWithContext(ctx aws.Context, input *ListDataViewsInput, opts ...request.Option) (*ListDataViewsOutput, error)

ListDataViewsWithContext is the same as ListDataViews with the addition of the ability to pass a context and additional request options.

See ListDataViews 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 (*FinSpaceData) ListDatasets added in v1.42.10 

func (c *FinSpaceData) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)

ListDatasets API operation for FinSpace Public API.

Lists all of the active Datasets that a user has access to.

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 Public API's API operation ListDatasets 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.

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

  • ConflictException The request conflicts with an existing resource.

  • ResourceNotFoundException One or more resources can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasets

func (*FinSpaceData) ListDatasetsPages added in v1.42.10 

func (c *FinSpaceData) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error

ListDatasetsPages iterates over the pages of a ListDatasets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatasets 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 ListDatasets operation.
pageNum := 0
err := client.ListDatasetsPages(params,
    func(page *finspacedata.ListDatasetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FinSpaceData) ListDatasetsPagesWithContext added in v1.42.10 

func (c *FinSpaceData) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error

ListDatasetsPagesWithContext same as ListDatasetsPages 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 (*FinSpaceData) ListDatasetsRequest added in v1.42.10 

func (c *FinSpaceData) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)

ListDatasetsRequest generates a "aws/request.Request" representing the client's request for the ListDatasets 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 ListDatasets for more information on using the ListDatasets 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 ListDatasetsRequest method.
req, resp := client.ListDatasetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasets

func (*FinSpaceData) ListDatasetsWithContext added in v1.42.10 

func (c *FinSpaceData) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error)

ListDatasetsWithContext is the same as ListDatasets with the addition of the ability to pass a context and additional request options.

See ListDatasets 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 (*FinSpaceData) ListPermissionGroups added in v1.43.8 

func (c *FinSpaceData) ListPermissionGroups(input *ListPermissionGroupsInput) (*ListPermissionGroupsOutput, error)

ListPermissionGroups API operation for FinSpace Public API.

Lists all available permission groups in FinSpace.

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 Public API's API operation ListPermissionGroups 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroups

func (*FinSpaceData) ListPermissionGroupsByUser added in v1.44.35 

func (c *FinSpaceData) ListPermissionGroupsByUser(input *ListPermissionGroupsByUserInput) (*ListPermissionGroupsByUserOutput, error)

ListPermissionGroupsByUser API operation for FinSpace Public API.

Lists all the permission groups that are associated with a specific user 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 Public API's API operation ListPermissionGroupsByUser 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-2020-07-13/ListPermissionGroupsByUser

func (*FinSpaceData) ListPermissionGroupsByUserRequest added in v1.44.35 

func (c *FinSpaceData) ListPermissionGroupsByUserRequest(input *ListPermissionGroupsByUserInput) (req *request.Request, output *ListPermissionGroupsByUserOutput)

ListPermissionGroupsByUserRequest generates a "aws/request.Request" representing the client's request for the ListPermissionGroupsByUser 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 ListPermissionGroupsByUser for more information on using the ListPermissionGroupsByUser 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 ListPermissionGroupsByUserRequest method.
req, resp := client.ListPermissionGroupsByUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsByUser

func (*FinSpaceData) ListPermissionGroupsByUserWithContext added in v1.44.35 

func (c *FinSpaceData) ListPermissionGroupsByUserWithContext(ctx aws.Context, input *ListPermissionGroupsByUserInput, opts ...request.Option) (*ListPermissionGroupsByUserOutput, error)

ListPermissionGroupsByUserWithContext is the same as ListPermissionGroupsByUser with the addition of the ability to pass a context and additional request options.

See ListPermissionGroupsByUser 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 (*FinSpaceData) ListPermissionGroupsPages added in v1.43.8 

func (c *FinSpaceData) ListPermissionGroupsPages(input *ListPermissionGroupsInput, fn func(*ListPermissionGroupsOutput, bool) bool) error

ListPermissionGroupsPages iterates over the pages of a ListPermissionGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPermissionGroups 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 ListPermissionGroups operation.
pageNum := 0
err := client.ListPermissionGroupsPages(params,
    func(page *finspacedata.ListPermissionGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FinSpaceData) ListPermissionGroupsPagesWithContext added in v1.43.8 

func (c *FinSpaceData) ListPermissionGroupsPagesWithContext(ctx aws.Context, input *ListPermissionGroupsInput, fn func(*ListPermissionGroupsOutput, bool) bool, opts ...request.Option) error

ListPermissionGroupsPagesWithContext same as ListPermissionGroupsPages 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 (*FinSpaceData) ListPermissionGroupsRequest added in v1.43.8 

func (c *FinSpaceData) ListPermissionGroupsRequest(input *ListPermissionGroupsInput) (req *request.Request, output *ListPermissionGroupsOutput)

ListPermissionGroupsRequest generates a "aws/request.Request" representing the client's request for the ListPermissionGroups 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 ListPermissionGroups for more information on using the ListPermissionGroups 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 ListPermissionGroupsRequest method.
req, resp := client.ListPermissionGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroups

func (*FinSpaceData) ListPermissionGroupsWithContext added in v1.43.8 

func (c *FinSpaceData) ListPermissionGroupsWithContext(ctx aws.Context, input *ListPermissionGroupsInput, opts ...request.Option) (*ListPermissionGroupsOutput, error)

ListPermissionGroupsWithContext is the same as ListPermissionGroups with the addition of the ability to pass a context and additional request options.

See ListPermissionGroups 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 (*FinSpaceData) ListUsers added in v1.43.8 

func (c *FinSpaceData) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for FinSpace Public API.

Lists all available user accounts in FinSpace.

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 Public API's API operation ListUsers 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsers

func (*FinSpaceData) ListUsersByPermissionGroup added in v1.44.35 

func (c *FinSpaceData) ListUsersByPermissionGroup(input *ListUsersByPermissionGroupInput) (*ListUsersByPermissionGroupOutput, error)

ListUsersByPermissionGroup API operation for FinSpace Public API.

Lists details of all the users in a specific permission group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for FinSpace Public API's API operation ListUsersByPermissionGroup 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-2020-07-13/ListUsersByPermissionGroup

func (*FinSpaceData) ListUsersByPermissionGroupRequest added in v1.44.35 

func (c *FinSpaceData) ListUsersByPermissionGroupRequest(input *ListUsersByPermissionGroupInput) (req *request.Request, output *ListUsersByPermissionGroupOutput)

ListUsersByPermissionGroupRequest generates a "aws/request.Request" representing the client's request for the ListUsersByPermissionGroup 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 ListUsersByPermissionGroup for more information on using the ListUsersByPermissionGroup 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 ListUsersByPermissionGroupRequest method.
req, resp := client.ListUsersByPermissionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersByPermissionGroup

func (*FinSpaceData) ListUsersByPermissionGroupWithContext added in v1.44.35 

func (c *FinSpaceData) ListUsersByPermissionGroupWithContext(ctx aws.Context, input *ListUsersByPermissionGroupInput, opts ...request.Option) (*ListUsersByPermissionGroupOutput, error)

ListUsersByPermissionGroupWithContext is the same as ListUsersByPermissionGroup with the addition of the ability to pass a context and additional request options.

See ListUsersByPermissionGroup 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 (*FinSpaceData) ListUsersPages added in v1.43.8 

func (c *FinSpaceData) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error

ListUsersPages iterates over the pages of a ListUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListUsers 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 ListUsers operation.
pageNum := 0
err := client.ListUsersPages(params,
    func(page *finspacedata.ListUsersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FinSpaceData) ListUsersPagesWithContext added in v1.43.8 

func (c *FinSpaceData) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error

ListUsersPagesWithContext same as ListUsersPages 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 (*FinSpaceData) ListUsersRequest added in v1.43.8 

func (c *FinSpaceData) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)

ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers 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 ListUsers for more information on using the ListUsers 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 ListUsersRequest method.
req, resp := client.ListUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsers

func (*FinSpaceData) ListUsersWithContext added in v1.43.8 

func (c *FinSpaceData) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)

ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.

See ListUsers 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 (*FinSpaceData) ResetUserPassword added in v1.43.8 

func (c *FinSpaceData) ResetUserPassword(input *ResetUserPasswordInput) (*ResetUserPasswordOutput, error)

ResetUserPassword API operation for FinSpace Public API.

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the 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 Public API's API operation ResetUserPassword 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 The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPassword

func (*FinSpaceData) ResetUserPasswordRequest added in v1.43.8 

func (c *FinSpaceData) ResetUserPasswordRequest(input *ResetUserPasswordInput) (req *request.Request, output *ResetUserPasswordOutput)

ResetUserPasswordRequest generates a "aws/request.Request" representing the client's request for the ResetUserPassword 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 ResetUserPassword for more information on using the ResetUserPassword 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 ResetUserPasswordRequest method.
req, resp := client.ResetUserPasswordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPassword

func (*FinSpaceData) ResetUserPasswordWithContext added in v1.43.8 

func (c *FinSpaceData) ResetUserPasswordWithContext(ctx aws.Context, input *ResetUserPasswordInput, opts ...request.Option) (*ResetUserPasswordOutput, error)

ResetUserPasswordWithContext is the same as ResetUserPassword with the addition of the ability to pass a context and additional request options.

See ResetUserPassword 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 (*FinSpaceData) UpdateChangeset added in v1.42.10 

func (c *FinSpaceData) UpdateChangeset(input *UpdateChangesetInput) (*UpdateChangesetOutput, error)

UpdateChangeset API operation for FinSpace Public API.

Updates a FinSpace 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 Public API's API operation UpdateChangeset 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.

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ConflictException The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangeset

func (*FinSpaceData) UpdateChangesetRequest added in v1.42.10 

func (c *FinSpaceData) UpdateChangesetRequest(input *UpdateChangesetInput) (req *request.Request, output *UpdateChangesetOutput)

UpdateChangesetRequest generates a "aws/request.Request" representing the client's request for the UpdateChangeset 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 UpdateChangeset for more information on using the UpdateChangeset 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 UpdateChangesetRequest method.
req, resp := client.UpdateChangesetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangeset

func (*FinSpaceData) UpdateChangesetWithContext added in v1.42.10 

func (c *FinSpaceData) UpdateChangesetWithContext(ctx aws.Context, input *UpdateChangesetInput, opts ...request.Option) (*UpdateChangesetOutput, error)

UpdateChangesetWithContext is the same as UpdateChangeset with the addition of the ability to pass a context and additional request options.

See UpdateChangeset 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 (*FinSpaceData) UpdateDataset added in v1.42.10 

func (c *FinSpaceData) UpdateDataset(input *UpdateDatasetInput) (*UpdateDatasetOutput, error)

UpdateDataset API operation for FinSpace Public API.

Updates a FinSpace Dataset.

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 Public API's API operation UpdateDataset 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 The request conflicts with an existing resource.

  • ResourceNotFoundException One or more resources can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDataset

func (*FinSpaceData) UpdateDatasetRequest added in v1.42.10 

func (c *FinSpaceData) UpdateDatasetRequest(input *UpdateDatasetInput) (req *request.Request, output *UpdateDatasetOutput)

UpdateDatasetRequest generates a "aws/request.Request" representing the client's request for the UpdateDataset 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 UpdateDataset for more information on using the UpdateDataset 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 UpdateDatasetRequest method.
req, resp := client.UpdateDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDataset

func (*FinSpaceData) UpdateDatasetWithContext added in v1.42.10 

func (c *FinSpaceData) UpdateDatasetWithContext(ctx aws.Context, input *UpdateDatasetInput, opts ...request.Option) (*UpdateDatasetOutput, error)

UpdateDatasetWithContext is the same as UpdateDataset with the addition of the ability to pass a context and additional request options.

See UpdateDataset 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 (*FinSpaceData) UpdatePermissionGroup added in v1.43.8 

func (c *FinSpaceData) UpdatePermissionGroup(input *UpdatePermissionGroupInput) (*UpdatePermissionGroupOutput, error)

UpdatePermissionGroup API operation for FinSpace Public API.

Modifies the details of a permission group. You cannot modify a permissionGroupID.

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 Public API's API operation UpdatePermissionGroup 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 The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroup

func (*FinSpaceData) UpdatePermissionGroupRequest added in v1.43.8 

func (c *FinSpaceData) UpdatePermissionGroupRequest(input *UpdatePermissionGroupInput) (req *request.Request, output *UpdatePermissionGroupOutput)

UpdatePermissionGroupRequest generates a "aws/request.Request" representing the client's request for the UpdatePermissionGroup 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 UpdatePermissionGroup for more information on using the UpdatePermissionGroup 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 UpdatePermissionGroupRequest method.
req, resp := client.UpdatePermissionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroup

func (*FinSpaceData) UpdatePermissionGroupWithContext added in v1.43.8 

func (c *FinSpaceData) UpdatePermissionGroupWithContext(ctx aws.Context, input *UpdatePermissionGroupInput, opts ...request.Option) (*UpdatePermissionGroupOutput, error)

UpdatePermissionGroupWithContext is the same as UpdatePermissionGroup with the addition of the ability to pass a context and additional request options.

See UpdatePermissionGroup 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 (*FinSpaceData) UpdateUser added in v1.43.8 

func (c *FinSpaceData) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser API operation for FinSpace Public API.

Modifies the details of the specified user account. You cannot update the userId for 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 Public API's API operation UpdateUser 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 The request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUser

func (*FinSpaceData) UpdateUserRequest added in v1.43.8 

func (c *FinSpaceData) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)

UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser 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 UpdateUser for more information on using the UpdateUser 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 UpdateUserRequest method.
req, resp := client.UpdateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUser

func (*FinSpaceData) UpdateUserWithContext added in v1.43.8 

func (c *FinSpaceData) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)

UpdateUserWithContext is the same as UpdateUser with the addition of the ability to pass a context and additional request options.

See UpdateUser 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 GetChangesetInput added in v1.42.10 

type GetChangesetInput struct {

	// The unique identifier of the Changeset for which to get data.
	//
	// ChangesetId is a required field
	ChangesetId *string `location:"uri" locationName:"changesetId" min:"1" type:"string" required:"true"`

	// The unique identifier for the FinSpace Dataset where the Changeset is created.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to describe a changeset.

func (GetChangesetInput) GoString added in v1.42.10 

func (s GetChangesetInput) 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 (*GetChangesetInput) SetChangesetId added in v1.42.10 

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

SetChangesetId sets the ChangesetId field's value.

func (*GetChangesetInput) SetDatasetId added in v1.42.10 

func (s *GetChangesetInput) SetDatasetId(v string) *GetChangesetInput

SetDatasetId sets the DatasetId field's value.

func (GetChangesetInput) String added in v1.42.10 

func (s GetChangesetInput) 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 (*GetChangesetInput) Validate added in v1.42.10 

func (s *GetChangesetInput) Validate() error

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

type GetChangesetOutput added in v1.42.10 

type GetChangesetOutput 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 *int64 `locationName:"activeFromTimestamp" type:"long"`

	// Time until 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.
	ActiveUntilTimestamp *int64 `locationName:"activeUntilTimestamp" type:"long"`

	// Type that indicates how a Changeset is applied to a Dataset.
	//
	//    * REPLACE – Changeset is considered as a replacement to all prior loaded
	//    Changesets.
	//
	//    * APPEND – Changeset is considered as an addition to the end of all
	//    prior loaded Changesets.
	//
	//    * MODIFY – Changeset is considered as a replacement to a specific prior
	//    ingested Changeset.
	ChangeType *string `locationName:"changeType" type:"string" enum:"ChangeType"`

	// The ARN identifier of the Changeset.
	ChangesetArn *string `locationName:"changesetArn" type:"string"`

	// The unique identifier for a 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.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The unique identifier for the FinSpace Dataset where the Changeset is created.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`

	// The structure with error messages.
	ErrorInfo *ChangesetErrorInfo `locationName:"errorInfo" type:"structure"`

	// Structure of the source file(s).
	FormatParams map[string]*string `locationName:"formatParams" type:"map"`

	// Options that define the location of the data being ingested.
	SourceParams map[string]*string `locationName:"sourceParams" type:"map"`

	// The status of Changeset creation operation.
	Status *string `locationName:"status" type:"string" enum:"IngestionStatus"`

	// The unique identifier of the updated Changeset.
	UpdatedByChangesetId *string `locationName:"updatedByChangesetId" min:"1" type:"string"`

	// The unique identifier of the Changeset that is being updated.
	UpdatesChangesetId *string `locationName:"updatesChangesetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from a describe changeset operation

func (GetChangesetOutput) GoString added in v1.42.10 

func (s GetChangesetOutput) 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 (*GetChangesetOutput) SetActiveFromTimestamp added in v1.42.24 

func (s *GetChangesetOutput) SetActiveFromTimestamp(v int64) *GetChangesetOutput

SetActiveFromTimestamp sets the ActiveFromTimestamp field's value.

func (*GetChangesetOutput) SetActiveUntilTimestamp added in v1.42.10 

func (s *GetChangesetOutput) SetActiveUntilTimestamp(v int64) *GetChangesetOutput

SetActiveUntilTimestamp sets the ActiveUntilTimestamp field's value.

func (*GetChangesetOutput) SetChangeType added in v1.42.10 

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

SetChangeType sets the ChangeType field's value.

func (*GetChangesetOutput) SetChangesetArn added in v1.42.10 

func (s *GetChangesetOutput) SetChangesetArn(v string) *GetChangesetOutput

SetChangesetArn sets the ChangesetArn field's value.

func (*GetChangesetOutput) SetChangesetId added in v1.42.10 

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

SetChangesetId sets the ChangesetId field's value.

func (*GetChangesetOutput) SetCreateTime added in v1.42.10 

func (s *GetChangesetOutput) SetCreateTime(v int64) *GetChangesetOutput

SetCreateTime sets the CreateTime field's value.

func (*GetChangesetOutput) SetDatasetId added in v1.42.10 

func (s *GetChangesetOutput) SetDatasetId(v string) *GetChangesetOutput

SetDatasetId sets the DatasetId field's value.

func (*GetChangesetOutput) SetErrorInfo added in v1.42.10 

func (s *GetChangesetOutput) SetErrorInfo(v *ChangesetErrorInfo) *GetChangesetOutput

SetErrorInfo sets the ErrorInfo field's value.

func (*GetChangesetOutput) SetFormatParams added in v1.42.10 

func (s *GetChangesetOutput) SetFormatParams(v map[string]*string) *GetChangesetOutput

SetFormatParams sets the FormatParams field's value.

func (*GetChangesetOutput) SetSourceParams added in v1.42.10 

func (s *GetChangesetOutput) SetSourceParams(v map[string]*string) *GetChangesetOutput

SetSourceParams sets the SourceParams field's value.

func (*GetChangesetOutput) SetStatus added in v1.42.10 

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

SetStatus sets the Status field's value.

func (*GetChangesetOutput) SetUpdatedByChangesetId added in v1.42.10 

func (s *GetChangesetOutput) SetUpdatedByChangesetId(v string) *GetChangesetOutput

SetUpdatedByChangesetId sets the UpdatedByChangesetId field's value.

func (*GetChangesetOutput) SetUpdatesChangesetId added in v1.42.10 

func (s *GetChangesetOutput) SetUpdatesChangesetId(v string) *GetChangesetOutput

SetUpdatesChangesetId sets the UpdatesChangesetId field's value.

func (GetChangesetOutput) String added in v1.42.10 

func (s GetChangesetOutput) 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 GetDataViewInput added in v1.42.10 

type GetDataViewInput struct {

	// The unique identifier for the Dataview.
	//
	// DataViewId is a required field
	DataViewId *string `location:"uri" locationName:"dataviewId" min:"1" type:"string" required:"true"`

	// The unique identifier for the Dataset used in the Dataview.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.

func (GetDataViewInput) GoString added in v1.42.10 

func (s GetDataViewInput) 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 (*GetDataViewInput) SetDataViewId added in v1.42.10 

func (s *GetDataViewInput) SetDataViewId(v string) *GetDataViewInput

SetDataViewId sets the DataViewId field's value.

func (*GetDataViewInput) SetDatasetId added in v1.42.10 

func (s *GetDataViewInput) SetDatasetId(v string) *GetDataViewInput

SetDatasetId sets the DatasetId field's value.

func (GetDataViewInput) String added in v1.42.10 

func (s GetDataViewInput) 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 (*GetDataViewInput) Validate added in v1.42.10 

func (s *GetDataViewInput) Validate() error

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

type GetDataViewOutput added in v1.42.10 

type GetDataViewOutput struct {

	// Time range to use for the Dataview. 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.
	AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"`

	// Flag to indicate Dataview should be updated automatically.
	AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"`

	// The timestamp at which the Dataview was created in FinSpace. The value is
	// determined as epoch time in milliseconds. For example, the value for Monday,
	// November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The ARN identifier of the Dataview.
	DataViewArn *string `locationName:"dataViewArn" type:"string"`

	// The unique identifier for the Dataview.
	DataViewId *string `locationName:"dataViewId" min:"1" type:"string"`

	// The unique identifier for the Dataset used in the Dataview.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`

	// Options that define the destination type for the Dataview.
	DestinationTypeParams *DataViewDestinationTypeParams `locationName:"destinationTypeParams" type:"structure"`

	// Information about an error that occurred for the Dataview.
	ErrorInfo *DataViewErrorInfo `locationName:"errorInfo" type:"structure"`

	// The last time that a Dataview 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.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// Ordered set of column names used to partition data.
	PartitionColumns []*string `locationName:"partitionColumns" type:"list"`

	// Columns to be used for sorting the data.
	SortColumns []*string `locationName:"sortColumns" type:"list"`

	// The status of a Dataview creation.
	//
	//    * RUNNING – Dataview creation is running.
	//
	//    * STARTING – Dataview creation is starting.
	//
	//    * FAILED – Dataview creation has failed.
	//
	//    * CANCELLED – Dataview creation has been cancelled.
	//
	//    * TIMEOUT – Dataview creation has timed out.
	//
	//    * SUCCESS – Dataview creation has succeeded.
	//
	//    * PENDING – Dataview creation is pending.
	//
	//    * FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup
	//    failed.
	Status *string `locationName:"status" type:"string" enum:"DataViewStatus"`
	// contains filtered or unexported fields
}

Response from retrieving a dataview, which includes details on the target database and table name

func (GetDataViewOutput) GoString added in v1.42.10 

func (s GetDataViewOutput) 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 (*GetDataViewOutput) SetAsOfTimestamp added in v1.42.10 

func (s *GetDataViewOutput) SetAsOfTimestamp(v int64) *GetDataViewOutput

SetAsOfTimestamp sets the AsOfTimestamp field's value.

func (*GetDataViewOutput) SetAutoUpdate added in v1.42.10 

func (s *GetDataViewOutput) SetAutoUpdate(v bool) *GetDataViewOutput

SetAutoUpdate sets the AutoUpdate field's value.

func (*GetDataViewOutput) SetCreateTime added in v1.42.10 

func (s *GetDataViewOutput) SetCreateTime(v int64) *GetDataViewOutput

SetCreateTime sets the CreateTime field's value.

func (*GetDataViewOutput) SetDataViewArn added in v1.42.10 

func (s *GetDataViewOutput) SetDataViewArn(v string) *GetDataViewOutput

SetDataViewArn sets the DataViewArn field's value.

func (*GetDataViewOutput) SetDataViewId added in v1.42.10 

func (s *GetDataViewOutput) SetDataViewId(v string) *GetDataViewOutput

SetDataViewId sets the DataViewId field's value.

func (*GetDataViewOutput) SetDatasetId added in v1.42.10 

func (s *GetDataViewOutput) SetDatasetId(v string) *GetDataViewOutput

SetDatasetId sets the DatasetId field's value.

func (*GetDataViewOutput) SetDestinationTypeParams added in v1.42.10 

func (s *GetDataViewOutput) SetDestinationTypeParams(v *DataViewDestinationTypeParams) *GetDataViewOutput

SetDestinationTypeParams sets the DestinationTypeParams field's value.

func (*GetDataViewOutput) SetErrorInfo added in v1.42.10 

func (s *GetDataViewOutput) SetErrorInfo(v *DataViewErrorInfo) *GetDataViewOutput

SetErrorInfo sets the ErrorInfo field's value.

func (*GetDataViewOutput) SetLastModifiedTime added in v1.42.10 

func (s *GetDataViewOutput) SetLastModifiedTime(v int64) *GetDataViewOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*GetDataViewOutput) SetPartitionColumns added in v1.42.10 

func (s *GetDataViewOutput) SetPartitionColumns(v []*string) *GetDataViewOutput

SetPartitionColumns sets the PartitionColumns field's value.

func (*GetDataViewOutput) SetSortColumns added in v1.42.10 

func (s *GetDataViewOutput) SetSortColumns(v []*string) *GetDataViewOutput

SetSortColumns sets the SortColumns field's value.

func (*GetDataViewOutput) SetStatus added in v1.42.10 

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

SetStatus sets the Status field's value.

func (GetDataViewOutput) String added in v1.42.10 

func (s GetDataViewOutput) 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 GetDatasetInput added in v1.42.10 

type GetDatasetInput struct {

	// The unique identifier for a Dataset.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for the GetDataset operation.

func (GetDatasetInput) GoString added in v1.42.10 

func (s GetDatasetInput) 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 (*GetDatasetInput) SetDatasetId added in v1.42.10 

func (s *GetDatasetInput) SetDatasetId(v string) *GetDatasetInput

SetDatasetId sets the DatasetId field's value.

func (GetDatasetInput) String added in v1.42.10 

func (s GetDatasetInput) 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 (*GetDatasetInput) Validate added in v1.42.10 

func (s *GetDatasetInput) Validate() error

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

type GetDatasetOutput added in v1.42.10 

type GetDatasetOutput struct {

	// The unique resource identifier for a Dataset.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The timestamp at which the Dataset 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.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The ARN identifier of the Dataset.
	DatasetArn *string `locationName:"datasetArn" type:"string"`

	// A description of the Dataset.
	DatasetDescription *string `locationName:"datasetDescription" type:"string"`

	// The unique identifier for a Dataset.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`

	// Display title for a Dataset.
	DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string"`

	// The format in which Dataset data is structured.
	//
	//    * TABULAR – Data is structured in a tabular format.
	//
	//    * NON_TABULAR – Data is structured in a non-tabular format.
	Kind *string `locationName:"kind" type:"string" enum:"DatasetKind"`

	// The last time that the Dataset 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.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// Definition for a schema on a tabular Dataset.
	SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"`

	// Status of the Dataset creation.
	//
	//    * PENDING – Dataset is pending creation.
	//
	//    * FAILED – Dataset creation has failed.
	//
	//    * SUCCESS – Dataset creation has succeeded.
	//
	//    * RUNNING – Dataset creation is running.
	Status *string `locationName:"status" type:"string" enum:"DatasetStatus"`
	// contains filtered or unexported fields
}

Response for the GetDataset operation

func (GetDatasetOutput) GoString added in v1.42.10 

func (s GetDatasetOutput) 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 (*GetDatasetOutput) SetAlias added in v1.42.10 

func (s *GetDatasetOutput) SetAlias(v string) *GetDatasetOutput

SetAlias sets the Alias field's value.

func (*GetDatasetOutput) SetCreateTime added in v1.42.10 

func (s *GetDatasetOutput) SetCreateTime(v int64) *GetDatasetOutput

SetCreateTime sets the CreateTime field's value.

func (*GetDatasetOutput) SetDatasetArn added in v1.42.10 

func (s *GetDatasetOutput) SetDatasetArn(v string) *GetDatasetOutput

SetDatasetArn sets the DatasetArn field's value.

func (*GetDatasetOutput) SetDatasetDescription added in v1.42.10 

func (s *GetDatasetOutput) SetDatasetDescription(v string) *GetDatasetOutput

SetDatasetDescription sets the DatasetDescription field's value.

func (*GetDatasetOutput) SetDatasetId added in v1.42.10 

func (s *GetDatasetOutput) SetDatasetId(v string) *GetDatasetOutput

SetDatasetId sets the DatasetId field's value.

func (*GetDatasetOutput) SetDatasetTitle added in v1.42.10 

func (s *GetDatasetOutput) SetDatasetTitle(v string) *GetDatasetOutput

SetDatasetTitle sets the DatasetTitle field's value.

func (*GetDatasetOutput) SetKind added in v1.42.10 

func (s *GetDatasetOutput) SetKind(v string) *GetDatasetOutput

SetKind sets the Kind field's value.

func (*GetDatasetOutput) SetLastModifiedTime added in v1.42.10 

func (s *GetDatasetOutput) SetLastModifiedTime(v int64) *GetDatasetOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*GetDatasetOutput) SetSchemaDefinition added in v1.42.10 

func (s *GetDatasetOutput) SetSchemaDefinition(v *SchemaUnion) *GetDatasetOutput

SetSchemaDefinition sets the SchemaDefinition field's value.

func (*GetDatasetOutput) SetStatus added in v1.42.10 

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

SetStatus sets the Status field's value.

func (GetDatasetOutput) String added in v1.42.10 

func (s GetDatasetOutput) 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 GetExternalDataViewAccessDetailsInput added in v1.44.44 

type GetExternalDataViewAccessDetailsInput struct {

	// The unique identifier for the Dataview that you want to access.
	//
	// DataViewId is a required field
	DataViewId *string `location:"uri" locationName:"dataviewId" min:"1" type:"string" required:"true"`

	// The unique identifier for the Dataset.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetExternalDataViewAccessDetailsInput) GoString added in v1.44.44 

func (s GetExternalDataViewAccessDetailsInput) 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 (*GetExternalDataViewAccessDetailsInput) SetDataViewId added in v1.44.44 

func (s *GetExternalDataViewAccessDetailsInput) SetDataViewId(v string) *GetExternalDataViewAccessDetailsInput

SetDataViewId sets the DataViewId field's value.

func (*GetExternalDataViewAccessDetailsInput) SetDatasetId added in v1.44.44 

func (s *GetExternalDataViewAccessDetailsInput) SetDatasetId(v string) *GetExternalDataViewAccessDetailsInput

SetDatasetId sets the DatasetId field's value.

func (GetExternalDataViewAccessDetailsInput) String added in v1.44.44 

func (s GetExternalDataViewAccessDetailsInput) 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 (*GetExternalDataViewAccessDetailsInput) Validate added in v1.44.44 

func (s *GetExternalDataViewAccessDetailsInput) Validate() error

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

type GetExternalDataViewAccessDetailsOutput added in v1.44.44 

type GetExternalDataViewAccessDetailsOutput struct {

	// The credentials required to access the external Dataview from the S3 location.
	Credentials *AwsCredentials `locationName:"credentials" type:"structure"`

	// The location where the external Dataview is stored.
	S3Location *S3Location `locationName:"s3Location" type:"structure"`
	// contains filtered or unexported fields
}

func (GetExternalDataViewAccessDetailsOutput) GoString added in v1.44.44 

func (s GetExternalDataViewAccessDetailsOutput) 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 (*GetExternalDataViewAccessDetailsOutput) SetCredentials added in v1.44.44 

func (s *GetExternalDataViewAccessDetailsOutput) SetCredentials(v *AwsCredentials) *GetExternalDataViewAccessDetailsOutput

SetCredentials sets the Credentials field's value.

func (*GetExternalDataViewAccessDetailsOutput) SetS3Location added in v1.44.44 

func (s *GetExternalDataViewAccessDetailsOutput) SetS3Location(v *S3Location) *GetExternalDataViewAccessDetailsOutput

SetS3Location sets the S3Location field's value.

func (GetExternalDataViewAccessDetailsOutput) String added in v1.44.44 

func (s GetExternalDataViewAccessDetailsOutput) 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 GetPermissionGroupInput added in v1.44.35 

type GetPermissionGroupInput struct {

	// The unique identifier for the permission group.
	//
	// PermissionGroupId is a required field
	PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPermissionGroupInput) GoString added in v1.44.35 

func (s GetPermissionGroupInput) 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 (*GetPermissionGroupInput) SetPermissionGroupId added in v1.44.35 

func (s *GetPermissionGroupInput) SetPermissionGroupId(v string) *GetPermissionGroupInput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (GetPermissionGroupInput) String added in v1.44.35 

func (s GetPermissionGroupInput) 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 (*GetPermissionGroupInput) Validate added in v1.44.35 

func (s *GetPermissionGroupInput) Validate() error

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

type GetPermissionGroupOutput added in v1.44.35 

type GetPermissionGroupOutput struct {

	// The structure for a permission group.
	PermissionGroup *PermissionGroup `locationName:"permissionGroup" type:"structure"`
	// contains filtered or unexported fields
}

func (GetPermissionGroupOutput) GoString added in v1.44.35 

func (s GetPermissionGroupOutput) 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 (*GetPermissionGroupOutput) SetPermissionGroup added in v1.44.35 

func (s *GetPermissionGroupOutput) SetPermissionGroup(v *PermissionGroup) *GetPermissionGroupOutput

SetPermissionGroup sets the PermissionGroup field's value.

func (GetPermissionGroupOutput) String added in v1.44.35 

func (s GetPermissionGroupOutput) 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 GetProgrammaticAccessCredentialsInput 

type GetProgrammaticAccessCredentialsInput struct {

	// The time duration in which the credentials remain valid.
	DurationInMinutes *int64 `location:"querystring" locationName:"durationInMinutes" min:"60" type:"long"`

	// The FinSpace environment identifier.
	//
	// EnvironmentId is a required field
	EnvironmentId *string `location:"querystring" locationName:"environmentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for GetProgrammaticAccessCredentials operation

func (GetProgrammaticAccessCredentialsInput) GoString 

func (s GetProgrammaticAccessCredentialsInput) 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 (*GetProgrammaticAccessCredentialsInput) SetDurationInMinutes 

func (s *GetProgrammaticAccessCredentialsInput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsInput

SetDurationInMinutes sets the DurationInMinutes field's value.

func (*GetProgrammaticAccessCredentialsInput) SetEnvironmentId 

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

SetEnvironmentId sets the EnvironmentId field's value.

func (GetProgrammaticAccessCredentialsInput) String 

func (s GetProgrammaticAccessCredentialsInput) 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 (*GetProgrammaticAccessCredentialsInput) Validate 

func (s *GetProgrammaticAccessCredentialsInput) Validate() error

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

type GetProgrammaticAccessCredentialsOutput 

type GetProgrammaticAccessCredentialsOutput struct {

	// Returns the programmatic credentials.
	Credentials *Credentials `locationName:"credentials" type:"structure"`

	// Returns the duration in which the credentials will remain valid.
	DurationInMinutes *int64 `locationName:"durationInMinutes" min:"60" type:"long"`
	// contains filtered or unexported fields
}

Response for GetProgrammaticAccessCredentials operation

func (GetProgrammaticAccessCredentialsOutput) GoString 

func (s GetProgrammaticAccessCredentialsOutput) 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 (*GetProgrammaticAccessCredentialsOutput) SetCredentials 

func (s *GetProgrammaticAccessCredentialsOutput) SetCredentials(v *Credentials) *GetProgrammaticAccessCredentialsOutput

SetCredentials sets the Credentials field's value.

func (*GetProgrammaticAccessCredentialsOutput) SetDurationInMinutes 

func (s *GetProgrammaticAccessCredentialsOutput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsOutput

SetDurationInMinutes sets the DurationInMinutes field's value.

func (GetProgrammaticAccessCredentialsOutput) String 

func (s GetProgrammaticAccessCredentialsOutput) 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 GetUserInput added in v1.43.8 

type GetUserInput struct {

	// The unique identifier of the user to get data for.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetUserInput) GoString added in v1.43.8 

func (s GetUserInput) 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 (*GetUserInput) SetUserId added in v1.43.8 

func (s *GetUserInput) SetUserId(v string) *GetUserInput

SetUserId sets the UserId field's value.

func (GetUserInput) String added in v1.43.8 

func (s GetUserInput) 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 (*GetUserInput) Validate added in v1.43.8 

func (s *GetUserInput) Validate() error

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

type GetUserOutput added in v1.43.8 

type GetUserOutput struct {

	// Indicates whether the user can use the GetProgrammaticAccessCredentials API
	// to obtain credentials that can then be used to access other FinSpace Data
	// API operations.
	//
	//    * ENABLED – The user has permissions to use the APIs.
	//
	//    * DISABLED – The user does not have permissions to use any APIs.
	ApiAccess *string `locationName:"apiAccess" type:"string" enum:"ApiAccess"`

	// The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
	// API to obtain a credentials token for a specific FinSpace user. This must
	// be an IAM role within your FinSpace account.
	ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"`

	// The timestamp at which the user account was created in FinSpace. The value
	// is determined as epoch time in milliseconds.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The email address that is associated with the user.
	//
	// EmailAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetUserOutput's
	// String and GoString methods.
	EmailAddress *string `locationName:"emailAddress" min:"4" type:"string" sensitive:"true"`

	// The first name of the user.
	//
	// FirstName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetUserOutput's
	// String and GoString methods.
	FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"`

	// Describes the last time the user account was disabled. The value is determined
	// as epoch time in milliseconds.
	LastDisabledTime *int64 `locationName:"lastDisabledTime" type:"long"`

	// Describes the last time the user account was enabled. The value is determined
	// as epoch time in milliseconds.
	LastEnabledTime *int64 `locationName:"lastEnabledTime" type:"long"`

	// Describes the last time that the user logged into their account. The value
	// is determined as epoch time in milliseconds.
	LastLoginTime *int64 `locationName:"lastLoginTime" type:"long"`

	// Describes the last time the user account was updated. The value is determined
	// as epoch time in milliseconds.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// The last name of the user.
	//
	// LastName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetUserOutput's
	// String and GoString methods.
	LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"`

	// The current status of the user account.
	//
	//    * CREATING – The user account creation is in progress.
	//
	//    * ENABLED – The user account is created and is currently active.
	//
	//    * DISABLED – The user account is currently inactive.
	Status *string `locationName:"status" type:"string" enum:"UserStatus"`

	// Indicates the type of user.
	//
	//    * SUPER_USER – A user with permission to all the functionality and data
	//    in FinSpace.
	//
	//    * APP_USER – A user with specific permissions in FinSpace. The users
	//    are assigned permissions by adding them to a permission group.
	Type *string `locationName:"type" type:"string" enum:"UserType"`

	// The unique identifier for the user account that is retrieved.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetUserOutput) GoString added in v1.43.8 

func (s GetUserOutput) 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 (*GetUserOutput) SetApiAccess added in v1.43.8 

func (s *GetUserOutput) SetApiAccess(v string) *GetUserOutput

SetApiAccess sets the ApiAccess field's value.

func (*GetUserOutput) SetApiAccessPrincipalArn added in v1.43.8 

func (s *GetUserOutput) SetApiAccessPrincipalArn(v string) *GetUserOutput

SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value.

func (*GetUserOutput) SetCreateTime added in v1.43.8 

func (s *GetUserOutput) SetCreateTime(v int64) *GetUserOutput

SetCreateTime sets the CreateTime field's value.

func (*GetUserOutput) SetEmailAddress added in v1.43.8 

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

SetEmailAddress sets the EmailAddress field's value.

func (*GetUserOutput) SetFirstName added in v1.43.8 

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

SetFirstName sets the FirstName field's value.

func (*GetUserOutput) SetLastDisabledTime added in v1.43.8 

func (s *GetUserOutput) SetLastDisabledTime(v int64) *GetUserOutput

SetLastDisabledTime sets the LastDisabledTime field's value.

func (*GetUserOutput) SetLastEnabledTime added in v1.43.8 

func (s *GetUserOutput) SetLastEnabledTime(v int64) *GetUserOutput

SetLastEnabledTime sets the LastEnabledTime field's value.

func (*GetUserOutput) SetLastLoginTime added in v1.43.8 

func (s *GetUserOutput) SetLastLoginTime(v int64) *GetUserOutput

SetLastLoginTime sets the LastLoginTime field's value.

func (*GetUserOutput) SetLastModifiedTime added in v1.43.8 

func (s *GetUserOutput) SetLastModifiedTime(v int64) *GetUserOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*GetUserOutput) SetLastName added in v1.43.8 

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

SetLastName sets the LastName field's value.

func (*GetUserOutput) SetStatus added in v1.43.8 

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

SetStatus sets the Status field's value.

func (*GetUserOutput) SetType added in v1.43.8 

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

SetType sets the Type field's value.

func (*GetUserOutput) SetUserId added in v1.43.8 

func (s *GetUserOutput) SetUserId(v string) *GetUserOutput

SetUserId sets the UserId field's value.

func (GetUserOutput) String added in v1.43.8 

func (s GetUserOutput) 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 GetWorkingLocationInput 

type GetWorkingLocationInput struct {

	// Specify the type of the working location.
	//
	//    * SAGEMAKER – Use the Amazon S3 location as a temporary location to
	//    store data content when working with FinSpace Notebooks that run on SageMaker
	//    studio.
	//
	//    * INGESTION – Use the Amazon S3 location as a staging location to copy
	//    your data content and then use the location with the Changeset creation
	//    operation.
	LocationType *string `locationName:"locationType" type:"string" enum:"LocationType"`
	// contains filtered or unexported fields
}

func (GetWorkingLocationInput) GoString 

func (s GetWorkingLocationInput) 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 (*GetWorkingLocationInput) SetLocationType 

func (s *GetWorkingLocationInput) SetLocationType(v string) *GetWorkingLocationInput

SetLocationType sets the LocationType field's value.

func (GetWorkingLocationInput) String 

func (s GetWorkingLocationInput) 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 GetWorkingLocationOutput 

type GetWorkingLocationOutput struct {

	// Returns the Amazon S3 bucket name for the working location.
	S3Bucket *string `locationName:"s3Bucket" min:"1" type:"string"`

	// Returns the Amazon S3 Path for the working location.
	S3Path *string `locationName:"s3Path" min:"1" type:"string"`

	// Returns the Amazon S3 URI for the working location.
	S3Uri *string `locationName:"s3Uri" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetWorkingLocationOutput) GoString 

func (s GetWorkingLocationOutput) 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 (*GetWorkingLocationOutput) SetS3Bucket 

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

SetS3Bucket sets the S3Bucket field's value.

func (*GetWorkingLocationOutput) SetS3Path 

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

SetS3Path sets the S3Path field's value.

func (*GetWorkingLocationOutput) SetS3Uri 

func (s *GetWorkingLocationOutput) SetS3Uri(v string) *GetWorkingLocationOutput

SetS3Uri sets the S3Uri field's value.

func (GetWorkingLocationOutput) String 

func (s GetWorkingLocationOutput) 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 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 LimitExceededException added in v1.42.10 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A limit has exceeded.

func (*LimitExceededException) Code added in v1.42.10 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.42.10 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.42.10 

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

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.42.10 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.42.10 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.42.10 

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String added in v1.42.10 

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

type ListChangesetsInput struct {

	// The unique identifier for the FinSpace Dataset to which the Changeset belongs.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`

	// The maximum number of results per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token that indicates where a results page should begin.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Request to ListChangesetsRequest. It exposes minimal query filters.

func (ListChangesetsInput) GoString added in v1.42.10 

func (s ListChangesetsInput) 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 (*ListChangesetsInput) SetDatasetId added in v1.42.10 

func (s *ListChangesetsInput) SetDatasetId(v string) *ListChangesetsInput

SetDatasetId sets the DatasetId field's value.

func (*ListChangesetsInput) SetMaxResults added in v1.42.10 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChangesetsInput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (ListChangesetsInput) String added in v1.42.10 

func (s ListChangesetsInput) 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 (*ListChangesetsInput) Validate added in v1.42.10 

func (s *ListChangesetsInput) Validate() error

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

type ListChangesetsOutput added in v1.42.10 

type ListChangesetsOutput struct {

	// List of Changesets found.
	Changesets []*ChangesetSummary `locationName:"changesets" type:"list"`

	// A token that indicates where a results page should begin.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.

func (ListChangesetsOutput) GoString added in v1.42.10 

func (s ListChangesetsOutput) 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 (*ListChangesetsOutput) SetChangesets added in v1.42.10 

func (s *ListChangesetsOutput) SetChangesets(v []*ChangesetSummary) *ListChangesetsOutput

SetChangesets sets the Changesets field's value.

func (*ListChangesetsOutput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (ListChangesetsOutput) String added in v1.42.10 

func (s ListChangesetsOutput) 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 ListDataViewsInput added in v1.42.10 

type ListDataViewsInput struct {

	// The unique identifier of the Dataset for which to retrieve Dataviews.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`

	// The maximum number of results per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token that indicates where a results page should begin.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Request for a list data views.

func (ListDataViewsInput) GoString added in v1.42.10 

func (s ListDataViewsInput) 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 (*ListDataViewsInput) SetDatasetId added in v1.42.10 

func (s *ListDataViewsInput) SetDatasetId(v string) *ListDataViewsInput

SetDatasetId sets the DatasetId field's value.

func (*ListDataViewsInput) SetMaxResults added in v1.42.10 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDataViewsInput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (ListDataViewsInput) String added in v1.42.10 

func (s ListDataViewsInput) 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 (*ListDataViewsInput) Validate added in v1.42.10 

func (s *ListDataViewsInput) Validate() error

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

type ListDataViewsOutput added in v1.42.10 

type ListDataViewsOutput struct {

	// A list of Dataviews.
	DataViews []*DataViewSummary `locationName:"dataViews" type:"list"`

	// A token that indicates where a results page should begin.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataViewsOutput) GoString added in v1.42.10 

func (s ListDataViewsOutput) 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 (*ListDataViewsOutput) SetDataViews added in v1.42.10 

func (s *ListDataViewsOutput) SetDataViews(v []*DataViewSummary) *ListDataViewsOutput

SetDataViews sets the DataViews field's value.

func (*ListDataViewsOutput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (ListDataViewsOutput) String added in v1.42.10 

func (s ListDataViewsOutput) 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 ListDatasetsInput added in v1.42.10 

type ListDatasetsInput struct {

	// The maximum number of results per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token that indicates where a results page should begin.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Request for the ListDatasets operation.

func (ListDatasetsInput) GoString added in v1.42.10 

func (s ListDatasetsInput) 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 (*ListDatasetsInput) SetMaxResults added in v1.42.10 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetsInput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetsInput) String added in v1.42.10 

func (s ListDatasetsInput) 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 (*ListDatasetsInput) Validate added in v1.42.10 

func (s *ListDatasetsInput) Validate() error

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

type ListDatasetsOutput added in v1.42.10 

type ListDatasetsOutput struct {

	// List of Datasets.
	Datasets []*Dataset `locationName:"datasets" type:"list"`

	// A token that indicates where a results page should begin.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Response for the ListDatasets operation

func (ListDatasetsOutput) GoString added in v1.42.10 

func (s ListDatasetsOutput) 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 (*ListDatasetsOutput) SetDatasets added in v1.42.10 

func (s *ListDatasetsOutput) SetDatasets(v []*Dataset) *ListDatasetsOutput

SetDatasets sets the Datasets field's value.

func (*ListDatasetsOutput) SetNextToken added in v1.42.10 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetsOutput) String added in v1.42.10 

func (s ListDatasetsOutput) 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 ListPermissionGroupsByUserInput added in v1.44.35 

type ListPermissionGroupsByUserInput struct {

	// The maximum number of results per page.
	//
	// MaxResults is a required field
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer" required:"true"`

	// A token that indicates where a results page should begin.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The unique identifier for the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListPermissionGroupsByUserInput) GoString added in v1.44.35 

func (s ListPermissionGroupsByUserInput) 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 (*ListPermissionGroupsByUserInput) SetMaxResults added in v1.44.35 

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

SetMaxResults sets the MaxResults field's value.

func (*ListPermissionGroupsByUserInput) SetNextToken added in v1.44.35 

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

SetNextToken sets the NextToken field's value.

func (*ListPermissionGroupsByUserInput) SetUserId added in v1.44.35 

func (s *ListPermissionGroupsByUserInput) SetUserId(v string) *ListPermissionGroupsByUserInput

SetUserId sets the UserId field's value.

func (ListPermissionGroupsByUserInput) String added in v1.44.35 

func (s ListPermissionGroupsByUserInput) 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 (*ListPermissionGroupsByUserInput) Validate added in v1.44.35 

func (s *ListPermissionGroupsByUserInput) Validate() error

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

type ListPermissionGroupsByUserOutput added in v1.44.35 

type ListPermissionGroupsByUserOutput struct {

	// A token that indicates where a results page should begin.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of returned permission groups.
	PermissionGroups []*PermissionGroupByUser `locationName:"permissionGroups" type:"list"`
	// contains filtered or unexported fields
}

func (ListPermissionGroupsByUserOutput) GoString added in v1.44.35 

func (s ListPermissionGroupsByUserOutput) 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 (*ListPermissionGroupsByUserOutput) SetNextToken added in v1.44.35 

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

SetNextToken sets the NextToken field's value.

func (*ListPermissionGroupsByUserOutput) SetPermissionGroups added in v1.44.35 

func (s *ListPermissionGroupsByUserOutput) SetPermissionGroups(v []*PermissionGroupByUser) *ListPermissionGroupsByUserOutput

SetPermissionGroups sets the PermissionGroups field's value.

func (ListPermissionGroupsByUserOutput) String added in v1.44.35 

func (s ListPermissionGroupsByUserOutput) 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 ListPermissionGroupsInput added in v1.43.8 

type ListPermissionGroupsInput struct {

	// The maximum number of results per page.
	//
	// MaxResults is a required field
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer" required:"true"`

	// A token that indicates where a results page should begin.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListPermissionGroupsInput) GoString added in v1.43.8 

func (s ListPermissionGroupsInput) 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 (*ListPermissionGroupsInput) SetMaxResults added in v1.43.8 

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

SetMaxResults sets the MaxResults field's value.

func (*ListPermissionGroupsInput) SetNextToken added in v1.43.8 

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

SetNextToken sets the NextToken field's value.

func (ListPermissionGroupsInput) String added in v1.43.8 

func (s ListPermissionGroupsInput) 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 (*ListPermissionGroupsInput) Validate added in v1.43.8 

func (s *ListPermissionGroupsInput) Validate() error

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

type ListPermissionGroupsOutput added in v1.43.8 

type ListPermissionGroupsOutput struct {

	// A token that indicates where a results page should begin.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of all the permission groups.
	PermissionGroups []*PermissionGroup `locationName:"permissionGroups" type:"list"`
	// contains filtered or unexported fields
}

func (ListPermissionGroupsOutput) GoString added in v1.43.8 

func (s ListPermissionGroupsOutput) 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 (*ListPermissionGroupsOutput) SetNextToken added in v1.43.8 

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

SetNextToken sets the NextToken field's value.

func (*ListPermissionGroupsOutput) SetPermissionGroups added in v1.43.8 

func (s *ListPermissionGroupsOutput) SetPermissionGroups(v []*PermissionGroup) *ListPermissionGroupsOutput

SetPermissionGroups sets the PermissionGroups field's value.

func (ListPermissionGroupsOutput) String added in v1.43.8 

func (s ListPermissionGroupsOutput) 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 ListUsersByPermissionGroupInput added in v1.44.35 

type ListUsersByPermissionGroupInput struct {

	// The maximum number of results per page.
	//
	// MaxResults is a required field
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer" required:"true"`

	// A token that indicates where a results page should begin.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The unique identifier for the permission group.
	//
	// PermissionGroupId is a required field
	PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListUsersByPermissionGroupInput) GoString added in v1.44.35 

func (s ListUsersByPermissionGroupInput) 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 (*ListUsersByPermissionGroupInput) SetMaxResults added in v1.44.35 

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

SetMaxResults sets the MaxResults field's value.

func (*ListUsersByPermissionGroupInput) SetNextToken added in v1.44.35 

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

SetNextToken sets the NextToken field's value.

func (*ListUsersByPermissionGroupInput) SetPermissionGroupId added in v1.44.35 

func (s *ListUsersByPermissionGroupInput) SetPermissionGroupId(v string) *ListUsersByPermissionGroupInput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (ListUsersByPermissionGroupInput) String added in v1.44.35 

func (s ListUsersByPermissionGroupInput) 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 (*ListUsersByPermissionGroupInput) Validate added in v1.44.35 

func (s *ListUsersByPermissionGroupInput) Validate() error

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

type ListUsersByPermissionGroupOutput added in v1.44.35 

type ListUsersByPermissionGroupOutput struct {

	// A token that indicates where a results page should begin.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Lists details of all users in a specific permission group.
	Users []*UserByPermissionGroup `locationName:"users" type:"list"`
	// contains filtered or unexported fields
}

func (ListUsersByPermissionGroupOutput) GoString added in v1.44.35 

func (s ListUsersByPermissionGroupOutput) 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 (*ListUsersByPermissionGroupOutput) SetNextToken added in v1.44.35 

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

SetNextToken sets the NextToken field's value.

func (*ListUsersByPermissionGroupOutput) SetUsers added in v1.44.35 

func (s *ListUsersByPermissionGroupOutput) SetUsers(v []*UserByPermissionGroup) *ListUsersByPermissionGroupOutput

SetUsers sets the Users field's value.

func (ListUsersByPermissionGroupOutput) String added in v1.44.35 

func (s ListUsersByPermissionGroupOutput) 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 ListUsersInput added in v1.43.8 

type ListUsersInput struct {

	// The maximum number of results per page.
	//
	// MaxResults is a required field
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer" required:"true"`

	// A token that indicates where a results page should begin.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListUsersInput) GoString added in v1.43.8 

func (s ListUsersInput) 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 (*ListUsersInput) SetMaxResults added in v1.43.8 

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

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken added in v1.43.8 

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

SetNextToken sets the NextToken field's value.

func (ListUsersInput) String added in v1.43.8 

func (s ListUsersInput) 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 (*ListUsersInput) Validate added in v1.43.8 

func (s *ListUsersInput) Validate() error

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

type ListUsersOutput added in v1.43.8 

type ListUsersOutput struct {

	// A token that indicates where a results page should begin.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of all the user accounts.
	Users []*User `locationName:"users" type:"list"`
	// contains filtered or unexported fields
}

func (ListUsersOutput) GoString added in v1.43.8 

func (s ListUsersOutput) 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 (*ListUsersOutput) SetNextToken added in v1.43.8 

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

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetUsers added in v1.43.8 

func (s *ListUsersOutput) SetUsers(v []*User) *ListUsersOutput

SetUsers sets the Users field's value.

func (ListUsersOutput) String added in v1.43.8 

func (s ListUsersOutput) 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 PermissionGroup added in v1.43.8 

type PermissionGroup struct {

	// Indicates the permissions that are granted to a specific group for accessing
	// the FinSpace application.
	//
	// When assigning application permissions, be aware that the permission ManageUsersAndGroups
	// allows users to grant themselves or others access to any functionality in
	// their FinSpace environment's application. It should only be granted to trusted
	// users.
	//
	//    * CreateDataset – Group members can create new datasets.
	//
	//    * ManageClusters – Group members can manage Apache Spark clusters from
	//    FinSpace notebooks.
	//
	//    * ManageUsersAndGroups – Group members can manage users and permission
	//    groups. This is a privileged permission that allows users to grant themselves
	//    or others access to any functionality in the application. It should only
	//    be granted to trusted users.
	//
	//    * ManageAttributeSets – Group members can manage attribute sets.
	//
	//    * ViewAuditData – Group members can view audit data.
	//
	//    * AccessNotebooks – Group members will have access to FinSpace notebooks.
	//
	//    * GetTemporaryCredentials – Group members can get temporary API credentials.
	ApplicationPermissions []*string `locationName:"applicationPermissions" type:"list" enum:"ApplicationPermission"`

	// The timestamp at which the group was created in FinSpace. The value is determined
	// as epoch time in milliseconds.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// A brief description for the permission group.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PermissionGroup's
	// String and GoString methods.
	Description *string `locationName:"description" min:"1" type:"string" sensitive:"true"`

	// Describes the last time the permission group was updated. The value is determined
	// as epoch time in milliseconds.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// Indicates the status of the user account within a permission group.
	//
	//    * ADDITION_IN_PROGRESS – The user account is currently being added to
	//    the permission group.
	//
	//    * ADDITION_SUCCESS – The user account is successfully added to the permission
	//    group.
	//
	//    * REMOVAL_IN_PROGRESS – The user is currently being removed from the
	//    permission group.
	MembershipStatus *string `locationName:"membershipStatus" type:"string" enum:"PermissionGroupMembershipStatus"`

	// The name of the permission group.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PermissionGroup's
	// String and GoString methods.
	Name *string `locationName:"name" min:"1" type:"string" sensitive:"true"`

	// The unique identifier for the permission group.
	PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The structure for a permission group.

func (PermissionGroup) GoString added in v1.43.8 

func (s PermissionGroup) 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 (*PermissionGroup) SetApplicationPermissions added in v1.43.8 

func (s *PermissionGroup) SetApplicationPermissions(v []*string) *PermissionGroup

SetApplicationPermissions sets the ApplicationPermissions field's value.

func (*PermissionGroup) SetCreateTime added in v1.43.8 

func (s *PermissionGroup) SetCreateTime(v int64) *PermissionGroup

SetCreateTime sets the CreateTime field's value.

func (*PermissionGroup) SetDescription added in v1.43.8 

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

SetDescription sets the Description field's value.

func (*PermissionGroup) SetLastModifiedTime added in v1.43.8 

func (s *PermissionGroup) SetLastModifiedTime(v int64) *PermissionGroup

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*PermissionGroup) SetMembershipStatus added in v1.44.35 

func (s *PermissionGroup) SetMembershipStatus(v string) *PermissionGroup

SetMembershipStatus sets the MembershipStatus field's value.

func (*PermissionGroup) SetName added in v1.43.8 

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

SetName sets the Name field's value.

func (*PermissionGroup) SetPermissionGroupId added in v1.43.8 

func (s *PermissionGroup) SetPermissionGroupId(v string) *PermissionGroup

SetPermissionGroupId sets the PermissionGroupId field's value.

func (PermissionGroup) String added in v1.43.8 

func (s PermissionGroup) 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 PermissionGroupByUser added in v1.44.35 

type PermissionGroupByUser struct {

	// Indicates the status of the user account within a permission group.
	//
	//    * ADDITION_IN_PROGRESS – The user account is currently being added to
	//    the permission group.
	//
	//    * ADDITION_SUCCESS – The user account is successfully added to the permission
	//    group.
	//
	//    * REMOVAL_IN_PROGRESS – The user is currently being removed from the
	//    permission group.
	MembershipStatus *string `locationName:"membershipStatus" type:"string" enum:"PermissionGroupMembershipStatus"`

	// The name of the permission group.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PermissionGroupByUser's
	// String and GoString methods.
	Name *string `locationName:"name" min:"1" type:"string" sensitive:"true"`

	// The unique identifier for the permission group.
	PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The structure of a permission group associated with a user account.

func (PermissionGroupByUser) GoString added in v1.44.35 

func (s PermissionGroupByUser) 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 (*PermissionGroupByUser) SetMembershipStatus added in v1.44.35 

func (s *PermissionGroupByUser) SetMembershipStatus(v string) *PermissionGroupByUser

SetMembershipStatus sets the MembershipStatus field's value.

func (*PermissionGroupByUser) SetName added in v1.44.35 

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

SetName sets the Name field's value.

func (*PermissionGroupByUser) SetPermissionGroupId added in v1.44.35 

func (s *PermissionGroupByUser) SetPermissionGroupId(v string) *PermissionGroupByUser

SetPermissionGroupId sets the PermissionGroupId field's value.

func (PermissionGroupByUser) String added in v1.44.35 

func (s PermissionGroupByUser) 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 PermissionGroupParams added in v1.42.10 

type PermissionGroupParams struct {

	// List of resource permissions.
	DatasetPermissions []*ResourcePermission `locationName:"datasetPermissions" type:"list"`

	// The unique identifier for the PermissionGroup.
	PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Permission group parameters for Dataset permissions.

Here is an example of how you could specify the PermissionGroupParams:

{ "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ {"permission": "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, {"permission": "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] }

func (PermissionGroupParams) GoString added in v1.42.10 

func (s PermissionGroupParams) 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 (*PermissionGroupParams) SetDatasetPermissions added in v1.42.10 

func (s *PermissionGroupParams) SetDatasetPermissions(v []*ResourcePermission) *PermissionGroupParams

SetDatasetPermissions sets the DatasetPermissions field's value.

func (*PermissionGroupParams) SetPermissionGroupId added in v1.42.10 

func (s *PermissionGroupParams) SetPermissionGroupId(v string) *PermissionGroupParams

SetPermissionGroupId sets the PermissionGroupId field's value.

func (PermissionGroupParams) String added in v1.42.10 

func (s PermissionGroupParams) 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 (*PermissionGroupParams) Validate added in v1.42.10 

func (s *PermissionGroupParams) Validate() error

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

type ResetUserPasswordInput added in v1.43.8 

type ResetUserPasswordInput struct {

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

	// The unique identifier of the user that a temporary password is requested
	// for.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResetUserPasswordInput) GoString added in v1.43.8 

func (s ResetUserPasswordInput) 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 (*ResetUserPasswordInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*ResetUserPasswordInput) SetUserId added in v1.43.8 

func (s *ResetUserPasswordInput) SetUserId(v string) *ResetUserPasswordInput

SetUserId sets the UserId field's value.

func (ResetUserPasswordInput) String added in v1.43.8 

func (s ResetUserPasswordInput) 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 (*ResetUserPasswordInput) Validate added in v1.43.8 

func (s *ResetUserPasswordInput) Validate() error

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

type ResetUserPasswordOutput added in v1.43.8 

type ResetUserPasswordOutput struct {

	// A randomly generated temporary password for the requested user account. This
	// password expires in 7 days.
	//
	// TemporaryPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ResetUserPasswordOutput's
	// String and GoString methods.
	TemporaryPassword *string `locationName:"temporaryPassword" min:"8" type:"string" sensitive:"true"`

	// The unique identifier of the user that a new password is generated for.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ResetUserPasswordOutput) GoString added in v1.43.8 

func (s ResetUserPasswordOutput) 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 (*ResetUserPasswordOutput) SetTemporaryPassword added in v1.43.8 

func (s *ResetUserPasswordOutput) SetTemporaryPassword(v string) *ResetUserPasswordOutput

SetTemporaryPassword sets the TemporaryPassword field's value.

func (*ResetUserPasswordOutput) SetUserId added in v1.43.8 

func (s *ResetUserPasswordOutput) SetUserId(v string) *ResetUserPasswordOutput

SetUserId sets the UserId field's value.

func (ResetUserPasswordOutput) String added in v1.43.8 

func (s ResetUserPasswordOutput) 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"`

	Reason *string `locationName:"reason" 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 ResourcePermission added in v1.42.10 

type ResourcePermission struct {

	// Permission for a resource.
	Permission *string `locationName:"permission" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.

The following is a list of valid dataset permissions that you can apply:

  • ViewDatasetDetails

  • ReadDatasetDetails

  • AddDatasetData

  • CreateDataView

  • EditDatasetMetadata

  • DeleteDataset

For more information on the dataset permissions, see Supported Dataset Permissions (https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions) in the FinSpace User Guide.

func (ResourcePermission) GoString added in v1.42.10 

func (s ResourcePermission) 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 (*ResourcePermission) SetPermission added in v1.42.10 

func (s *ResourcePermission) SetPermission(v string) *ResourcePermission

SetPermission sets the Permission field's value.

func (ResourcePermission) String added in v1.42.10 

func (s ResourcePermission) 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 (*ResourcePermission) Validate added in v1.42.10 

func (s *ResourcePermission) Validate() error

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

type S3Location added in v1.44.44 

type S3Location struct {

	// The name of the S3 bucket.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"1" type:"string" required:"true"`

	// The path of the folder, within the S3 bucket that contains the Dataset.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The location of an external Dataview in an S3 bucket.

func (S3Location) GoString added in v1.44.44 

func (s S3Location) 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 (*S3Location) SetBucket added in v1.44.44 

func (s *S3Location) SetBucket(v string) *S3Location

SetBucket sets the Bucket field's value.

func (*S3Location) SetKey added in v1.44.44 

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

SetKey sets the Key field's value.

func (S3Location) String added in v1.44.44 

func (s S3Location) 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 SchemaDefinition added in v1.42.10 

type SchemaDefinition struct {

	// List of column definitions.
	Columns []*ColumnDefinition `locationName:"columns" type:"list"`

	// List of column names used for primary key.
	PrimaryKeyColumns []*string `locationName:"primaryKeyColumns" type:"list"`
	// contains filtered or unexported fields
}

Definition for a schema on a tabular Dataset.

func (SchemaDefinition) GoString added in v1.42.10 

func (s SchemaDefinition) 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 (*SchemaDefinition) SetColumns added in v1.42.10 

func (s *SchemaDefinition) SetColumns(v []*ColumnDefinition) *SchemaDefinition

SetColumns sets the Columns field's value.

func (*SchemaDefinition) SetPrimaryKeyColumns added in v1.42.10 

func (s *SchemaDefinition) SetPrimaryKeyColumns(v []*string) *SchemaDefinition

SetPrimaryKeyColumns sets the PrimaryKeyColumns field's value.

func (SchemaDefinition) String added in v1.42.10 

func (s SchemaDefinition) 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 SchemaUnion added in v1.42.10 

type SchemaUnion struct {

	// The configuration for a schema on a tabular Dataset.
	TabularSchemaConfig *SchemaDefinition `locationName:"tabularSchemaConfig" type:"structure"`
	// contains filtered or unexported fields
}

A union of schema types.

func (SchemaUnion) GoString added in v1.42.10 

func (s SchemaUnion) 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 (*SchemaUnion) SetTabularSchemaConfig added in v1.42.10 

func (s *SchemaUnion) SetTabularSchemaConfig(v *SchemaDefinition) *SchemaUnion

SetTabularSchemaConfig sets the TabularSchemaConfig field's value.

func (SchemaUnion) String added in v1.42.10 

func (s SchemaUnion) 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 UpdateChangesetInput added in v1.42.10 

type UpdateChangesetInput struct {

	// The unique identifier for the Changeset to update.
	//
	// ChangesetId is a required field
	ChangesetId *string `location:"uri" locationName:"changesetId" min:"1" type:"string" required:"true"`

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

	// The unique identifier for the FinSpace Dataset in which the Changeset is
	// created.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`

	// Options that define the structure of the source file(s) including the format
	// type (formatType), header row (withHeader), data separation character (separator)
	// and the type of compression (compression).
	//
	// formatType is a required attribute and can have the following values:
	//
	//    * PARQUET – Parquet source file format.
	//
	//    * CSV – CSV source file format.
	//
	//    * JSON – JSON source file format.
	//
	//    * XML – XML source file format.
	//
	// Here is an example of how you could specify the formatParams:
	//
	// "formatParams": { "formatType": "CSV", "withHeader": "true", "separator":
	// ",", "compression":"None" }
	//
	// Note that if you only provide formatType as CSV, the rest of the attributes
	// will automatically default to CSV values as following:
	//
	// { "withHeader": "true", "separator": "," }
	//
	// For more information about supported file formats, see Supported Data Types
	// and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html)
	// in the FinSpace User Guide.
	//
	// FormatParams is a required field
	FormatParams map[string]*string `locationName:"formatParams" type:"map" required:"true"`

	// Options that define the location of the data being ingested (s3SourcePath)
	// and the source of the changeset (sourceType).
	//
	// Both s3SourcePath and sourceType are required attributes.
	//
	// Here is an example of how you could specify the sourceParams:
	//
	// "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
	// "sourceType": "S3" }
	//
	// The S3 path that you specify must allow the FinSpace role access. To do that,
	// you first need to configure the IAM policy on S3 bucket. For more information,
	// see Loading data from an Amazon S3 Bucket using the FinSpace API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets)section.
	//
	// SourceParams is a required field
	SourceParams map[string]*string `locationName:"sourceParams" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Request to update an existing changeset.

func (UpdateChangesetInput) GoString added in v1.42.10 

func (s UpdateChangesetInput) 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 (*UpdateChangesetInput) SetChangesetId added in v1.42.10 

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

SetChangesetId sets the ChangesetId field's value.

func (*UpdateChangesetInput) SetClientToken added in v1.42.10 

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

SetClientToken sets the ClientToken field's value.

func (*UpdateChangesetInput) SetDatasetId added in v1.42.10 

func (s *UpdateChangesetInput) SetDatasetId(v string) *UpdateChangesetInput

SetDatasetId sets the DatasetId field's value.

func (*UpdateChangesetInput) SetFormatParams added in v1.42.10 

func (s *UpdateChangesetInput) SetFormatParams(v map[string]*string) *UpdateChangesetInput

SetFormatParams sets the FormatParams field's value.

func (*UpdateChangesetInput) SetSourceParams added in v1.42.10 

func (s *UpdateChangesetInput) SetSourceParams(v map[string]*string) *UpdateChangesetInput

SetSourceParams sets the SourceParams field's value.

func (UpdateChangesetInput) String added in v1.42.10 

func (s UpdateChangesetInput) 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 (*UpdateChangesetInput) Validate added in v1.42.10 

func (s *UpdateChangesetInput) Validate() error

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

type UpdateChangesetOutput added in v1.42.10 

type UpdateChangesetOutput struct {

	// The unique identifier for the Changeset to update.
	ChangesetId *string `locationName:"changesetId" min:"1" type:"string"`

	// The unique identifier for the FinSpace Dataset in which the Changeset is
	// created.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from a update changeset operation.

func (UpdateChangesetOutput) GoString added in v1.42.10 

func (s UpdateChangesetOutput) 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 (*UpdateChangesetOutput) SetChangesetId added in v1.42.10 

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

SetChangesetId sets the ChangesetId field's value.

func (*UpdateChangesetOutput) SetDatasetId added in v1.42.10 

func (s *UpdateChangesetOutput) SetDatasetId(v string) *UpdateChangesetOutput

SetDatasetId sets the DatasetId field's value.

func (UpdateChangesetOutput) String added in v1.42.10 

func (s UpdateChangesetOutput) 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 UpdateDatasetInput added in v1.42.10 

type UpdateDatasetInput struct {

	// The unique resource identifier for a Dataset.
	Alias *string `locationName:"alias" min:"1" type:"string"`

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

	// A description for the Dataset.
	DatasetDescription *string `locationName:"datasetDescription" type:"string"`

	// The unique identifier for the Dataset to update.
	//
	// DatasetId is a required field
	DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"`

	// A display title for the Dataset.
	//
	// DatasetTitle is a required field
	DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string" required:"true"`

	// The format in which the Dataset data is structured.
	//
	//    * TABULAR – Data is structured in a tabular format.
	//
	//    * NON_TABULAR – Data is structured in a non-tabular format.
	//
	// Kind is a required field
	Kind *string `locationName:"kind" type:"string" required:"true" enum:"DatasetKind"`

	// Definition for a schema on a tabular Dataset.
	SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"`
	// contains filtered or unexported fields
}

The request for an UpdateDataset operation

func (UpdateDatasetInput) GoString added in v1.42.10 

func (s UpdateDatasetInput) 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 (*UpdateDatasetInput) SetAlias added in v1.42.10 

func (s *UpdateDatasetInput) SetAlias(v string) *UpdateDatasetInput

SetAlias sets the Alias field's value.

func (*UpdateDatasetInput) SetClientToken added in v1.42.10 

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

SetClientToken sets the ClientToken field's value.

func (*UpdateDatasetInput) SetDatasetDescription added in v1.42.10 

func (s *UpdateDatasetInput) SetDatasetDescription(v string) *UpdateDatasetInput

SetDatasetDescription sets the DatasetDescription field's value.

func (*UpdateDatasetInput) SetDatasetId added in v1.42.10 

func (s *UpdateDatasetInput) SetDatasetId(v string) *UpdateDatasetInput

SetDatasetId sets the DatasetId field's value.

func (*UpdateDatasetInput) SetDatasetTitle added in v1.42.10 

func (s *UpdateDatasetInput) SetDatasetTitle(v string) *UpdateDatasetInput

SetDatasetTitle sets the DatasetTitle field's value.

func (*UpdateDatasetInput) SetKind added in v1.42.10 

func (s *UpdateDatasetInput) SetKind(v string) *UpdateDatasetInput

SetKind sets the Kind field's value.

func (*UpdateDatasetInput) SetSchemaDefinition added in v1.42.10 

func (s *UpdateDatasetInput) SetSchemaDefinition(v *SchemaUnion) *UpdateDatasetInput

SetSchemaDefinition sets the SchemaDefinition field's value.

func (UpdateDatasetInput) String added in v1.42.10 

func (s UpdateDatasetInput) 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 (*UpdateDatasetInput) Validate added in v1.42.10 

func (s *UpdateDatasetInput) Validate() error

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

type UpdateDatasetOutput added in v1.42.10 

type UpdateDatasetOutput struct {

	// The unique identifier for updated Dataset.
	DatasetId *string `locationName:"datasetId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from an UpdateDataset operation

func (UpdateDatasetOutput) GoString added in v1.42.10 

func (s UpdateDatasetOutput) 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 (*UpdateDatasetOutput) SetDatasetId added in v1.42.10 

func (s *UpdateDatasetOutput) SetDatasetId(v string) *UpdateDatasetOutput

SetDatasetId sets the DatasetId field's value.

func (UpdateDatasetOutput) String added in v1.42.10 

func (s UpdateDatasetOutput) 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 UpdatePermissionGroupInput added in v1.43.8 

type UpdatePermissionGroupInput struct {

	// The permissions that are granted to a specific group for accessing the FinSpace
	// application.
	//
	// When assigning application permissions, be aware that the permission ManageUsersAndGroups
	// allows users to grant themselves or others access to any functionality in
	// their FinSpace environment's application. It should only be granted to trusted
	// users.
	//
	//    * CreateDataset – Group members can create new datasets.
	//
	//    * ManageClusters – Group members can manage Apache Spark clusters from
	//    FinSpace notebooks.
	//
	//    * ManageUsersAndGroups – Group members can manage users and permission
	//    groups. This is a privileged permission that allows users to grant themselves
	//    or others access to any functionality in the application. It should only
	//    be granted to trusted users.
	//
	//    * ManageAttributeSets – Group members can manage attribute sets.
	//
	//    * ViewAuditData – Group members can view audit data.
	//
	//    * AccessNotebooks – Group members will have access to FinSpace notebooks.
	//
	//    * GetTemporaryCredentials – Group members can get temporary API credentials.
	ApplicationPermissions []*string `locationName:"applicationPermissions" type:"list" enum:"ApplicationPermission"`

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

	// A brief description for the permission group.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdatePermissionGroupInput's
	// String and GoString methods.
	Description *string `locationName:"description" min:"1" type:"string" sensitive:"true"`

	// The name of the permission group.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdatePermissionGroupInput's
	// String and GoString methods.
	Name *string `locationName:"name" min:"1" type:"string" sensitive:"true"`

	// The unique identifier for the permission group to update.
	//
	// PermissionGroupId is a required field
	PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePermissionGroupInput) GoString added in v1.43.8 

func (s UpdatePermissionGroupInput) 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 (*UpdatePermissionGroupInput) SetApplicationPermissions added in v1.43.8 

func (s *UpdatePermissionGroupInput) SetApplicationPermissions(v []*string) *UpdatePermissionGroupInput

SetApplicationPermissions sets the ApplicationPermissions field's value.

func (*UpdatePermissionGroupInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*UpdatePermissionGroupInput) SetDescription added in v1.43.8 

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

SetDescription sets the Description field's value.

func (*UpdatePermissionGroupInput) SetName added in v1.43.8 

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

SetName sets the Name field's value.

func (*UpdatePermissionGroupInput) SetPermissionGroupId added in v1.43.8 

func (s *UpdatePermissionGroupInput) SetPermissionGroupId(v string) *UpdatePermissionGroupInput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (UpdatePermissionGroupInput) String added in v1.43.8 

func (s UpdatePermissionGroupInput) 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 (*UpdatePermissionGroupInput) Validate added in v1.43.8 

func (s *UpdatePermissionGroupInput) Validate() error

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

type UpdatePermissionGroupOutput added in v1.43.8 

type UpdatePermissionGroupOutput struct {

	// The unique identifier for the updated permission group.
	PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdatePermissionGroupOutput) GoString added in v1.43.8 

func (s UpdatePermissionGroupOutput) 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 (*UpdatePermissionGroupOutput) SetPermissionGroupId added in v1.43.8 

func (s *UpdatePermissionGroupOutput) SetPermissionGroupId(v string) *UpdatePermissionGroupOutput

SetPermissionGroupId sets the PermissionGroupId field's value.

func (UpdatePermissionGroupOutput) String added in v1.43.8 

func (s UpdatePermissionGroupOutput) 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 UpdateUserInput added in v1.43.8 

type UpdateUserInput struct {

	// The option to indicate whether the user can use the GetProgrammaticAccessCredentials
	// API to obtain credentials that can then be used to access other FinSpace
	// Data API operations.
	//
	//    * ENABLED – The user has permissions to use the APIs.
	//
	//    * DISABLED – The user does not have permissions to use any APIs.
	ApiAccess *string `locationName:"apiAccess" type:"string" enum:"ApiAccess"`

	// The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
	// API to obtain a credentials token for a specific FinSpace user. This must
	// be an IAM role within your FinSpace account.
	ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"`

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

	// The first name of the user.
	//
	// FirstName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateUserInput's
	// String and GoString methods.
	FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"`

	// The last name of the user.
	//
	// LastName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateUserInput's
	// String and GoString methods.
	LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"`

	// The option to indicate the type of user.
	//
	//    * SUPER_USER– A user with permission to all the functionality and data
	//    in FinSpace.
	//
	//    * APP_USER – A user with specific permissions in FinSpace. The users
	//    are assigned permissions by adding them to a permission group.
	Type *string `locationName:"type" type:"string" enum:"UserType"`

	// The unique identifier for the user account to update.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserInput) GoString added in v1.43.8 

func (s UpdateUserInput) 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 (*UpdateUserInput) SetApiAccess added in v1.43.8 

func (s *UpdateUserInput) SetApiAccess(v string) *UpdateUserInput

SetApiAccess sets the ApiAccess field's value.

func (*UpdateUserInput) SetApiAccessPrincipalArn added in v1.43.8 

func (s *UpdateUserInput) SetApiAccessPrincipalArn(v string) *UpdateUserInput

SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value.

func (*UpdateUserInput) SetClientToken added in v1.43.8 

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

SetClientToken sets the ClientToken field's value.

func (*UpdateUserInput) SetFirstName added in v1.43.8 

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

SetFirstName sets the FirstName field's value.

func (*UpdateUserInput) SetLastName added in v1.43.8 

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

SetLastName sets the LastName field's value.

func (*UpdateUserInput) SetType added in v1.43.8 

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

SetType sets the Type field's value.

func (*UpdateUserInput) SetUserId added in v1.43.8 

func (s *UpdateUserInput) SetUserId(v string) *UpdateUserInput

SetUserId sets the UserId field's value.

func (UpdateUserInput) String added in v1.43.8 

func (s UpdateUserInput) 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 (*UpdateUserInput) Validate added in v1.43.8 

func (s *UpdateUserInput) Validate() error

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

type UpdateUserOutput added in v1.43.8 

type UpdateUserOutput struct {

	// The unique identifier of the updated user account.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateUserOutput) GoString added in v1.43.8 

func (s UpdateUserOutput) 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 (*UpdateUserOutput) SetUserId added in v1.43.8 

func (s *UpdateUserOutput) SetUserId(v string) *UpdateUserOutput

SetUserId sets the UserId field's value.

func (UpdateUserOutput) String added in v1.43.8 

func (s UpdateUserOutput) 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 User added in v1.43.8 

type User struct {

	// Indicates whether the user can use the GetProgrammaticAccessCredentials API
	// to obtain credentials that can then be used to access other FinSpace Data
	// API operations.
	//
	//    * ENABLED – The user has permissions to use the APIs.
	//
	//    * DISABLED – The user does not have permissions to use any APIs.
	ApiAccess *string `locationName:"apiAccess" type:"string" enum:"ApiAccess"`

	// The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
	// API to obtain a credentials token for a specific FinSpace user. This must
	// be an IAM role within your FinSpace account.
	ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"`

	// The timestamp at which the user account was created in FinSpace. The value
	// is determined as epoch time in milliseconds.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The email address of the user. The email address serves as a uniquer identifier
	// for each user and cannot be changed after it's created.
	//
	// EmailAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by User's
	// String and GoString methods.
	EmailAddress *string `locationName:"emailAddress" min:"4" type:"string" sensitive:"true"`

	// The first name of the user.
	//
	// FirstName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by User's
	// String and GoString methods.
	FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"`

	// Describes the last time the user account was disabled. The value is determined
	// as epoch time in milliseconds.
	LastDisabledTime *int64 `locationName:"lastDisabledTime" type:"long"`

	// Describes the last time the user account was enabled. The value is determined
	// as epoch time in milliseconds.
	LastEnabledTime *int64 `locationName:"lastEnabledTime" type:"long"`

	// Describes the last time that the user logged into their account. The value
	// is determined as epoch time in milliseconds.
	LastLoginTime *int64 `locationName:"lastLoginTime" type:"long"`

	// Describes the last time the user account was updated. The value is determined
	// as epoch time in milliseconds.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// The last name of the user.
	//
	// LastName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by User's
	// String and GoString methods.
	LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"`

	// The current status of the user account.
	//
	//    * CREATING – The user account creation is in progress.
	//
	//    * ENABLED – The user account is created and is currently active.
	//
	//    * DISABLED – The user account is currently inactive.
	Status *string `locationName:"status" type:"string" enum:"UserStatus"`

	// Indicates the type of user.
	//
	//    * SUPER_USER – A user with permission to all the functionality and data
	//    in FinSpace.
	//
	//    * APP_USER – A user with specific permissions in FinSpace. The users
	//    are assigned permissions by adding them to a permission group.
	Type *string `locationName:"type" type:"string" enum:"UserType"`

	// The unique identifier for the user.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The details of the user account.

func (User) GoString added in v1.43.8 

func (s User) 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 (*User) SetApiAccess added in v1.43.8 

func (s *User) SetApiAccess(v string) *User

SetApiAccess sets the ApiAccess field's value.

func (*User) SetApiAccessPrincipalArn added in v1.43.8 

func (s *User) SetApiAccessPrincipalArn(v string) *User

SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value.

func (*User) SetCreateTime added in v1.43.8 

func (s *User) SetCreateTime(v int64) *User

SetCreateTime sets the CreateTime field's value.

func (*User) SetEmailAddress added in v1.43.8 

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

SetEmailAddress sets the EmailAddress field's value.

func (*User) SetFirstName added in v1.43.8 

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

SetFirstName sets the FirstName field's value.

func (*User) SetLastDisabledTime added in v1.43.8 

func (s *User) SetLastDisabledTime(v int64) *User

SetLastDisabledTime sets the LastDisabledTime field's value.

func (*User) SetLastEnabledTime added in v1.43.8 

func (s *User) SetLastEnabledTime(v int64) *User

SetLastEnabledTime sets the LastEnabledTime field's value.

func (*User) SetLastLoginTime added in v1.43.8 

func (s *User) SetLastLoginTime(v int64) *User

SetLastLoginTime sets the LastLoginTime field's value.

func (*User) SetLastModifiedTime added in v1.43.8 

func (s *User) SetLastModifiedTime(v int64) *User

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*User) SetLastName added in v1.43.8 

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

SetLastName sets the LastName field's value.

func (*User) SetStatus added in v1.43.8 

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

SetStatus sets the Status field's value.

func (*User) SetType added in v1.43.8 

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

SetType sets the Type field's value.

func (*User) SetUserId added in v1.43.8 

func (s *User) SetUserId(v string) *User

SetUserId sets the UserId field's value.

func (User) String added in v1.43.8 

func (s User) 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 UserByPermissionGroup added in v1.44.35 

type UserByPermissionGroup struct {

	// Indicates whether the user can access FinSpace API operations.
	//
	//    * ENABLED – The user has permissions to use the API operations.
	//
	//    * DISABLED – The user does not have permissions to use any API operations.
	ApiAccess *string `locationName:"apiAccess" type:"string" enum:"ApiAccess"`

	// The IAM ARN identifier that is attached to FinSpace API calls.
	ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"`

	// The email address of the user. The email address serves as a unique identifier
	// for each user and cannot be changed after it's created.
	//
	// EmailAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UserByPermissionGroup's
	// String and GoString methods.
	EmailAddress *string `locationName:"emailAddress" min:"4" type:"string" sensitive:"true"`

	// The first name of the user.
	//
	// FirstName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UserByPermissionGroup's
	// String and GoString methods.
	FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"`

	// The last name of the user.
	//
	// LastName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UserByPermissionGroup's
	// String and GoString methods.
	LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"`

	// Indicates the status of the user account within a permission group.
	//
	//    * ADDITION_IN_PROGRESS – The user account is currently being added to
	//    the permission group.
	//
	//    * ADDITION_SUCCESS – The user account is successfully added to the permission
	//    group.
	//
	//    * REMOVAL_IN_PROGRESS – The user is currently being removed from the
	//    permission group.
	MembershipStatus *string `locationName:"membershipStatus" type:"string" enum:"PermissionGroupMembershipStatus"`

	// The current status of the user account.
	//
	//    * CREATING – The user account creation is in progress.
	//
	//    * ENABLED – The user account is created and is currently active.
	//
	//    * DISABLED – The user account is currently inactive.
	Status *string `locationName:"status" type:"string" enum:"UserStatus"`

	// Indicates the type of user.
	//
	//    * SUPER_USER – A user with permission to all the functionality and data
	//    in FinSpace.
	//
	//    * APP_USER – A user with specific permissions in FinSpace. The users
	//    are assigned permissions by adding them to a permission group.
	Type *string `locationName:"type" type:"string" enum:"UserType"`

	// The unique identifier for the user.
	UserId *string `locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The structure of a user account associated with a permission group.

func (UserByPermissionGroup) GoString added in v1.44.35 

func (s UserByPermissionGroup) 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 (*UserByPermissionGroup) SetApiAccess added in v1.44.35 

func (s *UserByPermissionGroup) SetApiAccess(v string) *UserByPermissionGroup

SetApiAccess sets the ApiAccess field's value.

func (*UserByPermissionGroup) SetApiAccessPrincipalArn added in v1.44.35 

func (s *UserByPermissionGroup) SetApiAccessPrincipalArn(v string) *UserByPermissionGroup

SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value.

func (*UserByPermissionGroup) SetEmailAddress added in v1.44.35 

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

SetEmailAddress sets the EmailAddress field's value.

func (*UserByPermissionGroup) SetFirstName added in v1.44.35 

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

SetFirstName sets the FirstName field's value.

func (*UserByPermissionGroup) SetLastName added in v1.44.35 

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

SetLastName sets the LastName field's value.

func (*UserByPermissionGroup) SetMembershipStatus added in v1.44.35 

func (s *UserByPermissionGroup) SetMembershipStatus(v string) *UserByPermissionGroup

SetMembershipStatus sets the MembershipStatus field's value.

func (*UserByPermissionGroup) SetStatus added in v1.44.35 

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

SetStatus sets the Status field's value.

func (*UserByPermissionGroup) SetType added in v1.44.35 

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

SetType sets the Type field's value.

func (*UserByPermissionGroup) SetUserId added in v1.44.35 

func (s *UserByPermissionGroup) SetUserId(v string) *UserByPermissionGroup

SetUserId sets the UserId field's value.

func (UserByPermissionGroup) String added in v1.44.35 

func (s UserByPermissionGroup) 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"`

	Reason *string `locationName:"reason" 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".

Source Files

View all Source files

Directories

Path Synopsis
Package finspacedataiface provides an interface to enable mocking the FinSpace Public API service client for testing your code.
 Package finspacedataiface provides an interface to enable mocking the FinSpace Public API 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.