commonMain.aws.sdk.kotlin.services.quicksight.QuickSightClient.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.quicksight
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.borrow
import aws.sdk.kotlin.runtime.endpoint.AwsEndpointResolver
import aws.sdk.kotlin.runtime.region.resolveRegion
import aws.sdk.kotlin.services.quicksight.internal.DefaultEndpointResolver
import aws.sdk.kotlin.services.quicksight.model.*
import aws.smithy.kotlin.runtime.SdkClient
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awssigning.AwsSigner
import aws.smithy.kotlin.runtime.auth.awssigning.crt.CrtAwsSigner
import aws.smithy.kotlin.runtime.client.SdkLogMode
import aws.smithy.kotlin.runtime.config.SdkClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.endpoints.EndpointResolver
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.StandardRetryStrategy
/**
* # Amazon QuickSight API Reference
* Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
*/
interface QuickSightClient : SdkClient {
override val serviceName: String
get() = "QuickSight"
/**
* QuickSightClient's configuration
*/
val config: Config
companion object {
operator fun invoke(block: Config.Builder.() -> Unit): QuickSightClient {
val config = Config.Builder().apply(block).build()
return DefaultQuickSightClient(config)
}
operator fun invoke(config: Config): QuickSightClient = DefaultQuickSightClient(config)
/**
* Construct a [QuickSightClient] by resolving the configuration from the current environment.
*/
suspend fun fromEnvironment(block: (Config.Builder.() -> Unit)? = null): QuickSightClient {
val builder = Config.Builder()
if (block != null) builder.apply(block)
builder.region = builder.region ?: resolveRegion()
return DefaultQuickSightClient(builder.build())
}
}
class Config private constructor(builder: Builder): HttpClientConfig, SdkClientConfig {
val credentialsProvider: CredentialsProvider = builder.credentialsProvider?.borrow() ?: DefaultChainCredentialsProvider()
val endpointResolver: AwsEndpointResolver = builder.endpointResolver ?: DefaultEndpointResolver()
override val httpClientEngine: HttpClientEngine? = builder.httpClientEngine
val region: String = requireNotNull(builder.region) { "region is a required configuration property" }
val retryStrategy: RetryStrategy = StandardRetryStrategy()
override val sdkLogMode: SdkLogMode = builder.sdkLogMode
val signer: AwsSigner = builder.signer ?: CrtAwsSigner
companion object {
inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
class Builder {
/**
* 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.
*/
var credentialsProvider: CredentialsProvider? = null
/**
* Determines the endpoint (hostname) to make requests to. When not provided a default
* resolver is configured automatically. This is an advanced client option.
*/
var endpointResolver: AwsEndpointResolver? = null
/**
* Override the default HTTP client engine used to make SDK requests (e.g. configure proxy behavior, timeouts, concurrency, etc).
* NOTE: The caller is responsible for managing the lifetime of the engine when set. The SDK
* client will not close it when the client is closed.
*/
var httpClientEngine: HttpClientEngine? = null
/**
* AWS region to make requests to
*/
var region: String? = null
/**
* 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.
*/
var sdkLogMode: SdkLogMode = SdkLogMode.Default
/**
* The implementation of AWS signer to use for signing requests
*/
var signer: AwsSigner? = null
@PublishedApi
internal fun build(): Config = Config(this)
}
}
/**
* Cancels an ongoing ingestion of data into SPICE.
*/
suspend fun cancelIngestion(input: CancelIngestionRequest): CancelIngestionResponse
/**
* Cancels an ongoing ingestion of data into SPICE.
*/
suspend fun cancelIngestion(block: CancelIngestionRequest.Builder.() -> Unit) = cancelIngestion(CancelIngestionRequest.Builder().apply(block).build())
/**
* Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the `CreateAccountCustomization` or `UpdateAccountCustomization` API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see [Customizing Amazon QuickSight](https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html) in the *Amazon QuickSight User Guide.*
*
* You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the `DescribeAccountCustomization` API operation.
*
* Before you use the `CreateAccountCustomization` API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the ` DescribeThemePermissions ` API operation. To share the theme, grant permissions by using the ` UpdateThemePermissions ` API operation.
*/
suspend fun createAccountCustomization(input: CreateAccountCustomizationRequest): CreateAccountCustomizationResponse
/**
* Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the `CreateAccountCustomization` or `UpdateAccountCustomization` API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see [Customizing Amazon QuickSight](https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html) in the *Amazon QuickSight User Guide.*
*
* You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the `DescribeAccountCustomization` API operation.
*
* Before you use the `CreateAccountCustomization` API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the ` DescribeThemePermissions ` API operation. To share the theme, grant permissions by using the ` UpdateThemePermissions ` API operation.
*/
suspend fun createAccountCustomization(block: CreateAccountCustomizationRequest.Builder.() -> Unit) = createAccountCustomization(CreateAccountCustomizationRequest.Builder().apply(block).build())
/**
* Creates an analysis in Amazon QuickSight.
*/
suspend fun createAnalysis(input: CreateAnalysisRequest): CreateAnalysisResponse
/**
* Creates an analysis in Amazon QuickSight.
*/
suspend fun createAnalysis(block: CreateAnalysisRequest.Builder.() -> Unit) = createAnalysis(CreateAnalysisRequest.Builder().apply(block).build())
/**
* Creates a dashboard from a template. To first create a template, see the ` CreateTemplate ` API operation.
*
* A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
*/
suspend fun createDashboard(input: CreateDashboardRequest): CreateDashboardResponse
/**
* Creates a dashboard from a template. To first create a template, see the ` CreateTemplate ` API operation.
*
* A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
*/
suspend fun createDashboard(block: CreateDashboardRequest.Builder.() -> Unit) = createDashboard(CreateDashboardRequest.Builder().apply(block).build())
/**
* Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
*/
suspend fun createDataSet(input: CreateDataSetRequest): CreateDataSetResponse
/**
* Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
*/
suspend fun createDataSet(block: CreateDataSetRequest.Builder.() -> Unit) = createDataSet(CreateDataSetRequest.Builder().apply(block).build())
/**
* Creates a data source.
*/
suspend fun createDataSource(input: CreateDataSourceRequest): CreateDataSourceResponse
/**
* Creates a data source.
*/
suspend fun createDataSource(block: CreateDataSourceRequest.Builder.() -> Unit) = createDataSource(CreateDataSourceRequest.Builder().apply(block).build())
/**
* Creates an empty shared folder.
*/
suspend fun createFolder(input: CreateFolderRequest): CreateFolderResponse
/**
* Creates an empty shared folder.
*/
suspend fun createFolder(block: CreateFolderRequest.Builder.() -> Unit) = createFolder(CreateFolderRequest.Builder().apply(block).build())
/**
* Adds an asset, such as a dashboard, analysis, or dataset into a folder.
*/
suspend fun createFolderMembership(input: CreateFolderMembershipRequest): CreateFolderMembershipResponse
/**
* Adds an asset, such as a dashboard, analysis, or dataset into a folder.
*/
suspend fun createFolderMembership(block: CreateFolderMembershipRequest.Builder.() -> Unit) = createFolderMembership(CreateFolderMembershipRequest.Builder().apply(block).build())
/**
* Creates an Amazon QuickSight group.
*
* The permissions resource is `arn:aws:quicksight::: © 2015 - 2025 Weber Informatics LLC | Privacy Policy