aws_sdk_ec2/client/describe_regions.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`DescribeRegions`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`region_names(impl Into<String>)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::region_names) / [`set_region_names(Option<Vec::<String>>)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::set_region_names):<br>required: **false**<br><p>The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.</p><br>
7 /// - [`all_regions(bool)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::all_regions) / [`set_all_regions(Option<bool>)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::set_all_regions):<br>required: **false**<br><p>Indicates whether to display all Regions, including Regions that are disabled for your account.</p><br>
8 /// - [`dry_run(bool)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::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>
9 /// - [`filters(Filter)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul> <li> <p><code>endpoint</code> - The endpoint of the Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p></li> <li> <p><code>opt-in-status</code> - The opt-in status of the Region (<code>opt-in-not-required</code> | <code>opted-in</code> | <code>not-opted-in</code>).</p></li> <li> <p><code>region-name</code> - The name of the Region (for example, <code>us-east-1</code>).</p></li> </ul><br>
10 /// - On success, responds with [`DescribeRegionsOutput`](crate::operation::describe_regions::DescribeRegionsOutput) with field(s):
11 /// - [`regions(Option<Vec::<Region>>)`](crate::operation::describe_regions::DescribeRegionsOutput::regions): <p>Information about the Regions.</p>
12 /// - On failure, responds with [`SdkError<DescribeRegionsError>`](crate::operation::describe_regions::DescribeRegionsError)
13 pub fn describe_regions(&self) -> crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder {
14 crate::operation::describe_regions::builders::DescribeRegionsFluentBuilder::new(self.handle.clone())
15 }
16}