commonMain.aws.sdk.kotlin.services.databrew.DataBrewClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of databrew-jvm Show documentation
Show all versions of databrew-jvm Show documentation
The AWS Kotlin client for DataBrew
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.databrew
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.databrew.auth.DataBrewAuthSchemeProvider
import aws.sdk.kotlin.services.databrew.auth.DefaultDataBrewAuthSchemeProvider
import aws.sdk.kotlin.services.databrew.endpoints.DataBrewEndpointParameters
import aws.sdk.kotlin.services.databrew.endpoints.DataBrewEndpointProvider
import aws.sdk.kotlin.services.databrew.endpoints.DefaultDataBrewEndpointProvider
import aws.sdk.kotlin.services.databrew.model.BatchDeleteRecipeVersionRequest
import aws.sdk.kotlin.services.databrew.model.BatchDeleteRecipeVersionResponse
import aws.sdk.kotlin.services.databrew.model.CreateDatasetRequest
import aws.sdk.kotlin.services.databrew.model.CreateDatasetResponse
import aws.sdk.kotlin.services.databrew.model.CreateProfileJobRequest
import aws.sdk.kotlin.services.databrew.model.CreateProfileJobResponse
import aws.sdk.kotlin.services.databrew.model.CreateProjectRequest
import aws.sdk.kotlin.services.databrew.model.CreateProjectResponse
import aws.sdk.kotlin.services.databrew.model.CreateRecipeJobRequest
import aws.sdk.kotlin.services.databrew.model.CreateRecipeJobResponse
import aws.sdk.kotlin.services.databrew.model.CreateRecipeRequest
import aws.sdk.kotlin.services.databrew.model.CreateRecipeResponse
import aws.sdk.kotlin.services.databrew.model.CreateRulesetRequest
import aws.sdk.kotlin.services.databrew.model.CreateRulesetResponse
import aws.sdk.kotlin.services.databrew.model.CreateScheduleRequest
import aws.sdk.kotlin.services.databrew.model.CreateScheduleResponse
import aws.sdk.kotlin.services.databrew.model.DeleteDatasetRequest
import aws.sdk.kotlin.services.databrew.model.DeleteDatasetResponse
import aws.sdk.kotlin.services.databrew.model.DeleteJobRequest
import aws.sdk.kotlin.services.databrew.model.DeleteJobResponse
import aws.sdk.kotlin.services.databrew.model.DeleteProjectRequest
import aws.sdk.kotlin.services.databrew.model.DeleteProjectResponse
import aws.sdk.kotlin.services.databrew.model.DeleteRecipeVersionRequest
import aws.sdk.kotlin.services.databrew.model.DeleteRecipeVersionResponse
import aws.sdk.kotlin.services.databrew.model.DeleteRulesetRequest
import aws.sdk.kotlin.services.databrew.model.DeleteRulesetResponse
import aws.sdk.kotlin.services.databrew.model.DeleteScheduleRequest
import aws.sdk.kotlin.services.databrew.model.DeleteScheduleResponse
import aws.sdk.kotlin.services.databrew.model.DescribeDatasetRequest
import aws.sdk.kotlin.services.databrew.model.DescribeDatasetResponse
import aws.sdk.kotlin.services.databrew.model.DescribeJobRequest
import aws.sdk.kotlin.services.databrew.model.DescribeJobResponse
import aws.sdk.kotlin.services.databrew.model.DescribeJobRunRequest
import aws.sdk.kotlin.services.databrew.model.DescribeJobRunResponse
import aws.sdk.kotlin.services.databrew.model.DescribeProjectRequest
import aws.sdk.kotlin.services.databrew.model.DescribeProjectResponse
import aws.sdk.kotlin.services.databrew.model.DescribeRecipeRequest
import aws.sdk.kotlin.services.databrew.model.DescribeRecipeResponse
import aws.sdk.kotlin.services.databrew.model.DescribeRulesetRequest
import aws.sdk.kotlin.services.databrew.model.DescribeRulesetResponse
import aws.sdk.kotlin.services.databrew.model.DescribeScheduleRequest
import aws.sdk.kotlin.services.databrew.model.DescribeScheduleResponse
import aws.sdk.kotlin.services.databrew.model.ListDatasetsRequest
import aws.sdk.kotlin.services.databrew.model.ListDatasetsResponse
import aws.sdk.kotlin.services.databrew.model.ListJobRunsRequest
import aws.sdk.kotlin.services.databrew.model.ListJobRunsResponse
import aws.sdk.kotlin.services.databrew.model.ListJobsRequest
import aws.sdk.kotlin.services.databrew.model.ListJobsResponse
import aws.sdk.kotlin.services.databrew.model.ListProjectsRequest
import aws.sdk.kotlin.services.databrew.model.ListProjectsResponse
import aws.sdk.kotlin.services.databrew.model.ListRecipeVersionsRequest
import aws.sdk.kotlin.services.databrew.model.ListRecipeVersionsResponse
import aws.sdk.kotlin.services.databrew.model.ListRecipesRequest
import aws.sdk.kotlin.services.databrew.model.ListRecipesResponse
import aws.sdk.kotlin.services.databrew.model.ListRulesetsRequest
import aws.sdk.kotlin.services.databrew.model.ListRulesetsResponse
import aws.sdk.kotlin.services.databrew.model.ListSchedulesRequest
import aws.sdk.kotlin.services.databrew.model.ListSchedulesResponse
import aws.sdk.kotlin.services.databrew.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.databrew.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.databrew.model.PublishRecipeRequest
import aws.sdk.kotlin.services.databrew.model.PublishRecipeResponse
import aws.sdk.kotlin.services.databrew.model.SendProjectSessionActionRequest
import aws.sdk.kotlin.services.databrew.model.SendProjectSessionActionResponse
import aws.sdk.kotlin.services.databrew.model.StartJobRunRequest
import aws.sdk.kotlin.services.databrew.model.StartJobRunResponse
import aws.sdk.kotlin.services.databrew.model.StartProjectSessionRequest
import aws.sdk.kotlin.services.databrew.model.StartProjectSessionResponse
import aws.sdk.kotlin.services.databrew.model.StopJobRunRequest
import aws.sdk.kotlin.services.databrew.model.StopJobRunResponse
import aws.sdk.kotlin.services.databrew.model.TagResourceRequest
import aws.sdk.kotlin.services.databrew.model.TagResourceResponse
import aws.sdk.kotlin.services.databrew.model.UntagResourceRequest
import aws.sdk.kotlin.services.databrew.model.UntagResourceResponse
import aws.sdk.kotlin.services.databrew.model.UpdateDatasetRequest
import aws.sdk.kotlin.services.databrew.model.UpdateDatasetResponse
import aws.sdk.kotlin.services.databrew.model.UpdateProfileJobRequest
import aws.sdk.kotlin.services.databrew.model.UpdateProfileJobResponse
import aws.sdk.kotlin.services.databrew.model.UpdateProjectRequest
import aws.sdk.kotlin.services.databrew.model.UpdateProjectResponse
import aws.sdk.kotlin.services.databrew.model.UpdateRecipeJobRequest
import aws.sdk.kotlin.services.databrew.model.UpdateRecipeJobResponse
import aws.sdk.kotlin.services.databrew.model.UpdateRecipeRequest
import aws.sdk.kotlin.services.databrew.model.UpdateRecipeResponse
import aws.sdk.kotlin.services.databrew.model.UpdateRulesetRequest
import aws.sdk.kotlin.services.databrew.model.UpdateRulesetResponse
import aws.sdk.kotlin.services.databrew.model.UpdateScheduleRequest
import aws.sdk.kotlin.services.databrew.model.UpdateScheduleResponse
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.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 = "DataBrew"
public const val SdkVersion: String = "1.3.2"
public const val ServiceApiVersion: String = "2017-07-25"
/**
* Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.
*/
public interface DataBrewClient : SdkClient {
/**
* DataBrewClient'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,
"DataBrew",
"DATABREW",
"databrew",
)
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): DataBrewClient = DefaultDataBrewClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), 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: DataBrewEndpointProvider = builder.endpointProvider ?: DefaultDataBrewEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
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: DataBrewAuthSchemeProvider = builder.authSchemeProvider ?: DefaultDataBrewAuthSchemeProvider()
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]
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(), RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "DataBrew"
/**
* 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: DataBrewEndpointProvider? = 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
/**
* 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: DataBrewAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* Deletes one or more versions of a recipe at a time.
*
* The entire request will be rejected if:
* + The recipe does not exist.
* + There is an invalid version identifier in the list of versions.
* + The version list is empty.
* + The version list size exceeds 50.
* + The version list contains duplicate entries.
*
* The request will complete successfully, but with partial failures, if:
* + A version does not exist.
* + A version is being used by a job.
* + You specify `LATEST_WORKING`, but it's being used by a project.
* + The version fails to be deleted.
*
* The `LATEST_WORKING` version will only be deleted if the recipe has no other versions. If you try to delete `LATEST_WORKING` while other versions exist (or if they can't be deleted), then `LATEST_WORKING` will be listed as partial failure in the response.
*/
public suspend fun batchDeleteRecipeVersion(input: BatchDeleteRecipeVersionRequest): BatchDeleteRecipeVersionResponse
/**
* Creates a new DataBrew dataset.
*/
public suspend fun createDataset(input: CreateDatasetRequest): CreateDatasetResponse
/**
* Creates a new job to analyze a dataset and create its data profile.
*/
public suspend fun createProfileJob(input: CreateProfileJobRequest): CreateProfileJobResponse
/**
* Creates a new DataBrew project.
*/
public suspend fun createProject(input: CreateProjectRequest): CreateProjectResponse
/**
* Creates a new DataBrew recipe.
*/
public suspend fun createRecipe(input: CreateRecipeRequest): CreateRecipeResponse
/**
* Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
*/
public suspend fun createRecipeJob(input: CreateRecipeJobRequest): CreateRecipeJobResponse
/**
* Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.
*/
public suspend fun createRuleset(input: CreateRulesetRequest): CreateRulesetResponse
/**
* Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
*/
public suspend fun createSchedule(input: CreateScheduleRequest): CreateScheduleResponse
/**
* Deletes a dataset from DataBrew.
*/
public suspend fun deleteDataset(input: DeleteDatasetRequest): DeleteDatasetResponse
/**
* Deletes the specified DataBrew job.
*/
public suspend fun deleteJob(input: DeleteJobRequest): DeleteJobResponse
/**
* Deletes an existing DataBrew project.
*/
public suspend fun deleteProject(input: DeleteProjectRequest): DeleteProjectResponse
/**
* Deletes a single version of a DataBrew recipe.
*/
public suspend fun deleteRecipeVersion(input: DeleteRecipeVersionRequest): DeleteRecipeVersionResponse
/**
* Deletes a ruleset.
*/
public suspend fun deleteRuleset(input: DeleteRulesetRequest): DeleteRulesetResponse
/**
* Deletes the specified DataBrew schedule.
*/
public suspend fun deleteSchedule(input: DeleteScheduleRequest): DeleteScheduleResponse
/**
* Returns the definition of a specific DataBrew dataset.
*/
public suspend fun describeDataset(input: DescribeDatasetRequest): DescribeDatasetResponse
/**
* Returns the definition of a specific DataBrew job.
*/
public suspend fun describeJob(input: DescribeJobRequest): DescribeJobResponse
/**
* Represents one run of a DataBrew job.
*/
public suspend fun describeJobRun(input: DescribeJobRunRequest): DescribeJobRunResponse
/**
* Returns the definition of a specific DataBrew project.
*/
public suspend fun describeProject(input: DescribeProjectRequest): DescribeProjectResponse
/**
* Returns the definition of a specific DataBrew recipe corresponding to a particular version.
*/
public suspend fun describeRecipe(input: DescribeRecipeRequest): DescribeRecipeResponse
/**
* Retrieves detailed information about the ruleset.
*/
public suspend fun describeRuleset(input: DescribeRulesetRequest): DescribeRulesetResponse
/**
* Returns the definition of a specific DataBrew schedule.
*/
public suspend fun describeSchedule(input: DescribeScheduleRequest): DescribeScheduleResponse
/**
* Lists all of the DataBrew datasets.
*/
public suspend fun listDatasets(input: ListDatasetsRequest = ListDatasetsRequest { }): ListDatasetsResponse
/**
* Lists all of the previous runs of a particular DataBrew job.
*/
public suspend fun listJobRuns(input: ListJobRunsRequest): ListJobRunsResponse
/**
* Lists all of the DataBrew jobs that are defined.
*/
public suspend fun listJobs(input: ListJobsRequest = ListJobsRequest { }): ListJobsResponse
/**
* Lists all of the DataBrew projects that are defined.
*/
public suspend fun listProjects(input: ListProjectsRequest = ListProjectsRequest { }): ListProjectsResponse
/**
* Lists the versions of a particular DataBrew recipe, except for `LATEST_WORKING`.
*/
public suspend fun listRecipeVersions(input: ListRecipeVersionsRequest): ListRecipeVersionsResponse
/**
* Lists all of the DataBrew recipes that are defined.
*/
public suspend fun listRecipes(input: ListRecipesRequest = ListRecipesRequest { }): ListRecipesResponse
/**
* List all rulesets available in the current account or rulesets associated with a specific resource (dataset).
*/
public suspend fun listRulesets(input: ListRulesetsRequest = ListRulesetsRequest { }): ListRulesetsResponse
/**
* Lists the DataBrew schedules that are defined.
*/
public suspend fun listSchedules(input: ListSchedulesRequest = ListSchedulesRequest { }): ListSchedulesResponse
/**
* Lists all the tags for a DataBrew resource.
*/
public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse
/**
* Publishes a new version of a DataBrew recipe.
*/
public suspend fun publishRecipe(input: PublishRecipeRequest): PublishRecipeResponse
/**
* Performs a recipe step within an interactive DataBrew session that's currently open.
*/
public suspend fun sendProjectSessionAction(input: SendProjectSessionActionRequest): SendProjectSessionActionResponse
/**
* Runs a DataBrew job.
*/
public suspend fun startJobRun(input: StartJobRunRequest): StartJobRunResponse
/**
* Creates an interactive session, enabling you to manipulate data in a DataBrew project.
*/
public suspend fun startProjectSession(input: StartProjectSessionRequest): StartProjectSessionResponse
/**
* Stops a particular run of a job.
*/
public suspend fun stopJobRun(input: StopJobRunRequest): StopJobRunResponse
/**
* Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Removes metadata tags from a DataBrew resource.
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
/**
* Modifies the definition of an existing DataBrew dataset.
*/
public suspend fun updateDataset(input: UpdateDatasetRequest): UpdateDatasetResponse
/**
* Modifies the definition of an existing profile job.
*/
public suspend fun updateProfileJob(input: UpdateProfileJobRequest): UpdateProfileJobResponse
/**
* Modifies the definition of an existing DataBrew project.
*/
public suspend fun updateProject(input: UpdateProjectRequest): UpdateProjectResponse
/**
* Modifies the definition of the `LATEST_WORKING` version of a DataBrew recipe.
*/
public suspend fun updateRecipe(input: UpdateRecipeRequest): UpdateRecipeResponse
/**
* Modifies the definition of an existing DataBrew recipe job.
*/
public suspend fun updateRecipeJob(input: UpdateRecipeJobRequest): UpdateRecipeJobResponse
/**
* Updates specified ruleset.
*/
public suspend fun updateRuleset(input: UpdateRulesetRequest): UpdateRulesetResponse
/**
* Modifies the definition of an existing DataBrew schedule.
*/
public suspend fun updateSchedule(input: UpdateScheduleRequest): UpdateScheduleResponse
}
/**
* 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 DataBrewClient.withConfig(block: DataBrewClient.Config.Builder.() -> Unit): DataBrewClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultDataBrewClient(newConfig)
}
/**
* Deletes one or more versions of a recipe at a time.
*
* The entire request will be rejected if:
* + The recipe does not exist.
* + There is an invalid version identifier in the list of versions.
* + The version list is empty.
* + The version list size exceeds 50.
* + The version list contains duplicate entries.
*
* The request will complete successfully, but with partial failures, if:
* + A version does not exist.
* + A version is being used by a job.
* + You specify `LATEST_WORKING`, but it's being used by a project.
* + The version fails to be deleted.
*
* The `LATEST_WORKING` version will only be deleted if the recipe has no other versions. If you try to delete `LATEST_WORKING` while other versions exist (or if they can't be deleted), then `LATEST_WORKING` will be listed as partial failure in the response.
*/
public suspend inline fun DataBrewClient.batchDeleteRecipeVersion(crossinline block: BatchDeleteRecipeVersionRequest.Builder.() -> Unit): BatchDeleteRecipeVersionResponse = batchDeleteRecipeVersion(BatchDeleteRecipeVersionRequest.Builder().apply(block).build())
/**
* Creates a new DataBrew dataset.
*/
public suspend inline fun DataBrewClient.createDataset(crossinline block: CreateDatasetRequest.Builder.() -> Unit): CreateDatasetResponse = createDataset(CreateDatasetRequest.Builder().apply(block).build())
/**
* Creates a new job to analyze a dataset and create its data profile.
*/
public suspend inline fun DataBrewClient.createProfileJob(crossinline block: CreateProfileJobRequest.Builder.() -> Unit): CreateProfileJobResponse = createProfileJob(CreateProfileJobRequest.Builder().apply(block).build())
/**
* Creates a new DataBrew project.
*/
public suspend inline fun DataBrewClient.createProject(crossinline block: CreateProjectRequest.Builder.() -> Unit): CreateProjectResponse = createProject(CreateProjectRequest.Builder().apply(block).build())
/**
* Creates a new DataBrew recipe.
*/
public suspend inline fun DataBrewClient.createRecipe(crossinline block: CreateRecipeRequest.Builder.() -> Unit): CreateRecipeResponse = createRecipe(CreateRecipeRequest.Builder().apply(block).build())
/**
* Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
*/
public suspend inline fun DataBrewClient.createRecipeJob(crossinline block: CreateRecipeJobRequest.Builder.() -> Unit): CreateRecipeJobResponse = createRecipeJob(CreateRecipeJobRequest.Builder().apply(block).build())
/**
* Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.
*/
public suspend inline fun DataBrewClient.createRuleset(crossinline block: CreateRulesetRequest.Builder.() -> Unit): CreateRulesetResponse = createRuleset(CreateRulesetRequest.Builder().apply(block).build())
/**
* Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
*/
public suspend inline fun DataBrewClient.createSchedule(crossinline block: CreateScheduleRequest.Builder.() -> Unit): CreateScheduleResponse = createSchedule(CreateScheduleRequest.Builder().apply(block).build())
/**
* Deletes a dataset from DataBrew.
*/
public suspend inline fun DataBrewClient.deleteDataset(crossinline block: DeleteDatasetRequest.Builder.() -> Unit): DeleteDatasetResponse = deleteDataset(DeleteDatasetRequest.Builder().apply(block).build())
/**
* Deletes the specified DataBrew job.
*/
public suspend inline fun DataBrewClient.deleteJob(crossinline block: DeleteJobRequest.Builder.() -> Unit): DeleteJobResponse = deleteJob(DeleteJobRequest.Builder().apply(block).build())
/**
* Deletes an existing DataBrew project.
*/
public suspend inline fun DataBrewClient.deleteProject(crossinline block: DeleteProjectRequest.Builder.() -> Unit): DeleteProjectResponse = deleteProject(DeleteProjectRequest.Builder().apply(block).build())
/**
* Deletes a single version of a DataBrew recipe.
*/
public suspend inline fun DataBrewClient.deleteRecipeVersion(crossinline block: DeleteRecipeVersionRequest.Builder.() -> Unit): DeleteRecipeVersionResponse = deleteRecipeVersion(DeleteRecipeVersionRequest.Builder().apply(block).build())
/**
* Deletes a ruleset.
*/
public suspend inline fun DataBrewClient.deleteRuleset(crossinline block: DeleteRulesetRequest.Builder.() -> Unit): DeleteRulesetResponse = deleteRuleset(DeleteRulesetRequest.Builder().apply(block).build())
/**
* Deletes the specified DataBrew schedule.
*/
public suspend inline fun DataBrewClient.deleteSchedule(crossinline block: DeleteScheduleRequest.Builder.() -> Unit): DeleteScheduleResponse = deleteSchedule(DeleteScheduleRequest.Builder().apply(block).build())
/**
* Returns the definition of a specific DataBrew dataset.
*/
public suspend inline fun DataBrewClient.describeDataset(crossinline block: DescribeDatasetRequest.Builder.() -> Unit): DescribeDatasetResponse = describeDataset(DescribeDatasetRequest.Builder().apply(block).build())
/**
* Returns the definition of a specific DataBrew job.
*/
public suspend inline fun DataBrewClient.describeJob(crossinline block: DescribeJobRequest.Builder.() -> Unit): DescribeJobResponse = describeJob(DescribeJobRequest.Builder().apply(block).build())
/**
* Represents one run of a DataBrew job.
*/
public suspend inline fun DataBrewClient.describeJobRun(crossinline block: DescribeJobRunRequest.Builder.() -> Unit): DescribeJobRunResponse = describeJobRun(DescribeJobRunRequest.Builder().apply(block).build())
/**
* Returns the definition of a specific DataBrew project.
*/
public suspend inline fun DataBrewClient.describeProject(crossinline block: DescribeProjectRequest.Builder.() -> Unit): DescribeProjectResponse = describeProject(DescribeProjectRequest.Builder().apply(block).build())
/**
* Returns the definition of a specific DataBrew recipe corresponding to a particular version.
*/
public suspend inline fun DataBrewClient.describeRecipe(crossinline block: DescribeRecipeRequest.Builder.() -> Unit): DescribeRecipeResponse = describeRecipe(DescribeRecipeRequest.Builder().apply(block).build())
/**
* Retrieves detailed information about the ruleset.
*/
public suspend inline fun DataBrewClient.describeRuleset(crossinline block: DescribeRulesetRequest.Builder.() -> Unit): DescribeRulesetResponse = describeRuleset(DescribeRulesetRequest.Builder().apply(block).build())
/**
* Returns the definition of a specific DataBrew schedule.
*/
public suspend inline fun DataBrewClient.describeSchedule(crossinline block: DescribeScheduleRequest.Builder.() -> Unit): DescribeScheduleResponse = describeSchedule(DescribeScheduleRequest.Builder().apply(block).build())
/**
* Lists all of the DataBrew datasets.
*/
public suspend inline fun DataBrewClient.listDatasets(crossinline block: ListDatasetsRequest.Builder.() -> Unit): ListDatasetsResponse = listDatasets(ListDatasetsRequest.Builder().apply(block).build())
/**
* Lists all of the previous runs of a particular DataBrew job.
*/
public suspend inline fun DataBrewClient.listJobRuns(crossinline block: ListJobRunsRequest.Builder.() -> Unit): ListJobRunsResponse = listJobRuns(ListJobRunsRequest.Builder().apply(block).build())
/**
* Lists all of the DataBrew jobs that are defined.
*/
public suspend inline fun DataBrewClient.listJobs(crossinline block: ListJobsRequest.Builder.() -> Unit): ListJobsResponse = listJobs(ListJobsRequest.Builder().apply(block).build())
/**
* Lists all of the DataBrew projects that are defined.
*/
public suspend inline fun DataBrewClient.listProjects(crossinline block: ListProjectsRequest.Builder.() -> Unit): ListProjectsResponse = listProjects(ListProjectsRequest.Builder().apply(block).build())
/**
* Lists the versions of a particular DataBrew recipe, except for `LATEST_WORKING`.
*/
public suspend inline fun DataBrewClient.listRecipeVersions(crossinline block: ListRecipeVersionsRequest.Builder.() -> Unit): ListRecipeVersionsResponse = listRecipeVersions(ListRecipeVersionsRequest.Builder().apply(block).build())
/**
* Lists all of the DataBrew recipes that are defined.
*/
public suspend inline fun DataBrewClient.listRecipes(crossinline block: ListRecipesRequest.Builder.() -> Unit): ListRecipesResponse = listRecipes(ListRecipesRequest.Builder().apply(block).build())
/**
* List all rulesets available in the current account or rulesets associated with a specific resource (dataset).
*/
public suspend inline fun DataBrewClient.listRulesets(crossinline block: ListRulesetsRequest.Builder.() -> Unit): ListRulesetsResponse = listRulesets(ListRulesetsRequest.Builder().apply(block).build())
/**
* Lists the DataBrew schedules that are defined.
*/
public suspend inline fun DataBrewClient.listSchedules(crossinline block: ListSchedulesRequest.Builder.() -> Unit): ListSchedulesResponse = listSchedules(ListSchedulesRequest.Builder().apply(block).build())
/**
* Lists all the tags for a DataBrew resource.
*/
public suspend inline fun DataBrewClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())
/**
* Publishes a new version of a DataBrew recipe.
*/
public suspend inline fun DataBrewClient.publishRecipe(crossinline block: PublishRecipeRequest.Builder.() -> Unit): PublishRecipeResponse = publishRecipe(PublishRecipeRequest.Builder().apply(block).build())
/**
* Performs a recipe step within an interactive DataBrew session that's currently open.
*/
public suspend inline fun DataBrewClient.sendProjectSessionAction(crossinline block: SendProjectSessionActionRequest.Builder.() -> Unit): SendProjectSessionActionResponse = sendProjectSessionAction(SendProjectSessionActionRequest.Builder().apply(block).build())
/**
* Runs a DataBrew job.
*/
public suspend inline fun DataBrewClient.startJobRun(crossinline block: StartJobRunRequest.Builder.() -> Unit): StartJobRunResponse = startJobRun(StartJobRunRequest.Builder().apply(block).build())
/**
* Creates an interactive session, enabling you to manipulate data in a DataBrew project.
*/
public suspend inline fun DataBrewClient.startProjectSession(crossinline block: StartProjectSessionRequest.Builder.() -> Unit): StartProjectSessionResponse = startProjectSession(StartProjectSessionRequest.Builder().apply(block).build())
/**
* Stops a particular run of a job.
*/
public suspend inline fun DataBrewClient.stopJobRun(crossinline block: StopJobRunRequest.Builder.() -> Unit): StopJobRunResponse = stopJobRun(StopJobRunRequest.Builder().apply(block).build())
/**
* Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
*/
public suspend inline fun DataBrewClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Removes metadata tags from a DataBrew resource.
*/
public suspend inline fun DataBrewClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())
/**
* Modifies the definition of an existing DataBrew dataset.
*/
public suspend inline fun DataBrewClient.updateDataset(crossinline block: UpdateDatasetRequest.Builder.() -> Unit): UpdateDatasetResponse = updateDataset(UpdateDatasetRequest.Builder().apply(block).build())
/**
* Modifies the definition of an existing profile job.
*/
public suspend inline fun DataBrewClient.updateProfileJob(crossinline block: UpdateProfileJobRequest.Builder.() -> Unit): UpdateProfileJobResponse = updateProfileJob(UpdateProfileJobRequest.Builder().apply(block).build())
/**
* Modifies the definition of an existing DataBrew project.
*/
public suspend inline fun DataBrewClient.updateProject(crossinline block: UpdateProjectRequest.Builder.() -> Unit): UpdateProjectResponse = updateProject(UpdateProjectRequest.Builder().apply(block).build())
/**
* Modifies the definition of the `LATEST_WORKING` version of a DataBrew recipe.
*/
public suspend inline fun DataBrewClient.updateRecipe(crossinline block: UpdateRecipeRequest.Builder.() -> Unit): UpdateRecipeResponse = updateRecipe(UpdateRecipeRequest.Builder().apply(block).build())
/**
* Modifies the definition of an existing DataBrew recipe job.
*/
public suspend inline fun DataBrewClient.updateRecipeJob(crossinline block: UpdateRecipeJobRequest.Builder.() -> Unit): UpdateRecipeJobResponse = updateRecipeJob(UpdateRecipeJobRequest.Builder().apply(block).build())
/**
* Updates specified ruleset.
*/
public suspend inline fun DataBrewClient.updateRuleset(crossinline block: UpdateRulesetRequest.Builder.() -> Unit): UpdateRulesetResponse = updateRuleset(UpdateRulesetRequest.Builder().apply(block).build())
/**
* Modifies the definition of an existing DataBrew schedule.
*/
public suspend inline fun DataBrewClient.updateSchedule(crossinline block: UpdateScheduleRequest.Builder.() -> Unit): UpdateScheduleResponse = updateSchedule(UpdateScheduleRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy