pub struct Client { /* private fields */ }
Expand description
Client for AWS Glue
Client for invoking operations on AWS Glue. Each operation on AWS Glue 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_glue::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_glue::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 BatchCreatePartition
operation has
a Client::batch_create_partition
, 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_create_partition()
.catalog_id("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_create_partition(&self) -> BatchCreatePartitionFluentBuilder
pub fn batch_create_partition(&self) -> BatchCreatePartitionFluentBuilder
Constructs a fluent builder for the BatchCreatePartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the metadata database in which the partition is to be created.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the metadata table in which the partition is to be created.
partition_input_list(PartitionInput)
/set_partition_input_list(Option<Vec::<PartitionInput>>)
:
required: trueA list of
PartitionInput
structures that define the partitions to be created.
- On success, responds with
BatchCreatePartitionOutput
with field(s):errors(Option<Vec::<PartitionError>>)
:The errors encountered when trying to create the requested partitions.
- On failure, responds with
SdkError<BatchCreatePartitionError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_connection(&self) -> BatchDeleteConnectionFluentBuilder
pub fn batch_delete_connection(&self) -> BatchDeleteConnectionFluentBuilder
Constructs a fluent builder for the BatchDeleteConnection
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
connection_name_list(impl Into<String>)
/set_connection_name_list(Option<Vec::<String>>)
:
required: trueA list of names of the connections to delete.
- On success, responds with
BatchDeleteConnectionOutput
with field(s):succeeded(Option<Vec::<String>>)
:A list of names of the connection definitions that were successfully deleted.
errors(Option<HashMap::<String, ErrorDetail>>)
:A map of the names of connections that were not successfully deleted to error details.
- On failure, responds with
SdkError<BatchDeleteConnectionError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_partition(&self) -> BatchDeletePartitionFluentBuilder
pub fn batch_delete_partition(&self) -> BatchDeletePartitionFluentBuilder
Constructs a fluent builder for the BatchDeletePartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database in which the table in question resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table that contains the partitions to be deleted.
partitions_to_delete(PartitionValueList)
/set_partitions_to_delete(Option<Vec::<PartitionValueList>>)
:
required: trueA list of
PartitionInput
structures that define the partitions to be deleted.
- On success, responds with
BatchDeletePartitionOutput
with field(s):errors(Option<Vec::<PartitionError>>)
:The errors encountered when trying to delete the requested partitions.
- On failure, responds with
SdkError<BatchDeletePartitionError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_table(&self) -> BatchDeleteTableFluentBuilder
pub fn batch_delete_table(&self) -> BatchDeleteTableFluentBuilder
Constructs a fluent builder for the BatchDeleteTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
tables_to_delete(impl Into<String>)
/set_tables_to_delete(Option<Vec::<String>>)
:
required: trueA list of the table to delete.
transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:
required: falseThe transaction ID at which to delete the table contents.
- On success, responds with
BatchDeleteTableOutput
with field(s):errors(Option<Vec::<TableError>>)
:A list of errors encountered in attempting to delete the specified tables.
- On failure, responds with
SdkError<BatchDeleteTableError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_table_version(&self) -> BatchDeleteTableVersionFluentBuilder
pub fn batch_delete_table_version(&self) -> BatchDeleteTableVersionFluentBuilder
Constructs a fluent builder for the BatchDeleteTableVersion
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table. For Hive compatibility, this name is entirely lowercase.
version_ids(impl Into<String>)
/set_version_ids(Option<Vec::<String>>)
:
required: trueA list of the IDs of versions to be deleted. A
VersionId
is a string representation of an integer. Each version is incremented by 1.
- On success, responds with
BatchDeleteTableVersionOutput
with field(s):errors(Option<Vec::<TableVersionError>>)
:A list of errors encountered while trying to delete the specified table versions.
- On failure, responds with
SdkError<BatchDeleteTableVersionError>
Source§impl Client
impl Client
Sourcepub fn batch_get_blueprints(&self) -> BatchGetBlueprintsFluentBuilder
pub fn batch_get_blueprints(&self) -> BatchGetBlueprintsFluentBuilder
Constructs a fluent builder for the BatchGetBlueprints
operation.
- The fluent builder is configurable:
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: trueA list of blueprint names.
include_blueprint(bool)
/set_include_blueprint(Option<bool>)
:
required: falseSpecifies whether or not to include the blueprint in the response.
include_parameter_spec(bool)
/set_include_parameter_spec(Option<bool>)
:
required: falseSpecifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.
- On success, responds with
BatchGetBlueprintsOutput
with field(s):blueprints(Option<Vec::<Blueprint>>)
:Returns a list of blueprint as a
Blueprints
object.missing_blueprints(Option<Vec::<String>>)
:Returns a list of
BlueprintNames
that were not found.
- On failure, responds with
SdkError<BatchGetBlueprintsError>
Source§impl Client
impl Client
Sourcepub fn batch_get_crawlers(&self) -> BatchGetCrawlersFluentBuilder
pub fn batch_get_crawlers(&self) -> BatchGetCrawlersFluentBuilder
Constructs a fluent builder for the BatchGetCrawlers
operation.
- The fluent builder is configurable:
crawler_names(impl Into<String>)
/set_crawler_names(Option<Vec::<String>>)
:
required: trueA list of crawler names, which might be the names returned from the
ListCrawlers
operation.
- On success, responds with
BatchGetCrawlersOutput
with field(s):crawlers(Option<Vec::<Crawler>>)
:A list of crawler definitions.
crawlers_not_found(Option<Vec::<String>>)
:A list of names of crawlers that were not found.
- On failure, responds with
SdkError<BatchGetCrawlersError>
Source§impl Client
impl Client
Sourcepub fn batch_get_custom_entity_types(
&self,
) -> BatchGetCustomEntityTypesFluentBuilder
pub fn batch_get_custom_entity_types( &self, ) -> BatchGetCustomEntityTypesFluentBuilder
Constructs a fluent builder for the BatchGetCustomEntityTypes
operation.
- The fluent builder is configurable:
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: trueA list of names of the custom patterns that you want to retrieve.
- On success, responds with
BatchGetCustomEntityTypesOutput
with field(s):custom_entity_types(Option<Vec::<CustomEntityType>>)
:A list of
CustomEntityType
objects representing the custom patterns that have been created.custom_entity_types_not_found(Option<Vec::<String>>)
:A list of the names of custom patterns that were not found.
- On failure, responds with
SdkError<BatchGetCustomEntityTypesError>
Source§impl Client
impl Client
Sourcepub fn batch_get_data_quality_result(
&self,
) -> BatchGetDataQualityResultFluentBuilder
pub fn batch_get_data_quality_result( &self, ) -> BatchGetDataQualityResultFluentBuilder
Constructs a fluent builder for the BatchGetDataQualityResult
operation.
- The fluent builder is configurable:
result_ids(impl Into<String>)
/set_result_ids(Option<Vec::<String>>)
:
required: trueA list of unique result IDs for the data quality results.
- On success, responds with
BatchGetDataQualityResultOutput
with field(s):results(Vec::<DataQualityResult>)
:A list of
DataQualityResult
objects representing the data quality results.results_not_found(Option<Vec::<String>>)
:A list of result IDs for which results were not found.
- On failure, responds with
SdkError<BatchGetDataQualityResultError>
Source§impl Client
impl Client
Sourcepub fn batch_get_dev_endpoints(&self) -> BatchGetDevEndpointsFluentBuilder
pub fn batch_get_dev_endpoints(&self) -> BatchGetDevEndpointsFluentBuilder
Constructs a fluent builder for the BatchGetDevEndpoints
operation.
- The fluent builder is configurable:
dev_endpoint_names(impl Into<String>)
/set_dev_endpoint_names(Option<Vec::<String>>)
:
required: trueThe list of
DevEndpoint
names, which might be the names returned from theListDevEndpoint
operation.
- On success, responds with
BatchGetDevEndpointsOutput
with field(s):dev_endpoints(Option<Vec::<DevEndpoint>>)
:A list of
DevEndpoint
definitions.dev_endpoints_not_found(Option<Vec::<String>>)
:A list of
DevEndpoints
not found.
- On failure, responds with
SdkError<BatchGetDevEndpointsError>
Source§impl Client
impl Client
Sourcepub fn batch_get_jobs(&self) -> BatchGetJobsFluentBuilder
pub fn batch_get_jobs(&self) -> BatchGetJobsFluentBuilder
Constructs a fluent builder for the BatchGetJobs
operation.
- The fluent builder is configurable:
job_names(impl Into<String>)
/set_job_names(Option<Vec::<String>>)
:
required: trueA list of job names, which might be the names returned from the
ListJobs
operation.
- On success, responds with
BatchGetJobsOutput
with field(s):jobs(Option<Vec::<Job>>)
:A list of job definitions.
jobs_not_found(Option<Vec::<String>>)
:A list of names of jobs not found.
- On failure, responds with
SdkError<BatchGetJobsError>
Source§impl Client
impl Client
Sourcepub fn batch_get_partition(&self) -> BatchGetPartitionFluentBuilder
pub fn batch_get_partition(&self) -> BatchGetPartitionFluentBuilder
Constructs a fluent builder for the BatchGetPartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
partitions_to_get(PartitionValueList)
/set_partitions_to_get(Option<Vec::<PartitionValueList>>)
:
required: trueA list of partition values identifying the partitions to retrieve.
- On success, responds with
BatchGetPartitionOutput
with field(s):partitions(Option<Vec::<Partition>>)
:A list of the requested partitions.
unprocessed_keys(Option<Vec::<PartitionValueList>>)
:A list of the partition values in the request for which partitions were not returned.
- On failure, responds with
SdkError<BatchGetPartitionError>
Source§impl Client
impl Client
Sourcepub fn batch_get_table_optimizer(&self) -> BatchGetTableOptimizerFluentBuilder
pub fn batch_get_table_optimizer(&self) -> BatchGetTableOptimizerFluentBuilder
Constructs a fluent builder for the BatchGetTableOptimizer
operation.
- The fluent builder is configurable:
entries(BatchGetTableOptimizerEntry)
/set_entries(Option<Vec::<BatchGetTableOptimizerEntry>>)
:
required: trueA list of
BatchGetTableOptimizerEntry
objects specifying the table optimizers to retrieve.
- On success, responds with
BatchGetTableOptimizerOutput
with field(s):table_optimizers(Option<Vec::<BatchTableOptimizer>>)
:A list of
BatchTableOptimizer
objects.failures(Option<Vec::<BatchGetTableOptimizerError>>)
:A list of errors from the operation.
- On failure, responds with
SdkError<BatchGetTableOptimizerError>
Source§impl Client
impl Client
Sourcepub fn batch_get_triggers(&self) -> BatchGetTriggersFluentBuilder
pub fn batch_get_triggers(&self) -> BatchGetTriggersFluentBuilder
Constructs a fluent builder for the BatchGetTriggers
operation.
- The fluent builder is configurable:
trigger_names(impl Into<String>)
/set_trigger_names(Option<Vec::<String>>)
:
required: trueA list of trigger names, which may be the names returned from the
ListTriggers
operation.
- On success, responds with
BatchGetTriggersOutput
with field(s):triggers(Option<Vec::<Trigger>>)
:A list of trigger definitions.
triggers_not_found(Option<Vec::<String>>)
:A list of names of triggers not found.
- On failure, responds with
SdkError<BatchGetTriggersError>
Source§impl Client
impl Client
Sourcepub fn batch_get_workflows(&self) -> BatchGetWorkflowsFluentBuilder
pub fn batch_get_workflows(&self) -> BatchGetWorkflowsFluentBuilder
Constructs a fluent builder for the BatchGetWorkflows
operation.
- The fluent builder is configurable:
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: trueA list of workflow names, which may be the names returned from the
ListWorkflows
operation.include_graph(bool)
/set_include_graph(Option<bool>)
:
required: falseSpecifies whether to include a graph when returning the workflow resource metadata.
- On success, responds with
BatchGetWorkflowsOutput
with field(s):workflows(Option<Vec::<Workflow>>)
:A list of workflow resource metadata.
missing_workflows(Option<Vec::<String>>)
:A list of names of workflows not found.
- On failure, responds with
SdkError<BatchGetWorkflowsError>
Source§impl Client
impl Client
Sourcepub fn batch_put_data_quality_statistic_annotation(
&self,
) -> BatchPutDataQualityStatisticAnnotationFluentBuilder
pub fn batch_put_data_quality_statistic_annotation( &self, ) -> BatchPutDataQualityStatisticAnnotationFluentBuilder
Constructs a fluent builder for the BatchPutDataQualityStatisticAnnotation
operation.
- The fluent builder is configurable:
inclusion_annotations(DatapointInclusionAnnotation)
/set_inclusion_annotations(Option<Vec::<DatapointInclusionAnnotation>>)
:
required: trueA list of
DatapointInclusionAnnotation
’s.client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseClient Token.
- On success, responds with
BatchPutDataQualityStatisticAnnotationOutput
with field(s):failed_inclusion_annotations(Option<Vec::<AnnotationError>>)
:A list of
AnnotationError
’s.
- On failure, responds with
SdkError<BatchPutDataQualityStatisticAnnotationError>
Source§impl Client
impl Client
Sourcepub fn batch_stop_job_run(&self) -> BatchStopJobRunFluentBuilder
pub fn batch_stop_job_run(&self) -> BatchStopJobRunFluentBuilder
Constructs a fluent builder for the BatchStopJobRun
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job definition for which to stop job runs.
job_run_ids(impl Into<String>)
/set_job_run_ids(Option<Vec::<String>>)
:
required: trueA list of the
JobRunIds
that should be stopped for that job definition.
- On success, responds with
BatchStopJobRunOutput
with field(s):successful_submissions(Option<Vec::<BatchStopJobRunSuccessfulSubmission>>)
:A list of the JobRuns that were successfully submitted for stopping.
errors(Option<Vec::<BatchStopJobRunError>>)
:A list of the errors that were encountered in trying to stop
JobRuns
, including theJobRunId
for which each error was encountered and details about the error.
- On failure, responds with
SdkError<BatchStopJobRunError>
Source§impl Client
impl Client
Sourcepub fn batch_update_partition(&self) -> BatchUpdatePartitionFluentBuilder
pub fn batch_update_partition(&self) -> BatchUpdatePartitionFluentBuilder
Constructs a fluent builder for the BatchUpdatePartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the metadata database in which the partition is to be updated.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the metadata table in which the partition is to be updated.
entries(BatchUpdatePartitionRequestEntry)
/set_entries(Option<Vec::<BatchUpdatePartitionRequestEntry>>)
:
required: trueA list of up to 100
BatchUpdatePartitionRequestEntry
objects to update.
- On success, responds with
BatchUpdatePartitionOutput
with field(s):errors(Option<Vec::<BatchUpdatePartitionFailureEntry>>)
:The errors encountered when trying to update the requested partitions. A list of
BatchUpdatePartitionFailureEntry
objects.
- On failure, responds with
SdkError<BatchUpdatePartitionError>
Source§impl Client
impl Client
Sourcepub fn cancel_data_quality_rule_recommendation_run(
&self,
) -> CancelDataQualityRuleRecommendationRunFluentBuilder
pub fn cancel_data_quality_rule_recommendation_run( &self, ) -> CancelDataQualityRuleRecommendationRunFluentBuilder
Constructs a fluent builder for the CancelDataQualityRuleRecommendationRun
operation.
- The fluent builder is configurable:
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe unique run identifier associated with this run.
- On success, responds with
CancelDataQualityRuleRecommendationRunOutput
- On failure, responds with
SdkError<CancelDataQualityRuleRecommendationRunError>
Source§impl Client
impl Client
Sourcepub fn cancel_data_quality_ruleset_evaluation_run(
&self,
) -> CancelDataQualityRulesetEvaluationRunFluentBuilder
pub fn cancel_data_quality_ruleset_evaluation_run( &self, ) -> CancelDataQualityRulesetEvaluationRunFluentBuilder
Constructs a fluent builder for the CancelDataQualityRulesetEvaluationRun
operation.
- The fluent builder is configurable:
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe unique run identifier associated with this run.
- On success, responds with
CancelDataQualityRulesetEvaluationRunOutput
- On failure, responds with
SdkError<CancelDataQualityRulesetEvaluationRunError>
Source§impl Client
impl Client
Sourcepub fn cancel_ml_task_run(&self) -> CancelMLTaskRunFluentBuilder
pub fn cancel_ml_task_run(&self) -> CancelMLTaskRunFluentBuilder
Constructs a fluent builder for the CancelMLTaskRun
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the machine learning transform.
task_run_id(impl Into<String>)
/set_task_run_id(Option<String>)
:
required: trueA unique identifier for the task run.
- On success, responds with
CancelMlTaskRunOutput
with field(s):transform_id(Option<String>)
:The unique identifier of the machine learning transform.
task_run_id(Option<String>)
:The unique identifier for the task run.
status(Option<TaskStatusType>)
:The status for this run.
- On failure, responds with
SdkError<CancelMLTaskRunError>
Source§impl Client
impl Client
Sourcepub fn cancel_statement(&self) -> CancelStatementFluentBuilder
pub fn cancel_statement(&self) -> CancelStatementFluentBuilder
Constructs a fluent builder for the CancelStatement
operation.
- The fluent builder is configurable:
session_id(impl Into<String>)
/set_session_id(Option<String>)
:
required: trueThe Session ID of the statement to be cancelled.
id(i32)
/set_id(Option<i32>)
:
required: trueThe ID of the statement to be cancelled.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request to cancel the statement.
- On success, responds with
CancelStatementOutput
- On failure, responds with
SdkError<CancelStatementError>
Source§impl Client
impl Client
Sourcepub fn check_schema_version_validity(
&self,
) -> CheckSchemaVersionValidityFluentBuilder
pub fn check_schema_version_validity( &self, ) -> CheckSchemaVersionValidityFluentBuilder
Constructs a fluent builder for the CheckSchemaVersionValidity
operation.
- The fluent builder is configurable:
data_format(DataFormat)
/set_data_format(Option<DataFormat>)
:
required: trueThe data format of the schema definition. Currently
AVRO
,JSON
andPROTOBUF
are supported.schema_definition(impl Into<String>)
/set_schema_definition(Option<String>)
:
required: trueThe definition of the schema that has to be validated.
- On success, responds with
CheckSchemaVersionValidityOutput
with field(s):valid(bool)
:Return true, if the schema is valid and false otherwise.
error(Option<String>)
:A validation failure error message.
- On failure, responds with
SdkError<CheckSchemaVersionValidityError>
Source§impl Client
impl Client
Sourcepub fn create_blueprint(&self) -> CreateBlueprintFluentBuilder
pub fn create_blueprint(&self) -> CreateBlueprintFluentBuilder
Constructs a fluent builder for the CreateBlueprint
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the blueprint.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the blueprint.
blueprint_location(impl Into<String>)
/set_blueprint_location(Option<String>)
:
required: trueSpecifies a path in Amazon S3 where the blueprint is published.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to be applied to this blueprint.
- On success, responds with
CreateBlueprintOutput
with field(s):name(Option<String>)
:Returns the name of the blueprint that was registered.
- On failure, responds with
SdkError<CreateBlueprintError>
Source§impl Client
impl Client
Sourcepub fn create_catalog(&self) -> CreateCatalogFluentBuilder
pub fn create_catalog(&self) -> CreateCatalogFluentBuilder
Constructs a fluent builder for the CreateCatalog
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the catalog to create.
catalog_input(CatalogInput)
/set_catalog_input(Option<CatalogInput>)
:
required: trueA
CatalogInput
object that defines the metadata for the catalog.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA map array of key-value pairs, not more than 50 pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a UTF-8 string, not more than 256 bytes long. The tags you assign to the catalog.
- On success, responds with
CreateCatalogOutput
- On failure, responds with
SdkError<CreateCatalogError>
Source§impl Client
impl Client
Sourcepub fn create_classifier(&self) -> CreateClassifierFluentBuilder
pub fn create_classifier(&self) -> CreateClassifierFluentBuilder
Constructs a fluent builder for the CreateClassifier
operation.
- The fluent builder is configurable:
grok_classifier(CreateGrokClassifierRequest)
/set_grok_classifier(Option<CreateGrokClassifierRequest>)
:
required: falseA
GrokClassifier
object specifying the classifier to create.xml_classifier(CreateXmlClassifierRequest)
/set_xml_classifier(Option<CreateXmlClassifierRequest>)
:
required: falseAn
XMLClassifier
object specifying the classifier to create.json_classifier(CreateJsonClassifierRequest)
/set_json_classifier(Option<CreateJsonClassifierRequest>)
:
required: falseA
JsonClassifier
object specifying the classifier to create.csv_classifier(CreateCsvClassifierRequest)
/set_csv_classifier(Option<CreateCsvClassifierRequest>)
:
required: falseA
CsvClassifier
object specifying the classifier to create.
- On success, responds with
CreateClassifierOutput
- On failure, responds with
SdkError<CreateClassifierError>
Source§impl Client
impl Client
Sourcepub fn create_column_statistics_task_settings(
&self,
) -> CreateColumnStatisticsTaskSettingsFluentBuilder
pub fn create_column_statistics_task_settings( &self, ) -> CreateColumnStatisticsTaskSettingsFluentBuilder
Constructs a fluent builder for the CreateColumnStatisticsTaskSettings
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table for which to generate column statistics.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueThe role used for running the column statistics.
schedule(impl Into<String>)
/set_schedule(Option<String>)
:
required: falseA schedule for running the column statistics, specified in CRON syntax.
column_name_list(impl Into<String>)
/set_column_name_list(Option<Vec::<String>>)
:
required: falseA list of column names for which to run statistics.
sample_size(f64)
/set_sample_size(Option<f64>)
:
required: falseThe percentage of data to sample.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the database resides.
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseName of the security configuration that is used to encrypt CloudWatch logs.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA map of tags.
- On success, responds with
CreateColumnStatisticsTaskSettingsOutput
- On failure, responds with
SdkError<CreateColumnStatisticsTaskSettingsError>
Source§impl Client
impl Client
Sourcepub fn create_connection(&self) -> CreateConnectionFluentBuilder
pub fn create_connection(&self) -> CreateConnectionFluentBuilder
Constructs a fluent builder for the CreateConnection
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.
connection_input(ConnectionInput)
/set_connection_input(Option<ConnectionInput>)
:
required: trueA
ConnectionInput
object defining the connection to create.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags you assign to the connection.
- On success, responds with
CreateConnectionOutput
with field(s):create_connection_status(Option<ConnectionStatus>)
:The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.
- On failure, responds with
SdkError<CreateConnectionError>
Source§impl Client
impl Client
Sourcepub fn create_crawler(&self) -> CreateCrawlerFluentBuilder
pub fn create_crawler(&self) -> CreateCrawlerFluentBuilder
Constructs a fluent builder for the CreateCrawler
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the new crawler.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueThe IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: falseThe Glue database where results are written, such as:
arn:aws:daylight:us-east-1::database/sometable/*
.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the new crawler.
targets(CrawlerTargets)
/set_targets(Option<CrawlerTargets>)
:
required: trueA list of collection of targets to crawl.
schedule(impl Into<String>)
/set_schedule(Option<String>)
:
required: falseA
cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:cron(15 12 * * ? *)
.classifiers(impl Into<String>)
/set_classifiers(Option<Vec::<String>>)
:
required: falseA list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
table_prefix(impl Into<String>)
/set_table_prefix(Option<String>)
:
required: falseThe table prefix used for catalog tables that are created.
schema_change_policy(SchemaChangePolicy)
/set_schema_change_policy(Option<SchemaChangePolicy>)
:
required: falseThe policy for the crawler’s update and deletion behavior.
recrawl_policy(RecrawlPolicy)
/set_recrawl_policy(Option<RecrawlPolicy>)
:
required: falseA policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
lineage_configuration(LineageConfiguration)
/set_lineage_configuration(Option<LineageConfiguration>)
:
required: falseSpecifies data lineage configuration settings for the crawler.
lake_formation_configuration(LakeFormationConfiguration)
/set_lake_formation_configuration(Option<LakeFormationConfiguration>)
:
required: falseSpecifies Lake Formation configuration settings for the crawler.
configuration(impl Into<String>)
/set_configuration(Option<String>)
:
required: falseCrawler configuration information. This versioned JSON string allows users to specify aspects of a crawler’s behavior. For more information, see Setting crawler configuration options.
crawler_security_configuration(impl Into<String>)
/set_crawler_security_configuration(Option<String>)
:
required: falseThe name of the
SecurityConfiguration
structure to be used by this crawler.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
- On success, responds with
CreateCrawlerOutput
- On failure, responds with
SdkError<CreateCrawlerError>
Source§impl Client
impl Client
Sourcepub fn create_custom_entity_type(&self) -> CreateCustomEntityTypeFluentBuilder
pub fn create_custom_entity_type(&self) -> CreateCustomEntityTypeFluentBuilder
Constructs a fluent builder for the CreateCustomEntityType
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
regex_string(impl Into<String>)
/set_regex_string(Option<String>)
:
required: trueA regular expression string that is used for detecting sensitive data in a custom pattern.
context_words(impl Into<String>)
/set_context_words(Option<Vec::<String>>)
:
required: falseA list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of tags applied to the custom entity type.
- On success, responds with
CreateCustomEntityTypeOutput
with field(s):name(Option<String>)
:The name of the custom pattern you created.
- On failure, responds with
SdkError<CreateCustomEntityTypeError>
Source§impl Client
impl Client
Sourcepub fn create_data_quality_ruleset(
&self,
) -> CreateDataQualityRulesetFluentBuilder
pub fn create_data_quality_ruleset( &self, ) -> CreateDataQualityRulesetFluentBuilder
Constructs a fluent builder for the CreateDataQualityRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA unique name for the data quality ruleset.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the data quality ruleset.
ruleset(impl Into<String>)
/set_ruleset(Option<String>)
:
required: trueA Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of tags applied to the data quality ruleset.
target_table(DataQualityTargetTable)
/set_target_table(Option<DataQualityTargetTable>)
:
required: falseA target table associated with the data quality ruleset.
data_quality_security_configuration(impl Into<String>)
/set_data_quality_security_configuration(Option<String>)
:
required: falseThe name of the security configuration created with the data quality encryption option.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseUsed for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
- On success, responds with
CreateDataQualityRulesetOutput
with field(s):name(Option<String>)
:A unique name for the data quality ruleset.
- On failure, responds with
SdkError<CreateDataQualityRulesetError>
Source§impl Client
impl Client
Sourcepub fn create_database(&self) -> CreateDatabaseFluentBuilder
pub fn create_database(&self) -> CreateDatabaseFluentBuilder
Constructs a fluent builder for the CreateDatabase
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.
database_input(DatabaseInput)
/set_database_input(Option<DatabaseInput>)
:
required: trueThe metadata for the database.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags you assign to the database.
- On success, responds with
CreateDatabaseOutput
- On failure, responds with
SdkError<CreateDatabaseError>
Source§impl Client
impl Client
Sourcepub fn create_dev_endpoint(&self) -> CreateDevEndpointFluentBuilder
pub fn create_dev_endpoint(&self) -> CreateDevEndpointFluentBuilder
Constructs a fluent builder for the CreateDevEndpoint
operation.
- The fluent builder is configurable:
endpoint_name(impl Into<String>)
/set_endpoint_name(Option<String>)
:
required: trueThe name to be assigned to the new
DevEndpoint
.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe IAM role for the
DevEndpoint
.security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseSecurity group IDs for the security groups to be used by the new
DevEndpoint
.subnet_id(impl Into<String>)
/set_subnet_id(Option<String>)
:
required: falseThe subnet ID for the new
DevEndpoint
to use.public_key(impl Into<String>)
/set_public_key(Option<String>)
:
required: falseThe public key to be used by this
DevEndpoint
for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.public_keys(impl Into<String>)
/set_public_keys(Option<Vec::<String>>)
:
required: falseA list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the
UpdateDevEndpoint
API with the public key content in thedeletePublicKeys
attribute, and the list of new keys in theaddPublicKeys
attribute.number_of_nodes(i32)
/set_number_of_nodes(Option<i32>)
:
required: falseThe number of Glue Data Processing Units (DPUs) to allocate to this
DevEndpoint
.worker_type(WorkerType)
/set_worker_type(Option<WorkerType>)
:
required: falseThe type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.-
glue_version(impl Into<String>)
/set_glue_version(Option<String>)
:
required: falseGlue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of workers of a defined
workerType
that are allocated to the development endpoint.The maximum number of workers you can define are 299 for
G.1X
, and 149 forG.2X
.extra_python_libs_s3_path(impl Into<String>)
/set_extra_python_libs_s3_path(Option<String>)
:
required: falseThe paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
DevEndpoint
. Multiple values must be complete paths separated by a comma.You can only use pure Python libraries with a
DevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.extra_jars_s3_path(impl Into<String>)
/set_extra_jars_s3_path(Option<String>)
:
required: falseThe path to one or more Java
.jar
files in an S3 bucket that should be loaded in yourDevEndpoint
.security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseThe name of the
SecurityConfiguration
structure to be used with thisDevEndpoint
.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
arguments(impl Into<String>, impl Into<String>)
/set_arguments(Option<HashMap::<String, String>>)
:
required: falseA map of arguments used to configure the
DevEndpoint
.
- On success, responds with
CreateDevEndpointOutput
with field(s):endpoint_name(Option<String>)
:The name assigned to the new
DevEndpoint
.status(Option<String>)
:The current status of the new
DevEndpoint
.security_group_ids(Option<Vec::<String>>)
:The security groups assigned to the new
DevEndpoint
.subnet_id(Option<String>)
:The subnet ID assigned to the new
DevEndpoint
.role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the role assigned to the new
DevEndpoint
.yarn_endpoint_address(Option<String>)
:The address of the YARN endpoint used by this
DevEndpoint
.zeppelin_remote_spark_interpreter_port(i32)
:The Apache Zeppelin port for the remote Apache Spark interpreter.
number_of_nodes(i32)
:The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
worker_type(Option<WorkerType>)
:The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
glue_version(Option<String>)
:Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
number_of_workers(Option<i32>)
:The number of workers of a defined
workerType
that are allocated to the development endpoint.availability_zone(Option<String>)
:The Amazon Web Services Availability Zone where this
DevEndpoint
is located.vpc_id(Option<String>)
:The ID of the virtual private cloud (VPC) used by this
DevEndpoint
.extra_python_libs_s3_path(Option<String>)
:The paths to one or more Python libraries in an S3 bucket that will be loaded in your
DevEndpoint
.extra_jars_s3_path(Option<String>)
:Path to one or more Java
.jar
files in an S3 bucket that will be loaded in yourDevEndpoint
.failure_reason(Option<String>)
:The reason for a current failure in this
DevEndpoint
.security_configuration(Option<String>)
:The name of the
SecurityConfiguration
structure being used with thisDevEndpoint
.created_timestamp(Option<DateTime>)
:The point in time at which this
DevEndpoint
was created.arguments(Option<HashMap::<String, String>>)
:The map of arguments used to configure this
DevEndpoint
.Valid arguments are:
-
“–enable-glue-datacatalog”: “”
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.-
- On failure, responds with
SdkError<CreateDevEndpointError>
Source§impl Client
impl Client
Sourcepub fn create_integration(&self) -> CreateIntegrationFluentBuilder
pub fn create_integration(&self) -> CreateIntegrationFluentBuilder
Constructs a fluent builder for the CreateIntegration
operation.
- The fluent builder is configurable:
integration_name(impl Into<String>)
/set_integration_name(Option<String>)
:
required: trueA unique name for an integration in Glue.
source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:
required: trueThe ARN of the source resource for the integration.
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:
required: trueThe ARN of the target resource for the integration.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the integration.
data_filter(impl Into<String>)
/set_data_filter(Option<String>)
:
required: falseSelects source tables for the integration using Maxwell filter syntax.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe ARN of a KMS key used for encrypting the channel.
additional_encryption_context(impl Into<String>, impl Into<String>)
/set_additional_encryption_context(Option<HashMap::<String, String>>)
:
required: falseAn optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if
KMSKeyId
is provided.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseMetadata assigned to the resource consisting of a list of key-value pairs.
- On success, responds with
CreateIntegrationOutput
with field(s):source_arn(String)
:The ARN of the source resource for the integration.
target_arn(String)
:The ARN of the target resource for the integration.
integration_name(String)
:A unique name for an integration in Glue.
description(Option<String>)
:A description of the integration.
integration_arn(String)
:The Amazon Resource Name (ARN) for the created integration.
kms_key_id(Option<String>)
:The ARN of a KMS key used for encrypting the channel.
additional_encryption_context(Option<HashMap::<String, String>>)
:An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
tags(Option<Vec::<Tag>>)
:Metadata assigned to the resource consisting of a list of key-value pairs.
status(IntegrationStatus)
:The status of the integration being created.
The possible statuses are:
-
CREATING: The integration is being created.
-
ACTIVE: The integration creation succeeds.
-
MODIFYING: The integration is being modified.
-
FAILED: The integration creation fails.
-
DELETING: The integration is deleted.
-
SYNCING: The integration is synchronizing.
-
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
-
create_time(DateTime)
:The time when the integration was created, in UTC.
errors(Option<Vec::<IntegrationError>>)
:A list of errors associated with the integration creation.
data_filter(Option<String>)
:Selects source tables for the integration using Maxwell filter syntax.
- On failure, responds with
SdkError<CreateIntegrationError>
Source§impl Client
impl Client
Sourcepub fn create_integration_resource_property(
&self,
) -> CreateIntegrationResourcePropertyFluentBuilder
pub fn create_integration_resource_property( &self, ) -> CreateIntegrationResourcePropertyFluentBuilder
Constructs a fluent builder for the CreateIntegrationResourceProperty
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe connection ARN of the source, or the database ARN of the target.
source_processing_properties(SourceProcessingProperties)
/set_source_processing_properties(Option<SourceProcessingProperties>)
:
required: falseThe resource properties associated with the integration source.
target_processing_properties(TargetProcessingProperties)
/set_target_processing_properties(Option<TargetProcessingProperties>)
:
required: falseThe resource properties associated with the integration target.
- On success, responds with
CreateIntegrationResourcePropertyOutput
with field(s):resource_arn(String)
:The connection ARN of the source, or the database ARN of the target.
source_processing_properties(Option<SourceProcessingProperties>)
:The resource properties associated with the integration source.
target_processing_properties(Option<TargetProcessingProperties>)
:The resource properties associated with the integration target.
- On failure, responds with
SdkError<CreateIntegrationResourcePropertyError>
Source§impl Client
impl Client
Sourcepub fn create_integration_table_properties(
&self,
) -> CreateIntegrationTablePropertiesFluentBuilder
pub fn create_integration_table_properties( &self, ) -> CreateIntegrationTablePropertiesFluentBuilder
Constructs a fluent builder for the CreateIntegrationTableProperties
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe connection ARN of the source, or the database ARN of the target.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table to be replicated.
source_table_config(SourceTableConfig)
/set_source_table_config(Option<SourceTableConfig>)
:
required: falseA structure for the source table configuration.
target_table_config(TargetTableConfig)
/set_target_table_config(Option<TargetTableConfig>)
:
required: falseA structure for the target table configuration.
- On success, responds with
CreateIntegrationTablePropertiesOutput
- On failure, responds with
SdkError<CreateIntegrationTablePropertiesError>
Source§impl Client
impl Client
Sourcepub fn create_job(&self) -> CreateJobFluentBuilder
pub fn create_job(&self) -> CreateJobFluentBuilder
Constructs a fluent builder for the CreateJob
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name you assign to this job definition. It must be unique in your account.
job_mode(JobMode)
/set_job_mode(Option<JobMode>)
:
required: falseA mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
JobMode
field is missing or null,SCRIPT
is assigned as the default value.-
job_run_queuing_enabled(bool)
/set_job_run_queuing_enabled(Option<bool>)
:
required: falseSpecifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseDescription of the job being defined.
log_uri(impl Into<String>)
/set_log_uri(Option<String>)
:
required: falseThis field is reserved for future use.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueThe name or Amazon Resource Name (ARN) of the IAM role associated with this job.
execution_property(ExecutionProperty)
/set_execution_property(Option<ExecutionProperty>)
:
required: falseAn
ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.command(JobCommand)
/set_command(Option<JobCommand>)
:
required: trueThe
JobCommand
that runs this job.default_arguments(impl Into<String>, impl Into<String>)
/set_default_arguments(Option<HashMap::<String, String>>)
:
required: falseThe default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
non_overridable_arguments(impl Into<String>, impl Into<String>)
/set_non_overridable_arguments(Option<HashMap::<String, String>>)
:
required: falseArguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
connections(ConnectionsList)
/set_connections(Option<ConnectionsList>)
:
required: falseThe connections used for this job.
max_retries(i32)
/set_max_retries(Option<i32>)
:
required: falseThe maximum number of times to retry this job if it fails.
allocated_capacity(i32)
/set_allocated_capacity(Option<i32>)
:
required: falseThis parameter is deprecated. Use
MaxCapacity
instead.The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters
TIMEOUT
status.Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
When the value is left blank, the timeout is defaulted to 2880 minutes.
Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
max_capacity(f64)
/set_max_capacity(Option<f64>)
:
required: falseFor Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:-
When you specify a Python shell job (
JobCommand.Name
=“pythonshell”), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. -
When you specify an Apache Spark ETL job (
JobCommand.Name
=“glueetl”) or Apache Spark streaming ETL job (JobCommand.Name
=“gluestreaming”), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
-
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseThe name of the
SecurityConfiguration
structure to be used with this job.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
notification_property(NotificationProperty)
/set_notification_property(Option<NotificationProperty>)
:
required: falseSpecifies configuration properties of a job notification.
glue_version(impl Into<String>)
/set_glue_version(Option<String>)
:
required: falseIn Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of workers of a defined
workerType
that are allocated when a job runs.worker_type(WorkerType)
/set_worker_type(Option<WorkerType>)
:
required: falseThe type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
-
code_gen_configuration_nodes(impl Into<String>, CodeGenConfigurationNode)
/set_code_gen_configuration_nodes(Option<HashMap::<String, CodeGenConfigurationNode>>)
:
required: falseThe representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
execution_class(ExecutionClass)
/set_execution_class(Option<ExecutionClass>)
:
required: falseIndicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs.source_control_details(SourceControlDetails)
/set_source_control_details(Option<SourceControlDetails>)
:
required: falseThe details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
maintenance_window(impl Into<String>)
/set_maintenance_window(Option<String>)
:
required: falseThis field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
- On success, responds with
CreateJobOutput
with field(s):name(Option<String>)
:The unique name that was provided for this job definition.
- On failure, responds with
SdkError<CreateJobError>
Source§impl Client
impl Client
Sourcepub fn create_ml_transform(&self) -> CreateMLTransformFluentBuilder
pub fn create_ml_transform(&self) -> CreateMLTransformFluentBuilder
Constructs a fluent builder for the CreateMLTransform
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe unique name that you give the transform when you create it.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the machine learning transform that is being defined. The default is an empty string.
input_record_tables(GlueTable)
/set_input_record_tables(Option<Vec::<GlueTable>>)
:
required: trueA list of Glue table definitions used by the transform.
parameters(TransformParameters)
/set_parameters(Option<TransformParameters>)
:
required: trueThe algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueThe name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
-
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
-
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
-
glue_version(impl Into<String>)
/set_glue_version(Option<String>)
:
required: falseThis value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
max_capacity(f64)
/set_max_capacity(Option<f64>)
:
required: falseThe number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.-
worker_type(WorkerType)
/set_worker_type(Option<WorkerType>)
:
required: falseThe type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. -
For the
G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
-
number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of workers of a defined
workerType
that are allocated when this task runs.If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa).timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).max_retries(i32)
/set_max_retries(Option<i32>)
:
required: falseThe maximum number of times to retry a task for this transform after a task run fails.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
transform_encryption(TransformEncryption)
/set_transform_encryption(Option<TransformEncryption>)
:
required: falseThe encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
- On success, responds with
CreateMlTransformOutput
with field(s):transform_id(Option<String>)
:A unique identifier that is generated for the transform.
- On failure, responds with
SdkError<CreateMLTransformError>
Source§impl Client
impl Client
Sourcepub fn create_partition(&self) -> CreatePartitionFluentBuilder
pub fn create_partition(&self) -> CreatePartitionFluentBuilder
Constructs a fluent builder for the CreatePartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe Amazon Web Services account ID of the catalog in which the partition is to be created.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the metadata database in which the partition is to be created.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the metadata table in which the partition is to be created.
partition_input(PartitionInput)
/set_partition_input(Option<PartitionInput>)
:
required: trueA
PartitionInput
structure defining the partition to be created.
- On success, responds with
CreatePartitionOutput
- On failure, responds with
SdkError<CreatePartitionError>
Source§impl Client
impl Client
Sourcepub fn create_partition_index(&self) -> CreatePartitionIndexFluentBuilder
pub fn create_partition_index(&self) -> CreatePartitionIndexFluentBuilder
Constructs a fluent builder for the CreatePartitionIndex
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe catalog ID where the table resides.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueSpecifies the name of a database in which you want to create a partition index.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueSpecifies the name of a table in which you want to create a partition index.
partition_index(PartitionIndex)
/set_partition_index(Option<PartitionIndex>)
:
required: trueSpecifies a
PartitionIndex
structure to create a partition index in an existing table.
- On success, responds with
CreatePartitionIndexOutput
- On failure, responds with
SdkError<CreatePartitionIndexError>
Source§impl Client
impl Client
Sourcepub fn create_registry(&self) -> CreateRegistryFluentBuilder
pub fn create_registry(&self) -> CreateRegistryFluentBuilder
Constructs a fluent builder for the CreateRegistry
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueName of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the registry. If description is not provided, there will not be any default value for this.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAmazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
- On success, responds with
CreateRegistryOutput
with field(s):registry_arn(Option<String>)
:The Amazon Resource Name (ARN) of the newly created registry.
registry_name(Option<String>)
:The name of the registry.
description(Option<String>)
:A description of the registry.
tags(Option<HashMap::<String, String>>)
:The tags for the registry.
- On failure, responds with
SdkError<CreateRegistryError>
Source§impl Client
impl Client
Sourcepub fn create_schema(&self) -> CreateSchemaFluentBuilder
pub fn create_schema(&self) -> CreateSchemaFluentBuilder
Constructs a fluent builder for the CreateSchema
operation.
- The fluent builder is configurable:
registry_id(RegistryId)
/set_registry_id(Option<RegistryId>)
:
required: falseThis is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be:
arn:aws:glue:us-east-2:
.:registry/default-registry:random-5-letter-id schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueName of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
data_format(DataFormat)
/set_data_format(Option<DataFormat>)
:
required: trueThe data format of the schema definition. Currently
AVRO
,JSON
andPROTOBUF
are supported.compatibility(Compatibility)
/set_compatibility(Option<Compatibility>)
:
required: falseThe compatibility mode of the schema. The possible values are:
-
NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
-
DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
-
BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can’t be read by readers using the previous version.
-
BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
-
FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
-
FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
-
FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
-
FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
-
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAn optional description of the schema. If description is not provided, there will not be any automatic default value for this.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAmazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
schema_definition(impl Into<String>)
/set_schema_definition(Option<String>)
:
required: falseThe schema definition using the
DataFormat
setting forSchemaName
.
- On success, responds with
CreateSchemaOutput
with field(s):registry_name(Option<String>)
:The name of the registry.
registry_arn(Option<String>)
:The Amazon Resource Name (ARN) of the registry.
schema_name(Option<String>)
:The name of the schema.
schema_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schema.
description(Option<String>)
:A description of the schema if specified when created.
data_format(Option<DataFormat>)
:The data format of the schema definition. Currently
AVRO
,JSON
andPROTOBUF
are supported.compatibility(Option<Compatibility>)
:The schema compatibility mode.
schema_checkpoint(Option<i64>)
:The version number of the checkpoint (the last time the compatibility mode was changed).
latest_schema_version(Option<i64>)
:The latest version of the schema associated with the returned schema definition.
next_schema_version(Option<i64>)
:The next version of the schema associated with the returned schema definition.
schema_status(Option<SchemaStatus>)
:The status of the schema.
tags(Option<HashMap::<String, String>>)
:The tags for the schema.
schema_version_id(Option<String>)
:The unique identifier of the first schema version.
schema_version_status(Option<SchemaVersionStatus>)
:The status of the first schema version created.
- On failure, responds with
SdkError<CreateSchemaError>
Source§impl Client
impl Client
Sourcepub fn create_script(&self) -> CreateScriptFluentBuilder
pub fn create_script(&self) -> CreateScriptFluentBuilder
Constructs a fluent builder for the CreateScript
operation.
- The fluent builder is configurable:
dag_nodes(CodeGenNode)
/set_dag_nodes(Option<Vec::<CodeGenNode>>)
:
required: falseA list of the nodes in the DAG.
dag_edges(CodeGenEdge)
/set_dag_edges(Option<Vec::<CodeGenEdge>>)
:
required: falseA list of the edges in the DAG.
language(Language)
/set_language(Option<Language>)
:
required: falseThe programming language of the resulting code from the DAG.
- On success, responds with
CreateScriptOutput
with field(s):python_script(Option<String>)
:The Python script generated from the DAG.
scala_code(Option<String>)
:The Scala code generated from the DAG.
- On failure, responds with
SdkError<CreateScriptError>
Source§impl Client
impl Client
Sourcepub fn create_security_configuration(
&self,
) -> CreateSecurityConfigurationFluentBuilder
pub fn create_security_configuration( &self, ) -> CreateSecurityConfigurationFluentBuilder
Constructs a fluent builder for the CreateSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name for the new security configuration.
encryption_configuration(EncryptionConfiguration)
/set_encryption_configuration(Option<EncryptionConfiguration>)
:
required: trueThe encryption configuration for the new security configuration.
- On success, responds with
CreateSecurityConfigurationOutput
with field(s):name(Option<String>)
:The name assigned to the new security configuration.
created_timestamp(Option<DateTime>)
:The time at which the new security configuration was created.
- On failure, responds with
SdkError<CreateSecurityConfigurationError>
Source§impl Client
impl Client
Sourcepub fn create_session(&self) -> CreateSessionFluentBuilder
pub fn create_session(&self) -> CreateSessionFluentBuilder
Constructs a fluent builder for the CreateSession
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the session request.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the session.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueThe IAM Role ARN
command(SessionCommand)
/set_command(Option<SessionCommand>)
:
required: trueThe
SessionCommand
that runs the job.timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes). Consult the documentation for other job types.
idle_timeout(i32)
/set_idle_timeout(Option<i32>)
:
required: falseThe number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
default_arguments(impl Into<String>, impl Into<String>)
/set_default_arguments(Option<HashMap::<String, String>>)
:
required: falseA map array of key-value pairs. Max is 75 pairs.
connections(ConnectionsList)
/set_connections(Option<ConnectionsList>)
:
required: falseThe number of connections to use for the session.
max_capacity(f64)
/set_max_capacity(Option<f64>)
:
required: falseThe number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of workers of a defined
WorkerType
to use for the session.worker_type(WorkerType)
/set_worker_type(Option<WorkerType>)
:
required: falseThe type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
-
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseThe name of the SecurityConfiguration structure to be used with the session
glue_version(impl Into<String>)
/set_glue_version(Option<String>)
:
required: falseThe Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe map of key value pairs (tags) belonging to the session.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request.
- On success, responds with
CreateSessionOutput
with field(s):session(Option<Session>)
:Returns the session object in the response.
- On failure, responds with
SdkError<CreateSessionError>
Source§impl Client
impl Client
Sourcepub fn create_table(&self) -> CreateTableFluentBuilder
pub fn create_table(&self) -> CreateTableFluentBuilder
Constructs a fluent builder for the CreateTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which to create the
Table
. If none is supplied, the Amazon Web Services account ID is used by default.database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
table_input(TableInput)
/set_table_input(Option<TableInput>)
:
required: trueThe
TableInput
object that defines the metadata table to create in the catalog.partition_indexes(PartitionIndex)
/set_partition_indexes(Option<Vec::<PartitionIndex>>)
:
required: falseA list of partition indexes,
PartitionIndex
structures, to create in the table.transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:
required: falseThe ID of the transaction.
open_table_format_input(OpenTableFormatInput)
/set_open_table_format_input(Option<OpenTableFormatInput>)
:
required: falseSpecifies an
OpenTableFormatInput
structure when creating an open format table.
- On success, responds with
CreateTableOutput
- On failure, responds with
SdkError<CreateTableError>
Source§impl Client
impl Client
Sourcepub fn create_table_optimizer(&self) -> CreateTableOptimizerFluentBuilder
pub fn create_table_optimizer(&self) -> CreateTableOptimizerFluentBuilder
Constructs a fluent builder for the CreateTableOptimizer
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe Catalog ID of the table.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database in the catalog in which the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table.
r#type(TableOptimizerType)
/set_type(Option<TableOptimizerType>)
:
required: trueThe type of table optimizer.
table_optimizer_configuration(TableOptimizerConfiguration)
/set_table_optimizer_configuration(Option<TableOptimizerConfiguration>)
:
required: trueA
TableOptimizerConfiguration
object representing the configuration of a table optimizer.
- On success, responds with
CreateTableOptimizerOutput
- On failure, responds with
SdkError<CreateTableOptimizerError>
Source§impl Client
impl Client
Sourcepub fn create_trigger(&self) -> CreateTriggerFluentBuilder
pub fn create_trigger(&self) -> CreateTriggerFluentBuilder
Constructs a fluent builder for the CreateTrigger
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the trigger.
workflow_name(impl Into<String>)
/set_workflow_name(Option<String>)
:
required: falseThe name of the workflow associated with the trigger.
r#type(TriggerType)
/set_type(Option<TriggerType>)
:
required: trueThe type of the new trigger.
schedule(impl Into<String>)
/set_schedule(Option<String>)
:
required: falseA
cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:cron(15 12 * * ? *)
.This field is required when the trigger type is SCHEDULED.
predicate(Predicate)
/set_predicate(Option<Predicate>)
:
required: falseA predicate to specify when the new trigger should fire.
This field is required when the trigger type is
CONDITIONAL
.actions(Action)
/set_actions(Option<Vec::<Action>>)
:
required: trueThe actions initiated by this trigger when it fires.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the new trigger.
start_on_creation(bool)
/set_start_on_creation(Option<bool>)
:
required: falseSet to
true
to startSCHEDULED
andCONDITIONAL
triggers when created. True is not supported forON_DEMAND
triggers.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
event_batching_condition(EventBatchingCondition)
/set_event_batching_condition(Option<EventBatchingCondition>)
:
required: falseBatch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
- On success, responds with
CreateTriggerOutput
with field(s):name(Option<String>)
:The name of the trigger.
- On failure, responds with
SdkError<CreateTriggerError>
Source§impl Client
impl Client
Sourcepub fn create_usage_profile(&self) -> CreateUsageProfileFluentBuilder
pub fn create_usage_profile(&self) -> CreateUsageProfileFluentBuilder
Constructs a fluent builder for the CreateUsageProfile
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the usage profile.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the usage profile.
configuration(ProfileConfiguration)
/set_configuration(Option<ProfileConfiguration>)
:
required: trueA
ProfileConfiguration
object specifying the job and session values for the profile.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of tags applied to the usage profile.
- On success, responds with
CreateUsageProfileOutput
with field(s):name(Option<String>)
:The name of the usage profile that was created.
- On failure, responds with
SdkError<CreateUsageProfileError>
Source§impl Client
impl Client
Sourcepub fn create_user_defined_function(
&self,
) -> CreateUserDefinedFunctionFluentBuilder
pub fn create_user_defined_function( &self, ) -> CreateUserDefinedFunctionFluentBuilder
Constructs a fluent builder for the CreateUserDefinedFunction
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database in which to create the function.
function_input(UserDefinedFunctionInput)
/set_function_input(Option<UserDefinedFunctionInput>)
:
required: trueA
FunctionInput
object that defines the function to create in the Data Catalog.
- On success, responds with
CreateUserDefinedFunctionOutput
- On failure, responds with
SdkError<CreateUserDefinedFunctionError>
Source§impl Client
impl Client
Sourcepub fn create_workflow(&self) -> CreateWorkflowFluentBuilder
pub fn create_workflow(&self) -> CreateWorkflowFluentBuilder
Constructs a fluent builder for the CreateWorkflow
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name to be assigned to the workflow. It should be unique within your account.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the workflow.
default_run_properties(impl Into<String>, impl Into<String>)
/set_default_run_properties(Option<HashMap::<String, String>>)
:
required: falseA collection of properties to be used as part of each execution of the workflow.
Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to be used with this workflow.
max_concurrent_runs(i32)
/set_max_concurrent_runs(Option<i32>)
:
required: falseYou can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
- On success, responds with
CreateWorkflowOutput
with field(s):name(Option<String>)
:The name of the workflow which was provided as part of the request.
- On failure, responds with
SdkError<CreateWorkflowError>
Source§impl Client
impl Client
Sourcepub fn delete_blueprint(&self) -> DeleteBlueprintFluentBuilder
pub fn delete_blueprint(&self) -> DeleteBlueprintFluentBuilder
Constructs a fluent builder for the DeleteBlueprint
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the blueprint to delete.
- On success, responds with
DeleteBlueprintOutput
with field(s):name(Option<String>)
:Returns the name of the blueprint that was deleted.
- On failure, responds with
SdkError<DeleteBlueprintError>
Source§impl Client
impl Client
Sourcepub fn delete_catalog(&self) -> DeleteCatalogFluentBuilder
pub fn delete_catalog(&self) -> DeleteCatalogFluentBuilder
Constructs a fluent builder for the DeleteCatalog
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe ID of the catalog.
- On success, responds with
DeleteCatalogOutput
- On failure, responds with
SdkError<DeleteCatalogError>
Source§impl Client
impl Client
Sourcepub fn delete_classifier(&self) -> DeleteClassifierFluentBuilder
pub fn delete_classifier(&self) -> DeleteClassifierFluentBuilder
Constructs a fluent builder for the DeleteClassifier
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the classifier to remove.
- On success, responds with
DeleteClassifierOutput
- On failure, responds with
SdkError<DeleteClassifierError>
Source§impl Client
impl Client
Sourcepub fn delete_column_statistics_for_partition(
&self,
) -> DeleteColumnStatisticsForPartitionFluentBuilder
pub fn delete_column_statistics_for_partition( &self, ) -> DeleteColumnStatisticsForPartitionFluentBuilder
Constructs a fluent builder for the DeleteColumnStatisticsForPartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
partition_values(impl Into<String>)
/set_partition_values(Option<Vec::<String>>)
:
required: trueA list of partition values identifying the partition.
column_name(impl Into<String>)
/set_column_name(Option<String>)
:
required: trueName of the column.
- On success, responds with
DeleteColumnStatisticsForPartitionOutput
- On failure, responds with
SdkError<DeleteColumnStatisticsForPartitionError>
Source§impl Client
impl Client
Sourcepub fn delete_column_statistics_for_table(
&self,
) -> DeleteColumnStatisticsForTableFluentBuilder
pub fn delete_column_statistics_for_table( &self, ) -> DeleteColumnStatisticsForTableFluentBuilder
Constructs a fluent builder for the DeleteColumnStatisticsForTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
column_name(impl Into<String>)
/set_column_name(Option<String>)
:
required: trueThe name of the column.
- On success, responds with
DeleteColumnStatisticsForTableOutput
- On failure, responds with
SdkError<DeleteColumnStatisticsForTableError>
Source§impl Client
impl Client
Sourcepub fn delete_column_statistics_task_settings(
&self,
) -> DeleteColumnStatisticsTaskSettingsFluentBuilder
pub fn delete_column_statistics_task_settings( &self, ) -> DeleteColumnStatisticsTaskSettingsFluentBuilder
Constructs a fluent builder for the DeleteColumnStatisticsTaskSettings
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table for which to delete column statistics.
- On success, responds with
DeleteColumnStatisticsTaskSettingsOutput
- On failure, responds with
SdkError<DeleteColumnStatisticsTaskSettingsError>
Source§impl Client
impl Client
Sourcepub fn delete_connection(&self) -> DeleteConnectionFluentBuilder
pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder
Constructs a fluent builder for the DeleteConnection
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
connection_name(impl Into<String>)
/set_connection_name(Option<String>)
:
required: trueThe name of the connection to delete.
- On success, responds with
DeleteConnectionOutput
- On failure, responds with
SdkError<DeleteConnectionError>
Source§impl Client
impl Client
Sourcepub fn delete_crawler(&self) -> DeleteCrawlerFluentBuilder
pub fn delete_crawler(&self) -> DeleteCrawlerFluentBuilder
Constructs a fluent builder for the DeleteCrawler
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the crawler to remove.
- On success, responds with
DeleteCrawlerOutput
- On failure, responds with
SdkError<DeleteCrawlerError>
Source§impl Client
impl Client
Sourcepub fn delete_custom_entity_type(&self) -> DeleteCustomEntityTypeFluentBuilder
pub fn delete_custom_entity_type(&self) -> DeleteCustomEntityTypeFluentBuilder
Constructs a fluent builder for the DeleteCustomEntityType
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the custom pattern that you want to delete.
- On success, responds with
DeleteCustomEntityTypeOutput
with field(s):name(Option<String>)
:The name of the custom pattern you deleted.
- On failure, responds with
SdkError<DeleteCustomEntityTypeError>
Source§impl Client
impl Client
Sourcepub fn delete_data_quality_ruleset(
&self,
) -> DeleteDataQualityRulesetFluentBuilder
pub fn delete_data_quality_ruleset( &self, ) -> DeleteDataQualityRulesetFluentBuilder
Constructs a fluent builder for the DeleteDataQualityRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA name for the data quality ruleset.
- On success, responds with
DeleteDataQualityRulesetOutput
- On failure, responds with
SdkError<DeleteDataQualityRulesetError>
Source§impl Client
impl Client
Sourcepub fn delete_database(&self) -> DeleteDatabaseFluentBuilder
pub fn delete_database(&self) -> DeleteDatabaseFluentBuilder
Constructs a fluent builder for the DeleteDatabase
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the database to delete. For Hive compatibility, this must be all lowercase.
- On success, responds with
DeleteDatabaseOutput
- On failure, responds with
SdkError<DeleteDatabaseError>
Source§impl Client
impl Client
Sourcepub fn delete_dev_endpoint(&self) -> DeleteDevEndpointFluentBuilder
pub fn delete_dev_endpoint(&self) -> DeleteDevEndpointFluentBuilder
Constructs a fluent builder for the DeleteDevEndpoint
operation.
- The fluent builder is configurable:
endpoint_name(impl Into<String>)
/set_endpoint_name(Option<String>)
:
required: trueThe name of the
DevEndpoint
.
- On success, responds with
DeleteDevEndpointOutput
- On failure, responds with
SdkError<DeleteDevEndpointError>
Source§impl Client
impl Client
Sourcepub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder
pub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder
Constructs a fluent builder for the DeleteIntegration
operation.
- The fluent builder is configurable:
integration_identifier(impl Into<String>)
/set_integration_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for the integration.
- On success, responds with
DeleteIntegrationOutput
with field(s):source_arn(String)
:The ARN of the source for the integration.
target_arn(String)
:The ARN of the target for the integration.
integration_name(String)
:A unique name for an integration in Glue.
description(Option<String>)
:A description of the integration.
integration_arn(String)
:The Amazon Resource Name (ARN) for the integration.
kms_key_id(Option<String>)
:The ARN of a KMS key used for encrypting the channel.
additional_encryption_context(Option<HashMap::<String, String>>)
:An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
tags(Option<Vec::<Tag>>)
:Metadata assigned to the resource consisting of a list of key-value pairs.
status(IntegrationStatus)
:The status of the integration being deleted.
The possible statuses are:
-
CREATING: The integration is being created.
-
ACTIVE: The integration creation succeeds.
-
MODIFYING: The integration is being modified.
-
FAILED: The integration creation fails.
-
DELETING: The integration is deleted.
-
SYNCING: The integration is synchronizing.
-
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
-
create_time(DateTime)
:The time when the integration was created, in UTC.
errors(Option<Vec::<IntegrationError>>)
:A list of errors associated with the integration.
data_filter(Option<String>)
:Selects source tables for the integration using Maxwell filter syntax.
- On failure, responds with
SdkError<DeleteIntegrationError>
Source§impl Client
impl Client
Sourcepub fn delete_integration_table_properties(
&self,
) -> DeleteIntegrationTablePropertiesFluentBuilder
pub fn delete_integration_table_properties( &self, ) -> DeleteIntegrationTablePropertiesFluentBuilder
Constructs a fluent builder for the DeleteIntegrationTableProperties
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe connection ARN of the source, or the database ARN of the target.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table to be replicated.
- On success, responds with
DeleteIntegrationTablePropertiesOutput
- On failure, responds with
SdkError<DeleteIntegrationTablePropertiesError>
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:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job definition to delete.
- On success, responds with
DeleteJobOutput
with field(s):job_name(Option<String>)
:The name of the job definition that was deleted.
- On failure, responds with
SdkError<DeleteJobError>
Source§impl Client
impl Client
Sourcepub fn delete_ml_transform(&self) -> DeleteMLTransformFluentBuilder
pub fn delete_ml_transform(&self) -> DeleteMLTransformFluentBuilder
Constructs a fluent builder for the DeleteMLTransform
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the transform to delete.
- On success, responds with
DeleteMlTransformOutput
with field(s):transform_id(Option<String>)
:The unique identifier of the transform that was deleted.
- On failure, responds with
SdkError<DeleteMLTransformError>
Source§impl Client
impl Client
Sourcepub fn delete_partition(&self) -> DeletePartitionFluentBuilder
pub fn delete_partition(&self) -> DeletePartitionFluentBuilder
Constructs a fluent builder for the DeletePartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database in which the table in question resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table that contains the partition to be deleted.
partition_values(impl Into<String>)
/set_partition_values(Option<Vec::<String>>)
:
required: trueThe values that define the partition.
- On success, responds with
DeletePartitionOutput
- On failure, responds with
SdkError<DeletePartitionError>
Source§impl Client
impl Client
Sourcepub fn delete_partition_index(&self) -> DeletePartitionIndexFluentBuilder
pub fn delete_partition_index(&self) -> DeletePartitionIndexFluentBuilder
Constructs a fluent builder for the DeletePartitionIndex
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe catalog ID where the table resides.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueSpecifies the name of a database from which you want to delete a partition index.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueSpecifies the name of a table from which you want to delete a partition index.
index_name(impl Into<String>)
/set_index_name(Option<String>)
:
required: trueThe name of the partition index to be deleted.
- On success, responds with
DeletePartitionIndexOutput
- On failure, responds with
SdkError<DeletePartitionIndexError>
Source§impl Client
impl Client
Sourcepub fn delete_registry(&self) -> DeleteRegistryFluentBuilder
pub fn delete_registry(&self) -> DeleteRegistryFluentBuilder
Constructs a fluent builder for the DeleteRegistry
operation.
- The fluent builder is configurable:
registry_id(RegistryId)
/set_registry_id(Option<RegistryId>)
:
required: trueThis is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
- On success, responds with
DeleteRegistryOutput
with field(s):registry_name(Option<String>)
:The name of the registry being deleted.
registry_arn(Option<String>)
:The Amazon Resource Name (ARN) of the registry being deleted.
status(Option<RegistryStatus>)
:The status of the registry. A successful operation will return the
Deleting
status.
- On failure, responds with
SdkError<DeleteRegistryError>
Source§impl Client
impl Client
Sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
Constructs a fluent builder for the DeleteResourcePolicy
operation.
- The fluent builder is configurable:
policy_hash_condition(impl Into<String>)
/set_policy_hash_condition(Option<String>)
:
required: falseThe hash value returned when this policy was set.
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: falseThe ARN of the Glue resource for the resource policy to be deleted.
- On success, responds with
DeleteResourcePolicyOutput
- On failure, responds with
SdkError<DeleteResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_schema(&self) -> DeleteSchemaFluentBuilder
pub fn delete_schema(&self) -> DeleteSchemaFluentBuilder
Constructs a fluent builder for the DeleteSchema
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
- On success, responds with
DeleteSchemaOutput
with field(s):schema_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schema being deleted.
schema_name(Option<String>)
:The name of the schema being deleted.
status(Option<SchemaStatus>)
:The status of the schema.
- On failure, responds with
SdkError<DeleteSchemaError>
Source§impl Client
impl Client
Sourcepub fn delete_schema_versions(&self) -> DeleteSchemaVersionsFluentBuilder
pub fn delete_schema_versions(&self) -> DeleteSchemaVersionsFluentBuilder
Constructs a fluent builder for the DeleteSchemaVersions
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
versions(impl Into<String>)
/set_versions(Option<String>)
:
required: trueA version range may be supplied which may be of the format:
-
a single version number, 5
-
a range, 5-8 : deletes versions 5, 6, 7, 8
-
- On success, responds with
DeleteSchemaVersionsOutput
with field(s):schema_version_errors(Option<Vec::<SchemaVersionErrorItem>>)
:A list of
SchemaVersionErrorItem
objects, each containing an error and schema version.
- On failure, responds with
SdkError<DeleteSchemaVersionsError>
Source§impl Client
impl Client
Sourcepub fn delete_security_configuration(
&self,
) -> DeleteSecurityConfigurationFluentBuilder
pub fn delete_security_configuration( &self, ) -> DeleteSecurityConfigurationFluentBuilder
Constructs a fluent builder for the DeleteSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the security configuration to delete.
- On success, responds with
DeleteSecurityConfigurationOutput
- On failure, responds with
SdkError<DeleteSecurityConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_session(&self) -> DeleteSessionFluentBuilder
pub fn delete_session(&self) -> DeleteSessionFluentBuilder
Constructs a fluent builder for the DeleteSession
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the session to be deleted.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe name of the origin of the delete session request.
- On success, responds with
DeleteSessionOutput
with field(s):id(Option<String>)
:Returns the ID of the deleted session.
- On failure, responds with
SdkError<DeleteSessionError>
Source§impl Client
impl Client
Sourcepub fn delete_table(&self) -> DeleteTableFluentBuilder
pub fn delete_table(&self) -> DeleteTableFluentBuilder
Constructs a fluent builder for the DeleteTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.
transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:
required: falseThe transaction ID at which to delete the table contents.
- On success, responds with
DeleteTableOutput
- On failure, responds with
SdkError<DeleteTableError>
Source§impl Client
impl Client
Sourcepub fn delete_table_optimizer(&self) -> DeleteTableOptimizerFluentBuilder
pub fn delete_table_optimizer(&self) -> DeleteTableOptimizerFluentBuilder
Constructs a fluent builder for the DeleteTableOptimizer
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe Catalog ID of the table.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database in the catalog in which the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table.
r#type(TableOptimizerType)
/set_type(Option<TableOptimizerType>)
:
required: trueThe type of table optimizer.
- On success, responds with
DeleteTableOptimizerOutput
- On failure, responds with
SdkError<DeleteTableOptimizerError>
Source§impl Client
impl Client
Sourcepub fn delete_table_version(&self) -> DeleteTableVersionFluentBuilder
pub fn delete_table_version(&self) -> DeleteTableVersionFluentBuilder
Constructs a fluent builder for the DeleteTableVersion
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table. For Hive compatibility, this name is entirely lowercase.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe ID of the table version to be deleted. A
VersionID
is a string representation of an integer. Each version is incremented by 1.
- On success, responds with
DeleteTableVersionOutput
- On failure, responds with
SdkError<DeleteTableVersionError>
Source§impl Client
impl Client
Sourcepub fn delete_trigger(&self) -> DeleteTriggerFluentBuilder
pub fn delete_trigger(&self) -> DeleteTriggerFluentBuilder
Constructs a fluent builder for the DeleteTrigger
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the trigger to delete.
- On success, responds with
DeleteTriggerOutput
with field(s):name(Option<String>)
:The name of the trigger that was deleted.
- On failure, responds with
SdkError<DeleteTriggerError>
Source§impl Client
impl Client
Sourcepub fn delete_usage_profile(&self) -> DeleteUsageProfileFluentBuilder
pub fn delete_usage_profile(&self) -> DeleteUsageProfileFluentBuilder
Constructs a fluent builder for the DeleteUsageProfile
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the usage profile to delete.
- On success, responds with
DeleteUsageProfileOutput
- On failure, responds with
SdkError<DeleteUsageProfileError>
Source§impl Client
impl Client
Sourcepub fn delete_user_defined_function(
&self,
) -> DeleteUserDefinedFunctionFluentBuilder
pub fn delete_user_defined_function( &self, ) -> DeleteUserDefinedFunctionFluentBuilder
Constructs a fluent builder for the DeleteUserDefinedFunction
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the function to be deleted is located. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the function is located.
function_name(impl Into<String>)
/set_function_name(Option<String>)
:
required: trueThe name of the function definition to be deleted.
- On success, responds with
DeleteUserDefinedFunctionOutput
- On failure, responds with
SdkError<DeleteUserDefinedFunctionError>
Source§impl Client
impl Client
Sourcepub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder
pub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder
Constructs a fluent builder for the DeleteWorkflow
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the workflow to be deleted.
- On success, responds with
DeleteWorkflowOutput
with field(s):name(Option<String>)
:Name of the workflow specified in input.
- On failure, responds with
SdkError<DeleteWorkflowError>
Source§impl Client
impl Client
Sourcepub fn describe_connection_type(&self) -> DescribeConnectionTypeFluentBuilder
pub fn describe_connection_type(&self) -> DescribeConnectionTypeFluentBuilder
Constructs a fluent builder for the DescribeConnectionType
operation.
- The fluent builder is configurable:
connection_type(impl Into<String>)
/set_connection_type(Option<String>)
:
required: trueThe name of the connection type to be described.
- On success, responds with
DescribeConnectionTypeOutput
with field(s):connection_type(Option<String>)
:The name of the connection type.
description(Option<String>)
:A description of the connection type.
capabilities(Option<Capabilities>)
:The supported authentication types, data interface types (compute environments), and data operations of the connector.
connection_properties(Option<HashMap::<String, Property>>)
:Connection properties which are common across compute environments.
connection_options(Option<HashMap::<String, Property>>)
:Returns properties that can be set when creating a connection in the
ConnectionInput.ConnectionProperties
.ConnectionOptions
defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.authentication_configuration(Option<AuthConfiguration>)
:The type of authentication used for the connection.
compute_environment_configurations(Option<HashMap::<String, ComputeEnvironmentConfiguration>>)
:The compute environments that are supported by the connection.
physical_connection_requirements(Option<HashMap::<String, Property>>)
:Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.
athena_connection_properties(Option<HashMap::<String, Property>>)
:Connection properties specific to the Athena compute environment.
python_connection_properties(Option<HashMap::<String, Property>>)
:Connection properties specific to the Python compute environment.
spark_connection_properties(Option<HashMap::<String, Property>>)
:Connection properties specific to the Spark compute environment.
- On failure, responds with
SdkError<DescribeConnectionTypeError>
Source§impl Client
impl Client
Sourcepub fn describe_entity(&self) -> DescribeEntityFluentBuilder
pub fn describe_entity(&self) -> DescribeEntityFluentBuilder
Constructs a fluent builder for the DescribeEntity
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
connection_name(impl Into<String>)
/set_connection_name(Option<String>)
:
required: trueThe name of the connection that contains the connection type credentials.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.
entity_name(impl Into<String>)
/set_entity_name(Option<String>)
:
required: trueThe name of the entity that you want to describe from the connection type.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, included if this is a continuation call.
data_store_api_version(impl Into<String>)
/set_data_store_api_version(Option<String>)
:
required: falseThe version of the API used for the data store.
- On success, responds with
DescribeEntityOutput
with field(s):fields(Option<Vec::<Field>>)
:Describes the fields for that connector entity. This is the list of
Field
objects.Field
is very similar to column in a database. TheField
object has information about different properties associated with fields in the connector.next_token(Option<String>)
:A continuation token, present if the current segment is not the last.
- On failure, responds with
SdkError<DescribeEntityError>
Source§impl Client
impl Client
Sourcepub fn describe_inbound_integrations(
&self,
) -> DescribeInboundIntegrationsFluentBuilder
pub fn describe_inbound_integrations( &self, ) -> DescribeInboundIntegrationsFluentBuilder
Constructs a fluent builder for the DescribeInboundIntegrations
operation.
- The fluent builder is configurable:
integration_arn(impl Into<String>)
/set_integration_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the integration.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseA token to specify where to start paginating. This is the marker from a previously truncated response.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe total number of items to return in the output.
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the target resource in the integration.
- On success, responds with
DescribeInboundIntegrationsOutput
with field(s):inbound_integrations(Option<Vec::<InboundIntegration>>)
:A list of inbound integrations.
marker(Option<String>)
:A value that indicates the starting point for the next set of response records in a subsequent request.
- On failure, responds with
SdkError<DescribeInboundIntegrationsError>
Source§impl Client
impl Client
Sourcepub fn describe_integrations(&self) -> DescribeIntegrationsFluentBuilder
pub fn describe_integrations(&self) -> DescribeIntegrationsFluentBuilder
Constructs a fluent builder for the DescribeIntegrations
operation.
- The fluent builder is configurable:
integration_identifier(impl Into<String>)
/set_integration_identifier(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) for the integration.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseA value that indicates the starting point for the next set of response records in a subsequent request.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe total number of items to return in the output.
filters(IntegrationFilter)
/set_filters(Option<Vec::<IntegrationFilter>>)
:
required: falseA list of key and values, to filter down the results. Supported keys are “Status”, “IntegrationName”, and “SourceArn”. IntegrationName is limited to only one value.
- On success, responds with
DescribeIntegrationsOutput
with field(s):integrations(Option<Vec::<Integration>>)
:A list of zero-ETL integrations.
marker(Option<String>)
:A value that indicates the starting point for the next set of response records in a subsequent request.
- On failure, responds with
SdkError<DescribeIntegrationsError>
Source§impl Client
impl Client
Sourcepub fn get_blueprint(&self) -> GetBlueprintFluentBuilder
pub fn get_blueprint(&self) -> GetBlueprintFluentBuilder
Constructs a fluent builder for the GetBlueprint
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the blueprint.
include_blueprint(bool)
/set_include_blueprint(Option<bool>)
:
required: falseSpecifies whether or not to include the blueprint in the response.
include_parameter_spec(bool)
/set_include_parameter_spec(Option<bool>)
:
required: falseSpecifies whether or not to include the parameter specification.
- On success, responds with
GetBlueprintOutput
with field(s):blueprint(Option<Blueprint>)
:Returns a
Blueprint
object.
- On failure, responds with
SdkError<GetBlueprintError>
Source§impl Client
impl Client
Sourcepub fn get_blueprint_run(&self) -> GetBlueprintRunFluentBuilder
pub fn get_blueprint_run(&self) -> GetBlueprintRunFluentBuilder
Constructs a fluent builder for the GetBlueprintRun
operation.
- The fluent builder is configurable:
blueprint_name(impl Into<String>)
/set_blueprint_name(Option<String>)
:
required: trueThe name of the blueprint.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe run ID for the blueprint run you want to retrieve.
- On success, responds with
GetBlueprintRunOutput
with field(s):blueprint_run(Option<BlueprintRun>)
:Returns a
BlueprintRun
object.
- On failure, responds with
SdkError<GetBlueprintRunError>
Source§impl Client
impl Client
Sourcepub fn get_blueprint_runs(&self) -> GetBlueprintRunsFluentBuilder
pub fn get_blueprint_runs(&self) -> GetBlueprintRunsFluentBuilder
Constructs a fluent builder for the GetBlueprintRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
blueprint_name(impl Into<String>)
/set_blueprint_name(Option<String>)
:
required: trueThe name of the blueprint.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
- On success, responds with
GetBlueprintRunsOutput
with field(s):blueprint_runs(Option<Vec::<BlueprintRun>>)
:Returns a list of
BlueprintRun
objects.next_token(Option<String>)
:A continuation token, if not all blueprint runs have been returned.
- On failure, responds with
SdkError<GetBlueprintRunsError>
Source§impl Client
impl Client
Sourcepub fn get_catalog(&self) -> GetCatalogFluentBuilder
pub fn get_catalog(&self) -> GetCatalogFluentBuilder
Constructs a fluent builder for the GetCatalog
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
- On success, responds with
GetCatalogOutput
with field(s):catalog(Option<Catalog>)
:A
Catalog
object. The definition of the specified catalog in the Glue Data Catalog.
- On failure, responds with
SdkError<GetCatalogError>
Source§impl Client
impl Client
Sourcepub fn get_catalog_import_status(&self) -> GetCatalogImportStatusFluentBuilder
pub fn get_catalog_import_status(&self) -> GetCatalogImportStatusFluentBuilder
Constructs a fluent builder for the GetCatalogImportStatus
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
- On success, responds with
GetCatalogImportStatusOutput
with field(s):import_status(Option<CatalogImportStatus>)
:The status of the specified catalog migration.
- On failure, responds with
SdkError<GetCatalogImportStatusError>
Source§impl Client
impl Client
Sourcepub fn get_catalogs(&self) -> GetCatalogsFluentBuilder
pub fn get_catalogs(&self) -> GetCatalogsFluentBuilder
Constructs a fluent builder for the GetCatalogs
operation.
- The fluent builder is configurable:
parent_catalog_id(impl Into<String>)
/set_parent_catalog_id(Option<String>)
:
required: falseThe ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of catalogs to return in one response.
recursive(bool)
/set_recursive(Option<bool>)
:
required: falseWhether to list all catalogs across the catalog hierarchy, starting from the
ParentCatalogId
. Defaults tofalse
. Whentrue
, all catalog objects in theParentCatalogID
hierarchy are enumerated in the response.include_root(bool)
/set_include_root(Option<bool>)
:
required: falseWhether to list the default catalog in the account and region in the response. Defaults to
false
. Whentrue
andParentCatalogId = NULL | Amazon Web Services Account ID
, all catalogs and the default catalog are enumerated in the response.When the
ParentCatalogId
is not equal to null, and this attribute is passed asfalse
ortrue
, anInvalidInputException
is thrown.
- On success, responds with
GetCatalogsOutput
with field(s):catalog_list(Vec::<Catalog>)
:An array of
Catalog
objects. A list ofCatalog
objects from the specified parent catalog.next_token(Option<String>)
:A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- On failure, responds with
SdkError<GetCatalogsError>
Source§impl Client
impl Client
Sourcepub fn get_classifier(&self) -> GetClassifierFluentBuilder
pub fn get_classifier(&self) -> GetClassifierFluentBuilder
Constructs a fluent builder for the GetClassifier
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the classifier to retrieve.
- On success, responds with
GetClassifierOutput
with field(s):classifier(Option<Classifier>)
:The requested classifier.
- On failure, responds with
SdkError<GetClassifierError>
Source§impl Client
impl Client
Sourcepub fn get_classifiers(&self) -> GetClassifiersFluentBuilder
pub fn get_classifiers(&self) -> GetClassifiersFluentBuilder
Constructs a fluent builder for the GetClassifiers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe size of the list to return (optional).
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn optional continuation token.
- On success, responds with
GetClassifiersOutput
with field(s):classifiers(Option<Vec::<Classifier>>)
:The requested list of classifier objects.
next_token(Option<String>)
:A continuation token.
- On failure, responds with
SdkError<GetClassifiersError>
Source§impl Client
impl Client
Sourcepub fn get_column_statistics_for_partition(
&self,
) -> GetColumnStatisticsForPartitionFluentBuilder
pub fn get_column_statistics_for_partition( &self, ) -> GetColumnStatisticsForPartitionFluentBuilder
Constructs a fluent builder for the GetColumnStatisticsForPartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
partition_values(impl Into<String>)
/set_partition_values(Option<Vec::<String>>)
:
required: trueA list of partition values identifying the partition.
column_names(impl Into<String>)
/set_column_names(Option<Vec::<String>>)
:
required: trueA list of the column names.
- On success, responds with
GetColumnStatisticsForPartitionOutput
with field(s):column_statistics_list(Option<Vec::<ColumnStatistics>>)
:List of ColumnStatistics that failed to be retrieved.
errors(Option<Vec::<ColumnError>>)
:Error occurred during retrieving column statistics data.
- On failure, responds with
SdkError<GetColumnStatisticsForPartitionError>
Source§impl Client
impl Client
Sourcepub fn get_column_statistics_for_table(
&self,
) -> GetColumnStatisticsForTableFluentBuilder
pub fn get_column_statistics_for_table( &self, ) -> GetColumnStatisticsForTableFluentBuilder
Constructs a fluent builder for the GetColumnStatisticsForTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
column_names(impl Into<String>)
/set_column_names(Option<Vec::<String>>)
:
required: trueA list of the column names.
- On success, responds with
GetColumnStatisticsForTableOutput
with field(s):column_statistics_list(Option<Vec::<ColumnStatistics>>)
:List of ColumnStatistics.
errors(Option<Vec::<ColumnError>>)
:List of ColumnStatistics that failed to be retrieved.
- On failure, responds with
SdkError<GetColumnStatisticsForTableError>
Source§impl Client
impl Client
Sourcepub fn get_column_statistics_task_run(
&self,
) -> GetColumnStatisticsTaskRunFluentBuilder
pub fn get_column_statistics_task_run( &self, ) -> GetColumnStatisticsTaskRunFluentBuilder
Constructs a fluent builder for the GetColumnStatisticsTaskRun
operation.
- The fluent builder is configurable:
column_statistics_task_run_id(impl Into<String>)
/set_column_statistics_task_run_id(Option<String>)
:
required: trueThe identifier for the particular column statistics task run.
- On success, responds with
GetColumnStatisticsTaskRunOutput
with field(s):column_statistics_task_run(Option<ColumnStatisticsTaskRun>)
:A
ColumnStatisticsTaskRun
object representing the details of the column stats run.
- On failure, responds with
SdkError<GetColumnStatisticsTaskRunError>
Source§impl Client
impl Client
Sourcepub fn get_column_statistics_task_runs(
&self,
) -> GetColumnStatisticsTaskRunsFluentBuilder
pub fn get_column_statistics_task_runs( &self, ) -> GetColumnStatisticsTaskRunsFluentBuilder
Constructs a fluent builder for the GetColumnStatisticsTaskRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
GetColumnStatisticsTaskRunsOutput
with field(s):column_statistics_task_runs(Option<Vec::<ColumnStatisticsTaskRun>>)
:A list of column statistics task runs.
next_token(Option<String>)
:A continuation token, if not all task runs have yet been returned.
- On failure, responds with
SdkError<GetColumnStatisticsTaskRunsError>
Source§impl Client
impl Client
Sourcepub fn get_column_statistics_task_settings(
&self,
) -> GetColumnStatisticsTaskSettingsFluentBuilder
pub fn get_column_statistics_task_settings( &self, ) -> GetColumnStatisticsTaskSettingsFluentBuilder
Constructs a fluent builder for the GetColumnStatisticsTaskSettings
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table for which to retrieve column statistics.
- On success, responds with
GetColumnStatisticsTaskSettingsOutput
with field(s):column_statistics_task_settings(Option<ColumnStatisticsTaskSettings>)
:A
ColumnStatisticsTaskSettings
object representing the settings for the column statistics task.
- On failure, responds with
SdkError<GetColumnStatisticsTaskSettingsError>
Source§impl Client
impl Client
Sourcepub fn get_connection(&self) -> GetConnectionFluentBuilder
pub fn get_connection(&self) -> GetConnectionFluentBuilder
Constructs a fluent builder for the GetConnection
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the connection definition to retrieve.
hide_password(bool)
/set_hide_password(Option<bool>)
:
required: falseAllows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
apply_override_for_compute_environment(ComputeEnvironment)
/set_apply_override_for_compute_environment(Option<ComputeEnvironment>)
:
required: falseFor connections that may be used in multiple services, specifies returning properties for the specified compute environment.
- On success, responds with
GetConnectionOutput
with field(s):connection(Option<Connection>)
:The requested connection definition.
- On failure, responds with
SdkError<GetConnectionError>
Source§impl Client
impl Client
Sourcepub fn get_connections(&self) -> GetConnectionsFluentBuilder
pub fn get_connections(&self) -> GetConnectionsFluentBuilder
Constructs a fluent builder for the GetConnections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
filter(GetConnectionsFilter)
/set_filter(Option<GetConnectionsFilter>)
:
required: falseA filter that controls which connections are returned.
hide_password(bool)
/set_hide_password(Option<bool>)
:
required: falseAllows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of connections to return in one response.
- On success, responds with
GetConnectionsOutput
with field(s):connection_list(Option<Vec::<Connection>>)
:A list of requested connection definitions.
next_token(Option<String>)
:A continuation token, if the list of connections returned does not include the last of the filtered connections.
- On failure, responds with
SdkError<GetConnectionsError>
Source§impl Client
impl Client
Sourcepub fn get_crawler(&self) -> GetCrawlerFluentBuilder
pub fn get_crawler(&self) -> GetCrawlerFluentBuilder
Constructs a fluent builder for the GetCrawler
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the crawler to retrieve metadata for.
- On success, responds with
GetCrawlerOutput
with field(s):crawler(Option<Crawler>)
:The metadata for the specified crawler.
- On failure, responds with
SdkError<GetCrawlerError>
Source§impl Client
impl Client
Sourcepub fn get_crawler_metrics(&self) -> GetCrawlerMetricsFluentBuilder
pub fn get_crawler_metrics(&self) -> GetCrawlerMetricsFluentBuilder
Constructs a fluent builder for the GetCrawlerMetrics
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
crawler_name_list(impl Into<String>)
/set_crawler_name_list(Option<Vec::<String>>)
:
required: falseA list of the names of crawlers about which to retrieve metrics.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
GetCrawlerMetricsOutput
with field(s):crawler_metrics_list(Option<Vec::<CrawlerMetrics>>)
:A list of metrics for the specified crawler.
next_token(Option<String>)
:A continuation token, if the returned list does not contain the last metric available.
- On failure, responds with
SdkError<GetCrawlerMetricsError>
Source§impl Client
impl Client
Sourcepub fn get_crawlers(&self) -> GetCrawlersFluentBuilder
pub fn get_crawlers(&self) -> GetCrawlersFluentBuilder
Constructs a fluent builder for the GetCrawlers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe number of crawlers to return on each call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
- On success, responds with
GetCrawlersOutput
with field(s):crawlers(Option<Vec::<Crawler>>)
:A list of crawler metadata.
next_token(Option<String>)
:A continuation token, if the returned list has not reached the end of those defined in this customer account.
- On failure, responds with
SdkError<GetCrawlersError>
Source§impl Client
impl Client
Sourcepub fn get_custom_entity_type(&self) -> GetCustomEntityTypeFluentBuilder
pub fn get_custom_entity_type(&self) -> GetCustomEntityTypeFluentBuilder
Constructs a fluent builder for the GetCustomEntityType
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the custom pattern that you want to retrieve.
- On success, responds with
GetCustomEntityTypeOutput
with field(s):name(Option<String>)
:The name of the custom pattern that you retrieved.
regex_string(Option<String>)
:A regular expression string that is used for detecting sensitive data in a custom pattern.
context_words(Option<Vec::<String>>)
:A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
- On failure, responds with
SdkError<GetCustomEntityTypeError>
Source§impl Client
impl Client
Sourcepub fn get_data_catalog_encryption_settings(
&self,
) -> GetDataCatalogEncryptionSettingsFluentBuilder
pub fn get_data_catalog_encryption_settings( &self, ) -> GetDataCatalogEncryptionSettingsFluentBuilder
Constructs a fluent builder for the GetDataCatalogEncryptionSettings
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
- On success, responds with
GetDataCatalogEncryptionSettingsOutput
with field(s):data_catalog_encryption_settings(Option<DataCatalogEncryptionSettings>)
:The requested security configuration.
- On failure, responds with
SdkError<GetDataCatalogEncryptionSettingsError>
Source§impl Client
impl Client
Sourcepub fn get_data_quality_model(&self) -> GetDataQualityModelFluentBuilder
pub fn get_data_quality_model(&self) -> GetDataQualityModelFluentBuilder
Constructs a fluent builder for the GetDataQualityModel
operation.
- The fluent builder is configurable:
statistic_id(impl Into<String>)
/set_statistic_id(Option<String>)
:
required: falseThe Statistic ID.
profile_id(impl Into<String>)
/set_profile_id(Option<String>)
:
required: trueThe Profile ID.
- On success, responds with
GetDataQualityModelOutput
with field(s):status(Option<DataQualityModelStatus>)
:The training status of the data quality model.
started_on(Option<DateTime>)
:The timestamp when the data quality model training started.
completed_on(Option<DateTime>)
:The timestamp when the data quality model training completed.
failure_reason(Option<String>)
:The training failure reason.
- On failure, responds with
SdkError<GetDataQualityModelError>
Source§impl Client
impl Client
Sourcepub fn get_data_quality_model_result(
&self,
) -> GetDataQualityModelResultFluentBuilder
pub fn get_data_quality_model_result( &self, ) -> GetDataQualityModelResultFluentBuilder
Constructs a fluent builder for the GetDataQualityModelResult
operation.
- The fluent builder is configurable:
statistic_id(impl Into<String>)
/set_statistic_id(Option<String>)
:
required: trueThe Statistic ID.
profile_id(impl Into<String>)
/set_profile_id(Option<String>)
:
required: trueThe Profile ID.
- On success, responds with
GetDataQualityModelResultOutput
with field(s):completed_on(Option<DateTime>)
:The timestamp when the data quality model training completed.
model(Option<Vec::<StatisticModelResult>>)
:A list of
StatisticModelResult
- On failure, responds with
SdkError<GetDataQualityModelResultError>
Source§impl Client
impl Client
Sourcepub fn get_data_quality_result(&self) -> GetDataQualityResultFluentBuilder
pub fn get_data_quality_result(&self) -> GetDataQualityResultFluentBuilder
Constructs a fluent builder for the GetDataQualityResult
operation.
- The fluent builder is configurable:
result_id(impl Into<String>)
/set_result_id(Option<String>)
:
required: trueA unique result ID for the data quality result.
- On success, responds with
GetDataQualityResultOutput
with field(s):result_id(Option<String>)
:A unique result ID for the data quality result.
profile_id(Option<String>)
:The Profile ID for the data quality result.
score(Option<f64>)
:An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
data_source(Option<DataSource>)
:The table associated with the data quality result, if any.
ruleset_name(Option<String>)
:The name of the ruleset associated with the data quality result.
evaluation_context(Option<String>)
:In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the
evaluationContext
can differentiate the nodes.started_on(Option<DateTime>)
:The date and time when the run for this data quality result started.
completed_on(Option<DateTime>)
:The date and time when the run for this data quality result was completed.
job_name(Option<String>)
:The job name associated with the data quality result, if any.
job_run_id(Option<String>)
:The job run ID associated with the data quality result, if any.
ruleset_evaluation_run_id(Option<String>)
:The unique run ID associated with the ruleset evaluation.
rule_results(Option<Vec::<DataQualityRuleResult>>)
:A list of
DataQualityRuleResult
objects representing the results for each rule.analyzer_results(Option<Vec::<DataQualityAnalyzerResult>>)
:A list of
DataQualityAnalyzerResult
objects representing the results for each analyzer.observations(Option<Vec::<DataQualityObservation>>)
:A list of
DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.
- On failure, responds with
SdkError<GetDataQualityResultError>
Source§impl Client
impl Client
Sourcepub fn get_data_quality_rule_recommendation_run(
&self,
) -> GetDataQualityRuleRecommendationRunFluentBuilder
pub fn get_data_quality_rule_recommendation_run( &self, ) -> GetDataQualityRuleRecommendationRunFluentBuilder
Constructs a fluent builder for the GetDataQualityRuleRecommendationRun
operation.
- The fluent builder is configurable:
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe unique run identifier associated with this run.
- On success, responds with
GetDataQualityRuleRecommendationRunOutput
with field(s):run_id(Option<String>)
:The unique run identifier associated with this run.
data_source(Option<DataSource>)
:The data source (an Glue table) associated with this run.
role(Option<String>)
:An IAM role supplied to encrypt the results of the run.
number_of_workers(Option<i32>)
:The number of
G.1X
workers to be used in the run. The default is 5.timeout(Option<i32>)
:The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).status(Option<TaskStatusType>)
:The status for this run.
error_string(Option<String>)
:The error strings that are associated with the run.
started_on(Option<DateTime>)
:The date and time when this run started.
last_modified_on(Option<DateTime>)
:A timestamp. The last point in time when this data quality rule recommendation run was modified.
completed_on(Option<DateTime>)
:The date and time when this run was completed.
execution_time(i32)
:The amount of time (in seconds) that the run consumed resources.
recommended_ruleset(Option<String>)
:When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
created_ruleset_name(Option<String>)
:The name of the ruleset that was created by the run.
data_quality_security_configuration(Option<String>)
:The name of the security configuration created with the data quality encryption option.
- On failure, responds with
SdkError<GetDataQualityRuleRecommendationRunError>
Source§impl Client
impl Client
Sourcepub fn get_data_quality_ruleset(&self) -> GetDataQualityRulesetFluentBuilder
pub fn get_data_quality_ruleset(&self) -> GetDataQualityRulesetFluentBuilder
Constructs a fluent builder for the GetDataQualityRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the ruleset.
- On success, responds with
GetDataQualityRulesetOutput
with field(s):name(Option<String>)
:The name of the ruleset.
description(Option<String>)
:A description of the ruleset.
ruleset(Option<String>)
:A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
target_table(Option<DataQualityTargetTable>)
:The name and database name of the target table.
created_on(Option<DateTime>)
:A timestamp. The time and date that this data quality ruleset was created.
last_modified_on(Option<DateTime>)
:A timestamp. The last point in time when this data quality ruleset was modified.
recommendation_run_id(Option<String>)
:When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
data_quality_security_configuration(Option<String>)
:The name of the security configuration created with the data quality encryption option.
- On failure, responds with
SdkError<GetDataQualityRulesetError>
Source§impl Client
impl Client
Sourcepub fn get_data_quality_ruleset_evaluation_run(
&self,
) -> GetDataQualityRulesetEvaluationRunFluentBuilder
pub fn get_data_quality_ruleset_evaluation_run( &self, ) -> GetDataQualityRulesetEvaluationRunFluentBuilder
Constructs a fluent builder for the GetDataQualityRulesetEvaluationRun
operation.
- The fluent builder is configurable:
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe unique run identifier associated with this run.
- On success, responds with
GetDataQualityRulesetEvaluationRunOutput
with field(s):run_id(Option<String>)
:The unique run identifier associated with this run.
data_source(Option<DataSource>)
:The data source (an Glue table) associated with this evaluation run.
role(Option<String>)
:An IAM role supplied to encrypt the results of the run.
number_of_workers(Option<i32>)
:The number of
G.1X
workers to be used in the run. The default is 5.timeout(Option<i32>)
:The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).additional_run_options(Option<DataQualityEvaluationRunAdditionalRunOptions>)
:Additional run options you can specify for an evaluation run.
status(Option<TaskStatusType>)
:The status for this run.
error_string(Option<String>)
:The error strings that are associated with the run.
started_on(Option<DateTime>)
:The date and time when this run started.
last_modified_on(Option<DateTime>)
:A timestamp. The last point in time when this data quality rule recommendation run was modified.
completed_on(Option<DateTime>)
:The date and time when this run was completed.
execution_time(i32)
:The amount of time (in seconds) that the run consumed resources.
ruleset_names(Option<Vec::<String>>)
:A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.
result_ids(Option<Vec::<String>>)
:A list of result IDs for the data quality results for the run.
additional_data_sources(Option<HashMap::<String, DataSource>>)
:A map of reference strings to additional data sources you can specify for an evaluation run.
- On failure, responds with
SdkError<GetDataQualityRulesetEvaluationRunError>
Source§impl Client
impl Client
Sourcepub fn get_database(&self) -> GetDatabaseFluentBuilder
pub fn get_database(&self) -> GetDatabaseFluentBuilder
Constructs a fluent builder for the GetDatabase
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the database to retrieve. For Hive compatibility, this should be all lowercase.
- On success, responds with
GetDatabaseOutput
with field(s):database(Option<Database>)
:The definition of the specified database in the Data Catalog.
- On failure, responds with
SdkError<GetDatabaseError>
Source§impl Client
impl Client
Sourcepub fn get_databases(&self) -> GetDatabasesFluentBuilder
pub fn get_databases(&self) -> GetDatabasesFluentBuilder
Constructs a fluent builder for the GetDatabases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog from which to retrieve
Databases
. If none is provided, the Amazon Web Services account ID is used by default.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of databases to return in one response.
resource_share_type(ResourceShareType)
/set_resource_share_type(Option<ResourceShareType>)
:
required: falseAllows you to specify that you want to list the databases shared with your account. The allowable values are
FEDERATED
,FOREIGN
orALL
.-
If set to
FEDERATED
, will list the federated databases (referencing an external entity) shared with your account. -
If set to
FOREIGN
, will list the databases shared with your account. -
If set to
ALL
, will list the databases shared with your account, as well as the databases in yor local account.
-
attributes_to_get(DatabaseAttributes)
/set_attributes_to_get(Option<Vec::<DatabaseAttributes>>)
:
required: falseSpecifies the database fields returned by the
GetDatabases
call. This parameter doesn’t accept an empty list. The request must include theNAME
.
- On success, responds with
GetDatabasesOutput
with field(s):database_list(Vec::<Database>)
:A list of
Database
objects from the specified catalog.next_token(Option<String>)
:A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- On failure, responds with
SdkError<GetDatabasesError>
Source§impl Client
impl Client
Sourcepub fn get_dataflow_graph(&self) -> GetDataflowGraphFluentBuilder
pub fn get_dataflow_graph(&self) -> GetDataflowGraphFluentBuilder
Constructs a fluent builder for the GetDataflowGraph
operation.
- The fluent builder is configurable:
python_script(impl Into<String>)
/set_python_script(Option<String>)
:
required: falseThe Python script to transform.
- On success, responds with
GetDataflowGraphOutput
with field(s):dag_nodes(Option<Vec::<CodeGenNode>>)
:A list of the nodes in the resulting DAG.
dag_edges(Option<Vec::<CodeGenEdge>>)
:A list of the edges in the resulting DAG.
- On failure, responds with
SdkError<GetDataflowGraphError>
Source§impl Client
impl Client
Sourcepub fn get_dev_endpoint(&self) -> GetDevEndpointFluentBuilder
pub fn get_dev_endpoint(&self) -> GetDevEndpointFluentBuilder
Constructs a fluent builder for the GetDevEndpoint
operation.
- The fluent builder is configurable:
endpoint_name(impl Into<String>)
/set_endpoint_name(Option<String>)
:
required: trueName of the
DevEndpoint
to retrieve information for.
- On success, responds with
GetDevEndpointOutput
with field(s):dev_endpoint(Option<DevEndpoint>)
:A
DevEndpoint
definition.
- On failure, responds with
SdkError<GetDevEndpointError>
Source§impl Client
impl Client
Sourcepub fn get_dev_endpoints(&self) -> GetDevEndpointsFluentBuilder
pub fn get_dev_endpoints(&self) -> GetDevEndpointsFluentBuilder
Constructs a fluent builder for the GetDevEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of information to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
GetDevEndpointsOutput
with field(s):dev_endpoints(Option<Vec::<DevEndpoint>>)
:A list of
DevEndpoint
definitions.next_token(Option<String>)
:A continuation token, if not all
DevEndpoint
definitions have yet been returned.
- On failure, responds with
SdkError<GetDevEndpointsError>
Source§impl Client
impl Client
Sourcepub fn get_entity_records(&self) -> GetEntityRecordsFluentBuilder
pub fn get_entity_records(&self) -> GetEntityRecordsFluentBuilder
Constructs a fluent builder for the GetEntityRecords
operation.
- The fluent builder is configurable:
connection_name(impl Into<String>)
/set_connection_name(Option<String>)
:
required: falseThe name of the connection that contains the connection type credentials.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.
entity_name(impl Into<String>)
/set_entity_name(Option<String>)
:
required: trueName of the entity that we want to query the preview data from the given connection type.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, included if this is a continuation call.
data_store_api_version(impl Into<String>)
/set_data_store_api_version(Option<String>)
:
required: falseThe API version of the SaaS connector.
connection_options(impl Into<String>, impl Into<String>)
/set_connection_options(Option<HashMap::<String, String>>)
:
required: falseConnector options that are required to query the data.
filter_predicate(impl Into<String>)
/set_filter_predicate(Option<String>)
:
required: falseA filter predicate that you can apply in the query request.
limit(i64)
/set_limit(Option<i64>)
:
required: trueLimits the number of records fetched with the request.
order_by(impl Into<String>)
/set_order_by(Option<String>)
:
required: falseA parameter that orders the response preview data.
selected_fields(impl Into<String>)
/set_selected_fields(Option<Vec::<String>>)
:
required: falseList of fields that we want to fetch as part of preview data.
- On success, responds with
GetEntityRecordsOutput
with field(s):records(Option<Vec::<Document>>)
:A list of the requested objects.
next_token(Option<String>)
:A continuation token, present if the current segment is not the last.
- On failure, responds with
SdkError<GetEntityRecordsError>
Source§impl Client
impl Client
Sourcepub fn get_integration_resource_property(
&self,
) -> GetIntegrationResourcePropertyFluentBuilder
pub fn get_integration_resource_property( &self, ) -> GetIntegrationResourcePropertyFluentBuilder
Constructs a fluent builder for the GetIntegrationResourceProperty
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe connection ARN of the source, or the database ARN of the target.
- On success, responds with
GetIntegrationResourcePropertyOutput
with field(s):resource_arn(Option<String>)
:The connection ARN of the source, or the database ARN of the target.
source_processing_properties(Option<SourceProcessingProperties>)
:The resource properties associated with the integration source.
target_processing_properties(Option<TargetProcessingProperties>)
:The resource properties associated with the integration target.
- On failure, responds with
SdkError<GetIntegrationResourcePropertyError>
Source§impl Client
impl Client
Sourcepub fn get_integration_table_properties(
&self,
) -> GetIntegrationTablePropertiesFluentBuilder
pub fn get_integration_table_properties( &self, ) -> GetIntegrationTablePropertiesFluentBuilder
Constructs a fluent builder for the GetIntegrationTableProperties
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe connection ARN of the source, or the database ARN of the target.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table to be replicated.
- On success, responds with
GetIntegrationTablePropertiesOutput
with field(s):resource_arn(Option<String>)
:The connection ARN of the source, or the database ARN of the target.
table_name(Option<String>)
:The name of the table to be replicated.
source_table_config(Option<SourceTableConfig>)
:A structure for the source table configuration.
target_table_config(Option<TargetTableConfig>)
:A structure for the target table configuration.
- On failure, responds with
SdkError<GetIntegrationTablePropertiesError>
Source§impl Client
impl Client
Sourcepub fn get_job(&self) -> GetJobFluentBuilder
pub fn get_job(&self) -> GetJobFluentBuilder
Constructs a fluent builder for the GetJob
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job definition to retrieve.
- On success, responds with
GetJobOutput
with field(s):job(Option<Job>)
:The requested job definition.
- On failure, responds with
SdkError<GetJobError>
Source§impl Client
impl Client
Sourcepub fn get_job_bookmark(&self) -> GetJobBookmarkFluentBuilder
pub fn get_job_bookmark(&self) -> GetJobBookmarkFluentBuilder
Constructs a fluent builder for the GetJobBookmark
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job in question.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: falseThe unique run identifier associated with this job run.
- On success, responds with
GetJobBookmarkOutput
with field(s):job_bookmark_entry(Option<JobBookmarkEntry>)
:A structure that defines a point that a job can resume processing.
- On failure, responds with
SdkError<GetJobBookmarkError>
Source§impl Client
impl Client
Sourcepub fn get_job_run(&self) -> GetJobRunFluentBuilder
pub fn get_job_run(&self) -> GetJobRunFluentBuilder
Constructs a fluent builder for the GetJobRun
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueName of the job definition being run.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe ID of the job run.
predecessors_included(bool)
/set_predecessors_included(Option<bool>)
:
required: falseTrue if a list of predecessor runs should be returned.
- On success, responds with
GetJobRunOutput
with field(s):job_run(Option<JobRun>)
:The requested job-run metadata.
- On failure, responds with
SdkError<GetJobRunError>
Source§impl Client
impl Client
Sourcepub fn get_job_runs(&self) -> GetJobRunsFluentBuilder
pub fn get_job_runs(&self) -> GetJobRunsFluentBuilder
Constructs a fluent builder for the GetJobRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job definition for which to retrieve all job runs.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the response.
- On success, responds with
GetJobRunsOutput
with field(s):job_runs(Option<Vec::<JobRun>>)
:A list of job-run metadata objects.
next_token(Option<String>)
:A continuation token, if not all requested job runs have been returned.
- On failure, responds with
SdkError<GetJobRunsError>
Source§impl Client
impl Client
Sourcepub fn get_jobs(&self) -> GetJobsFluentBuilder
pub fn get_jobs(&self) -> GetJobsFluentBuilder
Constructs a fluent builder for the GetJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the response.
- On success, responds with
GetJobsOutput
with field(s):jobs(Option<Vec::<Job>>)
:A list of job definitions.
next_token(Option<String>)
:A continuation token, if not all job definitions have yet been returned.
- On failure, responds with
SdkError<GetJobsError>
Source§impl Client
impl Client
Sourcepub fn get_mapping(&self) -> GetMappingFluentBuilder
pub fn get_mapping(&self) -> GetMappingFluentBuilder
Constructs a fluent builder for the GetMapping
operation.
- The fluent builder is configurable:
source(CatalogEntry)
/set_source(Option<CatalogEntry>)
:
required: trueSpecifies the source table.
sinks(CatalogEntry)
/set_sinks(Option<Vec::<CatalogEntry>>)
:
required: falseA list of target tables.
location(Location)
/set_location(Option<Location>)
:
required: falseParameters for the mapping.
- On success, responds with
GetMappingOutput
with field(s):mapping(Vec::<MappingEntry>)
:A list of mappings to the specified targets.
- On failure, responds with
SdkError<GetMappingError>
Source§impl Client
impl Client
Sourcepub fn get_ml_task_run(&self) -> GetMLTaskRunFluentBuilder
pub fn get_ml_task_run(&self) -> GetMLTaskRunFluentBuilder
Constructs a fluent builder for the GetMLTaskRun
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the machine learning transform.
task_run_id(impl Into<String>)
/set_task_run_id(Option<String>)
:
required: trueThe unique identifier of the task run.
- On success, responds with
GetMlTaskRunOutput
with field(s):transform_id(Option<String>)
:The unique identifier of the task run.
task_run_id(Option<String>)
:The unique run identifier associated with this run.
status(Option<TaskStatusType>)
:The status for this task run.
log_group_name(Option<String>)
:The names of the log groups that are associated with the task run.
properties(Option<TaskRunProperties>)
:The list of properties that are associated with the task run.
error_string(Option<String>)
:The error strings that are associated with the task run.
started_on(Option<DateTime>)
:The date and time when this task run started.
last_modified_on(Option<DateTime>)
:The date and time when this task run was last modified.
completed_on(Option<DateTime>)
:The date and time when this task run was completed.
execution_time(i32)
:The amount of time (in seconds) that the task run consumed resources.
- On failure, responds with
SdkError<GetMLTaskRunError>
Source§impl Client
impl Client
Sourcepub fn get_ml_task_runs(&self) -> GetMLTaskRunsFluentBuilder
pub fn get_ml_task_runs(&self) -> GetMLTaskRunsFluentBuilder
Constructs a fluent builder for the GetMLTaskRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the machine learning transform.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token for pagination of the results. The default is empty.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
filter(TaskRunFilterCriteria)
/set_filter(Option<TaskRunFilterCriteria>)
:
required: falseThe filter criteria, in the
TaskRunFilterCriteria
structure, for the task run.sort(TaskRunSortCriteria)
/set_sort(Option<TaskRunSortCriteria>)
:
required: falseThe sorting criteria, in the
TaskRunSortCriteria
structure, for the task run.
- On success, responds with
GetMlTaskRunsOutput
with field(s):task_runs(Option<Vec::<TaskRun>>)
:A list of task runs that are associated with the transform.
next_token(Option<String>)
:A pagination token, if more results are available.
- On failure, responds with
SdkError<GetMLTaskRunsError>
Source§impl Client
impl Client
Sourcepub fn get_ml_transform(&self) -> GetMLTransformFluentBuilder
pub fn get_ml_transform(&self) -> GetMLTransformFluentBuilder
Constructs a fluent builder for the GetMLTransform
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the transform, generated at the time that the transform was created.
- On success, responds with
GetMlTransformOutput
with field(s):transform_id(Option<String>)
:The unique identifier of the transform, generated at the time that the transform was created.
name(Option<String>)
:The unique name given to the transform when it was created.
description(Option<String>)
:A description of the transform.
status(Option<TransformStatusType>)
:The last known status of the transform (to indicate whether it can be used or not). One of “NOT_READY”, “READY”, or “DELETING”.
created_on(Option<DateTime>)
:The date and time when the transform was created.
last_modified_on(Option<DateTime>)
:The date and time when the transform was last modified.
input_record_tables(Option<Vec::<GlueTable>>)
:A list of Glue table definitions used by the transform.
parameters(Option<TransformParameters>)
:The configuration parameters that are specific to the algorithm used.
evaluation_metrics(Option<EvaluationMetrics>)
:The latest evaluation metrics.
label_count(i32)
:The number of labels available for this transform.
schema(Option<Vec::<SchemaColumn>>)
:The
Map<column, type></column,>
object that represents the schema that this transform accepts. Has an upper bound of 100 columns.role(Option<String>)
:The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
glue_version(Option<String>)
:This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
max_capacity(Option<f64>)
:The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.worker_type(Option<WorkerType>)
:The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. -
For the
G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
-
number_of_workers(Option<i32>)
:The number of workers of a defined
workerType
that are allocated when this task runs.timeout(Option<i32>)
:The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).max_retries(Option<i32>)
:The maximum number of times to retry a task for this transform after a task run fails.
transform_encryption(Option<TransformEncryption>)
:The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
- On failure, responds with
SdkError<GetMLTransformError>
Source§impl Client
impl Client
Sourcepub fn get_ml_transforms(&self) -> GetMLTransformsFluentBuilder
pub fn get_ml_transforms(&self) -> GetMLTransformsFluentBuilder
Constructs a fluent builder for the GetMLTransforms
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA paginated token to offset the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
filter(TransformFilterCriteria)
/set_filter(Option<TransformFilterCriteria>)
:
required: falseThe filter transformation criteria.
sort(TransformSortCriteria)
/set_sort(Option<TransformSortCriteria>)
:
required: falseThe sorting criteria.
- On success, responds with
GetMlTransformsOutput
with field(s):transforms(Vec::<MlTransform>)
:A list of machine learning transforms.
next_token(Option<String>)
:A pagination token, if more results are available.
- On failure, responds with
SdkError<GetMLTransformsError>
Source§impl Client
impl Client
Sourcepub fn get_partition(&self) -> GetPartitionFluentBuilder
pub fn get_partition(&self) -> GetPartitionFluentBuilder
Constructs a fluent builder for the GetPartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partition resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partition’s table.
partition_values(impl Into<String>)
/set_partition_values(Option<Vec::<String>>)
:
required: trueThe values that define the partition.
- On success, responds with
GetPartitionOutput
with field(s):partition(Option<Partition>)
:The requested information, in the form of a
Partition
object.
- On failure, responds with
SdkError<GetPartitionError>
Source§impl Client
impl Client
Sourcepub fn get_partition_indexes(&self) -> GetPartitionIndexesFluentBuilder
pub fn get_partition_indexes(&self) -> GetPartitionIndexesFluentBuilder
Constructs a fluent builder for the GetPartitionIndexes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe catalog ID where the table resides.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueSpecifies the name of a database from which you want to retrieve partition indexes.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueSpecifies the name of a table for which you want to retrieve the partition indexes.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, included if this is a continuation call.
- On success, responds with
GetPartitionIndexesOutput
with field(s):partition_index_descriptor_list(Option<Vec::<PartitionIndexDescriptor>>)
:A list of index descriptors.
next_token(Option<String>)
:A continuation token, present if the current list segment is not the last.
- On failure, responds with
SdkError<GetPartitionIndexesError>
Source§impl Client
impl Client
Sourcepub fn get_partitions(&self) -> GetPartitionsFluentBuilder
pub fn get_partitions(&self) -> GetPartitionsFluentBuilder
Constructs a fluent builder for the GetPartitions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
expression(impl Into<String>)
/set_expression(Option<String>)
:
required: falseAn expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL
WHERE
filter clause. The SQL statement parser JSQLParser parses the expression.Operators: The following are the operators that you can use in the
Expression
API call:- =
-
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume ‘variable a’ holds 10 and ‘variable b’ holds 20.
(a = b) is not true.
- < >
-
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
- >
-
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
- <
-
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
- >=
-
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
- <=
-
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
- AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
-
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
-
string
-
date
-
timestamp
-
int
-
bigint
-
long
-
tinyint
-
smallint
-
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the
partitionKey
type is created as aSTRING
, to be compatible with the catalog partitions.Sample API Call:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is not the first call to retrieve these partitions.
segment(Segment)
/set_segment(Option<Segment>)
:
required: falseThe segment of the table’s partitions to scan in this request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of partitions to return in a single response.
exclude_column_schema(bool)
/set_exclude_column_schema(Option<bool>)
:
required: falseWhen true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:
required: falseThe transaction ID at which to read the partition contents.
query_as_of_time(DateTime)
/set_query_as_of_time(Option<DateTime>)
:
required: falseThe time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with
TransactionId
.
- On success, responds with
GetPartitionsOutput
with field(s):partitions(Option<Vec::<Partition>>)
:A list of requested partitions.
next_token(Option<String>)
:A continuation token, if the returned list of partitions does not include the last one.
- On failure, responds with
SdkError<GetPartitionsError>
Source§impl Client
impl Client
Sourcepub fn get_plan(&self) -> GetPlanFluentBuilder
pub fn get_plan(&self) -> GetPlanFluentBuilder
Constructs a fluent builder for the GetPlan
operation.
- The fluent builder is configurable:
mapping(MappingEntry)
/set_mapping(Option<Vec::<MappingEntry>>)
:
required: trueThe list of mappings from a source table to target tables.
source(CatalogEntry)
/set_source(Option<CatalogEntry>)
:
required: trueThe source table.
sinks(CatalogEntry)
/set_sinks(Option<Vec::<CatalogEntry>>)
:
required: falseThe target tables.
location(Location)
/set_location(Option<Location>)
:
required: falseThe parameters for the mapping.
language(Language)
/set_language(Option<Language>)
:
required: falseThe programming language of the code to perform the mapping.
additional_plan_options_map(impl Into<String>, impl Into<String>)
/set_additional_plan_options_map(Option<HashMap::<String, String>>)
:
required: falseA map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
-
inferSchema
— Specifies whether to setinferSchema
to true or false for the default script generated by an Glue job. For example, to setinferSchema
to true, pass the following key value pair:–additional-plan-options-map ‘{“inferSchema”:“true”}’
-
- On success, responds with
GetPlanOutput
with field(s):python_script(Option<String>)
:A Python script to perform the mapping.
scala_code(Option<String>)
:The Scala code to perform the mapping.
- On failure, responds with
SdkError<GetPlanError>
Source§impl Client
impl Client
Sourcepub fn get_registry(&self) -> GetRegistryFluentBuilder
pub fn get_registry(&self) -> GetRegistryFluentBuilder
Constructs a fluent builder for the GetRegistry
operation.
- The fluent builder is configurable:
registry_id(RegistryId)
/set_registry_id(Option<RegistryId>)
:
required: trueThis is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
- On success, responds with
GetRegistryOutput
with field(s):registry_name(Option<String>)
:The name of the registry.
registry_arn(Option<String>)
:The Amazon Resource Name (ARN) of the registry.
description(Option<String>)
:A description of the registry.
status(Option<RegistryStatus>)
:The status of the registry.
created_time(Option<String>)
:The date and time the registry was created.
updated_time(Option<String>)
:The date and time the registry was updated.
- On failure, responds with
SdkError<GetRegistryError>
Source§impl Client
impl Client
Sourcepub fn get_resource_policies(&self) -> GetResourcePoliciesFluentBuilder
pub fn get_resource_policies(&self) -> GetResourcePoliciesFluentBuilder
Constructs a fluent builder for the GetResourcePolicies
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
- On success, responds with
GetResourcePoliciesOutput
with field(s):get_resource_policies_response_list(Option<Vec::<GluePolicy>>)
:A list of the individual resource policies and the account-level resource policy.
next_token(Option<String>)
:A continuation token, if the returned list does not contain the last resource policy available.
- On failure, responds with
SdkError<GetResourcePoliciesError>
Source§impl Client
impl Client
Sourcepub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
Constructs a fluent builder for the GetResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: falseThe ARN of the Glue resource for which to retrieve the resource policy. If not supplied, the Data Catalog resource policy is returned. Use
GetResourcePolicies
to view all existing resource policies. For more information see Specifying Glue Resource ARNs.
- On success, responds with
GetResourcePolicyOutput
with field(s):policy_in_json(Option<String>)
:Contains the requested policy document, in JSON format.
policy_hash(Option<String>)
:Contains the hash value associated with this policy.
create_time(Option<DateTime>)
:The date and time at which the policy was created.
update_time(Option<DateTime>)
:The date and time at which the policy was last updated.
- On failure, responds with
SdkError<GetResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn get_schema(&self) -> GetSchemaFluentBuilder
pub fn get_schema(&self) -> GetSchemaFluentBuilder
Constructs a fluent builder for the GetSchema
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
-
- On success, responds with
GetSchemaOutput
with field(s):registry_name(Option<String>)
:The name of the registry.
registry_arn(Option<String>)
:The Amazon Resource Name (ARN) of the registry.
schema_name(Option<String>)
:The name of the schema.
schema_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schema.
description(Option<String>)
:A description of schema if specified when created
data_format(Option<DataFormat>)
:The data format of the schema definition. Currently
AVRO
,JSON
andPROTOBUF
are supported.compatibility(Option<Compatibility>)
:The compatibility mode of the schema.
schema_checkpoint(Option<i64>)
:The version number of the checkpoint (the last time the compatibility mode was changed).
latest_schema_version(Option<i64>)
:The latest version of the schema associated with the returned schema definition.
next_schema_version(Option<i64>)
:The next version of the schema associated with the returned schema definition.
schema_status(Option<SchemaStatus>)
:The status of the schema.
created_time(Option<String>)
:The date and time the schema was created.
updated_time(Option<String>)
:The date and time the schema was updated.
- On failure, responds with
SdkError<GetSchemaError>
Source§impl Client
impl Client
Sourcepub fn get_schema_by_definition(&self) -> GetSchemaByDefinitionFluentBuilder
pub fn get_schema_by_definition(&self) -> GetSchemaByDefinitionFluentBuilder
Constructs a fluent builder for the GetSchemaByDefinition
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided. -
SchemaId$SchemaName: The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.
-
schema_definition(impl Into<String>)
/set_schema_definition(Option<String>)
:
required: trueThe definition of the schema for which schema details are required.
- On success, responds with
GetSchemaByDefinitionOutput
with field(s):schema_version_id(Option<String>)
:The schema ID of the schema version.
schema_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schema.
data_format(Option<DataFormat>)
:The data format of the schema definition. Currently
AVRO
,JSON
andPROTOBUF
are supported.status(Option<SchemaVersionStatus>)
:The status of the schema version.
created_time(Option<String>)
:The date and time the schema was created.
- On failure, responds with
SdkError<GetSchemaByDefinitionError>
Source§impl Client
impl Client
Sourcepub fn get_schema_version(&self) -> GetSchemaVersionFluentBuilder
pub fn get_schema_version(&self) -> GetSchemaVersionFluentBuilder
Constructs a fluent builder for the GetSchemaVersion
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: falseThis is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
-
schema_version_id(impl Into<String>)
/set_schema_version_id(Option<String>)
:
required: falseThe
SchemaVersionId
of the schema version. This field is required for fetching by schema ID. Either this or theSchemaId
wrapper has to be provided.schema_version_number(SchemaVersionNumber)
/set_schema_version_number(Option<SchemaVersionNumber>)
:
required: falseThe version number of the schema.
- On success, responds with
GetSchemaVersionOutput
with field(s):schema_version_id(Option<String>)
:The
SchemaVersionId
of the schema version.schema_definition(Option<String>)
:The schema definition for the schema ID.
data_format(Option<DataFormat>)
:The data format of the schema definition. Currently
AVRO
,JSON
andPROTOBUF
are supported.schema_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schema.
version_number(Option<i64>)
:The version number of the schema.
status(Option<SchemaVersionStatus>)
:The status of the schema version.
created_time(Option<String>)
:The date and time the schema version was created.
- On failure, responds with
SdkError<GetSchemaVersionError>
Source§impl Client
impl Client
Sourcepub fn get_schema_versions_diff(&self) -> GetSchemaVersionsDiffFluentBuilder
pub fn get_schema_versions_diff(&self) -> GetSchemaVersionsDiffFluentBuilder
Constructs a fluent builder for the GetSchemaVersionsDiff
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided. -
SchemaId$SchemaName: The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.
-
first_schema_version_number(SchemaVersionNumber)
/set_first_schema_version_number(Option<SchemaVersionNumber>)
:
required: trueThe first of the two schema versions to be compared.
second_schema_version_number(SchemaVersionNumber)
/set_second_schema_version_number(Option<SchemaVersionNumber>)
:
required: trueThe second of the two schema versions to be compared.
schema_diff_type(SchemaDiffType)
/set_schema_diff_type(Option<SchemaDiffType>)
:
required: trueRefers to
SYNTAX_DIFF
, which is the currently supported diff type.
- On success, responds with
GetSchemaVersionsDiffOutput
with field(s):diff(Option<String>)
:The difference between schemas as a string in JsonPatch format.
- On failure, responds with
SdkError<GetSchemaVersionsDiffError>
Source§impl Client
impl Client
Sourcepub fn get_security_configuration(
&self,
) -> GetSecurityConfigurationFluentBuilder
pub fn get_security_configuration( &self, ) -> GetSecurityConfigurationFluentBuilder
Constructs a fluent builder for the GetSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the security configuration to retrieve.
- On success, responds with
GetSecurityConfigurationOutput
with field(s):security_configuration(Option<SecurityConfiguration>)
:The requested security configuration.
- On failure, responds with
SdkError<GetSecurityConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_security_configurations(
&self,
) -> GetSecurityConfigurationsFluentBuilder
pub fn get_security_configurations( &self, ) -> GetSecurityConfigurationsFluentBuilder
Constructs a fluent builder for the GetSecurityConfigurations
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.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
GetSecurityConfigurationsOutput
with field(s):security_configurations(Option<Vec::<SecurityConfiguration>>)
:A list of security configurations.
next_token(Option<String>)
:A continuation token, if there are more security configurations to return.
- On failure, responds with
SdkError<GetSecurityConfigurationsError>
Source§impl Client
impl Client
Sourcepub fn get_session(&self) -> GetSessionFluentBuilder
pub fn get_session(&self) -> GetSessionFluentBuilder
Constructs a fluent builder for the GetSession
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the session.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request.
- On success, responds with
GetSessionOutput
with field(s):session(Option<Session>)
:The session object is returned in the response.
- On failure, responds with
SdkError<GetSessionError>
Source§impl Client
impl Client
Sourcepub fn get_statement(&self) -> GetStatementFluentBuilder
pub fn get_statement(&self) -> GetStatementFluentBuilder
Constructs a fluent builder for the GetStatement
operation.
- The fluent builder is configurable:
session_id(impl Into<String>)
/set_session_id(Option<String>)
:
required: trueThe Session ID of the statement.
id(i32)
/set_id(Option<i32>)
:
required: trueThe Id of the statement.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request.
- On success, responds with
GetStatementOutput
with field(s):statement(Option<Statement>)
:Returns the statement.
- On failure, responds with
SdkError<GetStatementError>
Source§impl Client
impl Client
Sourcepub fn get_table(&self) -> GetTableFluentBuilder
pub fn get_table(&self) -> GetTableFluentBuilder
Constructs a fluent builder for the GetTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:
required: falseThe transaction ID at which to read the table contents.
query_as_of_time(DateTime)
/set_query_as_of_time(Option<DateTime>)
:
required: falseThe time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with
TransactionId
.include_status_details(bool)
/set_include_status_details(Option<bool>)
:
required: falseSpecifies whether to include status details related to a request to create or update an Glue Data Catalog view.
- On success, responds with
GetTableOutput
with field(s):table(Option<Table>)
:The
Table
object that defines the specified table.
- On failure, responds with
SdkError<GetTableError>
Source§impl Client
impl Client
Sourcepub fn get_table_optimizer(&self) -> GetTableOptimizerFluentBuilder
pub fn get_table_optimizer(&self) -> GetTableOptimizerFluentBuilder
Constructs a fluent builder for the GetTableOptimizer
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe Catalog ID of the table.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database in the catalog in which the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table.
r#type(TableOptimizerType)
/set_type(Option<TableOptimizerType>)
:
required: trueThe type of table optimizer.
- On success, responds with
GetTableOptimizerOutput
with field(s):catalog_id(Option<String>)
:The Catalog ID of the table.
database_name(Option<String>)
:The name of the database in the catalog in which the table resides.
table_name(Option<String>)
:The name of the table.
table_optimizer(Option<TableOptimizer>)
:The optimizer associated with the specified table.
- On failure, responds with
SdkError<GetTableOptimizerError>
Source§impl Client
impl Client
Sourcepub fn get_table_version(&self) -> GetTableVersionFluentBuilder
pub fn get_table_version(&self) -> GetTableVersionFluentBuilder
Constructs a fluent builder for the GetTableVersion
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table. For Hive compatibility, this name is entirely lowercase.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: falseThe ID value of the table version to be retrieved. A
VersionID
is a string representation of an integer. Each version is incremented by 1.
- On success, responds with
GetTableVersionOutput
with field(s):table_version(Option<TableVersion>)
:The requested table version.
- On failure, responds with
SdkError<GetTableVersionError>
Source§impl Client
impl Client
Sourcepub fn get_table_versions(&self) -> GetTableVersionsFluentBuilder
pub fn get_table_versions(&self) -> GetTableVersionsFluentBuilder
Constructs a fluent builder for the GetTableVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table. For Hive compatibility, this name is entirely lowercase.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is not the first call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of table versions to return in one response.
- On success, responds with
GetTableVersionsOutput
with field(s):table_versions(Option<Vec::<TableVersion>>)
:A list of strings identifying available versions of the specified table.
next_token(Option<String>)
:A continuation token, if the list of available versions does not include the last one.
- On failure, responds with
SdkError<GetTableVersionsError>
Source§impl Client
impl Client
Sourcepub fn get_tables(&self) -> GetTablesFluentBuilder
pub fn get_tables(&self) -> GetTablesFluentBuilder
Constructs a fluent builder for the GetTables
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
expression(impl Into<String>)
/set_expression(Option<String>)
:
required: falseA regular expression pattern. If present, only those tables whose names match the pattern are returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, included if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of tables to return in a single response.
transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:
required: falseThe transaction ID at which to read the table contents.
query_as_of_time(DateTime)
/set_query_as_of_time(Option<DateTime>)
:
required: falseThe time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with
TransactionId
.include_status_details(bool)
/set_include_status_details(Option<bool>)
:
required: falseSpecifies whether to include status details related to a request to create or update an Glue Data Catalog view.
attributes_to_get(TableAttributes)
/set_attributes_to_get(Option<Vec::<TableAttributes>>)
:
required: falseSpecifies the table fields returned by the
GetTables
call. This parameter doesn’t accept an empty list. The request must includeNAME
.The following are the valid combinations of values:
-
NAME
- Names of all tables in the database. -
NAME
,TABLE_TYPE
- Names of all tables and the table types.
-
- On success, responds with
GetTablesOutput
with field(s):table_list(Option<Vec::<Table>>)
:A list of the requested
Table
objects.next_token(Option<String>)
:A continuation token, present if the current list segment is not the last.
- On failure, responds with
SdkError<GetTablesError>
Source§impl Client
impl Client
Constructs a fluent builder for the GetTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource for which to retrieve tags.
- On success, responds with
GetTagsOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The requested tags.
- On failure, responds with
SdkError<GetTagsError>
Source§impl Client
impl Client
Sourcepub fn get_trigger(&self) -> GetTriggerFluentBuilder
pub fn get_trigger(&self) -> GetTriggerFluentBuilder
Constructs a fluent builder for the GetTrigger
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the trigger to retrieve.
- On success, responds with
GetTriggerOutput
with field(s):trigger(Option<Trigger>)
:The requested trigger definition.
- On failure, responds with
SdkError<GetTriggerError>
Source§impl Client
impl Client
Sourcepub fn get_triggers(&self) -> GetTriggersFluentBuilder
pub fn get_triggers(&self) -> GetTriggersFluentBuilder
Constructs a fluent builder for the GetTriggers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
dependent_job_name(impl Into<String>)
/set_dependent_job_name(Option<String>)
:
required: falseThe name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the response.
- On success, responds with
GetTriggersOutput
with field(s):triggers(Option<Vec::<Trigger>>)
:A list of triggers for the specified job.
next_token(Option<String>)
:A continuation token, if not all the requested triggers have yet been returned.
- On failure, responds with
SdkError<GetTriggersError>
Source§impl Client
impl Client
Sourcepub fn get_unfiltered_partition_metadata(
&self,
) -> GetUnfilteredPartitionMetadataFluentBuilder
pub fn get_unfiltered_partition_metadata( &self, ) -> GetUnfilteredPartitionMetadataFluentBuilder
Constructs a fluent builder for the GetUnfilteredPartitionMetadata
operation.
- The fluent builder is configurable:
region(impl Into<String>)
/set_region(Option<String>)
:
required: falseSpecified only if the base tables belong to a different Amazon Web Services Region.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe catalog ID where the partition resides.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: true(Required) Specifies the name of a database that contains the partition.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: true(Required) Specifies the name of a table that contains the partition.
partition_values(impl Into<String>)
/set_partition_values(Option<Vec::<String>>)
:
required: true(Required) A list of partition key values.
audit_context(AuditContext)
/set_audit_context(Option<AuditContext>)
:
required: falseA structure containing Lake Formation audit context information.
supported_permission_types(PermissionType)
/set_supported_permission_types(Option<Vec::<PermissionType>>)
:
required: true(Required) A list of supported permission types.
query_session_context(QuerySessionContext)
/set_query_session_context(Option<QuerySessionContext>)
:
required: falseA structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request’s authorization context.
- On success, responds with
GetUnfilteredPartitionMetadataOutput
with field(s):partition(Option<Partition>)
:A Partition object containing the partition metadata.
authorized_columns(Option<Vec::<String>>)
:A list of column names that the user has been granted access to.
is_registered_with_lake_formation(bool)
:A Boolean value that indicates whether the partition location is registered with Lake Formation.
- On failure, responds with
SdkError<GetUnfilteredPartitionMetadataError>
Source§impl Client
impl Client
Sourcepub fn get_unfiltered_partitions_metadata(
&self,
) -> GetUnfilteredPartitionsMetadataFluentBuilder
pub fn get_unfiltered_partitions_metadata( &self, ) -> GetUnfilteredPartitionsMetadataFluentBuilder
Constructs a fluent builder for the GetUnfilteredPartitionsMetadata
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
region(impl Into<String>)
/set_region(Option<String>)
:
required: falseSpecified only if the base tables belong to a different Amazon Web Services Region.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table that contains the partition.
expression(impl Into<String>)
/set_expression(Option<String>)
:
required: falseAn expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL
WHERE
filter clause. The SQL statement parser JSQLParser parses the expression.Operators: The following are the operators that you can use in the
Expression
API call:- =
-
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume ‘variable a’ holds 10 and ‘variable b’ holds 20.
(a = b) is not true.
- < >
-
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
- >
-
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
- <
-
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
- >=
-
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
- <=
-
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
- AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
-
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
-
string
-
date
-
timestamp
-
int
-
bigint
-
long
-
tinyint
-
smallint
-
decimal
If an type is encountered that is not valid, an exception is thrown.
audit_context(AuditContext)
/set_audit_context(Option<AuditContext>)
:
required: falseA structure containing Lake Formation audit context information.
supported_permission_types(PermissionType)
/set_supported_permission_types(Option<Vec::<PermissionType>>)
:
required: trueA list of supported permission types.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is not the first call to retrieve these partitions.
segment(Segment)
/set_segment(Option<Segment>)
:
required: falseThe segment of the table’s partitions to scan in this request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of partitions to return in a single response.
query_session_context(QuerySessionContext)
/set_query_session_context(Option<QuerySessionContext>)
:
required: falseA structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request’s authorization context.
- On success, responds with
GetUnfilteredPartitionsMetadataOutput
with field(s):unfiltered_partitions(Option<Vec::<UnfilteredPartition>>)
:A list of requested partitions.
next_token(Option<String>)
:A continuation token, if the returned list of partitions does not include the last one.
- On failure, responds with
SdkError<GetUnfilteredPartitionsMetadataError>
Source§impl Client
impl Client
Sourcepub fn get_unfiltered_table_metadata(
&self,
) -> GetUnfilteredTableMetadataFluentBuilder
pub fn get_unfiltered_table_metadata( &self, ) -> GetUnfilteredTableMetadataFluentBuilder
Constructs a fluent builder for the GetUnfilteredTableMetadata
operation.
- The fluent builder is configurable:
region(impl Into<String>)
/set_region(Option<String>)
:
required: falseSpecified only if the base tables belong to a different Amazon Web Services Region.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe catalog ID where the table resides.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: true(Required) Specifies the name of a database that contains the table.
name(impl Into<String>)
/set_name(Option<String>)
:
required: true(Required) Specifies the name of a table for which you are requesting metadata.
audit_context(AuditContext)
/set_audit_context(Option<AuditContext>)
:
required: falseA structure containing Lake Formation audit context information.
supported_permission_types(PermissionType)
/set_supported_permission_types(Option<Vec::<PermissionType>>)
:
required: trueIndicates the level of filtering a third-party analytical engine is capable of enforcing when calling the
GetUnfilteredTableMetadata
API operation. Accepted values are:-
COLUMN_PERMISSION
- Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns. -
CELL_FILTER_PERMISSION
- Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table. -
NESTED_PERMISSION
- Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions. -
NESTED_CELL_PERMISSION
- Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.
Important: If you provide a supported permission type that doesn’t match the user’s level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the
GetUnfilteredTableMetadata
operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.-
parent_resource_arn(impl Into<String>)
/set_parent_resource_arn(Option<String>)
:
required: falseThe resource ARN of the view.
root_resource_arn(impl Into<String>)
/set_root_resource_arn(Option<String>)
:
required: falseThe resource ARN of the root view in a chain of nested views.
supported_dialect(SupportedDialect)
/set_supported_dialect(Option<SupportedDialect>)
:
required: falseA structure specifying the dialect and dialect version used by the query engine.
permissions(Permission)
/set_permissions(Option<Vec::<Permission>>)
:
required: falseThe Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
query_session_context(QuerySessionContext)
/set_query_session_context(Option<QuerySessionContext>)
:
required: falseA structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request’s authorization context.
- On success, responds with
GetUnfilteredTableMetadataOutput
with field(s):table(Option<Table>)
:A Table object containing the table metadata.
authorized_columns(Option<Vec::<String>>)
:A list of column names that the user has been granted access to.
is_registered_with_lake_formation(bool)
:A Boolean value that indicates whether the partition location is registered with Lake Formation.
cell_filters(Option<Vec::<ColumnRowFilter>>)
:A list of column row filters.
query_authorization_id(Option<String>)
:A cryptographically generated query identifier generated by Glue or Lake Formation.
is_multi_dialect_view(bool)
:Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
resource_arn(Option<String>)
:The resource ARN of the parent resource extracted from the request.
is_protected(bool)
:A flag that instructs the engine not to push user-provided operations into the logical plan of the view during query planning. However, if set this flag does not guarantee that the engine will comply. Refer to the engine’s documentation to understand the guarantees provided, if any.
permissions(Option<Vec::<Permission>>)
:The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
row_filter(Option<String>)
:The filter that applies to the table. For example when applying the filter in SQL, it would go in the
WHERE
clause and can be evaluated by using anAND
operator with any other predicates applied by the user querying the table.
- On failure, responds with
SdkError<GetUnfilteredTableMetadataError>
Source§impl Client
impl Client
Sourcepub fn get_usage_profile(&self) -> GetUsageProfileFluentBuilder
pub fn get_usage_profile(&self) -> GetUsageProfileFluentBuilder
Constructs a fluent builder for the GetUsageProfile
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the usage profile to retrieve.
- On success, responds with
GetUsageProfileOutput
with field(s):name(Option<String>)
:The name of the usage profile.
description(Option<String>)
:A description of the usage profile.
configuration(Option<ProfileConfiguration>)
:A
ProfileConfiguration
object specifying the job and session values for the profile.created_on(Option<DateTime>)
:The date and time when the usage profile was created.
last_modified_on(Option<DateTime>)
:The date and time when the usage profile was last modified.
- On failure, responds with
SdkError<GetUsageProfileError>
Source§impl Client
impl Client
Sourcepub fn get_user_defined_function(&self) -> GetUserDefinedFunctionFluentBuilder
pub fn get_user_defined_function(&self) -> GetUserDefinedFunctionFluentBuilder
Constructs a fluent builder for the GetUserDefinedFunction
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the function to be retrieved is located. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the function is located.
function_name(impl Into<String>)
/set_function_name(Option<String>)
:
required: trueThe name of the function.
- On success, responds with
GetUserDefinedFunctionOutput
with field(s):user_defined_function(Option<UserDefinedFunction>)
:The requested function definition.
- On failure, responds with
SdkError<GetUserDefinedFunctionError>
Source§impl Client
impl Client
Sourcepub fn get_user_defined_functions(&self) -> GetUserDefinedFunctionsFluentBuilder
pub fn get_user_defined_functions(&self) -> GetUserDefinedFunctionsFluentBuilder
Constructs a fluent builder for the GetUserDefinedFunctions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: falseThe name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned.
pattern(impl Into<String>)
/set_pattern(Option<String>)
:
required: trueAn optional function-name pattern string that filters the function definitions returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of functions to return in one response.
- On success, responds with
GetUserDefinedFunctionsOutput
with field(s):user_defined_functions(Option<Vec::<UserDefinedFunction>>)
:A list of requested function definitions.
next_token(Option<String>)
:A continuation token, if the list of functions returned does not include the last requested function.
- On failure, responds with
SdkError<GetUserDefinedFunctionsError>
Source§impl Client
impl Client
Sourcepub fn get_workflow(&self) -> GetWorkflowFluentBuilder
pub fn get_workflow(&self) -> GetWorkflowFluentBuilder
Constructs a fluent builder for the GetWorkflow
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the workflow to retrieve.
include_graph(bool)
/set_include_graph(Option<bool>)
:
required: falseSpecifies whether to include a graph when returning the workflow resource metadata.
- On success, responds with
GetWorkflowOutput
with field(s):workflow(Option<Workflow>)
:The resource metadata for the workflow.
- On failure, responds with
SdkError<GetWorkflowError>
Source§impl Client
impl Client
Sourcepub fn get_workflow_run(&self) -> GetWorkflowRunFluentBuilder
pub fn get_workflow_run(&self) -> GetWorkflowRunFluentBuilder
Constructs a fluent builder for the GetWorkflowRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the workflow being run.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe ID of the workflow run.
include_graph(bool)
/set_include_graph(Option<bool>)
:
required: falseSpecifies whether to include the workflow graph in response or not.
- On success, responds with
GetWorkflowRunOutput
with field(s):run(Option<WorkflowRun>)
:The requested workflow run metadata.
- On failure, responds with
SdkError<GetWorkflowRunError>
Source§impl Client
impl Client
Sourcepub fn get_workflow_run_properties(
&self,
) -> GetWorkflowRunPropertiesFluentBuilder
pub fn get_workflow_run_properties( &self, ) -> GetWorkflowRunPropertiesFluentBuilder
Constructs a fluent builder for the GetWorkflowRunProperties
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the workflow which was run.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe ID of the workflow run whose run properties should be returned.
- On success, responds with
GetWorkflowRunPropertiesOutput
with field(s):run_properties(Option<HashMap::<String, String>>)
:The workflow run properties which were set during the specified run.
- On failure, responds with
SdkError<GetWorkflowRunPropertiesError>
Source§impl Client
impl Client
Sourcepub fn get_workflow_runs(&self) -> GetWorkflowRunsFluentBuilder
pub fn get_workflow_runs(&self) -> GetWorkflowRunsFluentBuilder
Constructs a fluent builder for the GetWorkflowRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the workflow whose metadata of runs should be returned.
include_graph(bool)
/set_include_graph(Option<bool>)
:
required: falseSpecifies whether to include the workflow graph in response or not.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe maximum size of the response.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of workflow runs to be included in the response.
- On success, responds with
GetWorkflowRunsOutput
with field(s):runs(Option<Vec::<WorkflowRun>>)
:A list of workflow run metadata objects.
next_token(Option<String>)
:A continuation token, if not all requested workflow runs have been returned.
- On failure, responds with
SdkError<GetWorkflowRunsError>
Source§impl Client
impl Client
Sourcepub fn import_catalog_to_glue(&self) -> ImportCatalogToGlueFluentBuilder
pub fn import_catalog_to_glue(&self) -> ImportCatalogToGlueFluentBuilder
Constructs a fluent builder for the ImportCatalogToGlue
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.
- On success, responds with
ImportCatalogToGlueOutput
- On failure, responds with
SdkError<ImportCatalogToGlueError>
Source§impl Client
impl Client
Sourcepub fn list_blueprints(&self) -> ListBlueprintsFluentBuilder
pub fn list_blueprints(&self) -> ListBlueprintsFluentBuilder
Constructs a fluent builder for the ListBlueprints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseFilters the list by an Amazon Web Services resource tag.
- On success, responds with
ListBlueprintsOutput
with field(s):blueprints(Option<Vec::<String>>)
:List of names of blueprints in the account.
next_token(Option<String>)
:A continuation token, if not all blueprint names have been returned.
- On failure, responds with
SdkError<ListBlueprintsError>
Source§impl Client
impl Client
Sourcepub fn list_column_statistics_task_runs(
&self,
) -> ListColumnStatisticsTaskRunsFluentBuilder
pub fn list_column_statistics_task_runs( &self, ) -> ListColumnStatisticsTaskRunsFluentBuilder
Constructs a fluent builder for the ListColumnStatisticsTaskRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListColumnStatisticsTaskRunsOutput
with field(s):column_statistics_task_run_ids(Option<Vec::<String>>)
:A list of column statistics task run IDs.
next_token(Option<String>)
:A continuation token, if not all task run IDs have yet been returned.
- On failure, responds with
SdkError<ListColumnStatisticsTaskRunsError>
Source§impl Client
impl Client
Sourcepub fn list_connection_types(&self) -> ListConnectionTypesFluentBuilder
pub fn list_connection_types(&self) -> ListConnectionTypesFluentBuilder
Constructs a fluent builder for the ListConnectionTypes
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.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListConnectionTypesOutput
with field(s):connection_types(Option<Vec::<ConnectionTypeBrief>>)
:A list of
ConnectionTypeBrief
objects containing brief information about the supported connection types.next_token(Option<String>)
:A continuation token, if the current list segment is not the last.
- On failure, responds with
SdkError<ListConnectionTypesError>
Source§impl Client
impl Client
Sourcepub fn list_crawlers(&self) -> ListCrawlersFluentBuilder
pub fn list_crawlers(&self) -> ListCrawlersFluentBuilder
Constructs a fluent builder for the ListCrawlers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseSpecifies to return only these tagged resources.
- On success, responds with
ListCrawlersOutput
with field(s):crawler_names(Option<Vec::<String>>)
:The names of all crawlers in the account, or the crawlers with the specified tags.
next_token(Option<String>)
:A continuation token, if the returned list does not contain the last metric available.
- On failure, responds with
SdkError<ListCrawlersError>
Source§impl Client
impl Client
Sourcepub fn list_crawls(&self) -> ListCrawlsFluentBuilder
pub fn list_crawls(&self) -> ListCrawlsFluentBuilder
Constructs a fluent builder for the ListCrawls
operation.
- The fluent builder is configurable:
crawler_name(impl Into<String>)
/set_crawler_name(Option<String>)
:
required: trueThe name of the crawler whose runs you want to retrieve.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return. The default is 20, and maximum is 100.
filters(CrawlsFilter)
/set_filters(Option<Vec::<CrawlsFilter>>)
:
required: falseFilters the crawls by the criteria you specify in a list of
CrawlsFilter
objects.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListCrawlsOutput
with field(s):crawls(Option<Vec::<CrawlerHistory>>)
:A list of
CrawlerHistory
objects representing the crawl runs that meet your criteria.next_token(Option<String>)
:A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- On failure, responds with
SdkError<ListCrawlsError>
Source§impl Client
impl Client
Sourcepub fn list_custom_entity_types(&self) -> ListCustomEntityTypesFluentBuilder
pub fn list_custom_entity_types(&self) -> ListCustomEntityTypesFluentBuilder
Constructs a fluent builder for the ListCustomEntityTypes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA paginated token to offset the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pair tags.
- On success, responds with
ListCustomEntityTypesOutput
with field(s):custom_entity_types(Option<Vec::<CustomEntityType>>)
:A list of
CustomEntityType
objects representing custom patterns.next_token(Option<String>)
:A pagination token, if more results are available.
- On failure, responds with
SdkError<ListCustomEntityTypesError>
Source§impl Client
impl Client
Sourcepub fn list_data_quality_results(&self) -> ListDataQualityResultsFluentBuilder
pub fn list_data_quality_results(&self) -> ListDataQualityResultsFluentBuilder
Constructs a fluent builder for the ListDataQualityResults
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(DataQualityResultFilterCriteria)
/set_filter(Option<DataQualityResultFilterCriteria>)
:
required: falseThe filter criteria.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA paginated token to offset the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
- On success, responds with
ListDataQualityResultsOutput
with field(s):results(Vec::<DataQualityResultDescription>)
:A list of
DataQualityResultDescription
objects.next_token(Option<String>)
:A pagination token, if more results are available.
- On failure, responds with
SdkError<ListDataQualityResultsError>
Source§impl Client
impl Client
Sourcepub fn list_data_quality_rule_recommendation_runs(
&self,
) -> ListDataQualityRuleRecommendationRunsFluentBuilder
pub fn list_data_quality_rule_recommendation_runs( &self, ) -> ListDataQualityRuleRecommendationRunsFluentBuilder
Constructs a fluent builder for the ListDataQualityRuleRecommendationRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(DataQualityRuleRecommendationRunFilter)
/set_filter(Option<DataQualityRuleRecommendationRunFilter>)
:
required: falseThe filter criteria.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA paginated token to offset the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
- On success, responds with
ListDataQualityRuleRecommendationRunsOutput
with field(s):runs(Option<Vec::<DataQualityRuleRecommendationRunDescription>>)
:A list of
DataQualityRuleRecommendationRunDescription
objects.next_token(Option<String>)
:A pagination token, if more results are available.
- On failure, responds with
SdkError<ListDataQualityRuleRecommendationRunsError>
Source§impl Client
impl Client
Sourcepub fn list_data_quality_ruleset_evaluation_runs(
&self,
) -> ListDataQualityRulesetEvaluationRunsFluentBuilder
pub fn list_data_quality_ruleset_evaluation_runs( &self, ) -> ListDataQualityRulesetEvaluationRunsFluentBuilder
Constructs a fluent builder for the ListDataQualityRulesetEvaluationRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(DataQualityRulesetEvaluationRunFilter)
/set_filter(Option<DataQualityRulesetEvaluationRunFilter>)
:
required: falseThe filter criteria.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA paginated token to offset the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
- On success, responds with
ListDataQualityRulesetEvaluationRunsOutput
with field(s):runs(Option<Vec::<DataQualityRulesetEvaluationRunDescription>>)
:A list of
DataQualityRulesetEvaluationRunDescription
objects representing data quality ruleset runs.next_token(Option<String>)
:A pagination token, if more results are available.
- On failure, responds with
SdkError<ListDataQualityRulesetEvaluationRunsError>
Source§impl Client
impl Client
Sourcepub fn list_data_quality_rulesets(&self) -> ListDataQualityRulesetsFluentBuilder
pub fn list_data_quality_rulesets(&self) -> ListDataQualityRulesetsFluentBuilder
Constructs a fluent builder for the ListDataQualityRulesets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA paginated token to offset the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
filter(DataQualityRulesetFilterCriteria)
/set_filter(Option<DataQualityRulesetFilterCriteria>)
:
required: falseThe filter criteria.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pair tags.
- On success, responds with
ListDataQualityRulesetsOutput
with field(s):rulesets(Option<Vec::<DataQualityRulesetListDetails>>)
:A paginated list of rulesets for the specified list of Glue tables.
next_token(Option<String>)
:A pagination token, if more results are available.
- On failure, responds with
SdkError<ListDataQualityRulesetsError>
Source§impl Client
impl Client
Sourcepub fn list_data_quality_statistic_annotations(
&self,
) -> ListDataQualityStatisticAnnotationsFluentBuilder
pub fn list_data_quality_statistic_annotations( &self, ) -> ListDataQualityStatisticAnnotationsFluentBuilder
Constructs a fluent builder for the ListDataQualityStatisticAnnotations
operation.
- The fluent builder is configurable:
statistic_id(impl Into<String>)
/set_statistic_id(Option<String>)
:
required: falseThe Statistic ID.
profile_id(impl Into<String>)
/set_profile_id(Option<String>)
:
required: falseThe Profile ID.
timestamp_filter(TimestampFilter)
/set_timestamp_filter(Option<TimestampFilter>)
:
required: falseA timestamp filter.
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 pagination token to retrieve the next set of results.
- On success, responds with
ListDataQualityStatisticAnnotationsOutput
with field(s):annotations(Option<Vec::<StatisticAnnotation>>)
:A list of
StatisticAnnotation
applied to the Statisticnext_token(Option<String>)
:A pagination token to retrieve the next set of results.
- On failure, responds with
SdkError<ListDataQualityStatisticAnnotationsError>
Source§impl Client
impl Client
Sourcepub fn list_data_quality_statistics(
&self,
) -> ListDataQualityStatisticsFluentBuilder
pub fn list_data_quality_statistics( &self, ) -> ListDataQualityStatisticsFluentBuilder
Constructs a fluent builder for the ListDataQualityStatistics
operation.
- The fluent builder is configurable:
statistic_id(impl Into<String>)
/set_statistic_id(Option<String>)
:
required: falseThe Statistic ID.
profile_id(impl Into<String>)
/set_profile_id(Option<String>)
:
required: falseThe Profile ID.
timestamp_filter(TimestampFilter)
/set_timestamp_filter(Option<TimestampFilter>)
:
required: falseA timestamp filter.
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 pagination token to request the next page of results.
- On success, responds with
ListDataQualityStatisticsOutput
with field(s):statistics(Option<Vec::<StatisticSummary>>)
:A
StatisticSummaryList
.next_token(Option<String>)
:A pagination token to request the next page of results.
- On failure, responds with
SdkError<ListDataQualityStatisticsError>
Source§impl Client
impl Client
Sourcepub fn list_dev_endpoints(&self) -> ListDevEndpointsFluentBuilder
pub fn list_dev_endpoints(&self) -> ListDevEndpointsFluentBuilder
Constructs a fluent builder for the ListDevEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseSpecifies to return only these tagged resources.
- On success, responds with
ListDevEndpointsOutput
with field(s):dev_endpoint_names(Option<Vec::<String>>)
:The names of all the
DevEndpoint
s in the account, or theDevEndpoint
s with the specified tags.next_token(Option<String>)
:A continuation token, if the returned list does not contain the last metric available.
- On failure, responds with
SdkError<ListDevEndpointsError>
Source§impl Client
impl Client
Sourcepub fn list_entities(&self) -> ListEntitiesFluentBuilder
pub fn list_entities(&self) -> ListEntitiesFluentBuilder
Constructs a fluent builder for the ListEntities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
connection_name(impl Into<String>)
/set_connection_name(Option<String>)
:
required: falseA name for the connection that has required credentials to query any connection type.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.
parent_entity_name(impl Into<String>)
/set_parent_entity_name(Option<String>)
:
required: falseName of the parent entity for which you want to list the children. This parameter takes a fully-qualified path of the entity in order to list the child entities.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, included if this is a continuation call.
data_store_api_version(impl Into<String>)
/set_data_store_api_version(Option<String>)
:
required: falseThe API version of the SaaS connector.
- On success, responds with
ListEntitiesOutput
with field(s):entities(Option<Vec::<Entity>>)
:A list of
Entity
objects.next_token(Option<String>)
:A continuation token, present if the current segment is not the last.
- On failure, responds with
SdkError<ListEntitiesError>
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:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseSpecifies to return only these tagged resources.
- On success, responds with
ListJobsOutput
with field(s):job_names(Option<Vec::<String>>)
:The names of all jobs in the account, or the jobs with the specified tags.
next_token(Option<String>)
:A continuation token, if the returned list does not contain the last metric available.
- On failure, responds with
SdkError<ListJobsError>
Source§impl Client
impl Client
Sourcepub fn list_ml_transforms(&self) -> ListMLTransformsFluentBuilder
pub fn list_ml_transforms(&self) -> ListMLTransformsFluentBuilder
Constructs a fluent builder for the ListMLTransforms
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
filter(TransformFilterCriteria)
/set_filter(Option<TransformFilterCriteria>)
:
required: falseA
TransformFilterCriteria
used to filter the machine learning transforms.sort(TransformSortCriteria)
/set_sort(Option<TransformSortCriteria>)
:
required: falseA
TransformSortCriteria
used to sort the machine learning transforms.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseSpecifies to return only these tagged resources.
- On success, responds with
ListMlTransformsOutput
with field(s):transform_ids(Vec::<String>)
:The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
next_token(Option<String>)
:A continuation token, if the returned list does not contain the last metric available.
- On failure, responds with
SdkError<ListMLTransformsError>
Source§impl Client
impl Client
Sourcepub fn list_registries(&self) -> ListRegistriesFluentBuilder
pub fn list_registries(&self) -> ListRegistriesFluentBuilder
Constructs a fluent builder for the ListRegistries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListRegistriesOutput
with field(s):registries(Option<Vec::<RegistryListItem>>)
:An array of
RegistryDetailedListItem
objects containing minimal details of each registry.next_token(Option<String>)
:A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- On failure, responds with
SdkError<ListRegistriesError>
Source§impl Client
impl Client
Sourcepub fn list_schema_versions(&self) -> ListSchemaVersionsFluentBuilder
pub fn list_schema_versions(&self) -> ListSchemaVersionsFluentBuilder
Constructs a fluent builder for the ListSchemaVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
-
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListSchemaVersionsOutput
with field(s):schemas(Option<Vec::<SchemaVersionListItem>>)
:An array of
SchemaVersionList
objects containing details of each schema version.next_token(Option<String>)
:A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- On failure, responds with
SdkError<ListSchemaVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_schemas(&self) -> ListSchemasFluentBuilder
pub fn list_schemas(&self) -> ListSchemasFluentBuilder
Constructs a fluent builder for the ListSchemas
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
registry_id(RegistryId)
/set_registry_id(Option<RegistryId>)
:
required: falseA wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListSchemasOutput
with field(s):schemas(Option<Vec::<SchemaListItem>>)
:An array of
SchemaListItem
objects containing details of each schema.next_token(Option<String>)
:A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- On failure, responds with
SdkError<ListSchemasError>
Source§impl Client
impl Client
Sourcepub fn list_sessions(&self) -> ListSessionsFluentBuilder
pub fn list_sessions(&self) -> ListSessionsFluentBuilder
Constructs a fluent builder for the ListSessions
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 for the next set of results, or null if there are no more result.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags belonging to the session.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request.
- On success, responds with
ListSessionsOutput
with field(s):ids(Option<Vec::<String>>)
:Returns the ID of the session.
sessions(Option<Vec::<Session>>)
:Returns the session object.
next_token(Option<String>)
:The token for the next set of results, or null if there are no more result.
- On failure, responds with
SdkError<ListSessionsError>
Source§impl Client
impl Client
Sourcepub fn list_statements(&self) -> ListStatementsFluentBuilder
pub fn list_statements(&self) -> ListStatementsFluentBuilder
Constructs a fluent builder for the ListStatements
operation.
- The fluent builder is configurable:
session_id(impl Into<String>)
/set_session_id(Option<String>)
:
required: trueThe Session ID of the statements.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request to list statements.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListStatementsOutput
with field(s):statements(Option<Vec::<Statement>>)
:Returns the list of statements.
next_token(Option<String>)
:A continuation token, if not all statements have yet been returned.
- On failure, responds with
SdkError<ListStatementsError>
Source§impl Client
impl Client
Sourcepub fn list_table_optimizer_runs(&self) -> ListTableOptimizerRunsFluentBuilder
pub fn list_table_optimizer_runs(&self) -> ListTableOptimizerRunsFluentBuilder
Constructs a fluent builder for the ListTableOptimizerRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe Catalog ID of the table.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database in the catalog in which the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table.
r#type(TableOptimizerType)
/set_type(Option<TableOptimizerType>)
:
required: trueThe type of table optimizer.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of optimizer runs to return on each call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
ListTableOptimizerRunsOutput
with field(s):catalog_id(Option<String>)
:The Catalog ID of the table.
database_name(Option<String>)
:The name of the database in the catalog in which the table resides.
table_name(Option<String>)
:The name of the table.
next_token(Option<String>)
:A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.
table_optimizer_runs(Option<Vec::<TableOptimizerRun>>)
:A list of the optimizer runs associated with a table.
- On failure, responds with
SdkError<ListTableOptimizerRunsError>
Source§impl Client
impl Client
Sourcepub fn list_triggers(&self) -> ListTriggersFluentBuilder
pub fn list_triggers(&self) -> ListTriggersFluentBuilder
Constructs a fluent builder for the ListTriggers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
dependent_job_name(impl Into<String>)
/set_dependent_job_name(Option<String>)
:
required: falseThe name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseSpecifies to return only these tagged resources.
- On success, responds with
ListTriggersOutput
with field(s):trigger_names(Option<Vec::<String>>)
:The names of all triggers in the account, or the triggers with the specified tags.
next_token(Option<String>)
:A continuation token, if the returned list does not contain the last metric available.
- On failure, responds with
SdkError<ListTriggersError>
Source§impl Client
impl Client
Sourcepub fn list_usage_profiles(&self) -> ListUsageProfilesFluentBuilder
pub fn list_usage_profiles(&self) -> ListUsageProfilesFluentBuilder
Constructs a fluent builder for the ListUsageProfiles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, included if this is a continuation call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of usage profiles to return in a single response.
- On success, responds with
ListUsageProfilesOutput
with field(s):profiles(Option<Vec::<UsageProfileDefinition>>)
:A list of usage profile (
UsageProfileDefinition
) objects.next_token(Option<String>)
:A continuation token, present if the current list segment is not the last.
- On failure, responds with
SdkError<ListUsageProfilesError>
Source§impl Client
impl Client
Sourcepub fn list_workflows(&self) -> ListWorkflowsFluentBuilder
pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder
Constructs a fluent builder for the ListWorkflows
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of a list to return.
- On success, responds with
ListWorkflowsOutput
with field(s):workflows(Option<Vec::<String>>)
:List of names of workflows in the account.
next_token(Option<String>)
:A continuation token, if not all workflow names have been returned.
- On failure, responds with
SdkError<ListWorkflowsError>
Source§impl Client
impl Client
Sourcepub fn modify_integration(&self) -> ModifyIntegrationFluentBuilder
pub fn modify_integration(&self) -> ModifyIntegrationFluentBuilder
Constructs a fluent builder for the ModifyIntegration
operation.
- The fluent builder is configurable:
integration_identifier(impl Into<String>)
/set_integration_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for the integration.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the integration.
data_filter(impl Into<String>)
/set_data_filter(Option<String>)
:
required: falseSelects source tables for the integration using Maxwell filter syntax.
integration_name(impl Into<String>)
/set_integration_name(Option<String>)
:
required: falseA unique name for an integration in Glue.
- On success, responds with
ModifyIntegrationOutput
with field(s):source_arn(String)
:The ARN of the source for the integration.
target_arn(String)
:The ARN of the target for the integration.
integration_name(String)
:A unique name for an integration in Glue.
description(Option<String>)
:A description of the integration.
integration_arn(String)
:The Amazon Resource Name (ARN) for the integration.
kms_key_id(Option<String>)
:The ARN of a KMS key used for encrypting the channel.
additional_encryption_context(Option<HashMap::<String, String>>)
:An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
tags(Option<Vec::<Tag>>)
:Metadata assigned to the resource consisting of a list of key-value pairs.
status(IntegrationStatus)
:The status of the integration being modified.
The possible statuses are:
-
CREATING: The integration is being created.
-
ACTIVE: The integration creation succeeds.
-
MODIFYING: The integration is being modified.
-
FAILED: The integration creation fails.
-
DELETING: The integration is deleted.
-
SYNCING: The integration is synchronizing.
-
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
-
create_time(DateTime)
:The time when the integration was created, in UTC.
errors(Option<Vec::<IntegrationError>>)
:A list of errors associated with the integration modification.
data_filter(Option<String>)
:Selects source tables for the integration using Maxwell filter syntax.
- On failure, responds with
SdkError<ModifyIntegrationError>
Source§impl Client
impl Client
Sourcepub fn put_data_catalog_encryption_settings(
&self,
) -> PutDataCatalogEncryptionSettingsFluentBuilder
pub fn put_data_catalog_encryption_settings( &self, ) -> PutDataCatalogEncryptionSettingsFluentBuilder
Constructs a fluent builder for the PutDataCatalogEncryptionSettings
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog to set the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
data_catalog_encryption_settings(DataCatalogEncryptionSettings)
/set_data_catalog_encryption_settings(Option<DataCatalogEncryptionSettings>)
:
required: trueThe security configuration to set.
- On success, responds with
PutDataCatalogEncryptionSettingsOutput
- On failure, responds with
SdkError<PutDataCatalogEncryptionSettingsError>
Source§impl Client
impl Client
Sourcepub fn put_data_quality_profile_annotation(
&self,
) -> PutDataQualityProfileAnnotationFluentBuilder
pub fn put_data_quality_profile_annotation( &self, ) -> PutDataQualityProfileAnnotationFluentBuilder
Constructs a fluent builder for the PutDataQualityProfileAnnotation
operation.
- The fluent builder is configurable:
profile_id(impl Into<String>)
/set_profile_id(Option<String>)
:
required: trueThe ID of the data quality monitoring profile to annotate.
inclusion_annotation(InclusionAnnotationValue)
/set_inclusion_annotation(Option<InclusionAnnotationValue>)
:
required: trueThe inclusion annotation value to apply to the profile.
- On success, responds with
PutDataQualityProfileAnnotationOutput
- On failure, responds with
SdkError<PutDataQualityProfileAnnotationError>
Source§impl Client
impl Client
Sourcepub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
Constructs a fluent builder for the PutResourcePolicy
operation.
- The fluent builder is configurable:
policy_in_json(impl Into<String>)
/set_policy_in_json(Option<String>)
:
required: trueContains the policy document to set, in JSON format.
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: falseDo not use. For internal use only.
policy_hash_condition(impl Into<String>)
/set_policy_hash_condition(Option<String>)
:
required: falseThe hash value returned when the previous policy was set using
PutResourcePolicy
. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.policy_exists_condition(ExistCondition)
/set_policy_exists_condition(Option<ExistCondition>)
:
required: falseA value of
MUST_EXIST
is used to update a policy. A value ofNOT_EXIST
is used to create a new policy. If a value ofNONE
or a null value is used, the call does not depend on the existence of a policy.enable_hybrid(EnableHybridValues)
/set_enable_hybrid(Option<EnableHybridValues>)
:
required: falseIf
‘TRUE’
, indicates that you are using both methods to grant cross-account access to Data Catalog resources:-
By directly updating the resource policy with
PutResourePolicy
-
By using the Grant permissions command on the Amazon Web Services Management Console.
Must be set to
‘TRUE’
if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is ‘FALSE’.-
- On success, responds with
PutResourcePolicyOutput
with field(s):policy_hash(Option<String>)
:A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
- On failure, responds with
SdkError<PutResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn put_schema_version_metadata(
&self,
) -> PutSchemaVersionMetadataFluentBuilder
pub fn put_schema_version_metadata( &self, ) -> PutSchemaVersionMetadataFluentBuilder
Constructs a fluent builder for the PutSchemaVersionMetadata
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: falseThe unique ID for the schema.
schema_version_number(SchemaVersionNumber)
/set_schema_version_number(Option<SchemaVersionNumber>)
:
required: falseThe version number of the schema.
schema_version_id(impl Into<String>)
/set_schema_version_id(Option<String>)
:
required: falseThe unique version ID of the schema version.
metadata_key_value(MetadataKeyValuePair)
/set_metadata_key_value(Option<MetadataKeyValuePair>)
:
required: trueThe metadata key’s corresponding value.
- On success, responds with
PutSchemaVersionMetadataOutput
with field(s):schema_arn(Option<String>)
:The Amazon Resource Name (ARN) for the schema.
schema_name(Option<String>)
:The name for the schema.
registry_name(Option<String>)
:The name for the registry.
latest_version(bool)
:The latest version of the schema.
version_number(Option<i64>)
:The version number of the schema.
schema_version_id(Option<String>)
:The unique version ID of the schema version.
metadata_key(Option<String>)
:The metadata key.
metadata_value(Option<String>)
:The value of the metadata key.
- On failure, responds with
SdkError<PutSchemaVersionMetadataError>
Source§impl Client
impl Client
Sourcepub fn put_workflow_run_properties(
&self,
) -> PutWorkflowRunPropertiesFluentBuilder
pub fn put_workflow_run_properties( &self, ) -> PutWorkflowRunPropertiesFluentBuilder
Constructs a fluent builder for the PutWorkflowRunProperties
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the workflow which was run.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe ID of the workflow run for which the run properties should be updated.
run_properties(impl Into<String>, impl Into<String>)
/set_run_properties(Option<HashMap::<String, String>>)
:
required: trueThe properties to put for the specified run.
Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
- On success, responds with
PutWorkflowRunPropertiesOutput
- On failure, responds with
SdkError<PutWorkflowRunPropertiesError>
Source§impl Client
impl Client
Sourcepub fn query_schema_version_metadata(
&self,
) -> QuerySchemaVersionMetadataFluentBuilder
pub fn query_schema_version_metadata( &self, ) -> QuerySchemaVersionMetadataFluentBuilder
Constructs a fluent builder for the QuerySchemaVersionMetadata
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: falseA wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
schema_version_number(SchemaVersionNumber)
/set_schema_version_number(Option<SchemaVersionNumber>)
:
required: falseThe version number of the schema.
schema_version_id(impl Into<String>)
/set_schema_version_id(Option<String>)
:
required: falseThe unique version ID of the schema version.
metadata_list(MetadataKeyValuePair)
/set_metadata_list(Option<Vec::<MetadataKeyValuePair>>)
:
required: falseSearch key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, if this is a continuation call.
- On success, responds with
QuerySchemaVersionMetadataOutput
with field(s):metadata_info_map(Option<HashMap::<String, MetadataInfo>>)
:A map of a metadata key and associated values.
schema_version_id(Option<String>)
:The unique version ID of the schema version.
next_token(Option<String>)
:A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- On failure, responds with
SdkError<QuerySchemaVersionMetadataError>
Source§impl Client
impl Client
Sourcepub fn register_schema_version(&self) -> RegisterSchemaVersionFluentBuilder
pub fn register_schema_version(&self) -> RegisterSchemaVersionFluentBuilder
Constructs a fluent builder for the RegisterSchemaVersion
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
-
schema_definition(impl Into<String>)
/set_schema_definition(Option<String>)
:
required: trueThe schema definition using the
DataFormat
setting for theSchemaName
.
- On success, responds with
RegisterSchemaVersionOutput
with field(s):schema_version_id(Option<String>)
:The unique ID that represents the version of this schema.
version_number(Option<i64>)
:The version of this schema (for sync flow only, in case this is the first version).
status(Option<SchemaVersionStatus>)
:The status of the schema version.
- On failure, responds with
SdkError<RegisterSchemaVersionError>
Source§impl Client
impl Client
Sourcepub fn remove_schema_version_metadata(
&self,
) -> RemoveSchemaVersionMetadataFluentBuilder
pub fn remove_schema_version_metadata( &self, ) -> RemoveSchemaVersionMetadataFluentBuilder
Constructs a fluent builder for the RemoveSchemaVersionMetadata
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: falseA wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
schema_version_number(SchemaVersionNumber)
/set_schema_version_number(Option<SchemaVersionNumber>)
:
required: falseThe version number of the schema.
schema_version_id(impl Into<String>)
/set_schema_version_id(Option<String>)
:
required: falseThe unique version ID of the schema version.
metadata_key_value(MetadataKeyValuePair)
/set_metadata_key_value(Option<MetadataKeyValuePair>)
:
required: trueThe value of the metadata key.
- On success, responds with
RemoveSchemaVersionMetadataOutput
with field(s):schema_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schema.
schema_name(Option<String>)
:The name of the schema.
registry_name(Option<String>)
:The name of the registry.
latest_version(bool)
:The latest version of the schema.
version_number(Option<i64>)
:The version number of the schema.
schema_version_id(Option<String>)
:The version ID for the schema version.
metadata_key(Option<String>)
:The metadata key.
metadata_value(Option<String>)
:The value of the metadata key.
- On failure, responds with
SdkError<RemoveSchemaVersionMetadataError>
Source§impl Client
impl Client
Sourcepub fn reset_job_bookmark(&self) -> ResetJobBookmarkFluentBuilder
pub fn reset_job_bookmark(&self) -> ResetJobBookmarkFluentBuilder
Constructs a fluent builder for the ResetJobBookmark
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job in question.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: falseThe unique run identifier associated with this job run.
- On success, responds with
ResetJobBookmarkOutput
with field(s):job_bookmark_entry(Option<JobBookmarkEntry>)
:The reset bookmark entry.
- On failure, responds with
SdkError<ResetJobBookmarkError>
Source§impl Client
impl Client
Sourcepub fn resume_workflow_run(&self) -> ResumeWorkflowRunFluentBuilder
pub fn resume_workflow_run(&self) -> ResumeWorkflowRunFluentBuilder
Constructs a fluent builder for the ResumeWorkflowRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the workflow to resume.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe ID of the workflow run to resume.
node_ids(impl Into<String>)
/set_node_ids(Option<Vec::<String>>)
:
required: trueA list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
- On success, responds with
ResumeWorkflowRunOutput
with field(s):run_id(Option<String>)
:The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
node_ids(Option<Vec::<String>>)
:A list of the node IDs for the nodes that were actually restarted.
- On failure, responds with
SdkError<ResumeWorkflowRunError>
Source§impl Client
impl Client
Sourcepub fn run_statement(&self) -> RunStatementFluentBuilder
pub fn run_statement(&self) -> RunStatementFluentBuilder
Constructs a fluent builder for the RunStatement
operation.
- The fluent builder is configurable:
session_id(impl Into<String>)
/set_session_id(Option<String>)
:
required: trueThe Session Id of the statement to be run.
code(impl Into<String>)
/set_code(Option<String>)
:
required: trueThe statement code to be run.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request.
- On success, responds with
RunStatementOutput
with field(s):id(i32)
:Returns the Id of the statement that was run.
- On failure, responds with
SdkError<RunStatementError>
Source§impl Client
impl Client
Sourcepub fn search_tables(&self) -> SearchTablesFluentBuilder
pub fn search_tables(&self) -> SearchTablesFluentBuilder
Constructs a fluent builder for the SearchTables
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseA unique identifier, consisting of
account_id
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA continuation token, included if this is a continuation call.
filters(PropertyPredicate)
/set_filters(Option<Vec::<PropertyPredicate>>)
:
required: falseA list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The
Comparator
member of thePropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as whenKey=Name
, a fuzzy match algorithm is used. TheKey
field (for example, the value of theName
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with theValue
member ofPropertyPredicate
. For example, ifKey=Name
andValue=link
, tables namedcustomer-link
andxx-link-yy
are returned, butxxlinkyy
is not returned.search_text(impl Into<String>)
/set_search_text(Option<String>)
:
required: falseA string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
sort_criteria(SortCriterion)
/set_sort_criteria(Option<Vec::<SortCriterion>>)
:
required: falseA list of criteria for sorting the results by a field name, in an ascending or descending order.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of tables to return in a single response.
resource_share_type(ResourceShareType)
/set_resource_share_type(Option<ResourceShareType>)
:
required: falseAllows you to specify that you want to search the tables shared with your account. The allowable values are
FOREIGN
orALL
.-
If set to
FOREIGN
, will search the tables shared with your account. -
If set to
ALL
, will search the tables shared with your account, as well as the tables in yor local account.
-
include_status_details(bool)
/set_include_status_details(Option<bool>)
:
required: falseSpecifies whether to include status details related to a request to create or update an Glue Data Catalog view.
- On success, responds with
SearchTablesOutput
with field(s):next_token(Option<String>)
:A continuation token, present if the current list segment is not the last.
table_list(Option<Vec::<Table>>)
:A list of the requested
Table
objects. TheSearchTables
response returns only the tables that you have access to.
- On failure, responds with
SdkError<SearchTablesError>
Source§impl Client
impl Client
Sourcepub fn start_blueprint_run(&self) -> StartBlueprintRunFluentBuilder
pub fn start_blueprint_run(&self) -> StartBlueprintRunFluentBuilder
Constructs a fluent builder for the StartBlueprintRun
operation.
- The fluent builder is configurable:
blueprint_name(impl Into<String>)
/set_blueprint_name(Option<String>)
:
required: trueThe name of the blueprint.
parameters(impl Into<String>)
/set_parameters(Option<String>)
:
required: falseSpecifies the parameters as a
BlueprintParameters
object.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueSpecifies the IAM role used to create the workflow.
- On success, responds with
StartBlueprintRunOutput
with field(s):run_id(Option<String>)
:The run ID for this blueprint run.
- On failure, responds with
SdkError<StartBlueprintRunError>
Source§impl Client
impl Client
Sourcepub fn start_column_statistics_task_run(
&self,
) -> StartColumnStatisticsTaskRunFluentBuilder
pub fn start_column_statistics_task_run( &self, ) -> StartColumnStatisticsTaskRunFluentBuilder
Constructs a fluent builder for the StartColumnStatisticsTaskRun
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table to generate statistics.
column_name_list(impl Into<String>)
/set_column_name_list(Option<Vec::<String>>)
:
required: falseA list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueThe IAM role that the service assumes to generate statistics.
sample_size(f64)
/set_sample_size(Option<f64>)
:
required: falseThe percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseName of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
- On success, responds with
StartColumnStatisticsTaskRunOutput
with field(s):column_statistics_task_run_id(Option<String>)
:The identifier for the column statistics task run.
- On failure, responds with
SdkError<StartColumnStatisticsTaskRunError>
Source§impl Client
impl Client
Sourcepub fn start_column_statistics_task_run_schedule(
&self,
) -> StartColumnStatisticsTaskRunScheduleFluentBuilder
pub fn start_column_statistics_task_run_schedule( &self, ) -> StartColumnStatisticsTaskRunScheduleFluentBuilder
Constructs a fluent builder for the StartColumnStatisticsTaskRunSchedule
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table for which to start a column statistic task run schedule.
- On success, responds with
StartColumnStatisticsTaskRunScheduleOutput
- On failure, responds with
SdkError<StartColumnStatisticsTaskRunScheduleError>
Source§impl Client
impl Client
Sourcepub fn start_crawler(&self) -> StartCrawlerFluentBuilder
pub fn start_crawler(&self) -> StartCrawlerFluentBuilder
Constructs a fluent builder for the StartCrawler
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the crawler to start.
- On success, responds with
StartCrawlerOutput
- On failure, responds with
SdkError<StartCrawlerError>
Source§impl Client
impl Client
Sourcepub fn start_crawler_schedule(&self) -> StartCrawlerScheduleFluentBuilder
pub fn start_crawler_schedule(&self) -> StartCrawlerScheduleFluentBuilder
Constructs a fluent builder for the StartCrawlerSchedule
operation.
- The fluent builder is configurable:
crawler_name(impl Into<String>)
/set_crawler_name(Option<String>)
:
required: trueName of the crawler to schedule.
- On success, responds with
StartCrawlerScheduleOutput
- On failure, responds with
SdkError<StartCrawlerScheduleError>
Source§impl Client
impl Client
Sourcepub fn start_data_quality_rule_recommendation_run(
&self,
) -> StartDataQualityRuleRecommendationRunFluentBuilder
pub fn start_data_quality_rule_recommendation_run( &self, ) -> StartDataQualityRuleRecommendationRunFluentBuilder
Constructs a fluent builder for the StartDataQualityRuleRecommendationRun
operation.
- The fluent builder is configurable:
data_source(DataSource)
/set_data_source(Option<DataSource>)
:
required: trueThe data source (Glue table) associated with this run.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueAn IAM role supplied to encrypt the results of the run.
number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of
G.1X
workers to be used in the run. The default is 5.timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).created_ruleset_name(impl Into<String>)
/set_created_ruleset_name(Option<String>)
:
required: falseA name for the ruleset.
data_quality_security_configuration(impl Into<String>)
/set_data_quality_security_configuration(Option<String>)
:
required: falseThe name of the security configuration created with the data quality encryption option.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseUsed for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
- On success, responds with
StartDataQualityRuleRecommendationRunOutput
with field(s):run_id(Option<String>)
:The unique run identifier associated with this run.
- On failure, responds with
SdkError<StartDataQualityRuleRecommendationRunError>
Source§impl Client
impl Client
Sourcepub fn start_data_quality_ruleset_evaluation_run(
&self,
) -> StartDataQualityRulesetEvaluationRunFluentBuilder
pub fn start_data_quality_ruleset_evaluation_run( &self, ) -> StartDataQualityRulesetEvaluationRunFluentBuilder
Constructs a fluent builder for the StartDataQualityRulesetEvaluationRun
operation.
- The fluent builder is configurable:
data_source(DataSource)
/set_data_source(Option<DataSource>)
:
required: trueThe data source (Glue table) associated with this run.
role(impl Into<String>)
/set_role(Option<String>)
:
required: trueAn IAM role supplied to encrypt the results of the run.
number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of
G.1X
workers to be used in the run. The default is 5.timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseUsed for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
additional_run_options(DataQualityEvaluationRunAdditionalRunOptions)
/set_additional_run_options(Option<DataQualityEvaluationRunAdditionalRunOptions>)
:
required: falseAdditional run options you can specify for an evaluation run.
ruleset_names(impl Into<String>)
/set_ruleset_names(Option<Vec::<String>>)
:
required: trueA list of ruleset names.
additional_data_sources(impl Into<String>, DataSource)
/set_additional_data_sources(Option<HashMap::<String, DataSource>>)
:
required: falseA map of reference strings to additional data sources you can specify for an evaluation run.
- On success, responds with
StartDataQualityRulesetEvaluationRunOutput
with field(s):run_id(Option<String>)
:The unique run identifier associated with this run.
- On failure, responds with
SdkError<StartDataQualityRulesetEvaluationRunError>
Source§impl Client
impl Client
Sourcepub fn start_export_labels_task_run(
&self,
) -> StartExportLabelsTaskRunFluentBuilder
pub fn start_export_labels_task_run( &self, ) -> StartExportLabelsTaskRunFluentBuilder
Constructs a fluent builder for the StartExportLabelsTaskRun
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the machine learning transform.
output_s3_path(impl Into<String>)
/set_output_s3_path(Option<String>)
:
required: trueThe Amazon S3 path where you export the labels.
- On success, responds with
StartExportLabelsTaskRunOutput
with field(s):task_run_id(Option<String>)
:The unique identifier for the task run.
- On failure, responds with
SdkError<StartExportLabelsTaskRunError>
Source§impl Client
impl Client
Sourcepub fn start_import_labels_task_run(
&self,
) -> StartImportLabelsTaskRunFluentBuilder
pub fn start_import_labels_task_run( &self, ) -> StartImportLabelsTaskRunFluentBuilder
Constructs a fluent builder for the StartImportLabelsTaskRun
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the machine learning transform.
input_s3_path(impl Into<String>)
/set_input_s3_path(Option<String>)
:
required: trueThe Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
replace_all_labels(bool)
/set_replace_all_labels(Option<bool>)
:
required: falseIndicates whether to overwrite your existing labels.
- On success, responds with
StartImportLabelsTaskRunOutput
with field(s):task_run_id(Option<String>)
:The unique identifier for the task run.
- On failure, responds with
SdkError<StartImportLabelsTaskRunError>
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:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job definition to use.
job_run_queuing_enabled(bool)
/set_job_run_queuing_enabled(Option<bool>)
:
required: falseSpecifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
job_run_id(impl Into<String>)
/set_job_run_id(Option<String>)
:
required: falseThe ID of a previous
JobRun
to retry.arguments(impl Into<String>, impl Into<String>)
/set_arguments(Option<HashMap::<String, String>>)
:
required: falseThe job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
allocated_capacity(i32)
/set_allocated_capacity(Option<i32>)
:
required: falseThis field is deprecated. Use
MaxCapacity
instead.The number of Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe
JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
When the value is left blank, the timeout is defaulted to 2880 minutes.
Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
max_capacity(f64)
/set_max_capacity(Option<f64>)
:
required: falseFor Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:-
When you specify a Python shell job (
JobCommand.Name
=“pythonshell”), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. -
When you specify an Apache Spark ETL job (
JobCommand.Name
=“glueetl”) or Apache Spark streaming ETL job (JobCommand.Name
=“gluestreaming”), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
-
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseThe name of the
SecurityConfiguration
structure to be used with this job run.notification_property(NotificationProperty)
/set_notification_property(Option<NotificationProperty>)
:
required: falseSpecifies configuration properties of a job run notification.
worker_type(WorkerType)
/set_worker_type(Option<WorkerType>)
:
required: falseThe type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
-
number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of workers of a defined
workerType
that are allocated when a job runs.execution_class(ExecutionClass)
/set_execution_class(Option<ExecutionClass>)
:
required: falseIndicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs.
- On success, responds with
StartJobRunOutput
with field(s):job_run_id(Option<String>)
:The ID assigned to this job run.
- On failure, responds with
SdkError<StartJobRunError>
Source§impl Client
impl Client
Sourcepub fn start_ml_evaluation_task_run(
&self,
) -> StartMLEvaluationTaskRunFluentBuilder
pub fn start_ml_evaluation_task_run( &self, ) -> StartMLEvaluationTaskRunFluentBuilder
Constructs a fluent builder for the StartMLEvaluationTaskRun
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the machine learning transform.
- On success, responds with
StartMlEvaluationTaskRunOutput
with field(s):task_run_id(Option<String>)
:The unique identifier associated with this run.
- On failure, responds with
SdkError<StartMLEvaluationTaskRunError>
Source§impl Client
impl Client
Sourcepub fn start_ml_labeling_set_generation_task_run(
&self,
) -> StartMLLabelingSetGenerationTaskRunFluentBuilder
pub fn start_ml_labeling_set_generation_task_run( &self, ) -> StartMLLabelingSetGenerationTaskRunFluentBuilder
Constructs a fluent builder for the StartMLLabelingSetGenerationTaskRun
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueThe unique identifier of the machine learning transform.
output_s3_path(impl Into<String>)
/set_output_s3_path(Option<String>)
:
required: trueThe Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
- On success, responds with
StartMlLabelingSetGenerationTaskRunOutput
with field(s):task_run_id(Option<String>)
:The unique run identifier that is associated with this task run.
- On failure, responds with
SdkError<StartMLLabelingSetGenerationTaskRunError>
Source§impl Client
impl Client
Sourcepub fn start_trigger(&self) -> StartTriggerFluentBuilder
pub fn start_trigger(&self) -> StartTriggerFluentBuilder
Constructs a fluent builder for the StartTrigger
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the trigger to start.
- On success, responds with
StartTriggerOutput
with field(s):name(Option<String>)
:The name of the trigger that was started.
- On failure, responds with
SdkError<StartTriggerError>
Source§impl Client
impl Client
Sourcepub fn start_workflow_run(&self) -> StartWorkflowRunFluentBuilder
pub fn start_workflow_run(&self) -> StartWorkflowRunFluentBuilder
Constructs a fluent builder for the StartWorkflowRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the workflow to start.
run_properties(impl Into<String>, impl Into<String>)
/set_run_properties(Option<HashMap::<String, String>>)
:
required: falseThe workflow run properties for the new workflow run.
Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
- On success, responds with
StartWorkflowRunOutput
with field(s):run_id(Option<String>)
:An Id for the new run.
- On failure, responds with
SdkError<StartWorkflowRunError>
Source§impl Client
impl Client
Sourcepub fn stop_column_statistics_task_run(
&self,
) -> StopColumnStatisticsTaskRunFluentBuilder
pub fn stop_column_statistics_task_run( &self, ) -> StopColumnStatisticsTaskRunFluentBuilder
Constructs a fluent builder for the StopColumnStatisticsTaskRun
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table.
- On success, responds with
StopColumnStatisticsTaskRunOutput
- On failure, responds with
SdkError<StopColumnStatisticsTaskRunError>
Source§impl Client
impl Client
Sourcepub fn stop_column_statistics_task_run_schedule(
&self,
) -> StopColumnStatisticsTaskRunScheduleFluentBuilder
pub fn stop_column_statistics_task_run_schedule( &self, ) -> StopColumnStatisticsTaskRunScheduleFluentBuilder
Constructs a fluent builder for the StopColumnStatisticsTaskRunSchedule
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table for which to stop a column statistic task run schedule.
- On success, responds with
StopColumnStatisticsTaskRunScheduleOutput
- On failure, responds with
SdkError<StopColumnStatisticsTaskRunScheduleError>
Source§impl Client
impl Client
Sourcepub fn stop_crawler(&self) -> StopCrawlerFluentBuilder
pub fn stop_crawler(&self) -> StopCrawlerFluentBuilder
Constructs a fluent builder for the StopCrawler
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the crawler to stop.
- On success, responds with
StopCrawlerOutput
- On failure, responds with
SdkError<StopCrawlerError>
Source§impl Client
impl Client
Sourcepub fn stop_crawler_schedule(&self) -> StopCrawlerScheduleFluentBuilder
pub fn stop_crawler_schedule(&self) -> StopCrawlerScheduleFluentBuilder
Constructs a fluent builder for the StopCrawlerSchedule
operation.
- The fluent builder is configurable:
crawler_name(impl Into<String>)
/set_crawler_name(Option<String>)
:
required: trueName of the crawler whose schedule state to set.
- On success, responds with
StopCrawlerScheduleOutput
- On failure, responds with
SdkError<StopCrawlerScheduleError>
Source§impl Client
impl Client
Sourcepub fn stop_session(&self) -> StopSessionFluentBuilder
pub fn stop_session(&self) -> StopSessionFluentBuilder
Constructs a fluent builder for the StopSession
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the session to be stopped.
request_origin(impl Into<String>)
/set_request_origin(Option<String>)
:
required: falseThe origin of the request.
- On success, responds with
StopSessionOutput
with field(s):id(Option<String>)
:Returns the Id of the stopped session.
- On failure, responds with
SdkError<StopSessionError>
Source§impl Client
impl Client
Sourcepub fn stop_trigger(&self) -> StopTriggerFluentBuilder
pub fn stop_trigger(&self) -> StopTriggerFluentBuilder
Constructs a fluent builder for the StopTrigger
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the trigger to stop.
- On success, responds with
StopTriggerOutput
with field(s):name(Option<String>)
:The name of the trigger that was stopped.
- On failure, responds with
SdkError<StopTriggerError>
Source§impl Client
impl Client
Sourcepub fn stop_workflow_run(&self) -> StopWorkflowRunFluentBuilder
pub fn stop_workflow_run(&self) -> StopWorkflowRunFluentBuilder
Constructs a fluent builder for the StopWorkflowRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the workflow to stop.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: trueThe ID of the workflow run to stop.
- On success, responds with
StopWorkflowRunOutput
- On failure, responds with
SdkError<StopWorkflowRunError>
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 ARN of the Glue resource to which to add the tags. For more information about Glue resource ARNs, see the Glue ARN string pattern.
tags_to_add(impl Into<String>, impl Into<String>)
/set_tags_to_add(Option<HashMap::<String, String>>)
:
required: trueTags to add to this resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn test_connection(&self) -> TestConnectionFluentBuilder
pub fn test_connection(&self) -> TestConnectionFluentBuilder
Constructs a fluent builder for the TestConnection
operation.
- The fluent builder is configurable:
connection_name(impl Into<String>)
/set_connection_name(Option<String>)
:
required: falseOptional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe catalog ID where the connection resides.
test_connection_input(TestConnectionInput)
/set_test_connection_input(Option<TestConnectionInput>)
:
required: falseA structure that is used to specify testing a connection to a service.
- On success, responds with
TestConnectionOutput
- On failure, responds with
SdkError<TestConnectionError>
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: trueThe Amazon Resource Name (ARN) of the resource from which to remove the tags.
tags_to_remove(impl Into<String>)
/set_tags_to_remove(Option<Vec::<String>>)
:
required: trueTags to remove from this resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_blueprint(&self) -> UpdateBlueprintFluentBuilder
pub fn update_blueprint(&self) -> UpdateBlueprintFluentBuilder
Constructs a fluent builder for the UpdateBlueprint
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the blueprint.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the blueprint.
blueprint_location(impl Into<String>)
/set_blueprint_location(Option<String>)
:
required: trueSpecifies a path in Amazon S3 where the blueprint is published.
- On success, responds with
UpdateBlueprintOutput
with field(s):name(Option<String>)
:Returns the name of the blueprint that was updated.
- On failure, responds with
SdkError<UpdateBlueprintError>
Source§impl Client
impl Client
Sourcepub fn update_catalog(&self) -> UpdateCatalogFluentBuilder
pub fn update_catalog(&self) -> UpdateCatalogFluentBuilder
Constructs a fluent builder for the UpdateCatalog
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe ID of the catalog.
catalog_input(CatalogInput)
/set_catalog_input(Option<CatalogInput>)
:
required: trueA
CatalogInput
object specifying the new properties of an existing catalog.
- On success, responds with
UpdateCatalogOutput
- On failure, responds with
SdkError<UpdateCatalogError>
Source§impl Client
impl Client
Sourcepub fn update_classifier(&self) -> UpdateClassifierFluentBuilder
pub fn update_classifier(&self) -> UpdateClassifierFluentBuilder
Constructs a fluent builder for the UpdateClassifier
operation.
- The fluent builder is configurable:
grok_classifier(UpdateGrokClassifierRequest)
/set_grok_classifier(Option<UpdateGrokClassifierRequest>)
:
required: falseA
GrokClassifier
object with updated fields.xml_classifier(UpdateXmlClassifierRequest)
/set_xml_classifier(Option<UpdateXmlClassifierRequest>)
:
required: falseAn
XMLClassifier
object with updated fields.json_classifier(UpdateJsonClassifierRequest)
/set_json_classifier(Option<UpdateJsonClassifierRequest>)
:
required: falseA
JsonClassifier
object with updated fields.csv_classifier(UpdateCsvClassifierRequest)
/set_csv_classifier(Option<UpdateCsvClassifierRequest>)
:
required: falseA
CsvClassifier
object with updated fields.
- On success, responds with
UpdateClassifierOutput
- On failure, responds with
SdkError<UpdateClassifierError>
Source§impl Client
impl Client
Sourcepub fn update_column_statistics_for_partition(
&self,
) -> UpdateColumnStatisticsForPartitionFluentBuilder
pub fn update_column_statistics_for_partition( &self, ) -> UpdateColumnStatisticsForPartitionFluentBuilder
Constructs a fluent builder for the UpdateColumnStatisticsForPartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
partition_values(impl Into<String>)
/set_partition_values(Option<Vec::<String>>)
:
required: trueA list of partition values identifying the partition.
column_statistics_list(ColumnStatistics)
/set_column_statistics_list(Option<Vec::<ColumnStatistics>>)
:
required: trueA list of the column statistics.
- On success, responds with
UpdateColumnStatisticsForPartitionOutput
with field(s):errors(Option<Vec::<ColumnStatisticsError>>)
:Error occurred during updating column statistics data.
- On failure, responds with
SdkError<UpdateColumnStatisticsForPartitionError>
Source§impl Client
impl Client
Sourcepub fn update_column_statistics_for_table(
&self,
) -> UpdateColumnStatisticsForTableFluentBuilder
pub fn update_column_statistics_for_table( &self, ) -> UpdateColumnStatisticsForTableFluentBuilder
Constructs a fluent builder for the UpdateColumnStatisticsForTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the partitions reside.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the partitions’ table.
column_statistics_list(ColumnStatistics)
/set_column_statistics_list(Option<Vec::<ColumnStatistics>>)
:
required: trueA list of the column statistics.
- On success, responds with
UpdateColumnStatisticsForTableOutput
with field(s):errors(Option<Vec::<ColumnStatisticsError>>)
:List of ColumnStatisticsErrors.
- On failure, responds with
SdkError<UpdateColumnStatisticsForTableError>
Source§impl Client
impl Client
Sourcepub fn update_column_statistics_task_settings(
&self,
) -> UpdateColumnStatisticsTaskSettingsFluentBuilder
pub fn update_column_statistics_task_settings( &self, ) -> UpdateColumnStatisticsTaskSettingsFluentBuilder
Constructs a fluent builder for the UpdateColumnStatisticsTaskSettings
operation.
- The fluent builder is configurable:
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table for which to generate column statistics.
role(impl Into<String>)
/set_role(Option<String>)
:
required: falseThe role used for running the column statistics.
schedule(impl Into<String>)
/set_schedule(Option<String>)
:
required: falseA schedule for running the column statistics, specified in CRON syntax.
column_name_list(impl Into<String>)
/set_column_name_list(Option<Vec::<String>>)
:
required: falseA list of column names for which to run statistics.
sample_size(f64)
/set_sample_size(Option<f64>)
:
required: falseThe percentage of data to sample.
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the database resides.
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseName of the security configuration that is used to encrypt CloudWatch logs.
- On success, responds with
UpdateColumnStatisticsTaskSettingsOutput
- On failure, responds with
SdkError<UpdateColumnStatisticsTaskSettingsError>
Source§impl Client
impl Client
Sourcepub fn update_connection(&self) -> UpdateConnectionFluentBuilder
pub fn update_connection(&self) -> UpdateConnectionFluentBuilder
Constructs a fluent builder for the UpdateConnection
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the connection definition to update.
connection_input(ConnectionInput)
/set_connection_input(Option<ConnectionInput>)
:
required: trueA
ConnectionInput
object that redefines the connection in question.
- On success, responds with
UpdateConnectionOutput
- On failure, responds with
SdkError<UpdateConnectionError>
Source§impl Client
impl Client
Sourcepub fn update_crawler(&self) -> UpdateCrawlerFluentBuilder
pub fn update_crawler(&self) -> UpdateCrawlerFluentBuilder
Constructs a fluent builder for the UpdateCrawler
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the new crawler.
role(impl Into<String>)
/set_role(Option<String>)
:
required: falseThe IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: falseThe Glue database where results are stored, such as:
arn:aws:daylight:us-east-1::database/sometable/*
.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the new crawler.
targets(CrawlerTargets)
/set_targets(Option<CrawlerTargets>)
:
required: falseA list of targets to crawl.
schedule(impl Into<String>)
/set_schedule(Option<String>)
:
required: falseA
cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:cron(15 12 * * ? *)
.classifiers(impl Into<String>)
/set_classifiers(Option<Vec::<String>>)
:
required: falseA list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
table_prefix(impl Into<String>)
/set_table_prefix(Option<String>)
:
required: falseThe table prefix used for catalog tables that are created.
schema_change_policy(SchemaChangePolicy)
/set_schema_change_policy(Option<SchemaChangePolicy>)
:
required: falseThe policy for the crawler’s update and deletion behavior.
recrawl_policy(RecrawlPolicy)
/set_recrawl_policy(Option<RecrawlPolicy>)
:
required: falseA policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
lineage_configuration(LineageConfiguration)
/set_lineage_configuration(Option<LineageConfiguration>)
:
required: falseSpecifies data lineage configuration settings for the crawler.
lake_formation_configuration(LakeFormationConfiguration)
/set_lake_formation_configuration(Option<LakeFormationConfiguration>)
:
required: falseSpecifies Lake Formation configuration settings for the crawler.
configuration(impl Into<String>)
/set_configuration(Option<String>)
:
required: falseCrawler configuration information. This versioned JSON string allows users to specify aspects of a crawler’s behavior. For more information, see Setting crawler configuration options.
crawler_security_configuration(impl Into<String>)
/set_crawler_security_configuration(Option<String>)
:
required: falseThe name of the
SecurityConfiguration
structure to be used by this crawler.
- On success, responds with
UpdateCrawlerOutput
- On failure, responds with
SdkError<UpdateCrawlerError>
Source§impl Client
impl Client
Sourcepub fn update_crawler_schedule(&self) -> UpdateCrawlerScheduleFluentBuilder
pub fn update_crawler_schedule(&self) -> UpdateCrawlerScheduleFluentBuilder
Constructs a fluent builder for the UpdateCrawlerSchedule
operation.
- The fluent builder is configurable:
crawler_name(impl Into<String>)
/set_crawler_name(Option<String>)
:
required: trueThe name of the crawler whose schedule to update.
schedule(impl Into<String>)
/set_schedule(Option<String>)
:
required: falseThe updated
cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:cron(15 12 * * ? *)
.
- On success, responds with
UpdateCrawlerScheduleOutput
- On failure, responds with
SdkError<UpdateCrawlerScheduleError>
Source§impl Client
impl Client
Sourcepub fn update_data_quality_ruleset(
&self,
) -> UpdateDataQualityRulesetFluentBuilder
pub fn update_data_quality_ruleset( &self, ) -> UpdateDataQualityRulesetFluentBuilder
Constructs a fluent builder for the UpdateDataQualityRuleset
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the data quality ruleset.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the ruleset.
ruleset(impl Into<String>)
/set_ruleset(Option<String>)
:
required: falseA Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
- On success, responds with
UpdateDataQualityRulesetOutput
with field(s):name(Option<String>)
:The name of the data quality ruleset.
description(Option<String>)
:A description of the ruleset.
ruleset(Option<String>)
:A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
- On failure, responds with
SdkError<UpdateDataQualityRulesetError>
Source§impl Client
impl Client
Sourcepub fn update_database(&self) -> UpdateDatabaseFluentBuilder
pub fn update_database(&self) -> UpdateDatabaseFluentBuilder
Constructs a fluent builder for the UpdateDatabase
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
database_input(DatabaseInput)
/set_database_input(Option<DatabaseInput>)
:
required: trueA
DatabaseInput
object specifying the new definition of the metadata database in the catalog.
- On success, responds with
UpdateDatabaseOutput
- On failure, responds with
SdkError<UpdateDatabaseError>
Source§impl Client
impl Client
Sourcepub fn update_dev_endpoint(&self) -> UpdateDevEndpointFluentBuilder
pub fn update_dev_endpoint(&self) -> UpdateDevEndpointFluentBuilder
Constructs a fluent builder for the UpdateDevEndpoint
operation.
- The fluent builder is configurable:
endpoint_name(impl Into<String>)
/set_endpoint_name(Option<String>)
:
required: trueThe name of the
DevEndpoint
to be updated.public_key(impl Into<String>)
/set_public_key(Option<String>)
:
required: falseThe public key for the
DevEndpoint
to use.add_public_keys(impl Into<String>)
/set_add_public_keys(Option<Vec::<String>>)
:
required: falseThe list of public keys for the
DevEndpoint
to use.delete_public_keys(impl Into<String>)
/set_delete_public_keys(Option<Vec::<String>>)
:
required: falseThe list of public keys to be deleted from the
DevEndpoint
.custom_libraries(DevEndpointCustomLibraries)
/set_custom_libraries(Option<DevEndpointCustomLibraries>)
:
required: falseCustom Python or Java libraries to be loaded in the
DevEndpoint
.update_etl_libraries(bool)
/set_update_etl_libraries(Option<bool>)
:
required: falseTrue
if the list of custom libraries to be loaded in the development endpoint needs to be updated, orFalse
if otherwise.delete_arguments(impl Into<String>)
/set_delete_arguments(Option<Vec::<String>>)
:
required: falseThe list of argument keys to be deleted from the map of arguments used to configure the
DevEndpoint
.add_arguments(impl Into<String>, impl Into<String>)
/set_add_arguments(Option<HashMap::<String, String>>)
:
required: falseThe map of arguments to add the map of arguments used to configure the
DevEndpoint
.Valid arguments are:
-
“–enable-glue-datacatalog”: “”
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.-
- On success, responds with
UpdateDevEndpointOutput
- On failure, responds with
SdkError<UpdateDevEndpointError>
Source§impl Client
impl Client
Sourcepub fn update_integration_resource_property(
&self,
) -> UpdateIntegrationResourcePropertyFluentBuilder
pub fn update_integration_resource_property( &self, ) -> UpdateIntegrationResourcePropertyFluentBuilder
Constructs a fluent builder for the UpdateIntegrationResourceProperty
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe connection ARN of the source, or the database ARN of the target.
source_processing_properties(SourceProcessingProperties)
/set_source_processing_properties(Option<SourceProcessingProperties>)
:
required: falseThe resource properties associated with the integration source.
target_processing_properties(TargetProcessingProperties)
/set_target_processing_properties(Option<TargetProcessingProperties>)
:
required: falseThe resource properties associated with the integration target.
- On success, responds with
UpdateIntegrationResourcePropertyOutput
with field(s):resource_arn(Option<String>)
:The connection ARN of the source, or the database ARN of the target.
source_processing_properties(Option<SourceProcessingProperties>)
:The resource properties associated with the integration source.
target_processing_properties(Option<TargetProcessingProperties>)
:The resource properties associated with the integration target.
- On failure, responds with
SdkError<UpdateIntegrationResourcePropertyError>
Source§impl Client
impl Client
Sourcepub fn update_integration_table_properties(
&self,
) -> UpdateIntegrationTablePropertiesFluentBuilder
pub fn update_integration_table_properties( &self, ) -> UpdateIntegrationTablePropertiesFluentBuilder
Constructs a fluent builder for the UpdateIntegrationTableProperties
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe connection ARN of the source, or the database ARN of the target.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table to be replicated.
source_table_config(SourceTableConfig)
/set_source_table_config(Option<SourceTableConfig>)
:
required: falseA structure for the source table configuration.
target_table_config(TargetTableConfig)
/set_target_table_config(Option<TargetTableConfig>)
:
required: falseA structure for the target table configuration.
- On success, responds with
UpdateIntegrationTablePropertiesOutput
- On failure, responds with
SdkError<UpdateIntegrationTablePropertiesError>
Source§impl Client
impl Client
Sourcepub fn update_job(&self) -> UpdateJobFluentBuilder
pub fn update_job(&self) -> UpdateJobFluentBuilder
Constructs a fluent builder for the UpdateJob
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: trueThe name of the job definition to update.
job_update(JobUpdate)
/set_job_update(Option<JobUpdate>)
:
required: trueSpecifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.
- On success, responds with
UpdateJobOutput
with field(s):job_name(Option<String>)
:Returns the name of the updated job definition.
- On failure, responds with
SdkError<UpdateJobError>
Source§impl Client
impl Client
Sourcepub fn update_job_from_source_control(
&self,
) -> UpdateJobFromSourceControlFluentBuilder
pub fn update_job_from_source_control( &self, ) -> UpdateJobFromSourceControlFluentBuilder
Constructs a fluent builder for the UpdateJobFromSourceControl
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: falseThe name of the Glue job to be synchronized to or from the remote repository.
provider(SourceControlProvider)
/set_provider(Option<SourceControlProvider>)
:
required: falseThe provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: falseThe name of the remote repository that contains the job artifacts. For BitBucket providers,
RepositoryName
should includeWorkspaceName
. Use the format
./ repository_owner(impl Into<String>)
/set_repository_owner(Option<String>)
:
required: falseThe owner of the remote repository that contains the job artifacts.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: falseAn optional branch in the remote repository.
folder(impl Into<String>)
/set_folder(Option<String>)
:
required: falseAn optional folder in the remote repository.
commit_id(impl Into<String>)
/set_commit_id(Option<String>)
:
required: falseA commit ID for a commit in the remote repository.
auth_strategy(SourceControlAuthStrategy)
/set_auth_strategy(Option<SourceControlAuthStrategy>)
:
required: falseThe type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
auth_token(impl Into<String>)
/set_auth_token(Option<String>)
:
required: falseThe value of the authorization token.
- On success, responds with
UpdateJobFromSourceControlOutput
with field(s):job_name(Option<String>)
:The name of the Glue job.
- On failure, responds with
SdkError<UpdateJobFromSourceControlError>
Source§impl Client
impl Client
Sourcepub fn update_ml_transform(&self) -> UpdateMLTransformFluentBuilder
pub fn update_ml_transform(&self) -> UpdateMLTransformFluentBuilder
Constructs a fluent builder for the UpdateMLTransform
operation.
- The fluent builder is configurable:
transform_id(impl Into<String>)
/set_transform_id(Option<String>)
:
required: trueA unique identifier that was generated when the transform was created.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe unique name that you gave the transform when you created it.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the transform. The default is an empty string.
parameters(TransformParameters)
/set_parameters(Option<TransformParameters>)
:
required: falseThe configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
role(impl Into<String>)
/set_role(Option<String>)
:
required: falseThe name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
glue_version(impl Into<String>)
/set_glue_version(Option<String>)
:
required: falseThis value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
max_capacity(f64)
/set_max_capacity(Option<f64>)
:
required: falseThe number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.worker_type(WorkerType)
/set_worker_type(Option<WorkerType>)
:
required: falseThe type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. -
For the
G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
-
number_of_workers(i32)
/set_number_of_workers(Option<i32>)
:
required: falseThe number of workers of a defined
workerType
that are allocated when this task runs.timeout(i32)
/set_timeout(Option<i32>)
:
required: falseThe timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).max_retries(i32)
/set_max_retries(Option<i32>)
:
required: falseThe maximum number of times to retry a task for this transform after a task run fails.
- On success, responds with
UpdateMlTransformOutput
with field(s):transform_id(Option<String>)
:The unique identifier for the transform that was updated.
- On failure, responds with
SdkError<UpdateMLTransformError>
Source§impl Client
impl Client
Sourcepub fn update_partition(&self) -> UpdatePartitionFluentBuilder
pub fn update_partition(&self) -> UpdatePartitionFluentBuilder
Constructs a fluent builder for the UpdatePartition
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the partition to be updated resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database in which the table in question resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table in which the partition to be updated is located.
partition_value_list(impl Into<String>)
/set_partition_value_list(Option<Vec::<String>>)
:
required: trueList of partition key values that define the partition to update.
partition_input(PartitionInput)
/set_partition_input(Option<PartitionInput>)
:
required: trueThe new partition object to update the partition to.
The
Values
property can’t be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
- On success, responds with
UpdatePartitionOutput
- On failure, responds with
SdkError<UpdatePartitionError>
Source§impl Client
impl Client
Sourcepub fn update_registry(&self) -> UpdateRegistryFluentBuilder
pub fn update_registry(&self) -> UpdateRegistryFluentBuilder
Constructs a fluent builder for the UpdateRegistry
operation.
- The fluent builder is configurable:
registry_id(RegistryId)
/set_registry_id(Option<RegistryId>)
:
required: trueThis is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueA description of the registry. If description is not provided, this field will not be updated.
- On success, responds with
UpdateRegistryOutput
with field(s):registry_name(Option<String>)
:The name of the updated registry.
registry_arn(Option<String>)
:The Amazon Resource name (ARN) of the updated registry.
- On failure, responds with
SdkError<UpdateRegistryError>
Source§impl Client
impl Client
Sourcepub fn update_schema(&self) -> UpdateSchemaFluentBuilder
pub fn update_schema(&self) -> UpdateSchemaFluentBuilder
Constructs a fluent builder for the UpdateSchema
operation.
- The fluent builder is configurable:
schema_id(SchemaId)
/set_schema_id(Option<SchemaId>)
:
required: trueThis is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided. -
SchemaId$SchemaName: The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.
-
schema_version_number(SchemaVersionNumber)
/set_schema_version_number(Option<SchemaVersionNumber>)
:
required: falseVersion number required for check pointing. One of
VersionNumber
orCompatibility
has to be provided.compatibility(Compatibility)
/set_compatibility(Option<Compatibility>)
:
required: falseThe new compatibility setting for the schema.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe new description for the schema.
- On success, responds with
UpdateSchemaOutput
with field(s):schema_arn(Option<String>)
:The Amazon Resource Name (ARN) of the schema.
schema_name(Option<String>)
:The name of the schema.
registry_name(Option<String>)
:The name of the registry that contains the schema.
- On failure, responds with
SdkError<UpdateSchemaError>
Source§impl Client
impl Client
Sourcepub fn update_source_control_from_job(
&self,
) -> UpdateSourceControlFromJobFluentBuilder
pub fn update_source_control_from_job( &self, ) -> UpdateSourceControlFromJobFluentBuilder
Constructs a fluent builder for the UpdateSourceControlFromJob
operation.
- The fluent builder is configurable:
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: falseThe name of the Glue job to be synchronized to or from the remote repository.
provider(SourceControlProvider)
/set_provider(Option<SourceControlProvider>)
:
required: falseThe provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: falseThe name of the remote repository that contains the job artifacts. For BitBucket providers,
RepositoryName
should includeWorkspaceName
. Use the format
./ repository_owner(impl Into<String>)
/set_repository_owner(Option<String>)
:
required: falseThe owner of the remote repository that contains the job artifacts.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: falseAn optional branch in the remote repository.
folder(impl Into<String>)
/set_folder(Option<String>)
:
required: falseAn optional folder in the remote repository.
commit_id(impl Into<String>)
/set_commit_id(Option<String>)
:
required: falseA commit ID for a commit in the remote repository.
auth_strategy(SourceControlAuthStrategy)
/set_auth_strategy(Option<SourceControlAuthStrategy>)
:
required: falseThe type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
auth_token(impl Into<String>)
/set_auth_token(Option<String>)
:
required: falseThe value of the authorization token.
- On success, responds with
UpdateSourceControlFromJobOutput
with field(s):job_name(Option<String>)
:The name of the Glue job.
- On failure, responds with
SdkError<UpdateSourceControlFromJobError>
Source§impl Client
impl Client
Sourcepub fn update_table(&self) -> UpdateTableFluentBuilder
pub fn update_table(&self) -> UpdateTableFluentBuilder
Constructs a fluent builder for the UpdateTable
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
table_input(TableInput)
/set_table_input(Option<TableInput>)
:
required: trueAn updated
TableInput
object to define the metadata table in the catalog.skip_archive(bool)
/set_skip_archive(Option<bool>)
:
required: falseBy default,
UpdateTable
always creates an archived version of the table before updating it. However, ifskipArchive
is set to true,UpdateTable
does not create the archived version.transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:
required: falseThe transaction ID at which to update the table contents.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: falseThe version ID at which to update the table contents.
view_update_action(ViewUpdateAction)
/set_view_update_action(Option<ViewUpdateAction>)
:
required: falseThe operation to be performed when updating the view.
force(bool)
/set_force(Option<bool>)
:
required: falseA flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.
- On success, responds with
UpdateTableOutput
- On failure, responds with
SdkError<UpdateTableError>
Source§impl Client
impl Client
Sourcepub fn update_table_optimizer(&self) -> UpdateTableOptimizerFluentBuilder
pub fn update_table_optimizer(&self) -> UpdateTableOptimizerFluentBuilder
Constructs a fluent builder for the UpdateTableOptimizer
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: trueThe Catalog ID of the table.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database in the catalog in which the table resides.
table_name(impl Into<String>)
/set_table_name(Option<String>)
:
required: trueThe name of the table.
r#type(TableOptimizerType)
/set_type(Option<TableOptimizerType>)
:
required: trueThe type of table optimizer.
table_optimizer_configuration(TableOptimizerConfiguration)
/set_table_optimizer_configuration(Option<TableOptimizerConfiguration>)
:
required: trueA
TableOptimizerConfiguration
object representing the configuration of a table optimizer.
- On success, responds with
UpdateTableOptimizerOutput
- On failure, responds with
SdkError<UpdateTableOptimizerError>
Source§impl Client
impl Client
Sourcepub fn update_trigger(&self) -> UpdateTriggerFluentBuilder
pub fn update_trigger(&self) -> UpdateTriggerFluentBuilder
Constructs a fluent builder for the UpdateTrigger
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the trigger to update.
trigger_update(TriggerUpdate)
/set_trigger_update(Option<TriggerUpdate>)
:
required: trueThe new values with which to update the trigger.
- On success, responds with
UpdateTriggerOutput
with field(s):trigger(Option<Trigger>)
:The resulting trigger definition.
- On failure, responds with
SdkError<UpdateTriggerError>
Source§impl Client
impl Client
Sourcepub fn update_usage_profile(&self) -> UpdateUsageProfileFluentBuilder
pub fn update_usage_profile(&self) -> UpdateUsageProfileFluentBuilder
Constructs a fluent builder for the UpdateUsageProfile
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the usage profile.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the usage profile.
configuration(ProfileConfiguration)
/set_configuration(Option<ProfileConfiguration>)
:
required: trueA
ProfileConfiguration
object specifying the job and session values for the profile.
- On success, responds with
UpdateUsageProfileOutput
with field(s):name(Option<String>)
:The name of the usage profile that was updated.
- On failure, responds with
SdkError<UpdateUsageProfileError>
Source§impl Client
impl Client
Sourcepub fn update_user_defined_function(
&self,
) -> UpdateUserDefinedFunctionFluentBuilder
pub fn update_user_defined_function( &self, ) -> UpdateUserDefinedFunctionFluentBuilder
Constructs a fluent builder for the UpdateUserDefinedFunction
operation.
- The fluent builder is configurable:
catalog_id(impl Into<String>)
/set_catalog_id(Option<String>)
:
required: falseThe ID of the Data Catalog where the function to be updated is located. If none is provided, the Amazon Web Services account ID is used by default.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the catalog database where the function to be updated is located.
function_name(impl Into<String>)
/set_function_name(Option<String>)
:
required: trueThe name of the function.
function_input(UserDefinedFunctionInput)
/set_function_input(Option<UserDefinedFunctionInput>)
:
required: trueA
FunctionInput
object that redefines the function in the Data Catalog.
- On success, responds with
UpdateUserDefinedFunctionOutput
- On failure, responds with
SdkError<UpdateUserDefinedFunctionError>
Source§impl Client
impl Client
Sourcepub fn update_workflow(&self) -> UpdateWorkflowFluentBuilder
pub fn update_workflow(&self) -> UpdateWorkflowFluentBuilder
Constructs a fluent builder for the UpdateWorkflow
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueName of the workflow to be updated.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the workflow.
default_run_properties(impl Into<String>, impl Into<String>)
/set_default_run_properties(Option<HashMap::<String, String>>)
:
required: falseA collection of properties to be used as part of each execution of the workflow.
Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
max_concurrent_runs(i32)
/set_max_concurrent_runs(Option<i32>)
:
required: falseYou can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
- On success, responds with
UpdateWorkflowOutput
with field(s):name(Option<String>)
:The name of the workflow which was specified in input.
- On failure, responds with
SdkError<UpdateWorkflowError>
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);