commonMain.aws.sdk.kotlin.services.finspacedata.FinspaceDataClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of finspacedata-jvm Show documentation
Show all versions of finspacedata-jvm Show documentation
The AWS SDK for Kotlin client for finspace data
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.finspacedata
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.finspacedata.auth.DefaultFinspaceDataAuthSchemeProvider
import aws.sdk.kotlin.services.finspacedata.auth.FinspaceDataAuthSchemeProvider
import aws.sdk.kotlin.services.finspacedata.endpoints.DefaultFinspaceDataEndpointProvider
import aws.sdk.kotlin.services.finspacedata.endpoints.FinspaceDataEndpointParameters
import aws.sdk.kotlin.services.finspacedata.endpoints.FinspaceDataEndpointProvider
import aws.sdk.kotlin.services.finspacedata.model.AssociateUserToPermissionGroupRequest
import aws.sdk.kotlin.services.finspacedata.model.AssociateUserToPermissionGroupResponse
import aws.sdk.kotlin.services.finspacedata.model.CreateChangesetRequest
import aws.sdk.kotlin.services.finspacedata.model.CreateChangesetResponse
import aws.sdk.kotlin.services.finspacedata.model.CreateDataViewRequest
import aws.sdk.kotlin.services.finspacedata.model.CreateDataViewResponse
import aws.sdk.kotlin.services.finspacedata.model.CreateDatasetRequest
import aws.sdk.kotlin.services.finspacedata.model.CreateDatasetResponse
import aws.sdk.kotlin.services.finspacedata.model.CreatePermissionGroupRequest
import aws.sdk.kotlin.services.finspacedata.model.CreatePermissionGroupResponse
import aws.sdk.kotlin.services.finspacedata.model.CreateUserRequest
import aws.sdk.kotlin.services.finspacedata.model.CreateUserResponse
import aws.sdk.kotlin.services.finspacedata.model.DeleteDatasetRequest
import aws.sdk.kotlin.services.finspacedata.model.DeleteDatasetResponse
import aws.sdk.kotlin.services.finspacedata.model.DeletePermissionGroupRequest
import aws.sdk.kotlin.services.finspacedata.model.DeletePermissionGroupResponse
import aws.sdk.kotlin.services.finspacedata.model.DisableUserRequest
import aws.sdk.kotlin.services.finspacedata.model.DisableUserResponse
import aws.sdk.kotlin.services.finspacedata.model.DisassociateUserFromPermissionGroupRequest
import aws.sdk.kotlin.services.finspacedata.model.DisassociateUserFromPermissionGroupResponse
import aws.sdk.kotlin.services.finspacedata.model.EnableUserRequest
import aws.sdk.kotlin.services.finspacedata.model.EnableUserResponse
import aws.sdk.kotlin.services.finspacedata.model.GetChangesetRequest
import aws.sdk.kotlin.services.finspacedata.model.GetChangesetResponse
import aws.sdk.kotlin.services.finspacedata.model.GetDataViewRequest
import aws.sdk.kotlin.services.finspacedata.model.GetDataViewResponse
import aws.sdk.kotlin.services.finspacedata.model.GetDatasetRequest
import aws.sdk.kotlin.services.finspacedata.model.GetDatasetResponse
import aws.sdk.kotlin.services.finspacedata.model.GetExternalDataViewAccessDetailsRequest
import aws.sdk.kotlin.services.finspacedata.model.GetExternalDataViewAccessDetailsResponse
import aws.sdk.kotlin.services.finspacedata.model.GetPermissionGroupRequest
import aws.sdk.kotlin.services.finspacedata.model.GetPermissionGroupResponse
import aws.sdk.kotlin.services.finspacedata.model.GetProgrammaticAccessCredentialsRequest
import aws.sdk.kotlin.services.finspacedata.model.GetProgrammaticAccessCredentialsResponse
import aws.sdk.kotlin.services.finspacedata.model.GetUserRequest
import aws.sdk.kotlin.services.finspacedata.model.GetUserResponse
import aws.sdk.kotlin.services.finspacedata.model.GetWorkingLocationRequest
import aws.sdk.kotlin.services.finspacedata.model.GetWorkingLocationResponse
import aws.sdk.kotlin.services.finspacedata.model.ListChangesetsRequest
import aws.sdk.kotlin.services.finspacedata.model.ListChangesetsResponse
import aws.sdk.kotlin.services.finspacedata.model.ListDataViewsRequest
import aws.sdk.kotlin.services.finspacedata.model.ListDataViewsResponse
import aws.sdk.kotlin.services.finspacedata.model.ListDatasetsRequest
import aws.sdk.kotlin.services.finspacedata.model.ListDatasetsResponse
import aws.sdk.kotlin.services.finspacedata.model.ListPermissionGroupsByUserRequest
import aws.sdk.kotlin.services.finspacedata.model.ListPermissionGroupsByUserResponse
import aws.sdk.kotlin.services.finspacedata.model.ListPermissionGroupsRequest
import aws.sdk.kotlin.services.finspacedata.model.ListPermissionGroupsResponse
import aws.sdk.kotlin.services.finspacedata.model.ListUsersByPermissionGroupRequest
import aws.sdk.kotlin.services.finspacedata.model.ListUsersByPermissionGroupResponse
import aws.sdk.kotlin.services.finspacedata.model.ListUsersRequest
import aws.sdk.kotlin.services.finspacedata.model.ListUsersResponse
import aws.sdk.kotlin.services.finspacedata.model.ResetUserPasswordRequest
import aws.sdk.kotlin.services.finspacedata.model.ResetUserPasswordResponse
import aws.sdk.kotlin.services.finspacedata.model.UpdateChangesetRequest
import aws.sdk.kotlin.services.finspacedata.model.UpdateChangesetResponse
import aws.sdk.kotlin.services.finspacedata.model.UpdateDatasetRequest
import aws.sdk.kotlin.services.finspacedata.model.UpdateDatasetResponse
import aws.sdk.kotlin.services.finspacedata.model.UpdatePermissionGroupRequest
import aws.sdk.kotlin.services.finspacedata.model.UpdatePermissionGroupResponse
import aws.sdk.kotlin.services.finspacedata.model.UpdateUserRequest
import aws.sdk.kotlin.services.finspacedata.model.UpdateUserResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.AbstractSdkClientFactory
import aws.smithy.kotlin.runtime.client.IdempotencyTokenConfig
import aws.smithy.kotlin.runtime.client.IdempotencyTokenProvider
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "finspace data"
public const val SdkVersion: String = "1.3.77"
public const val ServiceApiVersion: String = "2020-07-13"
/**
* The FinSpace APIs let you take actions inside the FinSpace.
*/
public interface FinspaceDataClient : SdkClient {
/**
* FinspaceDataClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory()
{
@JvmStatic
override fun builder(): Builder = Builder()
override fun finalizeConfig(builder: Builder) {
super.finalizeConfig(builder)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
override suspend fun finalizeEnvironmentalConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
super.finalizeEnvironmentalConfig(builder, sharedConfig, activeProfile)
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"FinspaceData",
"FINSPACE_DATA",
"finspace_data",
)
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): FinspaceDataClient = DefaultFinspaceDataClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: FinspaceDataEndpointProvider = builder.endpointProvider ?: DefaultFinspaceDataEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val idempotencyTokenProvider: IdempotencyTokenProvider = builder.idempotencyTokenProvider ?: IdempotencyTokenProvider.Default
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: FinspaceDataAuthSchemeProvider = builder.authSchemeProvider ?: DefaultFinspaceDataAuthSchemeProvider()
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
idempotencyTokenProvider = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), IdempotencyTokenConfig.Builder, RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "finspace data"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [AuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: FinspaceDataEndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Override the default idempotency token generator. SDK clients will generate tokens for members
* that represent idempotent tokens when not explicitly set by the caller using this generator.
*/
override var idempotencyTokenProvider: IdempotencyTokenProvider? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: FinspaceDataAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend fun associateUserToPermissionGroup(input: AssociateUserToPermissionGroupRequest): AssociateUserToPermissionGroupResponse
/**
* Creates a new Changeset in a FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun createChangeset(input: CreateChangesetRequest): CreateChangesetResponse
/**
* Creates a Dataview for a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun createDataView(input: CreateDataViewRequest): CreateDataViewResponse
/**
* Creates a new FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun createDataset(input: CreateDatasetRequest): CreateDatasetResponse
/**
* Creates a group of permissions for various actions that a user can perform in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend fun createPermissionGroup(input: CreatePermissionGroupRequest): CreatePermissionGroupResponse
/**
* Creates a new user in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend fun createUser(input: CreateUserRequest): CreateUserResponse
/**
* Deletes a FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun deleteDataset(input: DeleteDatasetRequest): DeleteDatasetResponse
/**
* Deletes a permission group. This action is irreversible.
*/
@Deprecated("This method will be discontinued.")
public suspend fun deletePermissionGroup(input: DeletePermissionGroupRequest): DeletePermissionGroupResponse
/**
* Denies access to the FinSpace web application and API for the specified user.
*/
@Deprecated("This method will be discontinued.")
public suspend fun disableUser(input: DisableUserRequest): DisableUserResponse
/**
* Removes a user from a permission group.
*/
@Deprecated("This method will be discontinued.")
public suspend fun disassociateUserFromPermissionGroup(input: DisassociateUserFromPermissionGroupRequest): DisassociateUserFromPermissionGroupResponse
/**
* Allows the specified user to access the FinSpace web application and API.
*/
@Deprecated("This method will be discontinued.")
public suspend fun enableUser(input: EnableUserRequest): EnableUserResponse
/**
* Get information about a Changeset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun getChangeset(input: GetChangesetRequest): GetChangesetResponse
/**
* Gets information about a Dataview.
*/
@Deprecated("This method will be discontinued.")
public suspend fun getDataView(input: GetDataViewRequest): GetDataViewResponse
/**
* Returns information about a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun getDataset(input: GetDatasetRequest): GetDatasetResponse
/**
* 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.")
public suspend fun getExternalDataViewAccessDetails(input: GetExternalDataViewAccessDetailsRequest): GetExternalDataViewAccessDetailsResponse
/**
* Retrieves the details of a specific permission group.
*/
@Deprecated("This method will be discontinued.")
public suspend fun getPermissionGroup(input: GetPermissionGroupRequest): GetPermissionGroupResponse
/**
* 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](https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials).
*/
@Deprecated("This method will be discontinued.")
public suspend fun getProgrammaticAccessCredentials(input: GetProgrammaticAccessCredentialsRequest): GetProgrammaticAccessCredentialsResponse
/**
* Retrieves details for a specific user.
*/
@Deprecated("This method will be discontinued.")
public suspend fun getUser(input: GetUserRequest): GetUserResponse
/**
* 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.")
public suspend fun getWorkingLocation(input: GetWorkingLocationRequest = GetWorkingLocationRequest { }): GetWorkingLocationResponse
/**
* Lists the FinSpace Changesets for a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun listChangesets(input: ListChangesetsRequest): ListChangesetsResponse
/**
* Lists all available Dataviews for a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun listDataViews(input: ListDataViewsRequest): ListDataViewsResponse
/**
* Lists all of the active Datasets that a user has access to.
*/
@Deprecated("This method will be discontinued.")
public suspend fun listDatasets(input: ListDatasetsRequest = ListDatasetsRequest { }): ListDatasetsResponse
/**
* Lists all available permission groups in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend fun listPermissionGroups(input: ListPermissionGroupsRequest): ListPermissionGroupsResponse
/**
* Lists all the permission groups that are associated with a specific user.
*/
@Deprecated("This method will be discontinued.")
public suspend fun listPermissionGroupsByUser(input: ListPermissionGroupsByUserRequest): ListPermissionGroupsByUserResponse
/**
* Lists all available users in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend fun listUsers(input: ListUsersRequest): ListUsersResponse
/**
* Lists details of all the users in a specific permission group.
*/
@Deprecated("This method will be discontinued.")
public suspend fun listUsersByPermissionGroup(input: ListUsersByPermissionGroupRequest): ListUsersByPermissionGroupResponse
/**
* 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.")
public suspend fun resetUserPassword(input: ResetUserPasswordRequest): ResetUserPasswordResponse
/**
* Updates a FinSpace Changeset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun updateChangeset(input: UpdateChangesetRequest): UpdateChangesetResponse
/**
* Updates a FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend fun updateDataset(input: UpdateDatasetRequest): UpdateDatasetResponse
/**
* Modifies the details of a permission group. You cannot modify a `permissionGroupID`.
*/
@Deprecated("This method will be discontinued.")
public suspend fun updatePermissionGroup(input: UpdatePermissionGroupRequest): UpdatePermissionGroupResponse
/**
* Modifies the details of the specified user. You cannot update the `userId` for a user.
*/
@Deprecated("This method will be discontinued.")
public suspend fun updateUser(input: UpdateUserRequest): UpdateUserResponse
}
/**
* Create a copy of the client with one or more configuration values overridden.
* This method allows the caller to perform scoped config overrides for one or more client operations.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun FinspaceDataClient.withConfig(block: FinspaceDataClient.Config.Builder.() -> Unit): FinspaceDataClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultFinspaceDataClient(newConfig)
}
/**
* Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.associateUserToPermissionGroup(crossinline block: AssociateUserToPermissionGroupRequest.Builder.() -> Unit): AssociateUserToPermissionGroupResponse = associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest.Builder().apply(block).build())
/**
* Creates a new Changeset in a FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.createChangeset(crossinline block: CreateChangesetRequest.Builder.() -> Unit): CreateChangesetResponse = createChangeset(CreateChangesetRequest.Builder().apply(block).build())
/**
* Creates a Dataview for a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.createDataView(crossinline block: CreateDataViewRequest.Builder.() -> Unit): CreateDataViewResponse = createDataView(CreateDataViewRequest.Builder().apply(block).build())
/**
* Creates a new FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.createDataset(crossinline block: CreateDatasetRequest.Builder.() -> Unit): CreateDatasetResponse = createDataset(CreateDatasetRequest.Builder().apply(block).build())
/**
* Creates a group of permissions for various actions that a user can perform in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.createPermissionGroup(crossinline block: CreatePermissionGroupRequest.Builder.() -> Unit): CreatePermissionGroupResponse = createPermissionGroup(CreatePermissionGroupRequest.Builder().apply(block).build())
/**
* Creates a new user in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse = createUser(CreateUserRequest.Builder().apply(block).build())
/**
* Deletes a FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.deleteDataset(crossinline block: DeleteDatasetRequest.Builder.() -> Unit): DeleteDatasetResponse = deleteDataset(DeleteDatasetRequest.Builder().apply(block).build())
/**
* Deletes a permission group. This action is irreversible.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.deletePermissionGroup(crossinline block: DeletePermissionGroupRequest.Builder.() -> Unit): DeletePermissionGroupResponse = deletePermissionGroup(DeletePermissionGroupRequest.Builder().apply(block).build())
/**
* Denies access to the FinSpace web application and API for the specified user.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.disableUser(crossinline block: DisableUserRequest.Builder.() -> Unit): DisableUserResponse = disableUser(DisableUserRequest.Builder().apply(block).build())
/**
* Removes a user from a permission group.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.disassociateUserFromPermissionGroup(crossinline block: DisassociateUserFromPermissionGroupRequest.Builder.() -> Unit): DisassociateUserFromPermissionGroupResponse = disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest.Builder().apply(block).build())
/**
* Allows the specified user to access the FinSpace web application and API.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.enableUser(crossinline block: EnableUserRequest.Builder.() -> Unit): EnableUserResponse = enableUser(EnableUserRequest.Builder().apply(block).build())
/**
* Get information about a Changeset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.getChangeset(crossinline block: GetChangesetRequest.Builder.() -> Unit): GetChangesetResponse = getChangeset(GetChangesetRequest.Builder().apply(block).build())
/**
* Gets information about a Dataview.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.getDataView(crossinline block: GetDataViewRequest.Builder.() -> Unit): GetDataViewResponse = getDataView(GetDataViewRequest.Builder().apply(block).build())
/**
* Returns information about a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.getDataset(crossinline block: GetDatasetRequest.Builder.() -> Unit): GetDatasetResponse = getDataset(GetDatasetRequest.Builder().apply(block).build())
/**
* 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.")
public suspend inline fun FinspaceDataClient.getExternalDataViewAccessDetails(crossinline block: GetExternalDataViewAccessDetailsRequest.Builder.() -> Unit): GetExternalDataViewAccessDetailsResponse = getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest.Builder().apply(block).build())
/**
* Retrieves the details of a specific permission group.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.getPermissionGroup(crossinline block: GetPermissionGroupRequest.Builder.() -> Unit): GetPermissionGroupResponse = getPermissionGroup(GetPermissionGroupRequest.Builder().apply(block).build())
/**
* 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](https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials).
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.getProgrammaticAccessCredentials(crossinline block: GetProgrammaticAccessCredentialsRequest.Builder.() -> Unit): GetProgrammaticAccessCredentialsResponse = getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest.Builder().apply(block).build())
/**
* Retrieves details for a specific user.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.getUser(crossinline block: GetUserRequest.Builder.() -> Unit): GetUserResponse = getUser(GetUserRequest.Builder().apply(block).build())
/**
* 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.")
public suspend inline fun FinspaceDataClient.getWorkingLocation(crossinline block: GetWorkingLocationRequest.Builder.() -> Unit): GetWorkingLocationResponse = getWorkingLocation(GetWorkingLocationRequest.Builder().apply(block).build())
/**
* Lists the FinSpace Changesets for a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.listChangesets(crossinline block: ListChangesetsRequest.Builder.() -> Unit): ListChangesetsResponse = listChangesets(ListChangesetsRequest.Builder().apply(block).build())
/**
* Lists all available Dataviews for a Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.listDataViews(crossinline block: ListDataViewsRequest.Builder.() -> Unit): ListDataViewsResponse = listDataViews(ListDataViewsRequest.Builder().apply(block).build())
/**
* Lists all of the active Datasets that a user has access to.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.listDatasets(crossinline block: ListDatasetsRequest.Builder.() -> Unit): ListDatasetsResponse = listDatasets(ListDatasetsRequest.Builder().apply(block).build())
/**
* Lists all available permission groups in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.listPermissionGroups(crossinline block: ListPermissionGroupsRequest.Builder.() -> Unit): ListPermissionGroupsResponse = listPermissionGroups(ListPermissionGroupsRequest.Builder().apply(block).build())
/**
* Lists all the permission groups that are associated with a specific user.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.listPermissionGroupsByUser(crossinline block: ListPermissionGroupsByUserRequest.Builder.() -> Unit): ListPermissionGroupsByUserResponse = listPermissionGroupsByUser(ListPermissionGroupsByUserRequest.Builder().apply(block).build())
/**
* Lists all available users in FinSpace.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse = listUsers(ListUsersRequest.Builder().apply(block).build())
/**
* Lists details of all the users in a specific permission group.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.listUsersByPermissionGroup(crossinline block: ListUsersByPermissionGroupRequest.Builder.() -> Unit): ListUsersByPermissionGroupResponse = listUsersByPermissionGroup(ListUsersByPermissionGroupRequest.Builder().apply(block).build())
/**
* 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.")
public suspend inline fun FinspaceDataClient.resetUserPassword(crossinline block: ResetUserPasswordRequest.Builder.() -> Unit): ResetUserPasswordResponse = resetUserPassword(ResetUserPasswordRequest.Builder().apply(block).build())
/**
* Updates a FinSpace Changeset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.updateChangeset(crossinline block: UpdateChangesetRequest.Builder.() -> Unit): UpdateChangesetResponse = updateChangeset(UpdateChangesetRequest.Builder().apply(block).build())
/**
* Updates a FinSpace Dataset.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.updateDataset(crossinline block: UpdateDatasetRequest.Builder.() -> Unit): UpdateDatasetResponse = updateDataset(UpdateDatasetRequest.Builder().apply(block).build())
/**
* Modifies the details of a permission group. You cannot modify a `permissionGroupID`.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.updatePermissionGroup(crossinline block: UpdatePermissionGroupRequest.Builder.() -> Unit): UpdatePermissionGroupResponse = updatePermissionGroup(UpdatePermissionGroupRequest.Builder().apply(block).build())
/**
* Modifies the details of the specified user. You cannot update the `userId` for a user.
*/
@Deprecated("This method will be discontinued.")
public suspend inline fun FinspaceDataClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse = updateUser(UpdateUserRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy