Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Athena

Client for invoking operations on Amazon Athena. Each operation on Amazon Athena 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_athena::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_athena::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 BatchGetPreparedStatement operation has a Client::batch_get_prepared_statement, 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_get_prepared_statement()
    .work_group("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

impl Client

pub fn batch_get_named_query(&self) -> BatchGetNamedQueryFluentBuilder

Constructs a fluent builder for the BatchGetNamedQuery operation.

• The fluent builder is configurable:
  • named_query_ids(impl Into<String>) / set_named_query_ids(Option<Vec::<String>>):
    required: true
    

    An array of query IDs.

    
    
• On success, responds with BatchGetNamedQueryOutput with field(s):
  • named_queries(Option<Vec::<NamedQuery>>):

    Information about the named query IDs submitted.

  • unprocessed_named_query_ids(Option<Vec::<UnprocessedNamedQueryId>>):

    Information about provided query IDs.

• On failure, responds with SdkError<BatchGetNamedQueryError>

impl Client

pub fn batch_get_prepared_statement( &self, ) -> BatchGetPreparedStatementFluentBuilder

Constructs a fluent builder for the BatchGetPreparedStatement operation.

• The fluent builder is configurable:
  • prepared_statement_names(impl Into<String>) / set_prepared_statement_names(Option<Vec::<String>>):
    required: true
    

    A list of prepared statement names to return.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The name of the workgroup to which the prepared statements belong.

    
    
• On success, responds with BatchGetPreparedStatementOutput with field(s):
  • prepared_statements(Option<Vec::<PreparedStatement>>):

    The list of prepared statements returned.

  • unprocessed_prepared_statement_names(Option<Vec::<UnprocessedPreparedStatementName>>):

    A list of one or more prepared statements that were requested but could not be returned.

• On failure, responds with SdkError<BatchGetPreparedStatementError>

impl Client

pub fn batch_get_query_execution(&self) -> BatchGetQueryExecutionFluentBuilder

Constructs a fluent builder for the BatchGetQueryExecution operation.

• The fluent builder is configurable:
  • query_execution_ids(impl Into<String>) / set_query_execution_ids(Option<Vec::<String>>):
    required: true
    

    An array of query execution IDs.

    
    
• On success, responds with BatchGetQueryExecutionOutput with field(s):
  • query_executions(Option<Vec::<QueryExecution>>):

    Information about a query execution.

  • unprocessed_query_execution_ids(Option<Vec::<UnprocessedQueryExecutionId>>):

    Information about the query executions that failed to run.

• On failure, responds with SdkError<BatchGetQueryExecutionError>

impl Client

pub fn cancel_capacity_reservation( &self, ) -> CancelCapacityReservationFluentBuilder

Constructs a fluent builder for the CancelCapacityReservation operation.

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

    The name of the capacity reservation to cancel.

    
    
• On success, responds with CancelCapacityReservationOutput
• On failure, responds with SdkError<CancelCapacityReservationError>

impl Client

pub fn create_capacity_reservation( &self, ) -> CreateCapacityReservationFluentBuilder

Constructs a fluent builder for the CreateCapacityReservation operation.

• The fluent builder is configurable:
  • target_dpus(i32) / set_target_dpus(Option<i32>):
    required: true
    

    The number of requested data processing units.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the capacity reservation to create.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags for the capacity reservation.

    
    
• On success, responds with CreateCapacityReservationOutput
• On failure, responds with SdkError<CreateCapacityReservationError>

impl Client

pub fn create_data_catalog(&self) -> CreateDataCatalogFluentBuilder

Constructs a fluent builder for the CreateDataCatalog operation.

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

    The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

    For FEDERATED type the catalog name has following considerations and limits:

    • The catalog name allows special characters such as _ , @ , \ , - . These characters are replaced with a hyphen (-) when creating the CFN Stack Name and with an underscore (_) when creating the Lambda Function and Glue Connection Name.

    • The catalog name has a theoretical limit of 128 characters. However, since we use it to create other resources that allow less characters and we prepend a prefix to it, the actual catalog name limit for FEDERATED catalog is 64 - 23 = 41 characters.

    
    
  • r#type(DataCatalogType) / set_type(Option<DataCatalogType>):
    required: true
    

    The type of data catalog to create: LAMBDA for a federated catalog, GLUE for an Glue Data Catalog, and HIVE for an external Apache Hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.

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

    A description of the data catalog to be created.

    
    
  • parameters(impl Into<String>, impl Into<String>) / set_parameters(Option<HashMap::<String, String>>):
    required: false
    

    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.

    • For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

      metadata-function=lambda_arn, sdk-version=version_number

    • For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

      • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

        metadata-function=lambda_arn, record-function=lambda_arn

      • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

        function=lambda_arn

    • The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.

      catalog-id=catalog_id

      • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.

    • The FEDERATED data catalog type uses one of the following parameters, but not both. Use connection-arn for an existing Glue connection. Use connection-type and connection-properties to specify the configuration setting for a new connection.

      • connection-arn:<glue_connection_arn_to_reuse></glue_connection_arn_to_reuse>

      • lambda-role-arn (optional): The execution role to use for the Lambda function. If not provided, one is created.

      • connection-type:MYSQL|REDSHIFT|…., connection-properties:“<json_string></json_string>”

        For <json_string></json_string> , use escaped JSON text, as in the following example.

        “{"spill_bucket":"my_spill","spill_prefix":"athena-spill","host":"abc12345.snowflakecomputing.com","port":"1234","warehouse":"DEV_WH","database":"TEST","schema":"PUBLIC","SecretArn":"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j"}”

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of comma separated tags to add to the data catalog that is created. All the resources that are created by the CreateDataCatalog API operation with FEDERATED type will have the tag federated_athena_datacatalog=“true”. This includes the CFN Stack, Glue Connection, Athena DataCatalog, and all the resources created as part of the CFN Stack (Lambda Function, IAM policies/roles).

    
    
• On success, responds with CreateDataCatalogOutput with field(s):
  • data_catalog(Option<DataCatalog>):

    Contains information about a data catalog in an Amazon Web Services account.

    In the Athena console, data catalogs are listed as “data sources” on the Data sources page under the Data source name column.

• On failure, responds with SdkError<CreateDataCatalogError>

impl Client

pub fn create_named_query(&self) -> CreateNamedQueryFluentBuilder

Constructs a fluent builder for the CreateNamedQuery operation.

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

    The query name.

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

    The query description.

    
    
  • database(impl Into<String>) / set_database(Option<String>):
    required: true
    

    The database to which the query belongs.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The contents of the query with all query statements.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup in which the named query is being created.

    
    
• On success, responds with CreateNamedQueryOutput with field(s):
  • named_query_id(Option<String>):

    The unique ID of the query.

• On failure, responds with SdkError<CreateNamedQueryError>

impl Client

pub fn create_notebook(&self) -> CreateNotebookFluentBuilder

Constructs a fluent builder for the CreateNotebook operation.

• The fluent builder is configurable:
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The name of the Spark enabled workgroup in which the notebook will be created.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
• On success, responds with CreateNotebookOutput with field(s):
  • notebook_id(Option<String>):

    A unique identifier for the notebook.

• On failure, responds with SdkError<CreateNotebookError>

impl Client

pub fn create_prepared_statement(&self) -> CreatePreparedStatementFluentBuilder

Constructs a fluent builder for the CreatePreparedStatement operation.

• The fluent builder is configurable:
  • statement_name(impl Into<String>) / set_statement_name(Option<String>):
    required: true
    

    The name of the prepared statement.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The name of the workgroup to which the prepared statement belongs.

    
    
  • query_statement(impl Into<String>) / set_query_statement(Option<String>):
    required: true
    

    The query string for the prepared statement.

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

    The description of the prepared statement.

    
    
• On success, responds with CreatePreparedStatementOutput
• On failure, responds with SdkError<CreatePreparedStatementError>

impl Client

pub fn create_presigned_notebook_url( &self, ) -> CreatePresignedNotebookUrlFluentBuilder

Constructs a fluent builder for the CreatePresignedNotebookUrl operation.

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

    
    
• On success, responds with CreatePresignedNotebookUrlOutput with field(s):
  • notebook_url(String):

    The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.

  • auth_token(String):

    The authentication token for the notebook.

  • auth_token_expiration_time(i64):

    The UTC epoch time when the authentication token expires.

• On failure, responds with SdkError<CreatePresignedNotebookUrlError>

impl Client

pub fn create_work_group(&self) -> CreateWorkGroupFluentBuilder

Constructs a fluent builder for the CreateWorkGroup operation.

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

    The workgroup name.

    
    
  • configuration(WorkGroupConfiguration) / set_configuration(Option<WorkGroupConfiguration>):
    required: false
    

    Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup’s settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

    The workgroup description.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of comma separated tags to add to the workgroup that is created.

    
    
• On success, responds with CreateWorkGroupOutput
• On failure, responds with SdkError<CreateWorkGroupError>

impl Client

pub fn delete_capacity_reservation( &self, ) -> DeleteCapacityReservationFluentBuilder

Constructs a fluent builder for the DeleteCapacityReservation operation.

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

    The name of the capacity reservation to delete.

    
    
• On success, responds with DeleteCapacityReservationOutput
• On failure, responds with SdkError<DeleteCapacityReservationError>

impl Client

pub fn delete_data_catalog(&self) -> DeleteDataCatalogFluentBuilder

Constructs a fluent builder for the DeleteDataCatalog operation.

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

    The name of the data catalog to delete.

    
    
  • delete_catalog_only(bool) / set_delete_catalog_only(Option<bool>):
    required: false
    

    Deletes the Athena Data Catalog. You can only use this with the FEDERATED catalogs. You usually perform this before registering the connector with Glue Data Catalog. After deletion, you will have to manage the Glue Connection and Lambda function.

    
    
• On success, responds with DeleteDataCatalogOutput with field(s):
  • data_catalog(Option<DataCatalog>):

    Contains information about a data catalog in an Amazon Web Services account.

    In the Athena console, data catalogs are listed as “data sources” on the Data sources page under the Data source name column.

• On failure, responds with SdkError<DeleteDataCatalogError>

impl Client

pub fn delete_named_query(&self) -> DeleteNamedQueryFluentBuilder

Constructs a fluent builder for the DeleteNamedQuery operation.

• The fluent builder is configurable:
  • named_query_id(impl Into<String>) / set_named_query_id(Option<String>):
    required: true
    

    The unique ID of the query to delete.

    
    
• On success, responds with DeleteNamedQueryOutput
• On failure, responds with SdkError<DeleteNamedQueryError>

impl Client

pub fn delete_notebook(&self) -> DeleteNotebookFluentBuilder

Constructs a fluent builder for the DeleteNotebook operation.

• The fluent builder is configurable:
  • notebook_id(impl Into<String>) / set_notebook_id(Option<String>):
    required: true
    

    The ID of the notebook to delete.

    
    
• On success, responds with DeleteNotebookOutput
• On failure, responds with SdkError<DeleteNotebookError>

impl Client

pub fn delete_prepared_statement(&self) -> DeletePreparedStatementFluentBuilder

Constructs a fluent builder for the DeletePreparedStatement operation.

• The fluent builder is configurable:
  • statement_name(impl Into<String>) / set_statement_name(Option<String>):
    required: true
    

    The name of the prepared statement to delete.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The workgroup to which the statement to be deleted belongs.

    
    
• On success, responds with DeletePreparedStatementOutput
• On failure, responds with SdkError<DeletePreparedStatementError>

impl Client

pub fn delete_work_group(&self) -> DeleteWorkGroupFluentBuilder

Constructs a fluent builder for the DeleteWorkGroup operation.

• The fluent builder is configurable:
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The unique name of the workgroup to delete.

    
    
  • recursive_delete_option(bool) / set_recursive_delete_option(Option<bool>):
    required: false
    

    The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.

    
    
• On success, responds with DeleteWorkGroupOutput
• On failure, responds with SdkError<DeleteWorkGroupError>

impl Client

pub fn export_notebook(&self) -> ExportNotebookFluentBuilder

Constructs a fluent builder for the ExportNotebook operation.

• The fluent builder is configurable:
  • notebook_id(impl Into<String>) / set_notebook_id(Option<String>):
    required: true
    

    The ID of the notebook to export.

    
    
• On success, responds with ExportNotebookOutput with field(s):
  • notebook_metadata(Option<NotebookMetadata>):

    The notebook metadata, including notebook ID, notebook name, and workgroup name.

  • payload(Option<String>):

    The content of the exported notebook.

• On failure, responds with SdkError<ExportNotebookError>

impl Client

pub fn get_calculation_execution(&self) -> GetCalculationExecutionFluentBuilder

Constructs a fluent builder for the GetCalculationExecution operation.

• The fluent builder is configurable:
  • calculation_execution_id(impl Into<String>) / set_calculation_execution_id(Option<String>):
    required: true
    

    The calculation execution UUID.

    
    
• On success, responds with GetCalculationExecutionOutput with field(s):
  • calculation_execution_id(Option<String>):

    The calculation execution UUID.

  • session_id(Option<String>):

    The session ID that the calculation ran in.

  • description(Option<String>):

    The description of the calculation execution.

  • working_directory(Option<String>):

    The Amazon S3 location in which calculation results are stored.

  • status(Option<CalculationStatus>):

    Contains information about the status of the calculation.

  • statistics(Option<CalculationStatistics>):

    Contains information about the data processing unit (DPU) execution time and progress. This field is populated only when statistics are available.

  • result(Option<CalculationResult>):

    Contains result information. This field is populated only if the calculation is completed.

• On failure, responds with SdkError<GetCalculationExecutionError>

impl Client

pub fn get_calculation_execution_code( &self, ) -> GetCalculationExecutionCodeFluentBuilder

Constructs a fluent builder for the GetCalculationExecutionCode operation.

• The fluent builder is configurable:
  • calculation_execution_id(impl Into<String>) / set_calculation_execution_id(Option<String>):
    required: true
    

    The calculation execution UUID.

    
    
• On success, responds with GetCalculationExecutionCodeOutput with field(s):
  • code_block(Option<String>):

    The unencrypted code that was executed for the calculation.

• On failure, responds with SdkError<GetCalculationExecutionCodeError>

impl Client

pub fn get_calculation_execution_status( &self, ) -> GetCalculationExecutionStatusFluentBuilder

Constructs a fluent builder for the GetCalculationExecutionStatus operation.

• The fluent builder is configurable:
  • calculation_execution_id(impl Into<String>) / set_calculation_execution_id(Option<String>):
    required: true
    

    The calculation execution UUID.

    
    
• On success, responds with GetCalculationExecutionStatusOutput with field(s):
  • status(Option<CalculationStatus>):

    Contains information about the calculation execution status.

  • statistics(Option<CalculationStatistics>):

    Contains information about the DPU execution time and progress.

• On failure, responds with SdkError<GetCalculationExecutionStatusError>

impl Client

pub fn get_capacity_assignment_configuration( &self, ) -> GetCapacityAssignmentConfigurationFluentBuilder

Constructs a fluent builder for the GetCapacityAssignmentConfiguration operation.

• The fluent builder is configurable:
  • capacity_reservation_name(impl Into<String>) / set_capacity_reservation_name(Option<String>):
    required: true
    

    The name of the capacity reservation to retrieve the capacity assignment configuration for.

    
    
• On success, responds with GetCapacityAssignmentConfigurationOutput with field(s):
  • capacity_assignment_configuration(Option<CapacityAssignmentConfiguration>):

    The requested capacity assignment configuration for the specified capacity reservation.

• On failure, responds with SdkError<GetCapacityAssignmentConfigurationError>

impl Client

pub fn get_capacity_reservation(&self) -> GetCapacityReservationFluentBuilder

Constructs a fluent builder for the GetCapacityReservation operation.

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

    The name of the capacity reservation.

    
    
• On success, responds with GetCapacityReservationOutput with field(s):
  • capacity_reservation(Option<CapacityReservation>):

    The requested capacity reservation structure.

• On failure, responds with SdkError<GetCapacityReservationError>

impl Client

pub fn get_data_catalog(&self) -> GetDataCatalogFluentBuilder

Constructs a fluent builder for the GetDataCatalog operation.

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

    The name of the data catalog to return.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup. Required if making an IAM Identity Center request.

    
    
• On success, responds with GetDataCatalogOutput with field(s):
  • data_catalog(Option<DataCatalog>):

    The data catalog returned.

• On failure, responds with SdkError<GetDataCatalogError>

impl Client

pub fn get_database(&self) -> GetDatabaseFluentBuilder

Constructs a fluent builder for the GetDatabase operation.

• The fluent builder is configurable:
  • catalog_name(impl Into<String>) / set_catalog_name(Option<String>):
    required: true
    

    The name of the data catalog that contains the database to return.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    The name of the database to return.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    
    
• On success, responds with GetDatabaseOutput with field(s):
  • database(Option<Database>):

    The database returned.

• On failure, responds with SdkError<GetDatabaseError>

impl Client

pub fn get_named_query(&self) -> GetNamedQueryFluentBuilder

Constructs a fluent builder for the GetNamedQuery operation.

• The fluent builder is configurable:
  • named_query_id(impl Into<String>) / set_named_query_id(Option<String>):
    required: true
    

    The unique ID of the query. Use ListNamedQueries to get query IDs.

    
    
• On success, responds with GetNamedQueryOutput with field(s):
  • named_query(Option<NamedQuery>):

    Information about the query.

• On failure, responds with SdkError<GetNamedQueryError>

impl Client

pub fn get_notebook_metadata(&self) -> GetNotebookMetadataFluentBuilder

Constructs a fluent builder for the GetNotebookMetadata operation.

• The fluent builder is configurable:
  • notebook_id(impl Into<String>) / set_notebook_id(Option<String>):
    required: true
    

    The ID of the notebook whose metadata is to be retrieved.

    
    
• On success, responds with GetNotebookMetadataOutput with field(s):
  • notebook_metadata(Option<NotebookMetadata>):

    The metadata that is returned for the specified notebook ID.

• On failure, responds with SdkError<GetNotebookMetadataError>

impl Client

pub fn get_prepared_statement(&self) -> GetPreparedStatementFluentBuilder

Constructs a fluent builder for the GetPreparedStatement operation.

• The fluent builder is configurable:
  • statement_name(impl Into<String>) / set_statement_name(Option<String>):
    required: true
    

    The name of the prepared statement to retrieve.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The workgroup to which the statement to be retrieved belongs.

    
    
• On success, responds with GetPreparedStatementOutput with field(s):
  • prepared_statement(Option<PreparedStatement>):

    The name of the prepared statement that was retrieved.

• On failure, responds with SdkError<GetPreparedStatementError>

impl Client

pub fn get_query_execution(&self) -> GetQueryExecutionFluentBuilder

Constructs a fluent builder for the GetQueryExecution operation.

• The fluent builder is configurable:
  • query_execution_id(impl Into<String>) / set_query_execution_id(Option<String>):
    required: true
    

    The unique ID of the query execution.

    
    
• On success, responds with GetQueryExecutionOutput with field(s):
  • query_execution(Option<QueryExecution>):

    Information about the query execution.

• On failure, responds with SdkError<GetQueryExecutionError>

impl Client

pub fn get_query_results(&self) -> GetQueryResultsFluentBuilder

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

• The fluent builder is configurable:
  • query_execution_id(impl Into<String>) / set_query_execution_id(Option<String>):
    required: true
    

    The unique ID of the query execution.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    The maximum number of results (rows) to return in this request.

    
    
• On success, responds with GetQueryResultsOutput with field(s):
  • update_count(Option<i64>):

    The number of rows inserted with a CREATE TABLE AS SELECT, INSERT INTO, or UPDATE statement.

  • result_set(Option<ResultSet>):

    The results of the query execution.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<GetQueryResultsError>

impl Client

pub fn get_query_runtime_statistics( &self, ) -> GetQueryRuntimeStatisticsFluentBuilder

Constructs a fluent builder for the GetQueryRuntimeStatistics operation.

• The fluent builder is configurable:
  • query_execution_id(impl Into<String>) / set_query_execution_id(Option<String>):
    required: true
    

    The unique ID of the query execution.

    
    
• On success, responds with GetQueryRuntimeStatisticsOutput with field(s):
  • query_runtime_statistics(Option<QueryRuntimeStatistics>):

    Runtime statistics about the query execution.

• On failure, responds with SdkError<GetQueryRuntimeStatisticsError>

impl Client

pub fn get_session(&self) -> GetSessionFluentBuilder

Constructs a fluent builder for the GetSession operation.

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

    
    
• On success, responds with GetSessionOutput with field(s):
  • session_id(Option<String>):

    The session ID.

  • description(Option<String>):

    The session description.

  • work_group(Option<String>):

    The workgroup to which the session belongs.

  • engine_version(Option<String>):

    The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

  • engine_configuration(Option<EngineConfiguration>):

    Contains engine configuration information like DPU usage.

  • notebook_version(Option<String>):

    The notebook version.

  • session_configuration(Option<SessionConfiguration>):

    Contains the workgroup configuration information used by the session.

  • status(Option<SessionStatus>):

    Contains information about the status of the session.

  • statistics(Option<SessionStatistics>):

    Contains the DPU execution time.

• On failure, responds with SdkError<GetSessionError>

impl Client

pub fn get_session_status(&self) -> GetSessionStatusFluentBuilder

Constructs a fluent builder for the GetSessionStatus operation.

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

    
    
• On success, responds with GetSessionStatusOutput with field(s):
  • session_id(Option<String>):

    The session ID.

  • status(Option<SessionStatus>):

    Contains information about the status of the session.

• On failure, responds with SdkError<GetSessionStatusError>

impl Client

pub fn get_table_metadata(&self) -> GetTableMetadataFluentBuilder

Constructs a fluent builder for the GetTableMetadata operation.

• The fluent builder is configurable:
  • catalog_name(impl Into<String>) / set_catalog_name(Option<String>):
    required: true
    

    The name of the data catalog that contains the database and table metadata to return.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    The name of the database that contains the table metadata to return.

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

    The name of the table for which metadata is returned.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    
    
• On success, responds with GetTableMetadataOutput with field(s):
  • table_metadata(Option<TableMetadata>):

    An object that contains table metadata.

• On failure, responds with SdkError<GetTableMetadataError>

impl Client

pub fn get_work_group(&self) -> GetWorkGroupFluentBuilder

Constructs a fluent builder for the GetWorkGroup operation.

• The fluent builder is configurable:
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The name of the workgroup.

    
    
• On success, responds with GetWorkGroupOutput with field(s):
  • work_group(Option<WorkGroup>):

    Information about the workgroup.

• On failure, responds with SdkError<GetWorkGroupError>

impl Client

pub fn import_notebook(&self) -> ImportNotebookFluentBuilder

Constructs a fluent builder for the ImportNotebook operation.

• The fluent builder is configurable:
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The name of the Spark enabled workgroup to import the notebook to.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the notebook to import.

    
    
  • payload(impl Into<String>) / set_payload(Option<String>):
    required: false
    

    The notebook content to be imported. The payload must be in ipynb format.

    
    
  • r#type(NotebookType) / set_type(Option<NotebookType>):
    required: true
    

    The notebook content type. Currently, the only valid type is IPYNB.

    
    
  • notebook_s3_location_uri(impl Into<String>) / set_notebook_s3_location_uri(Option<String>):
    required: false
    

    A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once).

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
• On success, responds with ImportNotebookOutput with field(s):
  • notebook_id(Option<String>):

    The ID assigned to the imported notebook.

