Class: Aws::FinSpaceData::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-finspacedata/client.rb,
sig/client.rbs

Overview

An API client for FinSpaceData. To construct a client, you need to configure a :region and :credentials.

client = Aws::FinSpaceData::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Defined Under Namespace

Modules: _AssociateUserToPermissionGroupResponseSuccess, _CreateChangesetResponseSuccess, _CreateDataViewResponseSuccess, _CreateDatasetResponseSuccess, _CreatePermissionGroupResponseSuccess, _CreateUserResponseSuccess, _DeleteDatasetResponseSuccess, _DeletePermissionGroupResponseSuccess, _DisableUserResponseSuccess, _DisassociateUserFromPermissionGroupResponseSuccess, _EnableUserResponseSuccess, _GetChangesetResponseSuccess, _GetDataViewResponseSuccess, _GetDatasetResponseSuccess, _GetExternalDataViewAccessDetailsResponseSuccess, _GetPermissionGroupResponseSuccess, _GetProgrammaticAccessCredentialsResponseSuccess, _GetUserResponseSuccess, _GetWorkingLocationResponseSuccess, _ListChangesetsResponseSuccess, _ListDataViewsResponseSuccess, _ListDatasetsResponseSuccess, _ListPermissionGroupsByUserResponseSuccess, _ListPermissionGroupsResponseSuccess, _ListUsersByPermissionGroupResponseSuccess, _ListUsersResponseSuccess, _ResetUserPasswordResponseSuccess, _UpdateChangesetResponseSuccess, _UpdateDatasetResponseSuccess, _UpdatePermissionGroupResponseSuccess, _UpdateUserResponseSuccess

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::FinSpaceData::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::FinSpaceData::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-finspacedata/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2230
2231
2232
 
# File 'lib/aws-sdk-finspacedata/client.rb', line 2230

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2233
2234
2235
 
# File 'lib/aws-sdk-finspacedata/client.rb', line 2233

def errors_module
  Errors
end

.new ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/FinSpaceData/Client.html#initialize-instance_method



14
 
# File 'sig/client.rbs', line 14

def self.new: (

Instance Method Details

#associate_user_to_permission_group(params = {}) ⇒ Types::AssociateUserToPermissionGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.associate_user_to_permission_group({
  permission_group_id: "PermissionGroupId", # required
  user_id: "UserId", # required
  client_token: "ClientToken",
})

Response structure


resp.status_code #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :permission_group_id (required, String) —

    The unique identifier for the permission group.

  • :user_id (required, String) —

    The unique identifier for the user.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



86
 
# File 'sig/client.rbs', line 86

