Struct aws_sdk_glue::client::Client

source · [−]
pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_glue::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_glue::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_glue::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the BatchCreatePartition operation.

Constructs a fluent builder for the BatchDeleteConnection operation.

Constructs a fluent builder for the BatchDeletePartition operation.

Constructs a fluent builder for the BatchDeleteTable operation.

Constructs a fluent builder for the BatchDeleteTableVersion operation.

Constructs a fluent builder for the BatchGetBlueprints operation.

Constructs a fluent builder for the BatchGetCrawlers operation.

Constructs a fluent builder for the BatchGetDevEndpoints operation.

Constructs a fluent builder for the BatchGetJobs operation.

Constructs a fluent builder for the BatchGetPartition operation.

Constructs a fluent builder for the BatchGetTriggers operation.

Constructs a fluent builder for the BatchGetWorkflows operation.

Constructs a fluent builder for the BatchStopJobRun operation.

Constructs a fluent builder for the BatchUpdatePartition operation.

Constructs a fluent builder for the CancelMLTaskRun operation.

Constructs a fluent builder for the CheckSchemaVersionValidity operation.

Constructs a fluent builder for the CreateBlueprint operation.

Constructs a fluent builder for the CreateClassifier operation.

Constructs a fluent builder for the CreateConnection operation.

Constructs a fluent builder for the CreateCrawler operation.

Constructs a fluent builder for the CreateDatabase operation.

Constructs a fluent builder for the CreateDevEndpoint operation.

Constructs a fluent builder for the CreateJob operation.

Constructs a fluent builder for the CreateMLTransform operation.

  • The fluent builder is configurable:
    • name(impl Into<String>) / set_name(Option<String>):

      The unique name that you give the transform when you create it.

    • description(impl Into<String>) / set_description(Option<String>):

      A description of the machine learning transform that is being defined. The default is an empty string.

    • input_record_tables(Vec<GlueTable>) / set_input_record_tables(Option<Vec<GlueTable>>):

      A list of Glue table definitions used by the transform.

    • parameters(TransformParameters) / set_parameters(Option<TransformParameters>):

      The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

    • role(impl Into<String>) / set_role(Option<String>):

      The 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>):

      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(f64) / set_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.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

      When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

      When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

    • worker_type(WorkerType) / set_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.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

    • number_of_workers(i32) / set_number_of_workers(Option<i32>):

      The number of workers of a defined workerType that are allocated when this task runs.

      If WorkerType is set, then NumberOfWorkers is required (and vice versa).

    • timeout(i32) / set_timeout(Option<i32>):

      The 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>):

      The maximum number of times to retry a task for this transform after a task run fails.

    • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

      The 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>):

      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 success, responds with CreateMlTransformOutput with field(s):
  • On failure, responds with SdkError<CreateMLTransformError>

Constructs a fluent builder for the CreatePartition operation.

Constructs a fluent builder for the CreatePartitionIndex operation.

Constructs a fluent builder for the CreateRegistry operation.

Constructs a fluent builder for the CreateSchema operation.

  • The fluent builder is configurable:
    • registry_id(RegistryId) / set_registry_id(Option<RegistryId>):

      This 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>):

      Name 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>):

      The data format of the schema definition. Currently AVRO and JSON are supported.

    • compatibility(Compatibility) / set_compatibility(Option<Compatibility>):

      The 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>):

      An optional description of the schema. If description is not provided, there will not be any automatic default value for this.

    • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

      Amazon 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>):

      The schema definition using the DataFormat setting for SchemaName.

  • On success, responds with CreateSchemaOutput with field(s):
  • On failure, responds with SdkError<CreateSchemaError>

Constructs a fluent builder for the CreateScript operation.

Constructs a fluent builder for the CreateSecurityConfiguration operation.

Constructs a fluent builder for the CreateTable operation.

Constructs a fluent builder for the CreateTrigger operation.

Constructs a fluent builder for the CreateUserDefinedFunction operation.

Constructs a fluent builder for the CreateWorkflow operation.