• On failure, responds with SdkError<ImportNotebookError>

impl Client

pub fn list_application_dpu_sizes(&self) -> ListApplicationDPUSizesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the maximum number of results to return.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

    
    
• On success, responds with ListApplicationDpuSizesOutput with field(s):
  • application_dpu_sizes(Option<Vec::<ApplicationDpuSizes>>):

    A list of the supported DPU sizes that the application runtime supports.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListApplicationDPUSizesError>

impl Client

pub fn list_calculation_executions( &self, ) -> ListCalculationExecutionsFluentBuilder

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

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

    
    
  • state_filter(CalculationExecutionState) / set_state_filter(Option<CalculationExecutionState>):
    required: false
    

    A filter for a specific calculation execution state. A description of each state follows.

    CREATING - The calculation is in the process of being created.

    CREATED - The calculation has been created and is ready to run.

    QUEUED - The calculation has been queued for processing.

    RUNNING - The calculation is running.

    CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

    CANCELED - The calculation is no longer running as the result of a cancel request.

    COMPLETED - The calculation has completed without error.

    FAILED - The calculation failed and is no longer running.

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

    The maximum number of calculation executions to return.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    
    
• On success, responds with ListCalculationExecutionsOutput with field(s):
  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • calculations(Option<Vec::<CalculationSummary>>):

    A list of CalculationSummary objects.

• On failure, responds with SdkError<ListCalculationExecutionsError>

impl Client

pub fn list_capacity_reservations( &self, ) -> ListCapacityReservationsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

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

    Specifies the maximum number of results to return.

    
    
• On success, responds with ListCapacityReservationsOutput with field(s):
  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • capacity_reservations(Vec::<CapacityReservation>):

    The capacity reservations for the current account.

• On failure, responds with SdkError<ListCapacityReservationsError>

impl Client

pub fn list_data_catalogs(&self) -> ListDataCatalogsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    Specifies the maximum number of data catalogs to return.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup. Required if making an IAM Identity Center request.

    
    
• On success, responds with ListDataCatalogsOutput with field(s):
  • data_catalogs_summary(Option<Vec::<DataCatalogSummary>>):

    A summary list of data catalogs.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListDataCatalogsError>

impl Client

pub fn list_databases(&self) -> ListDatabasesFluentBuilder

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

• The fluent builder is configurable:
  • catalog_name(impl Into<String>) / set_catalog_name(Option<String>):
    required: true
    

    The name of the data catalog that contains the databases to return.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    Specifies the maximum number of results to return.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    
    
• On success, responds with ListDatabasesOutput with field(s):
  • database_list(Option<Vec::<Database>>):

    A list of databases from a data catalog.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListDatabasesError>