def associate_user_to_permission_group: (

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'lib/aws-sdk-finspacedata/client.rb', line 2203

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::FinSpaceData')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-finspacedata'
  context[:gem_version] = '1.69.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_changeset(params = {}) ⇒ Types::CreateChangesetResponse

Creates a new Changeset in a FinSpace Dataset.

Examples:

Request syntax with placeholder values


resp = client.create_changeset({
  client_token: "ClientToken",
  dataset_id: "DatasetId", # required
  change_type: "REPLACE", # required, accepts REPLACE, APPEND, MODIFY
  source_params: { # required
    "StringMapKey" => "StringMapValue",
  },
  format_params: { # required
    "StringMapKey" => "StringMapValue",
  },
})

Response structure


resp.dataset_id #=> String
resp.changeset_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :dataset_id (required, String) —

    The unique identifier for the FinSpace Dataset where the Changeset will be created.

  • :change_type (required, String) —

    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.

  • :source_params (required, Hash<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.

  • :format_params (required, Hash<String,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.

Returns:

See Also:



99
 
# File 'sig/client.rbs', line 99

def create_changeset: (

#create_data_view(params = {}) ⇒ Types::CreateDataViewResponse

Creates a Dataview for a Dataset.

Examples:

Request syntax with placeholder values


resp = client.create_data_view({
  client_token: "ClientToken",
  dataset_id: "DatasetId", # required
  auto_update: false,
  sort_columns: ["StringValueLength1to255"],
  partition_columns: ["StringValueLength1to255"],
  as_of_timestamp: 1,
  destination_type_params: { # required
    destination_type: "DataViewDestinationType", # required
    s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
    s3_destination_export_file_format_options: {
      "StringMapKey" => "StringMapValue",
    },
  },
})

Response structure


resp.dataset_id #=> String
resp.data_view_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :dataset_id (required, String) —

    The unique Dataset identifier that is used to create a Dataview.

  • :auto_update (Boolean) —

    Flag to indicate Dataview should be updated automatically.

  • :sort_columns (Array<String>) —

    Columns to be used for sorting the data.

  • :partition_columns (Array<String>) —

    Ordered set of column names used to partition data.

  • :as_of_timestamp (Integer) —

    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.

  • :destination_type_params (required, Types::DataViewDestinationTypeParams) —

    Options that define the destination type for the Dataview.

Returns:

See Also:



114
 
# File 'sig/client.rbs', line 114

def create_data_view: (

#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse

Creates a new FinSpace Dataset.

Examples:

Request syntax with placeholder values


resp = client.create_dataset({
  client_token: "ClientToken",
  dataset_title: "DatasetTitle", # required
  kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
  dataset_description: "DatasetDescription",
  owner_info: {
    name: "OwnerName",
    phone_number: "PhoneNumber",
    email: "Email",
  },
  permission_group_params: { # required
    permission_group_id: "PermissionGroupId",
    dataset_permissions: [
      {
        permission: "StringValueLength1to250",
      },
    ],
  },
  alias: "AliasString",
  schema_definition: {
    tabular_schema_config: {
      columns: [
        {
          data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
          column_name: "ColumnName",
          column_description: "ColumnDescription",
        },
      ],
      primary_key_columns: ["ColumnName"],
    },
  },
})

Response structure


resp.dataset_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :dataset_title (required, String) —

    Display title for a FinSpace Dataset.

  • :kind (required, 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.

  • :dataset_description (String) —

    Description of a Dataset.

  • :owner_info (Types::DatasetOwnerInfo) —

    Contact information for a Dataset owner.

  • :permission_group_params (required, Types::PermissionGroupParams) —

    Permission group parameters for Dataset permissions.

  • :alias (String) —

    The unique resource identifier for a Dataset.

  • :schema_definition (Types::SchemaUnion) —

    Definition for a schema on a tabular Dataset.

Returns:

See Also:



134
 
# File 'sig/client.rbs', line 134

def create_dataset: (

#create_permission_group(params = {}) ⇒ Types::CreatePermissionGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_permission_group({
  name: "PermissionGroupName", # required
  description: "PermissionGroupDescription",
  application_permissions: ["CreateDataset"], # required, accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
  client_token: "ClientToken",
})

Response structure


resp.permission_group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the permission group.

  • :description (String) —

    A brief description for the permission group.

  • :application_permissions (required, Array<String>) —

    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.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



162
 
# File 'sig/client.rbs', line 162

def create_permission_group: (

#create_user(params = {}) ⇒ Types::CreateUserResponse

Creates a new user in FinSpace.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  email_address: "Email", # required
  type: "SUPER_USER", # required, accepts SUPER_USER, APP_USER
  first_name: "FirstName",
  last_name: "LastName",
  api_access: "ENABLED", # accepts ENABLED, DISABLED
  api_access_principal_arn: "RoleArn",
  client_token: "ClientToken",
})

Response structure


resp.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    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.

  • :type (required, 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.

  • :first_name (String) —

    The first name of the user that you want to register.

  • :last_name (String) —

    The last name of the user that you want to register.

  • :api_access (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.

  • :api_access_principal_arn (String) —

    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.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



175
 
# File 'sig/client.rbs', line 175

def create_user: (

#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse

Deletes a FinSpace Dataset.

Examples:

Request syntax with placeholder values


resp = client.delete_dataset({
  client_token: "ClientToken",
  dataset_id: "DatasetId", # required
})

Response structure


resp.dataset_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :dataset_id (required, String) —

    The unique identifier of the Dataset to be deleted.

Returns:

See Also:



191
 
# File 'sig/client.rbs', line 191

def delete_dataset: (

#delete_permission_group(params = {}) ⇒ Types::DeletePermissionGroupResponse

Deletes a permission group. This action is irreversible.

Examples:

Request syntax with placeholder values


resp = client.delete_permission_group({
  permission_group_id: "PermissionGroupId", # required
  client_token: "ClientToken",
})

Response structure


resp.permission_group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :permission_group_id (required, String) —

    The unique identifier for the permission group that you want to delete.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



202
 
# File 'sig/client.rbs', line 202

def delete_permission_group: (

#disable_user(params = {}) ⇒ Types::DisableUserResponse

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

Examples:

Request syntax with placeholder values


resp = client.disable_user({
  user_id: "UserId", # required
  client_token: "ClientToken",
})

Response structure


resp.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The unique identifier for the user that you want to deactivate.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



213
 
# File 'sig/client.rbs', line 213

def disable_user: (

#disassociate_user_from_permission_group(params = {}) ⇒ Types::DisassociateUserFromPermissionGroupResponse

Removes a user from a permission group.

Examples:

Request syntax with placeholder values


resp = client.disassociate_user_from_permission_group({
  permission_group_id: "PermissionGroupId", # required
  user_id: "UserId", # required
  client_token: "ClientToken",
})

Response structure


resp.status_code #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :permission_group_id (required, String) —

    The unique identifier for the permission group.

  • :user_id (required, String) —

    The unique identifier for the user.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



224
 
# File 'sig/client.rbs', line 224

def disassociate_user_from_permission_group: (

#enable_user(params = {}) ⇒ Types::EnableUserResponse

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

Examples:

Request syntax with placeholder values


resp = client.enable_user({
  user_id: "UserId", # required
  client_token: "ClientToken",
})

Response structure


resp.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The unique identifier for the user that you want to activate.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



236
 
# File 'sig/client.rbs', line 236

def enable_user: (

#get_changeset(params = {}) ⇒ Types::GetChangesetResponse

Get information about a Changeset.

Examples:

Request syntax with placeholder values


resp = client.get_changeset({
  dataset_id: "DatasetId", # required
  changeset_id: "ChangesetId", # required
})

Response structure


resp.changeset_id #=> String
resp.changeset_arn #=> String
resp.dataset_id #=> String
resp.change_type #=> String, one of "REPLACE", "APPEND", "MODIFY"
resp.source_params #=> Hash
resp.source_params["StringMapKey"] #=> String
resp.format_params #=> Hash
resp.format_params["StringMapKey"] #=> String
resp.create_time #=> Integer
resp.status #=> String, one of "PENDING", "FAILED", "SUCCESS", "RUNNING", "STOP_REQUESTED"
resp.error_info.error_message #=> String
resp.error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
resp.active_until_timestamp #=> Integer
resp.active_from_timestamp #=> Integer
resp.updates_changeset_id #=> String
resp.updated_by_changeset_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The unique identifier for the FinSpace Dataset where the Changeset is created.

  • :changeset_id (required, String) —

    The unique identifier of the Changeset for which to get data.

Returns:

See Also:



259
 
# File 'sig/client.rbs', line 259

def get_changeset: (

#get_data_view(params = {}) ⇒ Types::GetDataViewResponse

Gets information about a Dataview.

Examples:

Request syntax with placeholder values


resp = client.get_data_view({
  data_view_id: "DataViewId", # required
  dataset_id: "DatasetId", # required
})

Response structure


resp.auto_update #=> Boolean
resp.partition_columns #=> Array
resp.partition_columns[0] #=> String
resp.dataset_id #=> String
resp.as_of_timestamp #=> Integer
resp.error_info.error_message #=> String
resp.error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
resp.last_modified_time #=> Integer
resp.create_time #=> Integer
resp.sort_columns #=> Array
resp.sort_columns[0] #=> String
resp.data_view_id #=> String
resp.data_view_arn #=> String
resp.destination_type_params.destination_type #=> String
resp.destination_type_params.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
resp.destination_type_params.s3_destination_export_file_format_options #=> Hash
resp.destination_type_params.s3_destination_export_file_format_options["StringMapKey"] #=> String
resp.status #=> String, one of "RUNNING", "STARTING", "FAILED", "CANCELLED", "TIMEOUT", "SUCCESS", "PENDING", "FAILED_CLEANUP_FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_view_id (required, String) —

    The unique identifier for the Dataview.

  • :dataset_id (required, String) —

    The unique identifier for the Dataset used in the Dataview.

Returns:

See Also:



281
 
# File 'sig/client.rbs', line 281

def get_data_view: (

#get_dataset(params = {}) ⇒ Types::GetDatasetResponse

Returns information about a Dataset.

Examples:

Request syntax with placeholder values


resp = client.get_dataset({
  dataset_id: "StringValueLength1to255", # required
})

Response structure


resp.dataset_id #=> String
resp.dataset_arn #=> String
resp.dataset_title #=> String
resp.kind #=> String, one of "TABULAR", "NON_TABULAR"
resp.dataset_description #=> String
resp.create_time #=> Integer
resp.last_modified_time #=> Integer
resp.schema_definition.tabular_schema_config.columns #=> Array
resp.schema_definition.tabular_schema_config.columns[0].data_type #=> String, one of "STRING", "CHAR", "INTEGER", "TINYINT", "SMALLINT", "BIGINT", "FLOAT", "DOUBLE", "DATE", "DATETIME", "BOOLEAN", "BINARY"
resp.schema_definition.tabular_schema_config.columns[0].column_name #=> String
resp.schema_definition.tabular_schema_config.columns[0].column_description #=> String
resp.schema_definition.tabular_schema_config.primary_key_columns #=> Array
resp.schema_definition.tabular_schema_config.primary_key_columns[0] #=> String
resp.alias #=> String
resp.status #=> String, one of "PENDING", "FAILED", "SUCCESS", "RUNNING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The unique identifier for a Dataset.

Returns:

See Also:



301
 
# File 'sig/client.rbs', line 301

def get_dataset: (

#get_external_data_view_access_details(params = {}) ⇒ Types::GetExternalDataViewAccessDetailsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_external_data_view_access_details({
  data_view_id: "DataViewId", # required
  dataset_id: "DatasetId", # required
})

Response structure


resp.credentials.access_key_id #=> String
resp.credentials.secret_access_key #=> String
resp.credentials.session_token #=> String
resp.credentials.expiration #=> Integer
resp.s3_location.bucket #=> String
resp.s3_location.key #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_view_id (required, String) —

    The unique identifier for the Dataview that you want to access.

  • :dataset_id (required, String) —

    The unique identifier for the Dataset.

Returns:

See Also:



312
 
# File 'sig/client.rbs', line 312

def get_external_data_view_access_details: (

#get_permission_group(params = {}) ⇒ Types::GetPermissionGroupResponse

Retrieves the details of a specific permission group.

Examples:

Request syntax with placeholder values


resp = client.get_permission_group({
  permission_group_id: "PermissionGroupId", # required
})

Response structure


resp.permission_group.permission_group_id #=> String
resp.permission_group.name #=> String
resp.permission_group.description #=> String
resp.permission_group.application_permissions #=> Array
resp.permission_group.application_permissions[0] #=> String, one of "CreateDataset", "ManageClusters", "ManageUsersAndGroups", "ManageAttributeSets", "ViewAuditData", "AccessNotebooks", "GetTemporaryCredentials"
resp.permission_group.create_time #=> Integer
resp.permission_group.last_modified_time #=> Integer
resp.permission_group.membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :permission_group_id (required, String) —

    The unique identifier for the permission group.

Returns:

See Also:



323
 
# File 'sig/client.rbs', line 323

def get_permission_group: (

#get_programmatic_access_credentials(params = {}) ⇒ Types::GetProgrammaticAccessCredentialsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_programmatic_access_credentials({
  duration_in_minutes: 1,
  environment_id: "IdType", # required
})

Response structure


resp.credentials.access_key_id #=> String
resp.credentials.secret_access_key #=> String
resp.credentials.session_token #=> String
resp.duration_in_minutes #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :duration_in_minutes (Integer) —

    The time duration in which the credentials remain valid.

  • :environment_id (required, String) —

    The FinSpace environment identifier.

Returns:

See Also:



334
 
# File 'sig/client.rbs', line 334

def get_programmatic_access_credentials: (

#get_user(params = {}) ⇒ Types::GetUserResponse

Retrieves details for a specific user.

Examples:

Request syntax with placeholder values


resp = client.get_user({
  user_id: "UserId", # required
})

Response structure


resp.user_id #=> String
resp.status #=> String, one of "CREATING", "ENABLED", "DISABLED"
resp.first_name #=> String
resp.last_name #=> String
resp.email_address #=> String
resp.type #=> String, one of "SUPER_USER", "APP_USER"
resp.api_access #=> String, one of "ENABLED", "DISABLED"
resp.api_access_principal_arn #=> String
resp.create_time #=> Integer
resp.last_enabled_time #=> Integer
resp.last_disabled_time #=> Integer
resp.last_modified_time #=> Integer
resp. #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The unique identifier of the user to get data for.

Returns:

See Also:



357
 
# File 'sig/client.rbs', line 357

def get_user: (

#get_working_location(params = {}) ⇒ Types::GetWorkingLocationResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_working_location({
  location_type: "INGESTION", # accepts INGESTION, SAGEMAKER
})

Response structure


resp.s3_uri #=> String
resp.s3_path #=> String
resp.s3_bucket #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_type (String) —

    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.

Returns:

See Also:



369
 
# File 'sig/client.rbs', line 369

def get_working_location: (

#list_changesets(params = {}) ⇒ Types::ListChangesetsResponse

Lists the FinSpace Changesets for a Dataset.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_changesets({
  dataset_id: "DatasetId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.changesets #=> Array
resp.changesets[0].changeset_id #=> String
resp.changesets[0].changeset_arn #=> String
resp.changesets[0].dataset_id #=> String
resp.changesets[0].change_type #=> String, one of "REPLACE", "APPEND", "MODIFY"
resp.changesets[0].source_params #=> Hash
resp.changesets[0].source_params["StringMapKey"] #=> String
resp.changesets[0].format_params #=> Hash
resp.changesets[0].format_params["StringMapKey"] #=> String
resp.changesets[0].create_time #=> Integer
resp.changesets[0].status #=> String, one of "PENDING", "FAILED", "SUCCESS", "RUNNING", "STOP_REQUESTED"
resp.changesets[0].error_info.error_message #=> String
resp.changesets[0].error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
resp.changesets[0].active_until_timestamp #=> Integer
resp.changesets[0].active_from_timestamp #=> Integer
resp.changesets[0].updates_changeset_id #=> String
resp.changesets[0].updated_by_changeset_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The unique identifier for the FinSpace Dataset to which the Changeset belongs.

  • :max_results (Integer) —

    The maximum number of results per page.

  • :next_token (String) —

    A token that indicates where a results page should begin.

Returns:

See Also:



380
 
# File 'sig/client.rbs', line 380

def list_changesets: (

#list_data_views(params = {}) ⇒ Types::ListDataViewsResponse

Lists all available Dataviews for a Dataset.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_views({
  dataset_id: "DatasetId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.data_views #=> Array
resp.data_views[0].data_view_id #=> String
resp.data_views[0].data_view_arn #=> String
resp.data_views[0].dataset_id #=> String
resp.data_views[0].as_of_timestamp #=> Integer
resp.data_views[0].partition_columns #=> Array
resp.data_views[0].partition_columns[0] #=> String
resp.data_views[0].sort_columns #=> Array
resp.data_views[0].sort_columns[0] #=> String
resp.data_views[0].status #=> String, one of "RUNNING", "STARTING", "FAILED", "CANCELLED", "TIMEOUT", "SUCCESS", "PENDING", "FAILED_CLEANUP_FAILED"
resp.data_views[0].error_info.error_message #=> String
resp.data_views[0].error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
resp.data_views[0].destination_type_properties.destination_type #=> String
resp.data_views[0].destination_type_properties.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options #=> Hash
resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options["StringMapKey"] #=> String
resp.data_views[0].auto_update #=> Boolean
resp.data_views[0].create_time #=> Integer
resp.data_views[0].last_modified_time #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The unique identifier of the Dataset for which to retrieve Dataviews.

  • :next_token (String) —

    A token that indicates where a results page should begin.

  • :max_results (Integer) —

    The maximum number of results per page.

Returns:

See Also:



393
 
# File 'sig/client.rbs', line 393

def list_data_views: (

#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_datasets({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.datasets #=> Array
resp.datasets[0].dataset_id #=> String
resp.datasets[0].dataset_arn #=> String
resp.datasets[0].dataset_title #=> String
resp.datasets[0].kind #=> String, one of "TABULAR", "NON_TABULAR"
resp.datasets[0].dataset_description #=> String
resp.datasets[0].owner_info.name #=> String
resp.datasets[0].owner_info.phone_number #=> String
resp.datasets[0].owner_info.email #=> String
resp.datasets[0].create_time #=> Integer
resp.datasets[0].last_modified_time #=> Integer
resp.datasets[0].schema_definition.tabular_schema_config.columns #=> Array
resp.datasets[0].schema_definition.tabular_schema_config.columns[0].data_type #=> String, one of "STRING", "CHAR", "INTEGER", "TINYINT", "SMALLINT", "BIGINT", "FLOAT", "DOUBLE", "DATE", "DATETIME", "BOOLEAN", "BINARY"
resp.datasets[0].schema_definition.tabular_schema_config.columns[0].column_name #=> String
resp.datasets[0].schema_definition.tabular_schema_config.columns[0].column_description #=> String
resp.datasets[0].schema_definition.tabular_schema_config.primary_key_columns #=> Array
resp.datasets[0].schema_definition.tabular_schema_config.primary_key_columns[0] #=> String
resp.datasets[0].alias #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that indicates where a results page should begin.

  • :max_results (Integer) —

    The maximum number of results per page.

Returns:

See Also:



406
 
# File 'sig/client.rbs', line 406

def list_datasets: (

#list_permission_groups(params = {}) ⇒ Types::ListPermissionGroupsResponse

Lists all available permission groups in FinSpace.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_permission_groups({
  next_token: "PaginationToken",
  max_results: 1, # required
})

Response structure


resp.permission_groups #=> Array
resp.permission_groups[0].permission_group_id #=> String
resp.permission_groups[0].name #=> String
resp.permission_groups[0].description #=> String
resp.permission_groups[0].application_permissions #=> Array
resp.permission_groups[0].application_permissions[0] #=> String, one of "CreateDataset", "ManageClusters", "ManageUsersAndGroups", "ManageAttributeSets", "ViewAuditData", "AccessNotebooks", "GetTemporaryCredentials"
resp.permission_groups[0].create_time #=> Integer
resp.permission_groups[0].last_modified_time #=> Integer
resp.permission_groups[0].membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that indicates where a results page should begin.

  • :max_results (required, Integer) —

    The maximum number of results per page.

Returns:

See Also:



418
 
# File 'sig/client.rbs', line 418

def list_permission_groups: (

#list_permission_groups_by_user(params = {}) ⇒ Types::ListPermissionGroupsByUserResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_permission_groups_by_user({
  user_id: "UserId", # required
  next_token: "PaginationToken",
  max_results: 1, # required
})

Response structure


resp.permission_groups #=> Array
resp.permission_groups[0].permission_group_id #=> String
resp.permission_groups[0].name #=> String
resp.permission_groups[0].membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The unique identifier for the user.

  • :next_token (String) —

    A token that indicates where a results page should begin.

  • :max_results (required, Integer) —

    The maximum number of results per page.

Returns:

See Also:



430
 
# File 'sig/client.rbs', line 430

def list_permission_groups_by_user: (

#list_users(params = {}) ⇒ Types::ListUsersResponse

Lists all available users in FinSpace.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users({
  next_token: "PaginationToken",
  max_results: 1, # required
})

Response structure


resp.users #=> Array
resp.users[0].user_id #=> String
resp.users[0].status #=> String, one of "CREATING", "ENABLED", "DISABLED"
resp.users[0].first_name #=> String
resp.users[0].last_name #=> String
resp.users[0].email_address #=> String
resp.users[0].type #=> String, one of "SUPER_USER", "APP_USER"
resp.users[0].api_access #=> String, one of "ENABLED", "DISABLED"
resp.users[0].api_access_principal_arn #=> String
resp.users[0].create_time #=> Integer
resp.users[0].last_enabled_time #=> Integer
resp.users[0].last_disabled_time #=> Integer
resp.users[0].last_modified_time #=> Integer
resp.users[0]. #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that indicates where a results page should begin.

  • :max_results (required, Integer) —

    The maximum number of results per page.

Returns:

See Also:



443
 
# File 'sig/client.rbs', line 443

def list_users: (

#list_users_by_permission_group(params = {}) ⇒ Types::ListUsersByPermissionGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_users_by_permission_group({
  permission_group_id: "PermissionGroupId", # required
  next_token: "PaginationToken",
  max_results: 1, # required
})

Response structure


resp.users #=> Array
resp.users[0].user_id #=> String
resp.users[0].status #=> String, one of "CREATING", "ENABLED", "DISABLED"
resp.users[0].first_name #=> String
resp.users[0].last_name #=> String
resp.users[0].email_address #=> String
resp.users[0].type #=> String, one of "SUPER_USER", "APP_USER"
resp.users[0].api_access #=> String, one of "ENABLED", "DISABLED"
resp.users[0].api_access_principal_arn #=> String
resp.users[0].membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :permission_group_id (required, String) —

    The unique identifier for the permission group.

  • :next_token (String) —

    A token that indicates where a results page should begin.

  • :max_results (required, Integer) —

    The maximum number of results per page.

Returns:

See Also:



455
 
# File 'sig/client.rbs', line 455

def list_users_by_permission_group: (

#reset_user_password(params = {}) ⇒ Types::ResetUserPasswordResponse

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.

Examples:

Request syntax with placeholder values


resp = client.reset_user_password({
  user_id: "UserId", # required
  client_token: "ClientToken",
})

Response structure


resp.user_id #=> String
resp.temporary_password #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The unique identifier of the user that a temporary password is requested for.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



468
 
# File 'sig/client.rbs', line 468

def reset_user_password: (

#update_changeset(params = {}) ⇒ Types::UpdateChangesetResponse

Updates a FinSpace Changeset.

Examples:

Request syntax with placeholder values


resp = client.update_changeset({
  client_token: "ClientToken",
  dataset_id: "DatasetId", # required
  changeset_id: "ChangesetId", # required
  source_params: { # required
    "StringMapKey" => "StringMapValue",
  },
  format_params: { # required
    "StringMapKey" => "StringMapValue",
  },
})

Response structure


resp.changeset_id #=> String
resp.dataset_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :dataset_id (required, String) —

    The unique identifier for the FinSpace Dataset in which the Changeset is created.

  • :changeset_id (required, String) —

    The unique identifier for the Changeset to update.

  • :source_params (required, Hash<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 APIsection.

  • :format_params (required, Hash<String,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.

Returns:

See Also:



480
 
# File 'sig/client.rbs', line 480

def update_changeset: (

#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse

Updates a FinSpace Dataset.

Examples:

Request syntax with placeholder values


resp = client.update_dataset({
  client_token: "ClientToken",
  dataset_id: "DatasetId", # required
  dataset_title: "DatasetTitle", # required
  kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
  dataset_description: "DatasetDescription",
  alias: "AliasString",
  schema_definition: {
    tabular_schema_config: {
      columns: [
        {
          data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
          column_name: "ColumnName",
          column_description: "ColumnDescription",
        },
      ],
      primary_key_columns: ["ColumnName"],
    },
  },
})

Response structure


resp.dataset_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :dataset_id (required, String) —

    The unique identifier for the Dataset to update.

  • :dataset_title (required, String) —

    A display title for the Dataset.

  • :kind (required, 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.

  • :dataset_description (String) —

    A description for the Dataset.

  • :alias (String) —

    The unique resource identifier for a Dataset.

  • :schema_definition (Types::SchemaUnion) —

    Definition for a schema on a tabular Dataset.

Returns:

See Also:



494
 
# File 'sig/client.rbs', line 494

def update_dataset: (

#update_permission_group(params = {}) ⇒ Types::UpdatePermissionGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_permission_group({
  permission_group_id: "PermissionGroupId", # required
  name: "PermissionGroupName",
  description: "PermissionGroupDescription",
  application_permissions: ["CreateDataset"], # accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
  client_token: "ClientToken",
})

Response structure


resp.permission_group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :permission_group_id (required, String) —

    The unique identifier for the permission group to update.

  • :name (String) —

    The name of the permission group.

  • :description (String) —

    A brief description for the permission group.

  • :application_permissions (Array<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.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



510
 
# File 'sig/client.rbs', line 510

def update_permission_group: (

#update_user(params = {}) ⇒ Types::UpdateUserResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_user({
  user_id: "UserId", # required
  type: "SUPER_USER", # accepts SUPER_USER, APP_USER
  first_name: "FirstName",
  last_name: "LastName",
  api_access: "ENABLED", # accepts ENABLED, DISABLED
  api_access_principal_arn: "RoleArn",
  client_token: "ClientToken",
})

Response structure


resp.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The unique identifier for the user that you want to update.

  • :type (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.

  • :first_name (String) —

    The first name of the user.

  • :last_name (String) —

    The last name of the user.

  • :api_access (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.

  • :api_access_principal_arn (String) —

    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.

  • :client_token (String) —

    A token that ensures idempotency. This token expires in 10 minutes.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



524
 
# File 'sig/client.rbs', line 524

def update_user: (

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2223
2224
2225
 
# File 'lib/aws-sdk-finspacedata/client.rb', line 2223

def waiter_names
  []
end