aws_sdk_ec2/client/

describe_instance_sql_ha_states.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeInstanceSqlHaStates`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_ids(impl Into<String>)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::instance_ids) / [`set_instance_ids(Option<Vec::<String>>)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::set_instance_ids):<br>required: **false**<br><p>The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns SQL Server High Availability states for all SQL Server High Availability instances.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters to apply to the results. Supported filters include:</p> <ul>  <li>   <p><code>tag:<key></key></code> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with <code>Owner:TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>  <li>   <p><code>tag-key</code> - The tag key assigned to the instance.</p></li>  <li>   <p><code>haStatus</code> - The SQL Server High Availability status of the SQL Server High Availability instance (<code>processing</code> | <code>active</code> | <code>standby</code> | <code>invalid</code>).</p></li>  <li>   <p><code>sqlServerLicenseUsage</code> - The license type for the SQL Server license (<code>full</code> | <code>waived</code>).</p></li> </ul><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
    /// - On success, responds with [`DescribeInstanceSqlHaStatesOutput`](crate::operation::describe_instance_sql_ha_states::DescribeInstanceSqlHaStatesOutput) with field(s):
    ///   - [`instances(Option<Vec::<RegisteredInstance>>)`](crate::operation::describe_instance_sql_ha_states::DescribeInstanceSqlHaStatesOutput::instances): <p>Information about the SQL Server High Availability instances.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_instance_sql_ha_states::DescribeInstanceSqlHaStatesOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<DescribeInstanceSqlHaStatesError>`](crate::operation::describe_instance_sql_ha_states::DescribeInstanceSqlHaStatesError)
    pub fn describe_instance_sql_ha_states(
        &self,
    ) -> crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder {
        crate::operation::describe_instance_sql_ha_states::builders::DescribeInstanceSqlHaStatesFluentBuilder::new(self.handle.clone())
    }
}