impl Client

pub fn list_engine_versions(&self) -> ListEngineVersionsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    The maximum number of engine versions to return in this request.

    
    
• On success, responds with ListEngineVersionsOutput with field(s):
  • engine_versions(Option<Vec::<EngineVersion>>):

    A list of engine versions that are available to choose from.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListEngineVersionsError>

impl Client

pub fn list_executors(&self) -> ListExecutorsFluentBuilder

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

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

    
    
  • executor_state_filter(ExecutorState) / set_executor_state_filter(Option<ExecutorState>):
    required: false
    

    A filter for a specific executor state. A description of each state follows.

    CREATING - The executor is being started, including acquiring resources.

    CREATED - The executor has been started.

    REGISTERED - The executor has been registered.

    TERMINATING - The executor is in the process of shutting down.

    TERMINATED - The executor is no longer running.

    FAILED - Due to a failure, the executor is no longer running.

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

    The maximum number of executors to return.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    
    
• On success, responds with ListExecutorsOutput with field(s):
  • session_id(String):

    The session ID.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • executors_summary(Option<Vec::<ExecutorsSummary>>):

    Contains summary information about the executor.

• On failure, responds with SdkError<ListExecutorsError>

impl Client

pub fn list_named_queries(&self) -> ListNamedQueriesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    The maximum number of queries to return in this request.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.

    
    
• On success, responds with ListNamedQueriesOutput with field(s):
  • named_query_ids(Option<Vec::<String>>):

    The list of unique query IDs.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListNamedQueriesError>

impl Client

pub fn list_notebook_metadata(&self) -> ListNotebookMetadataFluentBuilder

Constructs a fluent builder for the ListNotebookMetadata operation.

• The fluent builder is configurable:
  • filters(FilterDefinition) / set_filters(Option<FilterDefinition>):
    required: false
    

    Search filter string.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

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

    Specifies the maximum number of results to return.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The name of the Spark enabled workgroup to retrieve notebook metadata for.

    
    
• On success, responds with ListNotebookMetadataOutput with field(s):
  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • notebook_metadata_list(Option<Vec::<NotebookMetadata>>):

    The list of notebook metadata for the specified workgroup.

• On failure, responds with SdkError<ListNotebookMetadataError>

impl Client

pub fn list_notebook_sessions(&self) -> ListNotebookSessionsFluentBuilder

Constructs a fluent builder for the ListNotebookSessions operation.

• The fluent builder is configurable:
  • notebook_id(impl Into<String>) / set_notebook_id(Option<String>):
    required: true
    

    The ID of the notebook to list sessions for.

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

    The maximum number of notebook sessions to return.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    
    
