Amazonka.EC2.GetIpamResourceCidrs

Get information about the resources in a scope.

This operation returns paginated results.

Creating a Request

data GetIpamResourceCidrs

See: newGetIpamResourceCidrs smart constructor.

Constructors

GetIpamResourceCidrs'

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.

• ipamPoolId :: Maybe Text

  The ID of the IPAM pool that the resource is in.

• maxResults :: Maybe Natural

  The maximum number of results to return in the request.

• nextToken :: Maybe Text

  The token for the next page of results.

• resourceId :: Maybe Text

  The ID of the resource.

• resourceOwner :: Maybe Text

  The ID of the Amazon Web Services account that owns the resource.

• resourceTag :: Maybe RequestIpamResourceTag

  The resource tag.

• resourceType :: Maybe IpamResourceType

  The resource type.

• ipamScopeId :: Text

  The ID of the scope that the resource is in.

Instances

ToHeaders GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

toHeaders :: GetIpamResourceCidrs -> [Header]

ToPath GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

toPath :: GetIpamResourceCidrs -> ByteString

ToQuery GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

toQuery :: GetIpamResourceCidrs -> QueryString

AWSPager GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

page :: GetIpamResourceCidrs -> AWSResponse GetIpamResourceCidrs -> Maybe GetIpamResourceCidrs

AWSRequest GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Associated Types

type AWSResponse GetIpamResourceCidrs

Methods

request :: (Service -> Service) -> GetIpamResourceCidrs -> Request GetIpamResourceCidrs

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIpamResourceCidrs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIpamResourceCidrs)))

Generic GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Associated Types

type Rep GetIpamResourceCidrs :: Type -> Type

Methods

from :: GetIpamResourceCidrs -> Rep GetIpamResourceCidrs x

to :: Rep GetIpamResourceCidrs x -> GetIpamResourceCidrs

Read GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

readsPrec :: Int -> ReadS GetIpamResourceCidrs

readList :: ReadS [GetIpamResourceCidrs]

readPrec :: ReadPrec GetIpamResourceCidrs

readListPrec :: ReadPrec [GetIpamResourceCidrs]

Show GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

showsPrec :: Int -> GetIpamResourceCidrs -> ShowS

show :: GetIpamResourceCidrs -> String

showList :: [GetIpamResourceCidrs] -> ShowS

NFData GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

rnf :: GetIpamResourceCidrs -> ()

Eq GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

(==) :: GetIpamResourceCidrs -> GetIpamResourceCidrs -> Bool

(/=) :: GetIpamResourceCidrs -> GetIpamResourceCidrs -> Bool

Hashable GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

hashWithSalt :: Int -> GetIpamResourceCidrs -> Int

hash :: GetIpamResourceCidrs -> Int

type AWSResponse GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

type AWSResponse GetIpamResourceCidrs = GetIpamResourceCidrsResponse

type Rep GetIpamResourceCidrs

Defined in Amazonka.EC2.GetIpamResourceCidrs

