finspacedata

package module
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Overview

Package finspacedata provides the API client, operations, and parameter types for FinSpace Public API. 

The FinSpace APIs let you take actions inside the FinSpace.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-07-13"
View Source 
const ServiceID = "finspace data"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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

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

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

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

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

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

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

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

Types

type AssociateUserToPermissionGroupInput 

type AssociateUserToPermissionGroupInput struct {

	// The unique identifier for the permission group.
	//
	// This member is required.
	PermissionGroupId *string

	// The unique identifier for the user.
	//
	// This member is required.
	UserId *string

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

type AssociateUserToPermissionGroupOutput 

type AssociateUserToPermissionGroupOutput struct {

	// The returned status code of the response.
	StatusCode int32

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

type AuthResolverParameters 

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

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

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

type AuthSchemeResolver 

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

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

type Client 

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

Client provides the API client to make operations call for FinSpace Public API.

func New 

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

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

func NewFromConfig 

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

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateUserToPermissionGroup deprecated 

func (c *Client) AssociateUserToPermissionGroup(ctx context.Context, params *AssociateUserToPermissionGroupInput, optFns ...func(*Options)) (*AssociateUserToPermissionGroupOutput, error)

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

Deprecated: This method will be discontinued.

func (*Client) CreateChangeset deprecated 

func (c *Client) CreateChangeset(ctx context.Context, params *CreateChangesetInput, optFns ...func(*Options)) (*CreateChangesetOutput, error)

Creates a new Changeset in a FinSpace Dataset.

Deprecated: This method will be discontinued.

func (*Client) CreateDataView deprecated 

func (c *Client) CreateDataView(ctx context.Context, params *CreateDataViewInput, optFns ...func(*Options)) (*CreateDataViewOutput, error)

Creates a Dataview for a Dataset.

Deprecated: This method will be discontinued.

func (*Client) CreateDataset deprecated 

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

Creates a new FinSpace Dataset.

Deprecated: This method will be discontinued.

func (*Client) CreatePermissionGroup deprecated 

func (c *Client) CreatePermissionGroup(ctx context.Context, params *CreatePermissionGroupInput, optFns ...func(*Options)) (*CreatePermissionGroupOutput, error)

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

Deprecated: This method will be discontinued.

func (*Client) CreateUser deprecated 

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

Creates a new user in FinSpace.

Deprecated: This method will be discontinued.

func (*Client) DeleteDataset deprecated 

func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)

Deletes a FinSpace Dataset.

Deprecated: This method will be discontinued.

func (*Client) DeletePermissionGroup deprecated 

func (c *Client) DeletePermissionGroup(ctx context.Context, params *DeletePermissionGroupInput, optFns ...func(*Options)) (*DeletePermissionGroupOutput, error)

Deletes a permission group. This action is irreversible.

Deprecated: This method will be discontinued.

func (*Client) DisableUser deprecated 

func (c *Client) DisableUser(ctx context.Context, params *DisableUserInput, optFns ...func(*Options)) (*DisableUserOutput, error)

Denies access to the FinSpace web application and API for the specified user.

Deprecated: This method will be discontinued.

func (*Client) DisassociateUserFromPermissionGroup deprecated 

func (c *Client) DisassociateUserFromPermissionGroup(ctx context.Context, params *DisassociateUserFromPermissionGroupInput, optFns ...func(*Options)) (*DisassociateUserFromPermissionGroupOutput, error)

Removes a user from a permission group.

Deprecated: This method will be discontinued.

func (*Client) EnableUser deprecated 

func (c *Client) EnableUser(ctx context.Context, params *EnableUserInput, optFns ...func(*Options)) (*EnableUserOutput, error)
Allows the specified user to access the FinSpace web application and API.

Deprecated: This method will be discontinued.

func (*Client) GetChangeset deprecated 

func (c *Client) GetChangeset(ctx context.Context, params *GetChangesetInput, optFns ...func(*Options)) (*GetChangesetOutput, error)

Get information about a Changeset.

Deprecated: This method will be discontinued.

func (*Client) GetDataView deprecated 

func (c *Client) GetDataView(ctx context.Context, params *GetDataViewInput, optFns ...func(*Options)) (*GetDataViewOutput, error)

Gets information about a Dataview.

Deprecated: This method will be discontinued.

func (*Client) GetDataset deprecated 

func (c *Client) GetDataset(ctx context.Context, params *GetDatasetInput, optFns ...func(*Options)) (*GetDatasetOutput, error)

Returns information about a Dataset.

Deprecated: This method will be discontinued.

func (*Client) GetExternalDataViewAccessDetails deprecated 

func (c *Client) GetExternalDataViewAccessDetails(ctx context.Context, params *GetExternalDataViewAccessDetailsInput, optFns ...func(*Options)) (*GetExternalDataViewAccessDetailsOutput, error)

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.

Deprecated: This method will be discontinued.

func (*Client) GetPermissionGroup deprecated 

func (c *Client) GetPermissionGroup(ctx context.Context, params *GetPermissionGroupInput, optFns ...func(*Options)) (*GetPermissionGroupOutput, error)

Retrieves the details of a specific permission group.

Deprecated: This method will be discontinued.

func (*Client) GetProgrammaticAccessCredentials deprecated 

func (c *Client) GetProgrammaticAccessCredentials(ctx context.Context, params *GetProgrammaticAccessCredentialsInput, optFns ...func(*Options)) (*GetProgrammaticAccessCredentialsOutput, error)

Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.

Deprecated: This method will be discontinued.

func (*Client) GetUser deprecated 

func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error)

Retrieves details for a specific user.

Deprecated: This method will be discontinued.

func (*Client) GetWorkingLocation deprecated 

func (c *Client) GetWorkingLocation(ctx context.Context, params *GetWorkingLocationInput, optFns ...func(*Options)) (*GetWorkingLocationOutput, error)

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.

Deprecated: This method will be discontinued.

func (*Client) ListChangesets deprecated 

func (c *Client) ListChangesets(ctx context.Context, params *ListChangesetsInput, optFns ...func(*Options)) (*ListChangesetsOutput, error)

Lists the FinSpace Changesets for a Dataset.

Deprecated: This method will be discontinued.

func (*Client) ListDataViews deprecated 

func (c *Client) ListDataViews(ctx context.Context, params *ListDataViewsInput, optFns ...func(*Options)) (*ListDataViewsOutput, error)

Lists all available Dataviews for a Dataset.

Deprecated: This method will be discontinued.

func (*Client) ListDatasets deprecated 

func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

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

Deprecated: This method will be discontinued.

func (*Client) ListPermissionGroups deprecated 

func (c *Client) ListPermissionGroups(ctx context.Context, params *ListPermissionGroupsInput, optFns ...func(*Options)) (*ListPermissionGroupsOutput, error)

Lists all available permission groups in FinSpace.

Deprecated: This method will be discontinued.

func (*Client) ListPermissionGroupsByUser deprecated 

func (c *Client) ListPermissionGroupsByUser(ctx context.Context, params *ListPermissionGroupsByUserInput, optFns ...func(*Options)) (*ListPermissionGroupsByUserOutput, error)

Lists all the permission groups that are associated with a specific user.

Deprecated: This method will be discontinued.

func (*Client) ListUsers deprecated 

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Lists all available users in FinSpace.

Deprecated: This method will be discontinued.

func (*Client) ListUsersByPermissionGroup deprecated 

func (c *Client) ListUsersByPermissionGroup(ctx context.Context, params *ListUsersByPermissionGroupInput, optFns ...func(*Options)) (*ListUsersByPermissionGroupOutput, error)

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

Deprecated: This method will be discontinued.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

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

func (*Client) ResetUserPassword deprecated 

func (c *Client) ResetUserPassword(ctx context.Context, params *ResetUserPasswordInput, optFns ...func(*Options)) (*ResetUserPasswordOutput, error)

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.

Deprecated: This method will be discontinued.

func (*Client) UpdateChangeset deprecated 