• On success, responds with ListNotebookSessionsOutput with field(s):
  • notebook_sessions_list(Vec::<NotebookSessionSummary>):

    A list of the sessions belonging to the notebook.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListNotebookSessionsError>

impl Client

pub fn list_prepared_statements(&self) -> ListPreparedStatementsFluentBuilder

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

• The fluent builder is configurable:
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The workgroup to list the prepared statements for.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    The maximum number of results to return in this request.

    
    
• On success, responds with ListPreparedStatementsOutput with field(s):
  • prepared_statements(Option<Vec::<PreparedStatementSummary>>):

    The list of prepared statements for the workgroup.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListPreparedStatementsError>

impl Client

pub fn list_query_executions(&self) -> ListQueryExecutionsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    The maximum number of query executions to return in this request.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.

    
    
• On success, responds with ListQueryExecutionsOutput with field(s):
  • query_execution_ids(Option<Vec::<String>>):

    The unique IDs of each query execution as an array of strings.

  • next_token(Option<String>):

    A token to be used by the next request if this request is truncated.

• On failure, responds with SdkError<ListQueryExecutionsError>

impl Client

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:
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The workgroup to which the session belongs.

    
    
  • state_filter(SessionState) / set_state_filter(Option<SessionState>):
    required: false
    

    A filter for a specific session state. A description of each state follows.

    CREATING - The session is being started, including acquiring resources.

    CREATED - The session has been started.

    IDLE - The session is able to accept a calculation.

    BUSY - The session is processing another task and is unable to accept a calculation.

    TERMINATING - The session is in the process of shutting down.

    TERMINATED - The session and its resources are no longer running.

    DEGRADED - The session has no healthy coordinators.

    FAILED - Due to a failure, the session and its resources are no longer running.

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

    The maximum number of sessions to return.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    
    
• On success, responds with ListSessionsOutput with field(s):
  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • sessions(Option<Vec::<SessionSummary>>):

    A list of sessions.

• On failure, responds with SdkError<ListSessionsError>

impl Client

pub fn list_table_metadata(&self) -> ListTableMetadataFluentBuilder

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

• The fluent builder is configurable:
  • catalog_name(impl Into<String>) / set_catalog_name(Option<String>):
    required: true
    

    The name of the data catalog for which table metadata should be returned.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    The name of the database for which table metadata should be returned.

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

    A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

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

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    Specifies the maximum number of results to return.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    
    
• On success, responds with ListTableMetadataOutput with field(s):
  • table_metadata_list(Option<Vec::<TableMetadata>>):

    A list of table metadata.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListTableMetadataError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

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

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Lists the tags for the resource with the specified ARN.

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

    The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the resource with the specified ARN.

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

    The maximum number of results to be returned per request that lists the tags for the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The list of tags associated with the specified resource.

  • next_token(Option<String>):

    A token to be used by the next request if this request is truncated.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_work_groups(&self) -> ListWorkGroupsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

    The maximum number of workgroups to return in this request.

    
    
• On success, responds with ListWorkGroupsOutput with field(s):
  • work_groups(Option<Vec::<WorkGroupSummary>>):

    A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.

  • next_token(Option<String>):

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• On failure, responds with SdkError<ListWorkGroupsError>

impl Client

pub fn put_capacity_assignment_configuration( &self, ) -> PutCapacityAssignmentConfigurationFluentBuilder

Constructs a fluent builder for the PutCapacityAssignmentConfiguration operation.

• The fluent builder is configurable:
  • capacity_reservation_name(impl Into<String>) / set_capacity_reservation_name(Option<String>):
    required: true
    

    The name of the capacity reservation to put a capacity assignment configuration for.

    
    
  • capacity_assignments(CapacityAssignment) / set_capacity_assignments(Option<Vec::<CapacityAssignment>>):
    required: true
    

    The list of assignments for the capacity assignment configuration.

    
    