Constructs a fluent builder for the DeleteBlueprint operation.

Constructs a fluent builder for the DeleteClassifier operation.

Constructs a fluent builder for the DeleteColumnStatisticsForPartition operation.

Constructs a fluent builder for the DeleteColumnStatisticsForTable operation.

Constructs a fluent builder for the DeleteConnection operation.

Constructs a fluent builder for the DeleteCrawler operation.

Constructs a fluent builder for the DeleteDatabase operation.

Constructs a fluent builder for the DeleteDevEndpoint operation.

Constructs a fluent builder for the DeleteJob operation.

Constructs a fluent builder for the DeleteMLTransform operation.

Constructs a fluent builder for the DeletePartition operation.

Constructs a fluent builder for the DeletePartitionIndex operation.

Constructs a fluent builder for the DeleteRegistry operation.

Constructs a fluent builder for the DeleteResourcePolicy operation.

Constructs a fluent builder for the DeleteSchema operation.

Constructs a fluent builder for the DeleteSchemaVersions operation.

Constructs a fluent builder for the DeleteSecurityConfiguration operation.

Constructs a fluent builder for the DeleteTable operation.

Constructs a fluent builder for the DeleteTableVersion operation.

Constructs a fluent builder for the DeleteTrigger operation.

Constructs a fluent builder for the DeleteUserDefinedFunction operation.

Constructs a fluent builder for the DeleteWorkflow operation.

Constructs a fluent builder for the GetBlueprint operation.

Constructs a fluent builder for the GetBlueprintRun operation.

Constructs a fluent builder for the GetBlueprintRuns operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetCatalogImportStatus operation.

Constructs a fluent builder for the GetClassifier operation.

Constructs a fluent builder for the GetClassifiers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetColumnStatisticsForPartition operation.

Constructs a fluent builder for the GetColumnStatisticsForTable operation.

Constructs a fluent builder for the GetConnection operation.

Constructs a fluent builder for the GetConnections operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetCrawler operation.

Constructs a fluent builder for the GetCrawlerMetrics operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetCrawlers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetDatabase operation.

Constructs a fluent builder for the GetDatabases operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetDataCatalogEncryptionSettings operation.

Constructs a fluent builder for the GetDataflowGraph operation.

Constructs a fluent builder for the GetDevEndpoint operation.

Constructs a fluent builder for the GetDevEndpoints operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetJob operation.

Constructs a fluent builder for the GetJobBookmark operation.

Constructs a fluent builder for the GetJobRun operation.

Constructs a fluent builder for the GetJobRuns operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetJobs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetMapping operation.

Constructs a fluent builder for the GetMLTaskRun operation.

Constructs a fluent builder for the GetMLTaskRuns operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetMLTransform operation.

Constructs a fluent builder for the GetMLTransforms operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetPartition operation.

Constructs a fluent builder for the GetPartitionIndexes operation. This operation supports pagination; See into_paginator().

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>):

      The 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>):

      The name of the catalog database where the partitions reside.

    • table_name(impl Into<String>) / set_table_name(Option<String>):

      The name of the partitions’ table.

    • expression(impl Into<String>) / set_expression(Option<String>):

      An 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 a STRING, to be compatible with the catalog partitions.

      Sample API Call:

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      A continuation token, if this is not the first call to retrieve these partitions.

    • segment(Segment) / set_segment(Option<Segment>):

      The segment of the table’s partitions to scan in this request.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of partitions to return in a single response.

    • exclude_column_schema(bool) / set_exclude_column_schema(Option<bool>):

      When 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>):

      The transaction ID at which to read the partition contents.

    • query_as_of_time(DateTime) / set_query_as_of_time(Option<DateTime>):

      The 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):
  • On failure, responds with SdkError<GetPartitionsError>

Constructs a fluent builder for the GetPlan operation.

Constructs a fluent builder for the GetRegistry operation.

Constructs a fluent builder for the GetResourcePolicies operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetResourcePolicy operation.

Constructs a fluent builder for the GetSchema operation.

Constructs a fluent builder for the GetSchemaByDefinition operation.

