pub struct Client { /* private fields */ }
Expand description
Client for AWS Glue DataBrew
Client for invoking operations on AWS Glue DataBrew. Each operation on AWS Glue DataBrew is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_databrew::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_databrew::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the BatchDeleteRecipeVersion
operation has
a Client::batch_delete_recipe_version
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.batch_delete_recipe_version()
.name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn batch_delete_recipe_version(
&self,
) -> BatchDeleteRecipeVersionFluentBuilder
pub fn batch_delete_recipe_version( &self, ) -> BatchDeleteRecipeVersionFluentBuilder
Constructs a fluent builder for the BatchDeleteRecipeVersion
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the recipe whose versions are to be deleted.
recipe_versions(impl Into<String>)
/set_recipe_versions(Option<Vec::<String>>)
:
required: trueAn array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (
X.Y
) orLATEST_WORKING
.LATEST_PUBLISHED
is not supported.
- On success, responds with
BatchDeleteRecipeVersionOutput
with field(s):name(String)
:The name of the recipe that was modified.
errors(Option<Vec::<RecipeVersionErrorDetail>>)
:Errors, if any, that occurred while attempting to delete the recipe versions.
- On failure, responds with
SdkError<BatchDeleteRecipeVersionError>
Source§impl Client
impl Client
Sourcepub fn create_dataset(&self) -> CreateDatasetFluentBuilder
pub fn create_dataset(&self) -> CreateDatasetFluentBuilder
Constructs a fluent builder for the CreateDataset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
format(InputFormat)
/set_format(Option<InputFormat>)
:
required: falseThe file format of a dataset that is created from an Amazon S3 file or folder.
format_options(FormatOptions)
/set_format_options(Option<FormatOptions>)
:
required: falseRepresents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
input(Input)
/set_input(Option<Input>)
:
required: trueRepresents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.
path_options(PathOptions)
/set_path_options(Option<PathOptions>)
:
required: falseA set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata tags to apply to this dataset.
- On success, responds with
CreateDatasetOutput
with field(s):name(String)
:The name of the dataset that you created.
- On failure, responds with
SdkError<CreateDatasetError>
Source§impl Client
impl Client
Sourcepub fn create_profile_job(&self) -> CreateProfileJobFluentBuilder
pub fn create_profile_job(&self) -> CreateProfileJobFluentBuilder
Constructs a fluent builder for the CreateProfileJob
operation.
- The fluent builder is configurable:
dataset_name(impl Into<String>)
/set_dataset_name(Option<String>)
:
required: trueThe name of the dataset that this job is to act upon.
encryption_key_arn(impl Into<String>)
/set_encryption_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
encryption_mode(EncryptionMode)
/set_encryption_mode(Option<EncryptionMode>)
:
required: falseThe encryption mode for the job, which can be one of the following:
-
SSE-KMS
-SSE-KMS
- Server-side encryption with KMS-managed keys. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
-
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
log_subscription(LogSubscription)
/set_log_subscription(Option<LogSubscription>)
:
required: falseEnables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
max_capacity(i32)
/set_max_capacity(Option<i32>)
:
required: falseThe maximum number of nodes that DataBrew can use when the job processes data.
max_retries(i32)
/set_max_retries(Option<i32>)
:
required: falseThe maximum number of times to retry the job after a job run fails.
output_location(S3Location)
/set_output_location(Option<S3Location>)
:
required: trueRepresents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
configuration(ProfileConfiguration)
/set_configuration(Option<ProfileConfiguration>)
:
required: falseConfiguration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
validation_configurations(ValidationConfiguration)
/set_validation_configurations(Option<Vec::<ValidationConfiguration>>)
:
required: falseList of validation configurations that are applied to the profile job.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata tags to apply to this job.
timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe job’s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT
.job_sample(JobSample)
/set_job_sample(Option<JobSample>)
:
required: falseSample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
- On success, responds with
CreateProfileJobOutput
with field(s):name(String)
:The name of the job that was created.
- On failure, responds with
SdkError<CreateProfileJobError>
Source§impl Client
impl Client
Sourcepub fn create_project(&self) -> CreateProjectFluentBuilder
pub fn create_project(&self) -> CreateProjectFluentBuilder
Constructs a fluent builder for the CreateProject
operation.
- The fluent builder is configurable:
dataset_name(impl Into<String>)
/set_dataset_name(Option<String>)
:
required: trueThe name of an existing dataset to associate this project with.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
recipe_name(impl Into<String>)
/set_recipe_name(Option<String>)
:
required: trueThe name of an existing recipe to associate with the project.
sample(Sample)
/set_sample(Option<Sample>)
:
required: falseRepresents the sample size and sampling type for DataBrew to use for interactive data analysis.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata tags to apply to this project.
- On success, responds with
CreateProjectOutput
with field(s):name(String)
:The name of the project that you created.
- On failure, responds with
SdkError<CreateProjectError>
Source§impl Client
impl Client
Sourcepub fn create_recipe(&self) -> CreateRecipeFluentBuilder
pub fn create_recipe(&self) -> CreateRecipeFluentBuilder
Constructs a fluent builder for the CreateRecipe
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the recipe.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
steps(RecipeStep)
/set_steps(Option<Vec::<RecipeStep>>)
:
required: trueAn array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action and (optionally) an array of condition expressions.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata tags to apply to this recipe.
- On success, responds with
CreateRecipeOutput
with field(s):name(String)
:The name of the recipe that you created.
- On failure, responds with
SdkError<CreateRecipeError>
Source§impl Client
impl Client
Sourcepub fn create_recipe_job(&self) -> CreateRecipeJobFluentBuilder
pub fn create_recipe_job(&self) -> CreateRecipeJobFluentBuilder
Constructs a fluent builder for the CreateRecipeJob
operation.
- The fluent builder is configurable:
dataset_name(impl Into<String>)
/set_dataset_name(Option<String>)
:
required: falseThe name of the dataset that this job processes.
encryption_key_arn(impl Into<String>)
/set_encryption_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
encryption_mode(EncryptionMode)
/set_encryption_mode(Option<EncryptionMode>)
:
required: falseThe encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
-
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
log_subscription(LogSubscription)
/set_log_subscription(Option<LogSubscription>)
:
required: falseEnables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
max_capacity(i32)
/set_max_capacity(Option<i32>)
:
required: falseThe maximum number of nodes that DataBrew can consume when the job processes data.
max_retries(i32)
/set_max_retries(Option<i32>)
:
required: falseThe maximum number of times to retry the job after a job run fails.
outputs(Output)
/set_outputs(Option<Vec::<Output>>)
:
required: falseOne or more artifacts that represent the output from running the job.
data_catalog_outputs(DataCatalogOutput)
/set_data_catalog_outputs(Option<Vec::<DataCatalogOutput>>)
:
required: falseOne or more artifacts that represent the Glue Data Catalog output from running the job.
database_outputs(DatabaseOutput)
/set_database_outputs(Option<Vec::<DatabaseOutput>>)
:
required: falseRepresents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: falseEither the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
recipe_reference(RecipeReference)
/set_recipe_reference(Option<RecipeReference>)
:
required: falseRepresents the name and version of a DataBrew recipe.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata tags to apply to this job.
timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe job’s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT
.
- On success, responds with
CreateRecipeJobOutput
with field(s):name(String)
:The name of the job that you created.
- On failure, responds with
SdkError<CreateRecipeJobError>
Source§impl Client
impl Client
Sourcepub fn create_ruleset(&self) -> CreateRulesetFluentBuilder
pub fn create_ruleset(&self) -> CreateRulesetFluentBuilder
Constructs a fluent builder for the CreateRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the ruleset.
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
rules(Rule)
/set_rules(Option<Vec::<Rule>>)
:
required: trueA list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata tags to apply to the ruleset.
- On success, responds with
CreateRulesetOutput
with field(s):name(String)
:The unique name of the created ruleset.
- On failure, responds with
SdkError<CreateRulesetError>
Source§impl Client
impl Client
Sourcepub fn create_schedule(&self) -> CreateScheduleFluentBuilder
pub fn create_schedule(&self) -> CreateScheduleFluentBuilder
Constructs a fluent builder for the CreateSchedule
operation.
- The fluent builder is configurable:
job_names(impl Into<String>)
/set_job_names(Option<Vec::<String>>)
:
required: falseThe name or names of one or more jobs to be run.
cron_expression(impl Into<String>)
/set_cron_expression(Option<String>)
:
required: trueThe date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata tags to apply to this schedule.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
- On success, responds with
CreateScheduleOutput
with field(s):name(String)
:The name of the schedule that was created.
- On failure, responds with
SdkError<CreateScheduleError>
Source§impl Client
impl Client
Sourcepub fn delete_dataset(&self) -> DeleteDatasetFluentBuilder
pub fn delete_dataset(&self) -> DeleteDatasetFluentBuilder
Constructs a fluent builder for the DeleteDataset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the dataset to be deleted.
- On success, responds with
DeleteDatasetOutput
with field(s):name(String)
:The name of the dataset that you deleted.
- On failure, responds with
SdkError<DeleteDatasetError>
Source§impl Client
impl Client
Sourcepub fn delete_job(&self) -> DeleteJobFluentBuilder
pub fn delete_job(&self) -> DeleteJobFluentBuilder
Constructs a fluent builder for the DeleteJob
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job to be deleted.
- On success, responds with
DeleteJobOutput
with field(s):name(String)
:The name of the job that you deleted.
- On failure, responds with
SdkError<DeleteJobError>
Source§impl Client
impl Client
Sourcepub fn delete_project(&self) -> DeleteProjectFluentBuilder
pub fn delete_project(&self) -> DeleteProjectFluentBuilder
Constructs a fluent builder for the DeleteProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the project to be deleted.
- On success, responds with
DeleteProjectOutput
with field(s):name(String)
:The name of the project that you deleted.
- On failure, responds with
SdkError<DeleteProjectError>
Source§impl Client
impl Client
Sourcepub fn delete_recipe_version(&self) -> DeleteRecipeVersionFluentBuilder
pub fn delete_recipe_version(&self) -> DeleteRecipeVersionFluentBuilder
Constructs a fluent builder for the DeleteRecipeVersion
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the recipe.
recipe_version(impl Into<String>)
/set_recipe_version(Option<String>)
:
required: trueThe version of the recipe to be deleted. You can specify a numeric versions (
X.Y
) orLATEST_WORKING
.LATEST_PUBLISHED
is not supported.
- On success, responds with
DeleteRecipeVersionOutput
with field(s):name(String)
:The name of the recipe that was deleted.
recipe_version(String)
:The version of the recipe that was deleted.
- On failure, responds with
SdkError<DeleteRecipeVersionError>
Source§impl Client
impl Client
Sourcepub fn delete_ruleset(&self) -> DeleteRulesetFluentBuilder
pub fn delete_ruleset(&self) -> DeleteRulesetFluentBuilder
Constructs a fluent builder for the DeleteRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the ruleset to be deleted.
- On success, responds with
DeleteRulesetOutput
with field(s):name(String)
:The name of the deleted ruleset.
- On failure, responds with
SdkError<DeleteRulesetError>
Source§impl Client
impl Client
Sourcepub fn delete_schedule(&self) -> DeleteScheduleFluentBuilder
pub fn delete_schedule(&self) -> DeleteScheduleFluentBuilder
Constructs a fluent builder for the DeleteSchedule
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the schedule to be deleted.
- On success, responds with
DeleteScheduleOutput
with field(s):name(String)
:The name of the schedule that was deleted.
- On failure, responds with
SdkError<DeleteScheduleError>
Source§impl Client
impl Client
Sourcepub fn describe_dataset(&self) -> DescribeDatasetFluentBuilder
pub fn describe_dataset(&self) -> DescribeDatasetFluentBuilder
Constructs a fluent builder for the DescribeDataset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the dataset to be described.
- On success, responds with
DescribeDatasetOutput
with field(s):created_by(Option<String>)
:The identifier (user name) of the user who created the dataset.
create_date(Option<DateTime>)
:The date and time that the dataset was created.
name(String)
:The name of the dataset.
format(Option<InputFormat>)
:The file format of a dataset that is created from an Amazon S3 file or folder.
format_options(Option<FormatOptions>)
:Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
input(Option<Input>)
:Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.
last_modified_date(Option<DateTime>)
:The date and time that the dataset was last modified.
last_modified_by(Option<String>)
:The identifier (user name) of the user who last modified the dataset.
source(Option<Source>)
:The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.
path_options(Option<PathOptions>)
:A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
tags(Option<HashMap::<String, String>>)
:Metadata tags associated with this dataset.
resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the dataset.
- On failure, responds with
SdkError<DescribeDatasetError>
Source§impl Client
impl Client
Sourcepub fn describe_job(&self) -> DescribeJobFluentBuilder
pub fn describe_job(&self) -> DescribeJobFluentBuilder
Constructs a fluent builder for the DescribeJob
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job to be described.
- On success, responds with
DescribeJobOutput
with field(s):create_date(Option<DateTime>)
:The date and time that the job was created.
created_by(Option<String>)
:The identifier (user name) of the user associated with the creation of the job.
dataset_name(Option<String>)
:The dataset that the job acts upon.
encryption_key_arn(Option<String>)
:The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
encryption_mode(Option<EncryptionMode>)
:The encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
-
name(String)
:The name of the job.
r#type(Option<JobType>)
:The job type, which must be one of the following:
-
PROFILE
- The job analyzes the dataset to determine its size, data types, data distribution, and more. -
RECIPE
- The job applies one or more transformations to a dataset.
-
last_modified_by(Option<String>)
:The identifier (user name) of the user who last modified the job.
last_modified_date(Option<DateTime>)
:The date and time that the job was last modified.
log_subscription(Option<LogSubscription>)
:Indicates whether Amazon CloudWatch logging is enabled for this job.
max_capacity(i32)
:The maximum number of compute nodes that DataBrew can consume when the job processes data.
max_retries(i32)
:The maximum number of times to retry the job after a job run fails.
outputs(Option<Vec::<Output>>)
:One or more artifacts that represent the output from running the job.
data_catalog_outputs(Option<Vec::<DataCatalogOutput>>)
:One or more artifacts that represent the Glue Data Catalog output from running the job.
database_outputs(Option<Vec::<DatabaseOutput>>)
:Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
project_name(Option<String>)
:The DataBrew project associated with this job.
profile_configuration(Option<ProfileConfiguration>)
:Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
validation_configurations(Option<Vec::<ValidationConfiguration>>)
:List of validation configurations that are applied to the profile job.
recipe_reference(Option<RecipeReference>)
:Represents the name and version of a DataBrew recipe.
resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the job.
role_arn(Option<String>)
:The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
tags(Option<HashMap::<String, String>>)
:Metadata tags associated with this job.
timeout(i32)
:The job’s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT
.job_sample(Option<JobSample>)
:Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.
- On failure, responds with
SdkError<DescribeJobError>
Source§impl Client
impl Client
Sourcepub fn describe_job_run(&self) -> DescribeJobRunFluentBuilder
pub fn describe_job_run(&self) -> DescribeJobRunFluentBuilder
Constructs a fluent builder for the DescribeJobRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job being processed during this run.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe unique identifier of the job run.
- On success, responds with
DescribeJobRunOutput
with field(s):attempt(i32)
:The number of times that DataBrew has attempted to run the job.
completed_on(Option<DateTime>)
:The date and time when the job completed processing.
dataset_name(Option<String>)
:The name of the dataset for the job to process.
error_message(Option<String>)
:A message indicating an error (if any) that was encountered when the job ran.
execution_time(i32)
:The amount of time, in seconds, during which the job run consumed resources.
job_name(String)
:The name of the job being processed during this run.
profile_configuration(Option<ProfileConfiguration>)
:Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
validation_configurations(Option<Vec::<ValidationConfiguration>>)
:List of validation configurations that are applied to the profile job.
run_id(Option<String>)
:The unique identifier of the job run.
state(Option<JobRunState>)
:The current state of the job run entity itself.
log_subscription(Option<LogSubscription>)
:The current status of Amazon CloudWatch logging for the job run.
log_group_name(Option<String>)
:The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
outputs(Option<Vec::<Output>>)
:One or more output artifacts from a job run.
data_catalog_outputs(Option<Vec::<DataCatalogOutput>>)
:One or more artifacts that represent the Glue Data Catalog output from running the job.
database_outputs(Option<Vec::<DatabaseOutput>>)
:Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
recipe_reference(Option<RecipeReference>)
:Represents the name and version of a DataBrew recipe.
started_by(Option<String>)
:The Amazon Resource Name (ARN) of the user who started the job run.
started_on(Option<DateTime>)
:The date and time when the job run began.
job_sample(Option<JobSample>)
:Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
- On failure, responds with
SdkError<DescribeJobRunError>
Source§impl Client
impl Client
Sourcepub fn describe_project(&self) -> DescribeProjectFluentBuilder
pub fn describe_project(&self) -> DescribeProjectFluentBuilder
Constructs a fluent builder for the DescribeProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the project to be described.
- On success, responds with
DescribeProjectOutput
with field(s):create_date(Option<DateTime>)
:The date and time that the project was created.
created_by(Option<String>)
:The identifier (user name) of the user who created the project.
dataset_name(Option<String>)
:The dataset associated with the project.
last_modified_date(Option<DateTime>)
:The date and time that the project was last modified.
last_modified_by(Option<String>)
:The identifier (user name) of the user who last modified the project.
name(String)
:The name of the project.
recipe_name(Option<String>)
:The recipe associated with this job.
resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the project.
sample(Option<Sample>)
:Represents the sample size and sampling type for DataBrew to use for interactive data analysis.
role_arn(Option<String>)
:The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
tags(Option<HashMap::<String, String>>)
:Metadata tags associated with this project.
session_status(Option<SessionStatus>)
:Describes the current state of the session:
-
PROVISIONING
- allocating resources for the session. -
INITIALIZING
- getting the session ready for first use. -
ASSIGNED
- the session is ready for use.
-
opened_by(Option<String>)
:The identifier (user name) of the user that opened the project for use.
open_date(Option<DateTime>)
:The date and time when the project was opened.
- On failure, responds with
SdkError<DescribeProjectError>
Source§impl Client
impl Client
Sourcepub fn describe_recipe(&self) -> DescribeRecipeFluentBuilder
pub fn describe_recipe(&self) -> DescribeRecipeFluentBuilder
Constructs a fluent builder for the DescribeRecipe
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the recipe to be described.
recipe_version(impl Into<String>)
/set_recipe_version(Option<String>)
:
required: falseThe recipe version identifier. If this parameter isn’t specified, then the latest published version is returned.
- On success, responds with
DescribeRecipeOutput
with field(s):created_by(Option<String>)
:The identifier (user name) of the user who created the recipe.
create_date(Option<DateTime>)
:The date and time that the recipe was created.
last_modified_by(Option<String>)
:The identifier (user name) of the user who last modified the recipe.
last_modified_date(Option<DateTime>)
:The date and time that the recipe was last modified.
project_name(Option<String>)
:The name of the project associated with this recipe.
published_by(Option<String>)
:The identifier (user name) of the user who last published the recipe.
published_date(Option<DateTime>)
:The date and time when the recipe was last published.
description(Option<String>)
:The description of the recipe.
name(String)
:The name of the recipe.
steps(Option<Vec::<RecipeStep>>)
:One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.
tags(Option<HashMap::<String, String>>)
:Metadata tags associated with this project.
resource_arn(Option<String>)
:The ARN of the recipe.
recipe_version(Option<String>)
:The recipe version identifier.
- On failure, responds with
SdkError<DescribeRecipeError>
Source§impl Client
impl Client
Sourcepub fn describe_ruleset(&self) -> DescribeRulesetFluentBuilder
pub fn describe_ruleset(&self) -> DescribeRulesetFluentBuilder
Constructs a fluent builder for the DescribeRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the ruleset to be described.
- On success, responds with
DescribeRulesetOutput
with field(s):name(String)
:The name of the ruleset.
description(Option<String>)
:The description of the ruleset.
target_arn(Option<String>)
:The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
rules(Option<Vec::<Rule>>)
:A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.
create_date(Option<DateTime>)
:The date and time that the ruleset was created.
created_by(Option<String>)
:The Amazon Resource Name (ARN) of the user who created the ruleset.
last_modified_by(Option<String>)
:The Amazon Resource Name (ARN) of the user who last modified the ruleset.
last_modified_date(Option<DateTime>)
:The modification date and time of the ruleset.
resource_arn(Option<String>)
:The Amazon Resource Name (ARN) for the ruleset.
tags(Option<HashMap::<String, String>>)
:Metadata tags that have been applied to the ruleset.
- On failure, responds with
SdkError<DescribeRulesetError>
Source§impl Client
impl Client
Sourcepub fn describe_schedule(&self) -> DescribeScheduleFluentBuilder
pub fn describe_schedule(&self) -> DescribeScheduleFluentBuilder
Constructs a fluent builder for the DescribeSchedule
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the schedule to be described.
- On success, responds with
DescribeScheduleOutput
with field(s):create_date(Option<DateTime>)
:The date and time that the schedule was created.
created_by(Option<String>)
:The identifier (user name) of the user who created the schedule.
job_names(Option<Vec::<String>>)
:The name or names of one or more jobs to be run by using the schedule.
last_modified_by(Option<String>)
:The identifier (user name) of the user who last modified the schedule.
last_modified_date(Option<DateTime>)
:The date and time that the schedule was last modified.
resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schedule.
cron_expression(Option<String>)
:The date or dates and time or times when the jobs are to be run for the schedule. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
tags(Option<HashMap::<String, String>>)
:Metadata tags associated with this schedule.
name(String)
:The name of the schedule.
- On failure, responds with
SdkError<DescribeScheduleError>
Source§impl Client
impl Client
Sourcepub fn list_datasets(&self) -> ListDatasetsFluentBuilder
pub fn list_datasets(&self) -> ListDatasetsFluentBuilder
Constructs a fluent builder for the ListDatasets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned by a previous call to retrieve the next set of results.
- On success, responds with
ListDatasetsOutput
with field(s):datasets(Vec::<Dataset>)
:A list of datasets that are defined.
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListDatasetsError>
Source§impl Client
impl Client
Sourcepub fn list_job_runs(&self) -> ListJobRunsFluentBuilder
pub fn list_job_runs(&self) -> ListJobRunsFluentBuilder
Constructs a fluent builder for the ListJobRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned by a previous call to retrieve the next set of results.
- On success, responds with
ListJobRunsOutput
with field(s):job_runs(Vec::<JobRun>)
:A list of job runs that have occurred for the specified job.
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListJobRunsError>
Source§impl Client
impl Client
Sourcepub fn list_jobs(&self) -> ListJobsFluentBuilder
pub fn list_jobs(&self) -> ListJobsFluentBuilder
Constructs a fluent builder for the ListJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
dataset_name(impl Into<String>)
/set_dataset_name(Option<String>)
:
required: falseThe name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: falseThe name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.
- On success, responds with
ListJobsOutput
with field(s):jobs(Vec::<Job>)
:A list of jobs that are defined.
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListJobsError>
Source§impl Client
impl Client
Sourcepub fn list_projects(&self) -> ListProjectsFluentBuilder
pub fn list_projects(&self) -> ListProjectsFluentBuilder
Constructs a fluent builder for the ListProjects
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned by a previous call to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListProjectsOutput
with field(s):projects(Vec::<Project>)
:A list of projects that are defined .
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListProjectsError>
Source§impl Client
impl Client
Sourcepub fn list_recipe_versions(&self) -> ListRecipeVersionsFluentBuilder
pub fn list_recipe_versions(&self) -> ListRecipeVersionsFluentBuilder
Constructs a fluent builder for the ListRecipeVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned by a previous call to retrieve the next set of results.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the recipe for which to return version information.
- On success, responds with
ListRecipeVersionsOutput
with field(s):next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
recipes(Vec::<Recipe>)
:A list of versions for the specified recipe.
- On failure, responds with
SdkError<ListRecipeVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_recipes(&self) -> ListRecipesFluentBuilder
pub fn list_recipes(&self) -> ListRecipesFluentBuilder
Constructs a fluent builder for the ListRecipes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned by a previous call to retrieve the next set of results.
recipe_version(impl Into<String>)
/set_recipe_version(Option<String>)
:
required: falseReturn only those recipes with a version identifier of
LATEST_WORKING
orLATEST_PUBLISHED
. IfRecipeVersion
is omitted,ListRecipes
returns all of theLATEST_PUBLISHED
recipe versions.Valid values:
LATEST_WORKING
|LATEST_PUBLISHED
- On success, responds with
ListRecipesOutput
with field(s):recipes(Vec::<Recipe>)
:A list of recipes that are defined.
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListRecipesError>
Source§impl Client
impl Client
Sourcepub fn list_rulesets(&self) -> ListRulesetsFluentBuilder
pub fn list_rulesets(&self) -> ListRulesetsFluentBuilder
Constructs a fluent builder for the ListRulesets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.
- On success, responds with
ListRulesetsOutput
with field(s):rulesets(Vec::<RulesetItem>)
:A list of RulesetItem. RulesetItem contains meta data of a ruleset.
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListRulesetsError>
Source§impl Client
impl Client
Sourcepub fn list_schedules(&self) -> ListSchedulesFluentBuilder
pub fn list_schedules(&self) -> ListSchedulesFluentBuilder
Constructs a fluent builder for the ListSchedules
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: falseThe name of the job that these schedules apply to.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned by a previous call to retrieve the next set of results.
- On success, responds with
ListSchedulesOutput
with field(s):schedules(Vec::<Schedule>)
:A list of schedules that are defined.
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListSchedulesError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:A list of tags associated with the DataBrew resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn publish_recipe(&self) -> PublishRecipeFluentBuilder
pub fn publish_recipe(&self) -> PublishRecipeFluentBuilder
Constructs a fluent builder for the PublishRecipe
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the recipe to be published, for this version of the recipe.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the recipe to be published.
- On success, responds with
PublishRecipeOutput
with field(s):name(String)
:The name of the recipe that you published.
- On failure, responds with
SdkError<PublishRecipeError>
Source§impl Client
impl Client
Sourcepub fn send_project_session_action(
&self,
) -> SendProjectSessionActionFluentBuilder
pub fn send_project_session_action( &self, ) -> SendProjectSessionActionFluentBuilder
Constructs a fluent builder for the SendProjectSessionAction
operation.
- The fluent builder is configurable:
preview(bool)
/set_preview(Option<bool>)
:
required: falseIf true, the result of the recipe step will be returned, but not applied.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the project to apply the action to.
recipe_step(RecipeStep)
/set_recipe_step(Option<RecipeStep>)
:
required: falseRepresents a single step from a DataBrew recipe to be performed.
step_index(i32)
/set_step_index(Option<i32>)
:
required: falseThe index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack.
client_session_id(impl Into<String>)
/set_client_session_id(Option<String>)
:
required: falseA unique identifier for an interactive session that’s currently open and ready for work. The action will be performed on this session.
view_frame(ViewFrame)
/set_view_frame(Option<ViewFrame>)
:
required: falseRepresents the data being transformed during an action.
- On success, responds with
SendProjectSessionActionOutput
with field(s):result(Option<String>)
:A message indicating the result of performing the action.
name(String)
:The name of the project that was affected by the action.
action_id(Option<i32>)
:A unique identifier for the action that was performed.
- On failure, responds with
SdkError<SendProjectSessionActionError>
Source§impl Client
impl Client
Sourcepub fn start_job_run(&self) -> StartJobRunFluentBuilder
pub fn start_job_run(&self) -> StartJobRunFluentBuilder
Constructs a fluent builder for the StartJobRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job to be run.
- On success, responds with
StartJobRunOutput
with field(s):run_id(String)
:A system-generated identifier for this particular job run.
- On failure, responds with
SdkError<StartJobRunError>
Source§impl Client
impl Client
Sourcepub fn start_project_session(&self) -> StartProjectSessionFluentBuilder
pub fn start_project_session(&self) -> StartProjectSessionFluentBuilder
Constructs a fluent builder for the StartProjectSession
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the project to act upon.
assume_control(bool)
/set_assume_control(Option<bool>)
:
required: falseA value that, if true, enables you to take control of a session, even if a different client is currently accessing the project.
- On success, responds with
StartProjectSessionOutput
with field(s):name(String)
:The name of the project to be acted upon.
client_session_id(Option<String>)
:A system-generated identifier for the session.
- On failure, responds with
SdkError<StartProjectSessionError>
Source§impl Client
impl Client
Sourcepub fn stop_job_run(&self) -> StopJobRunFluentBuilder
pub fn stop_job_run(&self) -> StopJobRunFluentBuilder
Constructs a fluent builder for the StopJobRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job to be stopped.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe ID of the job run to be stopped.
- On success, responds with
StopJobRunOutput
with field(s):run_id(String)
:The ID of the job run that you stopped.
- On failure, responds with
SdkError<StopJobRunError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe DataBrew resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a recipe.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueOne or more tags to be assigned to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueA DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag keys (names) of one or more tags to be removed.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_dataset(&self) -> UpdateDatasetFluentBuilder
pub fn update_dataset(&self) -> UpdateDatasetFluentBuilder
Constructs a fluent builder for the UpdateDataset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the dataset to be updated.
format(InputFormat)
/set_format(Option<InputFormat>)
:
required: falseThe file format of a dataset that is created from an Amazon S3 file or folder.
format_options(FormatOptions)
/set_format_options(Option<FormatOptions>)
:
required: falseRepresents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
input(Input)
/set_input(Option<Input>)
:
required: trueRepresents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.
path_options(PathOptions)
/set_path_options(Option<PathOptions>)
:
required: falseA set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
- On success, responds with
UpdateDatasetOutput
with field(s):name(String)
:The name of the dataset that you updated.
- On failure, responds with
SdkError<UpdateDatasetError>
Source§impl Client
impl Client
Sourcepub fn update_profile_job(&self) -> UpdateProfileJobFluentBuilder
pub fn update_profile_job(&self) -> UpdateProfileJobFluentBuilder
Constructs a fluent builder for the UpdateProfileJob
operation.
- The fluent builder is configurable:
configuration(ProfileConfiguration)
/set_configuration(Option<ProfileConfiguration>)
:
required: falseConfiguration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
encryption_key_arn(impl Into<String>)
/set_encryption_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
encryption_mode(EncryptionMode)
/set_encryption_mode(Option<EncryptionMode>)
:
required: falseThe encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
-
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job to be updated.
log_subscription(LogSubscription)
/set_log_subscription(Option<LogSubscription>)
:
required: falseEnables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
max_capacity(i32)
/set_max_capacity(Option<i32>)
:
required: falseThe maximum number of compute nodes that DataBrew can use when the job processes data.
max_retries(i32)
/set_max_retries(Option<i32>)
:
required: falseThe maximum number of times to retry the job after a job run fails.
output_location(S3Location)
/set_output_location(Option<S3Location>)
:
required: trueRepresents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
validation_configurations(ValidationConfiguration)
/set_validation_configurations(Option<Vec::<ValidationConfiguration>>)
:
required: falseList of validation configurations that are applied to the profile job.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe job’s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT
.job_sample(JobSample)
/set_job_sample(Option<JobSample>)
:
required: falseSample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
- On success, responds with
UpdateProfileJobOutput
with field(s):name(String)
:The name of the job that was updated.
- On failure, responds with
SdkError<UpdateProfileJobError>
Source§impl Client
impl Client
Sourcepub fn update_project(&self) -> UpdateProjectFluentBuilder
pub fn update_project(&self) -> UpdateProjectFluentBuilder
Constructs a fluent builder for the UpdateProject
operation.
- The fluent builder is configurable:
sample(Sample)
/set_sample(Option<Sample>)
:
required: falseRepresents the sample size and sampling type for DataBrew to use for interactive data analysis.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the IAM role to be assumed for this request.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the project to be updated.
- On success, responds with
UpdateProjectOutput
with field(s):last_modified_date(Option<DateTime>)
:The date and time that the project was last modified.
name(String)
:The name of the project that you updated.
- On failure, responds with
SdkError<UpdateProjectError>
Source§impl Client
impl Client
Sourcepub fn update_recipe(&self) -> UpdateRecipeFluentBuilder
pub fn update_recipe(&self) -> UpdateRecipeFluentBuilder
Constructs a fluent builder for the UpdateRecipe
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the recipe.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the recipe to be updated.
steps(RecipeStep)
/set_steps(Option<Vec::<RecipeStep>>)
:
required: falseOne or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.
- On success, responds with
UpdateRecipeOutput
with field(s):name(String)
:The name of the recipe that was updated.
- On failure, responds with
SdkError<UpdateRecipeError>
Source§impl Client
impl Client
Sourcepub fn update_recipe_job(&self) -> UpdateRecipeJobFluentBuilder
pub fn update_recipe_job(&self) -> UpdateRecipeJobFluentBuilder
Constructs a fluent builder for the UpdateRecipeJob
operation.
- The fluent builder is configurable:
encryption_key_arn(impl Into<String>)
/set_encryption_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
encryption_mode(EncryptionMode)
/set_encryption_mode(Option<EncryptionMode>)
:
required: falseThe encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
-
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job to update.
log_subscription(LogSubscription)
/set_log_subscription(Option<LogSubscription>)
:
required: falseEnables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
max_capacity(i32)
/set_max_capacity(Option<i32>)
:
required: falseThe maximum number of nodes that DataBrew can consume when the job processes data.
max_retries(i32)
/set_max_retries(Option<i32>)
:
required: falseThe maximum number of times to retry the job after a job run fails.
outputs(Output)
/set_outputs(Option<Vec::<Output>>)
:
required: falseOne or more artifacts that represent the output from running the job.
data_catalog_outputs(DataCatalogOutput)
/set_data_catalog_outputs(Option<Vec::<DataCatalogOutput>>)
:
required: falseOne or more artifacts that represent the Glue Data Catalog output from running the job.
database_outputs(DatabaseOutput)
/set_database_outputs(Option<Vec::<DatabaseOutput>>)
:
required: falseRepresents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe job’s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT
.
- On success, responds with
UpdateRecipeJobOutput
with field(s):name(String)
:The name of the job that you updated.
- On failure, responds with
SdkError<UpdateRecipeJobError>
Source§impl Client
impl Client
Sourcepub fn update_ruleset(&self) -> UpdateRulesetFluentBuilder
pub fn update_ruleset(&self) -> UpdateRulesetFluentBuilder
Constructs a fluent builder for the UpdateRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the ruleset to be updated.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the ruleset.
rules(Rule)
/set_rules(Option<Vec::<Rule>>)
:
required: trueA list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.
- On success, responds with
UpdateRulesetOutput
with field(s):name(String)
:The name of the updated ruleset.
- On failure, responds with
SdkError<UpdateRulesetError>
Source§impl Client
impl Client
Sourcepub fn update_schedule(&self) -> UpdateScheduleFluentBuilder
pub fn update_schedule(&self) -> UpdateScheduleFluentBuilder
Constructs a fluent builder for the UpdateSchedule
operation.
- The fluent builder is configurable:
job_names(impl Into<String>)
/set_job_names(Option<Vec::<String>>)
:
required: falseThe name or names of one or more jobs to be run for this schedule.
cron_expression(impl Into<String>)
/set_cron_expression(Option<String>)
:
required: trueThe date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the schedule to update.
- On success, responds with
UpdateScheduleOutput
with field(s):name(String)
:The name of the schedule that was updated.
- On failure, responds with
SdkError<UpdateScheduleError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);