• On success, responds with PutCapacityAssignmentConfigurationOutput
• On failure, responds with SdkError<PutCapacityAssignmentConfigurationError>

impl Client

pub fn start_calculation_execution( &self, ) -> StartCalculationExecutionFluentBuilder

Constructs a fluent builder for the StartCalculationExecution operation.

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

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

    A description of the calculation.

    
    
  • calculation_configuration(CalculationConfiguration) / set_calculation_configuration(Option<CalculationConfiguration>):
    required: false
    

    Contains configuration information for the calculation.

    
    
  • code_block(impl Into<String>) / set_code_block(Option<String>):
    required: false
    

    A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
• On success, responds with StartCalculationExecutionOutput with field(s):
  • calculation_execution_id(Option<String>):

    The calculation execution UUID.

  • state(Option<CalculationExecutionState>):

    CREATING - The calculation is in the process of being created.

    CREATED - The calculation has been created and is ready to run.

    QUEUED - The calculation has been queued for processing.

    RUNNING - The calculation is running.

    CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

    CANCELED - The calculation is no longer running as the result of a cancel request.

    COMPLETED - The calculation has completed without error.

    FAILED - The calculation failed and is no longer running.

• On failure, responds with SdkError<StartCalculationExecutionError>

impl Client

pub fn start_query_execution(&self) -> StartQueryExecutionFluentBuilder

Constructs a fluent builder for the StartQueryExecution operation.

• The fluent builder is configurable:
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The SQL query statements to be executed.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn’t have permission on the tables specified in QueryString.

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
  • query_execution_context(QueryExecutionContext) / set_query_execution_context(Option<QueryExecutionContext>):
    required: false
    

    The database within which the query executes.

    
    
  • result_configuration(ResultConfiguration) / set_result_configuration(Option<ResultConfiguration>):
    required: false
    

    Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup’s settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: false
    

    The name of the workgroup in which the query is being started.

    
    
  • execution_parameters(impl Into<String>) / set_execution_parameters(Option<Vec::<String>>):
    required: false
    

    A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

    
    
  • result_reuse_configuration(ResultReuseConfiguration) / set_result_reuse_configuration(Option<ResultReuseConfiguration>):
    required: false
    

    Specifies the query result reuse behavior for the query.

    
    
• On success, responds with StartQueryExecutionOutput with field(s):
  • query_execution_id(Option<String>):

    The unique ID of the query that ran as a result of this request.

• On failure, responds with SdkError<StartQueryExecutionError>

impl Client

pub fn start_session(&self) -> StartSessionFluentBuilder

Constructs a fluent builder for the StartSession operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The session description.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The workgroup to which the session belongs.

    
    
  • engine_configuration(EngineConfiguration) / set_engine_configuration(Option<EngineConfiguration>):
    required: true
    

    Contains engine data processing unit (DPU) configuration settings and parameter mappings.

    
    
  • notebook_version(impl Into<String>) / set_notebook_version(Option<String>):
    required: false
    

    The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is Athena notebook version 1. If you specify a value for NotebookVersion, you must also specify a value for NotebookId. See EngineConfiguration$AdditionalConfigs.

    
    
  • session_idle_timeout_in_minutes(i32) / set_session_idle_timeout_in_minutes(Option<i32>):
    required: false
    

    The idle timeout in minutes for the session.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
• On success, responds with StartSessionOutput with field(s):
  • session_id(Option<String>):

    The session ID.

  • state(Option<SessionState>):

    The state of the session. A description of each state follows.

    CREATING - The session is being started, including acquiring resources.

    CREATED - The session has been started.

    IDLE - The session is able to accept a calculation.

    BUSY - The session is processing another task and is unable to accept a calculation.

    TERMINATING - The session is in the process of shutting down.

    TERMINATED - The session and its resources are no longer running.

    DEGRADED - The session has no healthy coordinators.

    FAILED - Due to a failure, the session and its resources are no longer running.

• On failure, responds with SdkError<StartSessionError>

impl Client

pub fn stop_calculation_execution( &self, ) -> StopCalculationExecutionFluentBuilder

Constructs a fluent builder for the StopCalculationExecution operation.

• The fluent builder is configurable:
  • calculation_execution_id(impl Into<String>) / set_calculation_execution_id(Option<String>):
    required: true
    

    The calculation execution UUID.

    
    
• On success, responds with StopCalculationExecutionOutput with field(s):
  • state(Option<CalculationExecutionState>):

    CREATING - The calculation is in the process of being created.

    CREATED - The calculation has been created and is ready to run.

    QUEUED - The calculation has been queued for processing.

    RUNNING - The calculation is running.

    CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

    CANCELED - The calculation is no longer running as the result of a cancel request.

    COMPLETED - The calculation has completed without error.

    FAILED - The calculation failed and is no longer running.

• On failure, responds with SdkError<StopCalculationExecutionError>

impl Client

pub fn stop_query_execution(&self) -> StopQueryExecutionFluentBuilder

Constructs a fluent builder for the StopQueryExecution operation.

• The fluent builder is configurable:
  • query_execution_id(impl Into<String>) / set_query_execution_id(Option<String>):
    required: true
    

    The unique ID of the query execution to stop.

    
    
• On success, responds with StopQueryExecutionOutput
• On failure, responds with SdkError<StopQueryExecutionError>

impl Client

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

    Specifies the ARN of the Athena resource to which tags are to be added.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    A collection of one or more tags, separated by commas, to be added to an Athena resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn terminate_session(&self) -> TerminateSessionFluentBuilder