Constructs a fluent builder for the GetSchemaVersion operation.

Constructs a fluent builder for the GetSchemaVersionsDiff operation.

Constructs a fluent builder for the GetSecurityConfiguration operation.

Constructs a fluent builder for the GetSecurityConfigurations operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetTable operation.

Constructs a fluent builder for the GetTables operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetTableVersion operation.

Constructs a fluent builder for the GetTableVersions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetTags operation.

Constructs a fluent builder for the GetTrigger operation.

Constructs a fluent builder for the GetTriggers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetUnfilteredPartitionMetadata operation.

Constructs a fluent builder for the GetUnfilteredPartitionsMetadata operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetUnfilteredTableMetadata operation.

Constructs a fluent builder for the GetUserDefinedFunction operation.

Constructs a fluent builder for the GetUserDefinedFunctions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetWorkflow operation.

Constructs a fluent builder for the GetWorkflowRun operation.

Constructs a fluent builder for the GetWorkflowRunProperties operation.

Constructs a fluent builder for the GetWorkflowRuns operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ImportCatalogToGlue operation.

Constructs a fluent builder for the ListBlueprints operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListCrawlers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListDevEndpoints operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListJobs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListMLTransforms operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListRegistries operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSchemas operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSchemaVersions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListTriggers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListWorkflows operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the PutDataCatalogEncryptionSettings operation.

Constructs a fluent builder for the PutResourcePolicy operation.

Constructs a fluent builder for the PutSchemaVersionMetadata operation.

Constructs a fluent builder for the PutWorkflowRunProperties operation.

Constructs a fluent builder for the QuerySchemaVersionMetadata operation.

Constructs a fluent builder for the RegisterSchemaVersion operation.

Constructs a fluent builder for the RemoveSchemaVersionMetadata operation.

Constructs a fluent builder for the ResetJobBookmark operation.

Constructs a fluent builder for the ResumeWorkflowRun operation.

Constructs a fluent builder for the SearchTables operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the StartBlueprintRun operation.

Constructs a fluent builder for the StartCrawler operation.

Constructs a fluent builder for the StartCrawlerSchedule operation.

Constructs a fluent builder for the StartExportLabelsTaskRun operation.

Constructs a fluent builder for the StartImportLabelsTaskRun operation.

Constructs a fluent builder for the StartJobRun operation.

Constructs a fluent builder for the StartMLEvaluationTaskRun operation.

Constructs a fluent builder for the StartMLLabelingSetGenerationTaskRun operation.

Constructs a fluent builder for the StartTrigger operation.

Constructs a fluent builder for the StartWorkflowRun operation.

Constructs a fluent builder for the StopCrawler operation.

Constructs a fluent builder for the StopCrawlerSchedule operation.

Constructs a fluent builder for the StopTrigger operation.

Constructs a fluent builder for the StopWorkflowRun operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateBlueprint operation.

Constructs a fluent builder for the UpdateClassifier operation.

Constructs a fluent builder for the UpdateColumnStatisticsForPartition operation.

Constructs a fluent builder for the UpdateColumnStatisticsForTable operation.

Constructs a fluent builder for the UpdateConnection operation.

Constructs a fluent builder for the UpdateCrawler operation.

Constructs a fluent builder for the UpdateCrawlerSchedule operation.

Constructs a fluent builder for the UpdateDatabase operation.

Constructs a fluent builder for the UpdateDevEndpoint operation.

Constructs a fluent builder for the UpdateJob operation.

Constructs a fluent builder for the UpdateMLTransform operation.

Constructs a fluent builder for the UpdatePartition operation.

Constructs a fluent builder for the UpdateRegistry operation.

Constructs a fluent builder for the UpdateSchema operation.

Constructs a fluent builder for the UpdateTable operation.

Constructs a fluent builder for the UpdateTrigger operation.

Constructs a fluent builder for the UpdateUserDefinedFunction operation.

Constructs a fluent builder for the UpdateWorkflow operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more