aws_sdk_databasemigration/client/
describe_fleet_advisor_schemas.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeFleetAdvisorSchemas`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filters(Filter)`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::set_filters):<br>required: **false**<br><p>If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:</p> <ul>  <li>   <p><code>complexity</code> – The schema's complexity, for example <code>Simple</code>.</p></li>  <li>   <p><code>database-id</code> – The ID of the schema's database.</p></li>  <li>   <p><code>database-ip-address</code> – The IP address of the schema's database.</p></li>  <li>   <p><code>database-name</code> – The name of the schema's database.</p></li>  <li>   <p><code>database-engine</code> – The name of the schema database's engine.</p></li>  <li>   <p><code>original-schema-name</code> – The name of the schema's database's main schema.</p></li>  <li>   <p><code>schema-id</code> – The ID of the schema, for example <code>15</code>.</p></li>  <li>   <p><code>schema-name</code> – The name of the schema.</p></li>  <li>   <p><code>server-ip-address</code> – The IP address of the schema database's server.</p></li> </ul> <p>An example is: <code>describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"</code></p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::set_max_records):<br>required: **false**<br><p>Sets the maximum number of records returned in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::set_next_token):<br>required: **false**<br><p>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p><br>
    /// - On success, responds with [`DescribeFleetAdvisorSchemasOutput`](crate::operation::describe_fleet_advisor_schemas::DescribeFleetAdvisorSchemasOutput) with field(s):
    ///   - [`fleet_advisor_schemas(Option<Vec::<SchemaResponse>>)`](crate::operation::describe_fleet_advisor_schemas::DescribeFleetAdvisorSchemasOutput::fleet_advisor_schemas): <p>A collection of <code>SchemaResponse</code> objects.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_fleet_advisor_schemas::DescribeFleetAdvisorSchemasOutput::next_token): <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p>
    /// - On failure, responds with [`SdkError<DescribeFleetAdvisorSchemasError>`](crate::operation::describe_fleet_advisor_schemas::DescribeFleetAdvisorSchemasError)
    pub fn describe_fleet_advisor_schemas(
        &self,
    ) -> crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder {
        crate::operation::describe_fleet_advisor_schemas::builders::DescribeFleetAdvisorSchemasFluentBuilder::new(self.handle.clone())
    }
}