Constructs a fluent builder for the TerminateSession operation.

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The session ID.

    
    
• On success, responds with TerminateSessionOutput with field(s):
  • state(Option<SessionState>):

    The state of the session. A description of each state follows.

    CREATING - The session is being started, including acquiring resources.

    CREATED - The session has been started.

    IDLE - The session is able to accept a calculation.

    BUSY - The session is processing another task and is unable to accept a calculation.

    TERMINATING - The session is in the process of shutting down.

    TERMINATED - The session and its resources are no longer running.

    DEGRADED - The session has no healthy coordinators.

    FAILED - Due to a failure, the session and its resources are no longer running.

• On failure, responds with SdkError<TerminateSessionError>

impl Client

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

    Specifies the ARN of the resource from which tags are to be removed.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A comma-separated list of one or more tag keys whose tags are to be removed from the specified resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_capacity_reservation( &self, ) -> UpdateCapacityReservationFluentBuilder

Constructs a fluent builder for the UpdateCapacityReservation operation.

• The fluent builder is configurable:
  • target_dpus(i32) / set_target_dpus(Option<i32>):
    required: true
    

    The new number of requested data processing units.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the capacity reservation.

    
    
• On success, responds with UpdateCapacityReservationOutput
• On failure, responds with SdkError<UpdateCapacityReservationError>

impl Client

pub fn update_data_catalog(&self) -> UpdateDataCatalogFluentBuilder

Constructs a fluent builder for the UpdateDataCatalog operation.

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

    The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

    
    
  • r#type(DataCatalogType) / set_type(Option<DataCatalogType>):
    required: true
    

    Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

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

    New or modified text that describes the data catalog.

    
    
  • parameters(impl Into<String>, impl Into<String>) / set_parameters(Option<HashMap::<String, String>>):
    required: false
    

    Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type.

    • For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

      metadata-function=lambda_arn, sdk-version=version_number

    • For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

      • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

        metadata-function=lambda_arn, record-function=lambda_arn

      • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

        function=lambda_arn

    
    
• On success, responds with UpdateDataCatalogOutput
• On failure, responds with SdkError<UpdateDataCatalogError>

impl Client

pub fn update_named_query(&self) -> UpdateNamedQueryFluentBuilder

Constructs a fluent builder for the UpdateNamedQuery operation.

• The fluent builder is configurable:
  • named_query_id(impl Into<String>) / set_named_query_id(Option<String>):
    required: true
    

    The unique identifier (UUID) of the query.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the query.

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

    The query description.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The contents of the query with all query statements.

    
    
• On success, responds with UpdateNamedQueryOutput
• On failure, responds with SdkError<UpdateNamedQueryError>

impl Client

pub fn update_notebook(&self) -> UpdateNotebookFluentBuilder

Constructs a fluent builder for the UpdateNotebook operation.

• The fluent builder is configurable:
  • notebook_id(impl Into<String>) / set_notebook_id(Option<String>):
    required: true
    

    The ID of the notebook to update.

    
    
  • payload(impl Into<String>) / set_payload(Option<String>):
    required: true
    

    The updated content for the notebook.

    
    
  • r#type(NotebookType) / set_type(Option<NotebookType>):
    required: true
    

    The notebook content type. Currently, the only valid type is IPYNB.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: false
    

    The active notebook session ID. Required if the notebook has an active session.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
• On success, responds with UpdateNotebookOutput
• On failure, responds with SdkError<UpdateNotebookError>

impl Client

pub fn update_notebook_metadata(&self) -> UpdateNotebookMetadataFluentBuilder

Constructs a fluent builder for the UpdateNotebookMetadata operation.

• The fluent builder is configurable:
  • notebook_id(impl Into<String>) / set_notebook_id(Option<String>):
    required: true
    

    The ID of the notebook to update the metadata for.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name to update the notebook to.

    
    
• On success, responds with UpdateNotebookMetadataOutput
• On failure, responds with SdkError<UpdateNotebookMetadataError>

impl Client

pub fn update_prepared_statement(&self) -> UpdatePreparedStatementFluentBuilder

Constructs a fluent builder for the UpdatePreparedStatement operation.

• The fluent builder is configurable:
  • statement_name(impl Into<String>) / set_statement_name(Option<String>):
    required: true
    

    The name of the prepared statement.

    
    
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The workgroup for the prepared statement.

    
    
  • query_statement(impl Into<String>) / set_query_statement(Option<String>):
    required: true
    

    The query string for the prepared statement.

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

    The description of the prepared statement.

    
    
• On success, responds with UpdatePreparedStatementOutput
• On failure, responds with SdkError<UpdatePreparedStatementError>

impl Client

pub fn update_work_group(&self) -> UpdateWorkGroupFluentBuilder

Constructs a fluent builder for the UpdateWorkGroup operation.

• The fluent builder is configurable:
  • work_group(impl Into<String>) / set_work_group(Option<String>):
    required: true
    

    The specified workgroup that will be updated.

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

    The workgroup description.

    
    
  • configuration_updates(WorkGroupConfigurationUpdates) / set_configuration_updates(Option<WorkGroupConfigurationUpdates>):
    required: false
    

    Contains configuration updates for an Athena SQL workgroup.

    
    
  • state(WorkGroupState) / set_state(Option<WorkGroupState>):
    required: false
    

    The workgroup state that will be updated for the given workgroup.

    
    
• On success, responds with UpdateWorkGroupOutput
• On failure, responds with SdkError<UpdateWorkGroupError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.