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

Amazonka.EC2.DescribeIpamScopes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get information about your IPAM scopes.

This operation returns paginated results.

Synopsis

data DescribeIpamScopes = DescribeIpamScopes' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- ipamScopeIds :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
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.

Constructors

DescribeIpamScopes'

Fields

dryRun :: Maybe Bool
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.
filters :: Maybe [Filter]
One or more filters for the request. For more information about filtering, see Filtering CLI output.
ipamScopeIds :: Maybe [Text]
The IDs of the scopes you want information on.
maxResults :: Maybe Natural
The maximum number of results to return in the request.
nextToken :: Maybe Text
The token for the next page of results.

Instances

Instances details

ToHeaders DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods toHeaders :: DescribeIpamScopes -> [Header] #
ToPath DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods toPath :: DescribeIpamScopes -> ByteString #
ToQuery DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods toQuery :: DescribeIpamScopes -> QueryString #
AWSPager DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods page :: DescribeIpamScopes -> AWSResponse DescribeIpamScopes -> Maybe DescribeIpamScopes #
AWSRequest DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Associated Types type AWSResponse DescribeIpamScopes # Methods request :: (Service -> Service) -> DescribeIpamScopes -> Request DescribeIpamScopes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeIpamScopes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeIpamScopes))) #
Generic DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Associated Types type Rep DescribeIpamScopes :: Type -> Type # Methods from :: DescribeIpamScopes -> Rep DescribeIpamScopes x # to :: Rep DescribeIpamScopes x -> DescribeIpamScopes #
Read DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods readsPrec :: Int -> ReadS DescribeIpamScopes # readList :: ReadS [DescribeIpamScopes] # readPrec :: ReadPrec DescribeIpamScopes # readListPrec :: ReadPrec [DescribeIpamScopes] #
Show DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods showsPrec :: Int -> DescribeIpamScopes -> ShowS # show :: DescribeIpamScopes -> String # showList :: [DescribeIpamScopes] -> ShowS #
NFData DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods rnf :: DescribeIpamScopes -> () #
Eq DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods (==) :: DescribeIpamScopes -> DescribeIpamScopes -> Bool # (/=) :: DescribeIpamScopes -> DescribeIpamScopes -> Bool #
Hashable DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods hashWithSalt :: Int -> DescribeIpamScopes -> Int # hash :: DescribeIpamScopes -> Int #
type AWSResponse DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes type AWSResponse DescribeIpamScopes = DescribeIpamScopesResponse
type Rep DescribeIpamScopes Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes type Rep DescribeIpamScopes = D1 ('MetaData "DescribeIpamScopes" "Amazonka.EC2.DescribeIpamScopes" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeIpamScopes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "ipamScopeIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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.

Constructors

DescribeIpamScopesResponse'
Fields ipamScopes :: Maybe [IpamScope] The scopes you want information on. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeIpamScopesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Associated Types type Rep DescribeIpamScopesResponse :: Type -> Type # Methods from :: DescribeIpamScopesResponse -> Rep DescribeIpamScopesResponse x # to :: Rep DescribeIpamScopesResponse x -> DescribeIpamScopesResponse #
Read DescribeIpamScopesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods readsPrec :: Int -> ReadS DescribeIpamScopesResponse # readList :: ReadS [DescribeIpamScopesResponse] # readPrec :: ReadPrec DescribeIpamScopesResponse # readListPrec :: ReadPrec [DescribeIpamScopesResponse] #
Show DescribeIpamScopesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods showsPrec :: Int -> DescribeIpamScopesResponse -> ShowS # show :: DescribeIpamScopesResponse -> String # showList :: [DescribeIpamScopesResponse] -> ShowS #
NFData DescribeIpamScopesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods rnf :: DescribeIpamScopesResponse -> () #
Eq DescribeIpamScopesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes Methods (==) :: DescribeIpamScopesResponse -> DescribeIpamScopesResponse -> Bool # (/=) :: DescribeIpamScopesResponse -> DescribeIpamScopesResponse -> Bool #
type Rep DescribeIpamScopesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpamScopes type Rep DescribeIpamScopesResponse = D1 ('MetaData "DescribeIpamScopesResponse" "Amazonka.EC2.DescribeIpamScopes" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeIpamScopesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipamScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpamScope])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeIpamScopesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeIpamScopesResponse'`
-> DescribeIpamScopesResponse

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.