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 |
Get information about your IPAM scopes.
This operation returns paginated results.
Synopsis
- data DescribeIpamScopes = DescribeIpamScopes' {}
- newDescribeIpamScopes :: DescribeIpamScopes
- describeIpamScopes_dryRun :: Lens' DescribeIpamScopes (Maybe Bool)
- describeIpamScopes_filters :: Lens' DescribeIpamScopes (Maybe [Filter])
- describeIpamScopes_ipamScopeIds :: Lens' DescribeIpamScopes (Maybe [Text])
- describeIpamScopes_maxResults :: Lens' DescribeIpamScopes (Maybe Natural)
- describeIpamScopes_nextToken :: Lens' DescribeIpamScopes (Maybe Text)
- data DescribeIpamScopesResponse = DescribeIpamScopesResponse' {
- ipamScopes :: Maybe [IpamScope]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeIpamScopesResponse :: Int -> DescribeIpamScopesResponse
- describeIpamScopesResponse_ipamScopes :: Lens' DescribeIpamScopesResponse (Maybe [IpamScope])
- describeIpamScopesResponse_nextToken :: Lens' DescribeIpamScopesResponse (Maybe Text)
- describeIpamScopesResponse_httpStatus :: Lens' DescribeIpamScopesResponse Int
Creating a Request
data DescribeIpamScopes Source #
See: newDescribeIpamScopes
smart constructor.
DescribeIpamScopes' | |
|
Instances
newDescribeIpamScopes :: DescribeIpamScopes Source #
Create a value of DescribeIpamScopes
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:dryRun:DescribeIpamScopes'
, describeIpamScopes_dryRun
- A check for 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:DescribeIpamScopes'
, describeIpamScopes_filters
- One or more filters for the request. For more information about
filtering, see
Filtering CLI output.
$sel:ipamScopeIds:DescribeIpamScopes'
, describeIpamScopes_ipamScopeIds
- The IDs of the scopes you want information on.
$sel:maxResults:DescribeIpamScopes'
, describeIpamScopes_maxResults
- The maximum number of results to return in the request.
DescribeIpamScopes
, describeIpamScopes_nextToken
- The token for the next page of results.
Request Lenses
describeIpamScopes_dryRun :: Lens' DescribeIpamScopes (Maybe Bool) Source #
A check for 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
.
describeIpamScopes_filters :: Lens' DescribeIpamScopes (Maybe [Filter]) Source #
One or more filters for the request. For more information about filtering, see Filtering CLI output.
describeIpamScopes_ipamScopeIds :: Lens' DescribeIpamScopes (Maybe [Text]) Source #
The IDs of the scopes you want information on.
describeIpamScopes_maxResults :: Lens' DescribeIpamScopes (Maybe Natural) Source #
The maximum number of results to return in the request.
describeIpamScopes_nextToken :: Lens' DescribeIpamScopes (Maybe Text) Source #
The token for the next page of results.
Destructuring the Response
data DescribeIpamScopesResponse Source #
See: newDescribeIpamScopesResponse
smart constructor.
DescribeIpamScopesResponse' | |
|
Instances
newDescribeIpamScopesResponse Source #
Create a value of DescribeIpamScopesResponse
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:ipamScopes:DescribeIpamScopesResponse'
, describeIpamScopesResponse_ipamScopes
- The scopes you want information on.
DescribeIpamScopes
, describeIpamScopesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:DescribeIpamScopesResponse'
, describeIpamScopesResponse_httpStatus
- The response's http status code.
Response Lenses
describeIpamScopesResponse_ipamScopes :: Lens' DescribeIpamScopesResponse (Maybe [IpamScope]) Source #
The scopes you want information on.
describeIpamScopesResponse_nextToken :: Lens' DescribeIpamScopesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeIpamScopesResponse_httpStatus :: Lens' DescribeIpamScopesResponse Int Source #
The response's http status code.