Struct aws_sdk_redshiftdata::Client

pub struct Client { /* private fields */ }

Client for Redshift Data API Service

Client for invoking operations on Redshift Data API Service. Each operation on Redshift Data API Service 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_redshiftdata::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config 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_redshiftdata::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 BatchExecuteStatement operation has a Client::batch_execute_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_execute_statement()
    .cluster_identifier("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_execute_statement(&self) -> BatchExecuteStatementFluentBuilder

Constructs a fluent builder for the BatchExecuteStatement operation.

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

    One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don’t start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: false
    

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

    
    
  • db_user(impl Into<String>) / set_db_user(Option<String>):
    required: false
    

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

    
    
  • with_event(bool) / set_with_event(Option<bool>):
    required: false
    

    A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

    
    
  • statement_name(impl Into<String>) / set_statement_name(Option<String>):
    required: false
    

    The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with BatchExecuteStatementOutput with field(s):
  • id(Option<String>):

    The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment.

  • created_at(Option<DateTime>):

    The date and time (UTC) the statement was created.

  • cluster_identifier(Option<String>):

    The cluster identifier. This element is not returned when connecting to a serverless workgroup.

  • db_user(Option<String>):

    The database user name.

  • database(Option<String>):

    The name of the database.

  • secret_arn(Option<String>):

    The name or ARN of the secret that enables access to the database.

  • workgroup_name(Option<String>):

    The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

• On failure, responds with SdkError<BatchExecuteStatementError>

impl Client

pub fn cancel_statement(&self) -> CancelStatementFluentBuilder

Constructs a fluent builder for the CancelStatement operation.

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

    The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

    
    
• On success, responds with CancelStatementOutput with field(s):
  • status(Option<bool>):

    A value that indicates whether the cancel statement succeeded (true).

• On failure, responds with SdkError<CancelStatementError>

impl Client

pub fn describe_statement(&self) -> DescribeStatementFluentBuilder

Constructs a fluent builder for the DescribeStatement operation.

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

    The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements.

    
    
• On success, responds with DescribeStatementOutput with field(s):
  • id(String):

    The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

  • secret_arn(Option<String>):

    The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

  • db_user(Option<String>):

    The database user name.

  • database(Option<String>):

    The name of the database.

  • cluster_identifier(Option<String>):

    The cluster identifier.

  • duration(i64):

    The amount of time in nanoseconds that the statement ran.

  • error(Option<String>):

    The error message from the cluster if the SQL statement encountered an error while running.

  • status(Option<StatusString>):

    The status of the SQL statement being described. Status values are defined as follows:

    • ABORTED - The query run was stopped by the user.

    • ALL - A status value that includes all query statuses. This value can be used to filter results.

    • FAILED - The query run failed.

    • FINISHED - The query has finished running.

    • PICKED - The query has been chosen to be run.

    • STARTED - The query run has started.

    • SUBMITTED - The query was submitted, but not yet processed.

  • created_at(Option<DateTime>):

    The date and time (UTC) when the SQL statement was submitted to run.

  • updated_at(Option<DateTime>):

    The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

  • redshift_pid(i64):

    The process identifier from Amazon Redshift.

  • has_result_set(Option<bool>):

    A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

  • query_string(Option<String>):

    The SQL statement text.

  • result_rows(i64):

    Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

  • result_size(i64):

    The size in bytes of the returned results. A -1 indicates the value is null.

  • redshift_query_id(i64):

    The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

  • query_parameters(Option<Vec::<SqlParameter>>):

    The parameters for the SQL statement.

  • sub_statements(Option<Vec::<SubStatementData>>):

    The SQL statements from a multiple statement run.

  • workgroup_name(Option<String>):

    The serverless workgroup name or Amazon Resource Name (ARN).

• On failure, responds with SdkError<DescribeStatementError>

impl Client

pub fn describe_table(&self) -> DescribeTableFluentBuilder

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

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

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: false
    

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

    
    
  • db_user(impl Into<String>) / set_db_user(Option<String>):
    required: false
    

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

    The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

    
    
  • connected_database(impl Into<String>) / set_connected_database(Option<String>):
    required: false
    

    A database name. The connected database is specified when you connect with your authentication credentials.

    
    
  • schema(impl Into<String>) / set_schema(Option<String>):
    required: false
    

    The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

    
    
  • table(impl Into<String>) / set_table(Option<String>):
    required: false
    

    The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned

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

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

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

    The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

    
    
• On success, responds with DescribeTableOutput with field(s):
  • table_name(Option<String>):

    The table name.

  • column_list(Option<Vec::<ColumnMetadata>>):

    A list of columns in the table.

  • next_token(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeTableError>

impl Client

pub fn execute_statement(&self) -> ExecuteStatementFluentBuilder

Constructs a fluent builder for the ExecuteStatement operation.

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

    The SQL statement text to run.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: false
    

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

    
    
  • db_user(impl Into<String>) / set_db_user(Option<String>):
    required: false
    

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

    
    
  • with_event(bool) / set_with_event(Option<bool>):
    required: false
    

    A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

    
    
  • statement_name(impl Into<String>) / set_statement_name(Option<String>):
    required: false
    

    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

    
    
  • parameters(SqlParameter) / set_parameters(Option<Vec::<SqlParameter>>):
    required: false
    

    The parameters for the SQL statement.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with ExecuteStatementOutput with field(s):
  • id(Option<String>):

    The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

  • created_at(Option<DateTime>):

    The date and time (UTC) the statement was created.

  • cluster_identifier(Option<String>):

    The cluster identifier. This element is not returned when connecting to a serverless workgroup.

  • db_user(Option<String>):

    The database user name.

  • database(Option<String>):

    The name of the database.

  • secret_arn(Option<String>):

    The name or ARN of the secret that enables access to the database.

  • workgroup_name(Option<String>):

    The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

• On failure, responds with SdkError<ExecuteStatementError>

impl Client

pub fn get_statement_result(&self) -> GetStatementResultFluentBuilder

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

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

    The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

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

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    
    
• On success, responds with GetStatementResultOutput with field(s):
  • records(Vec::<Vec::<Field>>):

    The results of the SQL statement.

  • column_metadata(Option<Vec::<ColumnMetadata>>):

    The properties (metadata) of a column.

  • total_num_rows(i64):

    The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.

  • next_token(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<GetStatementResultError>

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:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

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

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: false
    

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

    
    
  • db_user(impl Into<String>) / set_db_user(Option<String>):
    required: false
    

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

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

    The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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

    The names of databases.

  • next_token(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<ListDatabasesError>

impl Client

pub fn list_schemas(&self) -> ListSchemasFluentBuilder

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

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

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: false
    

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

    
    
  • db_user(impl Into<String>) / set_db_user(Option<String>):
    required: false
    

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

    The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

    
    
  • connected_database(impl Into<String>) / set_connected_database(Option<String>):
    required: false
    

    A database name. The connected database is specified when you connect with your authentication credentials.

    
    
  • schema_pattern(impl Into<String>) / set_schema_pattern(Option<String>):
    required: false
    

    A pattern to filter results by schema name. Within a schema pattern, “%” means match any substring of 0 or more characters and “_” means match any one character. Only schema name entries matching the search pattern are returned.

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

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

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

    The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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

    The schemas that match the request pattern.

  • next_token(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<ListSchemasError>

impl Client

pub fn list_statements(&self) -> ListStatementsFluentBuilder

Constructs a fluent builder for the ListStatements 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 value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

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

    The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.

    
    
  • statement_name(impl Into<String>) / set_statement_name(Option<String>):
    required: false
    

    The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.

    
    
  • status(StatusString) / set_status(Option<StatusString>):
    required: false
    

    The status of the SQL statement to list. Status values are defined as follows:

    • ABORTED - The query run was stopped by the user.

    • ALL - A status value that includes all query statuses. This value can be used to filter results.

    • FAILED - The query run failed.

    • FINISHED - The query has finished running.

    • PICKED - The query has been chosen to be run.

    • STARTED - The query run has started.

    • SUBMITTED - The query was submitted, but not yet processed.

    
    
  • role_level(bool) / set_role_level(Option<bool>):
    required: false
    

    A value that filters which statements to return in the response. If true, all statements run by the caller’s IAM role are returned. If false, only statements run by the caller’s IAM role in the current IAM session are returned. The default is true.

    
    
• On success, responds with ListStatementsOutput with field(s):
  • statements(Vec::<StatementData>):

    The SQL statements.

  • next_token(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<ListStatementsError>

impl Client

pub fn list_tables(&self) -> ListTablesFluentBuilder

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

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

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: false
    

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

    
    
  • db_user(impl Into<String>) / set_db_user(Option<String>):
    required: false
    

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

    The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

    
    
  • connected_database(impl Into<String>) / set_connected_database(Option<String>):
    required: false
    

    A database name. The connected database is specified when you connect with your authentication credentials.

    
    
  • schema_pattern(impl Into<String>) / set_schema_pattern(Option<String>):
    required: false
    

    A pattern to filter results by schema name. Within a schema pattern, “%” means match any substring of 0 or more characters and “_” means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

    
    
  • table_pattern(impl Into<String>) / set_table_pattern(Option<String>):
    required: false
    

    A pattern to filter results by table name. Within a table pattern, “%” means match any substring of 0 or more characters and “_” means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

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

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

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

    The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

    
    
• On success, responds with ListTablesOutput with field(s):
  • tables(Option<Vec::<TableMember>>):

    The tables that match the request pattern.

  • next_token(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<ListTablesError>

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.