func (c *Client) UpdateChangeset(ctx context.Context, params *UpdateChangesetInput, optFns ...func(*Options)) (*UpdateChangesetOutput, error)

Updates a FinSpace Changeset.

Deprecated: This method will be discontinued.

func (*Client) UpdateDataset deprecated 

func (c *Client) UpdateDataset(ctx context.Context, params *UpdateDatasetInput, optFns ...func(*Options)) (*UpdateDatasetOutput, error)

Updates a FinSpace Dataset.

Deprecated: This method will be discontinued.

func (*Client) UpdatePermissionGroup deprecated 

func (c *Client) UpdatePermissionGroup(ctx context.Context, params *UpdatePermissionGroupInput, optFns ...func(*Options)) (*UpdatePermissionGroupOutput, error)

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

Deprecated: This method will be discontinued.

func (*Client) UpdateUser deprecated 

func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)

Modifies the details of the specified user. You cannot update the userId for a user.

Deprecated: This method will be discontinued.

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.
	//
	// This member is required.
	ChangeType types.ChangeType

	// The unique identifier for the FinSpace Dataset where the Changeset will be
	// created.
	//
	// This member is required.
	DatasetId *string

	// 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] in the FinSpace User
	// Guide.
	//
	// [Supported Data Types and File Formats]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
	//
	// This member is required.
	FormatParams map[string]string

	// 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]section.
	//
	// [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
	//
	// This member is required.
	SourceParams map[string]string

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

The request for a CreateChangeset operation.

type CreateChangesetOutput 

