Struct aws_sdk_redshiftdata::input::ListStatementsInput

#[non_exhaustive]
pub struct ListStatementsInput {
    pub next_token: Option<String>,
    pub max_results: i32,
    pub statement_name: Option<String>,
    pub status: Option<StatusString>,
    pub role_level: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

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

Implementations

impl ListStatementsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ListStatements, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ListStatements>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListStatementsInput

impl ListStatementsInput

pub fn next_token(&self) -> Option<&str>

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.

pub fn max_results(&self) -> 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.

pub fn statement_name(&self) -> Option<&str>

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.

pub fn status(&self) -> 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.

pub fn role_level(&self) -> 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.

Trait Implementations

impl Clone for ListStatementsInput

fn clone(&self) -> ListStatementsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListStatementsInput

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

Formats the value using the given formatter.

impl PartialEq<ListStatementsInput> for ListStatementsInput

fn eq(&self, other: &ListStatementsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListStatementsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for ListStatementsInput