pub struct Client { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

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

Constructing a client with custom configuration

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

Implementations§

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the BatchExecuteStatement operation.

Constructs a fluent builder for the CancelStatement operation.

Constructs a fluent builder for the DescribeStatement operation.

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

      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(Option<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.

  • On failure, responds with SdkError<DescribeStatementError>

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

Constructs a fluent builder for the ExecuteStatement operation.

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

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

      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(Option<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>

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

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

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

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_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.

    • max_results(i32) / set_max_results(i32):

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

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

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

      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(Option<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>

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

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.

Creates a new client from the service Config.

Panics
  • This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

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

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more