type CreateChangesetOutput struct {

	// The unique identifier of the Changeset that is created.
	ChangesetId *string

	// The unique identifier for the FinSpace Dataset where the Changeset is created.
	DatasetId *string

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

The response from a CreateChangeset operation.

type CreateDataViewInput 

type CreateDataViewInput struct {

	// The unique Dataset identifier that is used to create a Dataview.
	//
	// This member is required.
	DatasetId *string

	// Options that define the destination type for the Dataview.
	//
	// This member is required.
	DestinationTypeParams *types.DataViewDestinationTypeParams

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

	// Flag to indicate Dataview should be updated automatically.
	AutoUpdate bool

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

	// Ordered set of column names used to partition data.
	PartitionColumns []string

	// Columns to be used for sorting the data.
	SortColumns []string
	// contains filtered or unexported fields
}

Request for creating a data view.

type CreateDataViewOutput 

type CreateDataViewOutput struct {

	// The unique identifier for the created Dataview.
	DataViewId *string

	// The unique identifier of the Dataset used for the Dataview.
	DatasetId *string

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

Response for creating a data view.

type CreateDatasetInput 

type CreateDatasetInput struct {

	// Display title for a FinSpace Dataset.
	//
	// This member is required.
	DatasetTitle *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.
	//
	// This member is required.
	Kind types.DatasetKind

	// Permission group parameters for Dataset permissions.
	//
	// This member is required.
	PermissionGroupParams *types.PermissionGroupParams

	// The unique resource identifier for a Dataset.
	Alias *string

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

	// Description of a Dataset.
	DatasetDescription *string

	// Contact information for a Dataset owner.
	OwnerInfo *types.DatasetOwnerInfo

	// Definition for a schema on a tabular Dataset.
	SchemaDefinition *types.SchemaUnion
	// contains filtered or unexported fields
}

The request for a CreateDataset operation

type CreateDatasetOutput 

type CreateDatasetOutput struct {

	// The unique identifier for the created Dataset.
	DatasetId *string

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

The response from a CreateDataset operation

type CreatePermissionGroupInput 

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.
	//
	// This member is required.
	ApplicationPermissions []types.ApplicationPermission

	// The name of the permission group.
	//
	// This member is required.
	Name *string

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

	// A brief description for the permission group.
	Description *string
	// contains filtered or unexported fields
}

type CreatePermissionGroupOutput 

type CreatePermissionGroupOutput struct {

	// The unique identifier for the permission group.
	PermissionGroupId *string

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

type CreateUserInput 

type CreateUserInput struct {

	// 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.
	//
	// This member is required.
	EmailAddress *string

	// 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.
	//
	// This member is required.
	Type types.UserType

	// 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 types.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

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

	// The first name of the user that you want to register.
	FirstName *string

	// The last name of the user that you want to register.
	LastName *string
	// contains filtered or unexported fields
}

type CreateUserOutput 

type CreateUserOutput struct {

	// The unique identifier for the user.
	UserId *string

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

type DeleteDatasetInput 

type DeleteDatasetInput struct {

	// The unique identifier of the Dataset to be deleted.
	//
	// This member is required.
	DatasetId *string

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

The request for a DeleteDataset operation.

type DeleteDatasetOutput 

type DeleteDatasetOutput struct {

	// The unique identifier for the deleted Dataset.
	DatasetId *string

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

The response from an DeleteDataset operation

type DeletePermissionGroupInput 

type DeletePermissionGroupInput struct {

	// The unique identifier for the permission group that you want to delete.
	//
	// This member is required.
	PermissionGroupId *string

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

type DeletePermissionGroupOutput 

type DeletePermissionGroupOutput struct {

	// The unique identifier for the deleted permission group.
	PermissionGroupId *string

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

type DisableUserInput 

type DisableUserInput struct {

	// The unique identifier for the user that you want to deactivate.
	//
	// This member is required.
	UserId *string

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

type DisableUserOutput 

type DisableUserOutput struct {

	// The unique identifier for the deactivated user.
	UserId *string

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

type DisassociateUserFromPermissionGroupInput 

type DisassociateUserFromPermissionGroupInput struct {

	// The unique identifier for the permission group.
	//
	// This member is required.
	PermissionGroupId *string

	// The unique identifier for the user.
	//
	// This member is required.
	UserId *string

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

type DisassociateUserFromPermissionGroupOutput 

type DisassociateUserFromPermissionGroupOutput struct {

	// The returned status code of the response.
	StatusCode int32

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

type EnableUserInput 

type EnableUserInput struct {

	// The unique identifier for the user that you want to activate.
	//
	// This member is required.
	UserId *string

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

type EnableUserOutput 

type EnableUserOutput struct {

	// The unique identifier for the active user.
	UserId *string

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

type EndpointParameters 

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

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

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

type EndpointResolverFunc 

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

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

func (EndpointResolverFunc) ResolveEndpoint 

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

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetChangesetInput 

type GetChangesetInput struct {

	// The unique identifier of the Changeset for which to get data.
	//
	// This member is required.
	ChangesetId *string

	// The unique identifier for the FinSpace Dataset where the Changeset is created.
	//
	// This member is required.
	DatasetId *string
	// contains filtered or unexported fields
}

Request to describe a changeset.

type GetChangesetOutput 

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

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

	// 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 types.ChangeType

	// The ARN identifier of the Changeset.
	ChangesetArn *string

	// The unique identifier for a Changeset.
	ChangesetId *string

	// The timestamp at which the Changeset was created in FinSpace. The value is
	// determined as epoch time in milliseconds. For example, the value for Monday,
	// November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
	CreateTime int64

	// The unique identifier for the FinSpace Dataset where the Changeset is created.
	DatasetId *string

	// The structure with error messages.
	ErrorInfo *types.ChangesetErrorInfo

	// Structure of the source file(s).
	FormatParams map[string]string

	// Options that define the location of the data being ingested.
	SourceParams map[string]string

	// The status of Changeset creation operation.
	Status types.IngestionStatus

	// The unique identifier of the updated Changeset.
	UpdatedByChangesetId *string

	// The unique identifier of the Changeset that is being updated.
	UpdatesChangesetId *string

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

The response from a describe changeset operation

type GetDataViewInput 

type GetDataViewInput struct {

	// The unique identifier for the Dataview.
	//
	// This member is required.
	DataViewId *string

	// The unique identifier for the Dataset used in the Dataview.
	//
	// This member is required.
	DatasetId *string
	// contains filtered or unexported fields
}

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

type GetDataViewOutput 

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

	// Flag to indicate Dataview should be updated automatically.
	AutoUpdate bool

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

	// The ARN identifier of the Dataview.
	DataViewArn *string

	// The unique identifier for the Dataview.
	DataViewId *string

	// The unique identifier for the Dataset used in the Dataview.
	DatasetId *string

	// Options that define the destination type for the Dataview.
	DestinationTypeParams *types.DataViewDestinationTypeParams

	// Information about an error that occurred for the Dataview.
	ErrorInfo *types.DataViewErrorInfo

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

	// Ordered set of column names used to partition data.
	PartitionColumns []string

	// Columns to be used for sorting the data.
	SortColumns []string

	// 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 types.DataViewStatus

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

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

type GetDatasetInput 

type GetDatasetInput struct {

	// The unique identifier for a Dataset.
	//
	// This member is required.
	DatasetId *string
	// contains filtered or unexported fields
}

Request for the GetDataset operation.

type GetDatasetOutput 

type GetDatasetOutput struct {

	// The unique resource identifier for a Dataset.
	Alias *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

	// The ARN identifier of the Dataset.
	DatasetArn *string

	// A description of the Dataset.
	DatasetDescription *string

	// The unique identifier for a Dataset.
	DatasetId *string

	// Display title for a Dataset.
	DatasetTitle *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 types.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

	// Definition for a schema on a tabular Dataset.
	SchemaDefinition *types.SchemaUnion

	// 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 types.DatasetStatus

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

Response for the GetDataset operation

type GetExternalDataViewAccessDetailsInput 

type GetExternalDataViewAccessDetailsInput struct {

	// The unique identifier for the Dataview that you want to access.
	//
	// This member is required.
	DataViewId *string

	// The unique identifier for the Dataset.
	//
	// This member is required.
	DatasetId *string
	// contains filtered or unexported fields
}

type GetExternalDataViewAccessDetailsOutput 

type GetExternalDataViewAccessDetailsOutput struct {

	// The credentials required to access the external Dataview from the S3 location.
	Credentials *types.AwsCredentials

	// The location where the external Dataview is stored.
	S3Location *types.S3Location

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

type GetPermissionGroupInput 

type GetPermissionGroupInput struct {

	// The unique identifier for the permission group.
	//
	// This member is required.
	PermissionGroupId *string
	// contains filtered or unexported fields
}

type GetPermissionGroupOutput 

type GetPermissionGroupOutput struct {

	// The structure for a permission group.
	PermissionGroup *types.PermissionGroup

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

type GetProgrammaticAccessCredentialsInput 

type GetProgrammaticAccessCredentialsInput struct {

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

	// The time duration in which the credentials remain valid.
	DurationInMinutes *int64
	// contains filtered or unexported fields
}

Request for GetProgrammaticAccessCredentials operation

type GetProgrammaticAccessCredentialsOutput 

type GetProgrammaticAccessCredentialsOutput struct {

	// Returns the programmatic credentials.
	Credentials *types.Credentials

	// Returns the duration in which the credentials will remain valid.
	DurationInMinutes *int64

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

Response for GetProgrammaticAccessCredentials operation

type GetUserInput 

type GetUserInput struct {

	// The unique identifier of the user to get data for.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type GetUserOutput 

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

	// The timestamp at which the user was created in FinSpace. The value is
	// determined as epoch time in milliseconds.
	CreateTime int64

	// The email address that is associated with the user.
	EmailAddress *string

	// The first name of the user.
	FirstName *string

	// Describes the last time the user was deactivated. The value is determined as
	// epoch time in milliseconds.
	LastDisabledTime int64

	// Describes the last time the user was activated. The value is determined as
	// epoch time in milliseconds.
	LastEnabledTime int64

	// Describes the last time that the user logged into their account. The value is
	// determined as epoch time in milliseconds.
	LastLoginTime int64

	// Describes the last time the user details were updated. The value is determined
	// as epoch time in milliseconds.
	LastModifiedTime int64

	// The last name of the user.
	LastName *string

	// The current status of the user.
	//
	//   - CREATING – The creation is in progress.
	//
	//   - ENABLED – The user is created and is currently active.
	//
	//   - DISABLED – The user is currently inactive.
	Status types.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 types.UserType

	// The unique identifier for the user that is retrieved.
	UserId *string

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

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 types.LocationType
	// contains filtered or unexported fields
}

type GetWorkingLocationOutput 

type GetWorkingLocationOutput struct {

	// Returns the Amazon S3 bucket name for the working location.
	S3Bucket *string

	// Returns the Amazon S3 Path for the working location.
	S3Path *string

	// Returns the Amazon S3 URI for the working location.
	S3Uri *string

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

type HTTPClient 

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

type HTTPSignerV4 

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

type IdempotencyTokenProvider 

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

IdempotencyTokenProvider interface for providing idempotency token

type ListChangesetsAPIClient 

type ListChangesetsAPIClient interface {
	ListChangesets(context.Context, *ListChangesetsInput, ...func(*Options)) (*ListChangesetsOutput, error)
}

ListChangesetsAPIClient is a client that implements the ListChangesets operation.

type ListChangesetsInput 

type ListChangesetsInput struct {

	// The unique identifier for the FinSpace Dataset to which the Changeset belongs.
	//
	// This member is required.
	DatasetId *string

	// The maximum number of results per page.
	MaxResults *int32

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

Request to ListChangesetsRequest. It exposes minimal query filters.

type ListChangesetsOutput 

type ListChangesetsOutput struct {

	// List of Changesets found.
	Changesets []types.ChangesetSummary

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

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

Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.

type ListChangesetsPaginator 

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

ListChangesetsPaginator is a paginator for ListChangesets

func NewListChangesetsPaginator 

func NewListChangesetsPaginator(client ListChangesetsAPIClient, params *ListChangesetsInput, optFns ...func(*ListChangesetsPaginatorOptions)) *ListChangesetsPaginator

NewListChangesetsPaginator returns a new ListChangesetsPaginator

func (*ListChangesetsPaginator) HasMorePages 

func (p *ListChangesetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChangesetsPaginator) NextPage 

func (p *ListChangesetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChangesetsOutput, error)

NextPage retrieves the next ListChangesets page.

type ListChangesetsPaginatorOptions 

type ListChangesetsPaginatorOptions struct {
	// The maximum number of results per page.
	Limit int32

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

ListChangesetsPaginatorOptions is the paginator options for ListChangesets

type ListDataViewsAPIClient 

type ListDataViewsAPIClient interface {
	ListDataViews(context.Context, *ListDataViewsInput, ...func(*Options)) (*ListDataViewsOutput, error)
}

ListDataViewsAPIClient is a client that implements the ListDataViews operation.

type ListDataViewsInput 

type ListDataViewsInput struct {

	// The unique identifier of the Dataset for which to retrieve Dataviews.
	//
	// This member is required.
	DatasetId *string

	// The maximum number of results per page.
	MaxResults *int32

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

Request for a list data views.

type ListDataViewsOutput 

type ListDataViewsOutput struct {

	// A list of Dataviews.
	DataViews []types.DataViewSummary

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

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

type ListDataViewsPaginator 

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

ListDataViewsPaginator is a paginator for ListDataViews

func NewListDataViewsPaginator 

func NewListDataViewsPaginator(client ListDataViewsAPIClient, params *ListDataViewsInput, optFns ...func(*ListDataViewsPaginatorOptions)) *ListDataViewsPaginator

NewListDataViewsPaginator returns a new ListDataViewsPaginator

func (*ListDataViewsPaginator) HasMorePages 

func (p *ListDataViewsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataViewsPaginator) NextPage 

func (p *ListDataViewsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataViewsOutput, error)

NextPage retrieves the next ListDataViews page.

type ListDataViewsPaginatorOptions 

type ListDataViewsPaginatorOptions struct {
	// The maximum number of results per page.
	Limit int32

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

ListDataViewsPaginatorOptions is the paginator options for ListDataViews

type ListDatasetsAPIClient 

type ListDatasetsAPIClient interface {
	ListDatasets(context.Context, *ListDatasetsInput, ...func(*Options)) (*ListDatasetsOutput, error)
}

ListDatasetsAPIClient is a client that implements the ListDatasets operation.

type ListDatasetsInput 

type ListDatasetsInput struct {

	// The maximum number of results per page.
	MaxResults *int32

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

Request for the ListDatasets operation.

type ListDatasetsOutput 

type ListDatasetsOutput struct {

	// List of Datasets.
	Datasets []types.Dataset

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

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

Response for the ListDatasets operation

type ListDatasetsPaginator 

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

ListDatasetsPaginator is a paginator for ListDatasets

func NewListDatasetsPaginator 

func NewListDatasetsPaginator(client ListDatasetsAPIClient, params *ListDatasetsInput, optFns ...func(*ListDatasetsPaginatorOptions)) *ListDatasetsPaginator

NewListDatasetsPaginator returns a new ListDatasetsPaginator

func (*ListDatasetsPaginator) HasMorePages 

func (p *ListDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetsPaginator) NextPage 

func (p *ListDatasetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetsOutput, error)

NextPage retrieves the next ListDatasets page.

type ListDatasetsPaginatorOptions 

type ListDatasetsPaginatorOptions struct {
	// The maximum number of results per page.
	Limit int32

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

ListDatasetsPaginatorOptions is the paginator options for ListDatasets

type ListPermissionGroupsAPIClient 

type ListPermissionGroupsAPIClient interface {
	ListPermissionGroups(context.Context, *ListPermissionGroupsInput, ...func(*Options)) (*ListPermissionGroupsOutput, error)
}

ListPermissionGroupsAPIClient is a client that implements the ListPermissionGroups operation.

type ListPermissionGroupsByUserInput 

type ListPermissionGroupsByUserInput struct {

	// The maximum number of results per page.
	//
	// This member is required.
	MaxResults *int32

	// The unique identifier for the user.
	//
	// This member is required.
	UserId *string

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

type ListPermissionGroupsByUserOutput 

type ListPermissionGroupsByUserOutput struct {

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

	// A list of returned permission groups.
	PermissionGroups []types.PermissionGroupByUser

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

type ListPermissionGroupsInput 

type ListPermissionGroupsInput struct {

	// The maximum number of results per page.
	//
	// This member is required.
	MaxResults *int32

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

type ListPermissionGroupsOutput 

type ListPermissionGroupsOutput struct {

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

	// A list of all the permission groups.
	PermissionGroups []types.PermissionGroup

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

type ListPermissionGroupsPaginator 

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

ListPermissionGroupsPaginator is a paginator for ListPermissionGroups

func NewListPermissionGroupsPaginator 

func NewListPermissionGroupsPaginator(client ListPermissionGroupsAPIClient, params *ListPermissionGroupsInput, optFns ...func(*ListPermissionGroupsPaginatorOptions)) *ListPermissionGroupsPaginator

NewListPermissionGroupsPaginator returns a new ListPermissionGroupsPaginator

func (*ListPermissionGroupsPaginator) HasMorePages 

func (p *ListPermissionGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPermissionGroupsPaginator) NextPage 

func (p *ListPermissionGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionGroupsOutput, error)

NextPage retrieves the next ListPermissionGroups page.

type ListPermissionGroupsPaginatorOptions 

type ListPermissionGroupsPaginatorOptions struct {
	// The maximum number of results per page.
	Limit int32

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

ListPermissionGroupsPaginatorOptions is the paginator options for ListPermissionGroups

type ListUsersAPIClient 

type ListUsersAPIClient interface {
	ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}

ListUsersAPIClient is a client that implements the ListUsers operation.

type ListUsersByPermissionGroupInput 

type ListUsersByPermissionGroupInput struct {

	// The maximum number of results per page.
	//
	// This member is required.
	MaxResults *int32

	// The unique identifier for the permission group.
	//
	// This member is required.
	PermissionGroupId *string

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

type ListUsersByPermissionGroupOutput 

type ListUsersByPermissionGroupOutput struct {

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

	// Lists details of all users in a specific permission group.
	Users []types.UserByPermissionGroup

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

type ListUsersInput 

type ListUsersInput struct {

	// The maximum number of results per page.
	//
	// This member is required.
	MaxResults *int32

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

type ListUsersOutput 

type ListUsersOutput struct {

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

	// A list of all the users.
	Users []types.User

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

type ListUsersPaginator 

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

ListUsersPaginator is a paginator for ListUsers

func NewListUsersPaginator 

func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator

NewListUsersPaginator returns a new ListUsersPaginator

func (*ListUsersPaginator) HasMorePages 

func (p *ListUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsersPaginator) NextPage 

func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)

NextPage retrieves the next ListUsers page.

type ListUsersPaginatorOptions 

type ListUsersPaginatorOptions struct {
	// The maximum number of results per page.
	Limit int32

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

ListUsersPaginatorOptions is the paginator options for ListUsers

type Options 

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

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

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

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

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

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

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

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

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

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

type ResetUserPasswordInput 

type ResetUserPasswordInput struct {

	// The unique identifier of the user that a temporary password is requested for.
	//
	// This member is required.
	UserId *string

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

type ResetUserPasswordOutput 

type ResetUserPasswordOutput struct {

	// A randomly generated temporary password for the requested user. This password
	// expires in 7 days.
	TemporaryPassword *string

	// The unique identifier of the user that a new password is generated for.
	UserId *string

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type UpdateChangesetInput 

type UpdateChangesetInput struct {

	// The unique identifier for the Changeset to update.
	//
	// This member is required.
	ChangesetId *string

	// The unique identifier for the FinSpace Dataset in which the Changeset is
	// created.
	//
	// This member is required.
	DatasetId *string

	// 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] in the FinSpace User
	// Guide.
	//
	// [Supported Data Types and File Formats]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
	//
	// This member is required.
	FormatParams map[string]string

	// 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]section.
	//
	// [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
	//
	// This member is required.
	SourceParams map[string]string

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

Request to update an existing changeset.

type UpdateChangesetOutput 

type UpdateChangesetOutput struct {

	// The unique identifier for the Changeset to update.
	ChangesetId *string

	// The unique identifier for the FinSpace Dataset in which the Changeset is
	// created.
	DatasetId *string

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

The response from a update changeset operation.

type UpdateDatasetInput 

type UpdateDatasetInput struct {

	// The unique identifier for the Dataset to update.
	//
	// This member is required.
	DatasetId *string

	// A display title for the Dataset.
	//
	// This member is required.
	DatasetTitle *string

	// 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.
	//
	// This member is required.
	Kind types.DatasetKind

	// The unique resource identifier for a Dataset.
	Alias *string

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

	// A description for the Dataset.
	DatasetDescription *string

	// Definition for a schema on a tabular Dataset.
	SchemaDefinition *types.SchemaUnion
	// contains filtered or unexported fields
}

The request for an UpdateDataset operation

type UpdateDatasetOutput 

type UpdateDatasetOutput struct {

	// The unique identifier for updated Dataset.
	DatasetId *string

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

The response from an UpdateDataset operation

type UpdatePermissionGroupInput 

type UpdatePermissionGroupInput struct {

	// The unique identifier for the permission group to update.
	//
	// This member is required.
	PermissionGroupId *string

	// 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 []types.ApplicationPermission

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

	// A brief description for the permission group.
	Description *string

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

type UpdatePermissionGroupOutput 

type UpdatePermissionGroupOutput struct {

	// The unique identifier for the updated permission group.
	PermissionGroupId *string

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

type UpdateUserInput 

type UpdateUserInput struct {

	// The unique identifier for the user that you want to update.
	//
	// This member is required.
	UserId *string

	// 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 types.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

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

	// The first name of the user.
	FirstName *string

	// The last name of the user.
	LastName *string

	// 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 types.UserType
	// contains filtered or unexported fields
}

type UpdateUserOutput 

type UpdateUserOutput struct {

	// The unique identifier of the updated user.
	UserId *string

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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