Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.
For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
Synopsis
- data DescribeRegions = DescribeRegions' {}
- newDescribeRegions :: DescribeRegions
- describeRegions_allRegions :: Lens' DescribeRegions (Maybe Bool)
- describeRegions_dryRun :: Lens' DescribeRegions (Maybe Bool)
- describeRegions_filters :: Lens' DescribeRegions (Maybe [Filter])
- describeRegions_regionNames :: Lens' DescribeRegions (Maybe [Text])
- data DescribeRegionsResponse = DescribeRegionsResponse' {
- regions :: Maybe [RegionInfo]
- httpStatus :: Int
- newDescribeRegionsResponse :: Int -> DescribeRegionsResponse
- describeRegionsResponse_regions :: Lens' DescribeRegionsResponse (Maybe [RegionInfo])
- describeRegionsResponse_httpStatus :: Lens' DescribeRegionsResponse Int
Creating a Request
data DescribeRegions Source #
See: newDescribeRegions
smart constructor.
DescribeRegions' | |
|
Instances
newDescribeRegions :: DescribeRegions Source #
Create a value of DescribeRegions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allRegions:DescribeRegions'
, describeRegions_allRegions
- Indicates whether to display all Regions, including Regions that are
disabled for your account.
$sel:dryRun:DescribeRegions'
, describeRegions_dryRun
- 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 DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
$sel:filters:DescribeRegions'
, describeRegions_filters
- The filters.
endpoint
- The endpoint of the Region (for example,ec2.us-east-1.amazonaws.com
).opt-in-status
- The opt-in status of the Region (opt-in-not-required
|opted-in
|not-opted-in
).region-name
- The name of the Region (for example,us-east-1
).
$sel:regionNames:DescribeRegions'
, describeRegions_regionNames
- The names of the Regions. You can specify any Regions, whether they are
enabled and disabled for your account.
Request Lenses
describeRegions_allRegions :: Lens' DescribeRegions (Maybe Bool) Source #
Indicates whether to display all Regions, including Regions that are disabled for your account.
describeRegions_dryRun :: Lens' DescribeRegions (Maybe Bool) Source #
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 DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
describeRegions_filters :: Lens' DescribeRegions (Maybe [Filter]) Source #
The filters.
endpoint
- The endpoint of the Region (for example,ec2.us-east-1.amazonaws.com
).opt-in-status
- The opt-in status of the Region (opt-in-not-required
|opted-in
|not-opted-in
).region-name
- The name of the Region (for example,us-east-1
).
describeRegions_regionNames :: Lens' DescribeRegions (Maybe [Text]) Source #
The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
Destructuring the Response
data DescribeRegionsResponse Source #
See: newDescribeRegionsResponse
smart constructor.
DescribeRegionsResponse' | |
|
Instances
newDescribeRegionsResponse Source #
Create a value of DescribeRegionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regions:DescribeRegionsResponse'
, describeRegionsResponse_regions
- Information about the Regions.
$sel:httpStatus:DescribeRegionsResponse'
, describeRegionsResponse_httpStatus
- The response's http status code.
Response Lenses
describeRegionsResponse_regions :: Lens' DescribeRegionsResponse (Maybe [RegionInfo]) Source #
Information about the Regions.
describeRegionsResponse_httpStatus :: Lens' DescribeRegionsResponse Int Source #
The response's http status code.