type Rep GetIpamResourceCidrs = D1 ('MetaData "GetIpamResourceCidrs" "Amazonka.EC2.GetIpamResourceCidrs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetIpamResourceCidrs'" '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 "ipamPoolId") '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))))) :*: ((S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestIpamResourceTag)) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamResourceType)) :*: S1 ('MetaSel ('Just "ipamScopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetIpamResourceCidrs

Arguments

:: Text

GetIpamResourceCidrs

-> GetIpamResourceCidrs

Create a value of GetIpamResourceCidrs 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:GetIpamResourceCidrs', getIpamResourceCidrs_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:GetIpamResourceCidrs', getIpamResourceCidrs_filters - One or more filters for the request. For more information about filtering, see Filtering CLI output.

GetIpamResourceCidrs, getIpamResourceCidrs_ipamPoolId - The ID of the IPAM pool that the resource is in.

$sel:maxResults:GetIpamResourceCidrs', getIpamResourceCidrs_maxResults - The maximum number of results to return in the request.

GetIpamResourceCidrs, getIpamResourceCidrs_nextToken - The token for the next page of results.

GetIpamResourceCidrs, getIpamResourceCidrs_resourceId - The ID of the resource.

GetIpamResourceCidrs, getIpamResourceCidrs_resourceOwner - The ID of the Amazon Web Services account that owns the resource.

$sel:resourceTag:GetIpamResourceCidrs', getIpamResourceCidrs_resourceTag - The resource tag.

GetIpamResourceCidrs, getIpamResourceCidrs_resourceType - The resource type.

GetIpamResourceCidrs, getIpamResourceCidrs_ipamScopeId - The ID of the scope that the resource is in.

Request Lenses

getIpamResourceCidrs_dryRun :: Lens' GetIpamResourceCidrs (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.

getIpamResourceCidrs_filters :: Lens' GetIpamResourceCidrs (Maybe [Filter])

One or more filters for the request. For more information about filtering, see Filtering CLI output.

getIpamResourceCidrs_ipamPoolId :: Lens' GetIpamResourceCidrs (Maybe Text)

The ID of the IPAM pool that the resource is in.

getIpamResourceCidrs_maxResults :: Lens' GetIpamResourceCidrs (Maybe Natural)

The maximum number of results to return in the request.

getIpamResourceCidrs_nextToken :: Lens' GetIpamResourceCidrs (Maybe Text)

The token for the next page of results.

getIpamResourceCidrs_resourceId :: Lens' GetIpamResourceCidrs (Maybe Text)

The ID of the resource.

getIpamResourceCidrs_resourceOwner :: Lens' GetIpamResourceCidrs (Maybe Text)

The ID of the Amazon Web Services account that owns the resource.

getIpamResourceCidrs_resourceTag :: Lens' GetIpamResourceCidrs (Maybe RequestIpamResourceTag)

The resource tag.

getIpamResourceCidrs_resourceType :: Lens' GetIpamResourceCidrs (Maybe IpamResourceType)

The resource type.

getIpamResourceCidrs_ipamScopeId :: Lens' GetIpamResourceCidrs Text

The ID of the scope that the resource is in.

Destructuring the Response

data GetIpamResourceCidrsResponse

See: newGetIpamResourceCidrsResponse smart constructor.

Constructors

GetIpamResourceCidrsResponse'

Fields

• ipamResourceCidrs :: Maybe [IpamResourceCidr]

  The resource CIDRs.

• 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

Generic GetIpamResourceCidrsResponse

Defined in Amazonka.EC2.GetIpamResourceCidrs

Associated Types

type Rep GetIpamResourceCidrsResponse :: Type -> Type

Methods

from :: GetIpamResourceCidrsResponse -> Rep GetIpamResourceCidrsResponse x

to :: Rep GetIpamResourceCidrsResponse x -> GetIpamResourceCidrsResponse

Read GetIpamResourceCidrsResponse

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

readsPrec :: Int -> ReadS GetIpamResourceCidrsResponse

readList :: ReadS [GetIpamResourceCidrsResponse]

readPrec :: ReadPrec GetIpamResourceCidrsResponse

readListPrec :: ReadPrec [GetIpamResourceCidrsResponse]

Show GetIpamResourceCidrsResponse

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

showsPrec :: Int -> GetIpamResourceCidrsResponse -> ShowS

show :: GetIpamResourceCidrsResponse -> String

showList :: [GetIpamResourceCidrsResponse] -> ShowS

NFData GetIpamResourceCidrsResponse

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

rnf :: GetIpamResourceCidrsResponse -> ()

Eq GetIpamResourceCidrsResponse

Defined in Amazonka.EC2.GetIpamResourceCidrs

Methods

(==) :: GetIpamResourceCidrsResponse -> GetIpamResourceCidrsResponse -> Bool

(/=) :: GetIpamResourceCidrsResponse -> GetIpamResourceCidrsResponse -> Bool

type Rep GetIpamResourceCidrsResponse

Defined in Amazonka.EC2.GetIpamResourceCidrs

type Rep GetIpamResourceCidrsResponse = D1 ('MetaData "GetIpamResourceCidrsResponse" "Amazonka.EC2.GetIpamResourceCidrs" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetIpamResourceCidrsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipamResourceCidrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpamResourceCidr])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetIpamResourceCidrsResponse

Arguments

:: Int

$sel:httpStatus:GetIpamResourceCidrsResponse'

-> GetIpamResourceCidrsResponse

Create a value of GetIpamResourceCidrsResponse 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:ipamResourceCidrs:GetIpamResourceCidrsResponse', getIpamResourceCidrsResponse_ipamResourceCidrs - The resource CIDRs.

GetIpamResourceCidrs, getIpamResourceCidrsResponse_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:GetIpamResourceCidrsResponse', getIpamResourceCidrsResponse_httpStatus - The response's http status code.

Response Lenses

getIpamResourceCidrsResponse_ipamResourceCidrs :: Lens' GetIpamResourceCidrsResponse (Maybe [IpamResourceCidr])

The resource CIDRs.

getIpamResourceCidrsResponse_nextToken :: Lens' GetIpamResourceCidrsResponse (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.

getIpamResourceCidrsResponse_httpStatus :: Lens' GetIpamResourceCidrsResponse Int

The response's http status code.