amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.ModifyIpam

Description

Modify the configurations of an IPAM.

Synopsis

Creating a Request

data ModifyIpam Source #

See: newModifyIpam smart constructor.

Constructors

ModifyIpam' 

Fields

  • addOperatingRegions :: Maybe [AddIpamOperatingRegion]

    Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

    For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

  • description :: Maybe Text

    The description of the IPAM you want to modify.

  • 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.

  • removeOperatingRegions :: Maybe [RemoveIpamOperatingRegion]

    The operating Regions to remove.

  • ipamId :: Text

    The ID of the IPAM you want to modify.

Instances

Instances details
ToHeaders ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

toHeaders :: ModifyIpam -> [Header] #

ToPath ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

toPath :: ModifyIpam -> ByteString #

ToQuery ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

toQuery :: ModifyIpam -> QueryString #

AWSRequest ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Associated Types

type AWSResponse ModifyIpam #

Methods

request :: (Service -> Service) -> ModifyIpam -> Request ModifyIpam #

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

Generic ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Associated Types

type Rep ModifyIpam :: Type -> Type #

Methods

from :: ModifyIpam -> Rep ModifyIpam x #

to :: Rep ModifyIpam x -> ModifyIpam #

Read ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

readsPrec :: Int -> ReadS ModifyIpam #

readList :: ReadS [ModifyIpam] #

readPrec :: ReadPrec ModifyIpam #

readListPrec :: ReadPrec [ModifyIpam] #

Show ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

showsPrec :: Int -> ModifyIpam -> ShowS #

show :: ModifyIpam -> String #

showList :: [ModifyIpam] -> ShowS #

NFData ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

rnf :: ModifyIpam -> () #

Eq ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

(==) :: ModifyIpam -> ModifyIpam -> Bool #

(/=) :: ModifyIpam -> ModifyIpam -> Bool #

Hashable ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

hashWithSalt :: Int -> ModifyIpam -> Int #

hash :: ModifyIpam -> Int #

type AWSResponse ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

type AWSResponse ModifyIpam = ModifyIpamResponse
type Rep ModifyIpam Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

type Rep ModifyIpam = D1 ('MetaData "ModifyIpam" "Amazonka.EC2.ModifyIpam" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyIpam'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "addOperatingRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AddIpamOperatingRegion])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "removeOperatingRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RemoveIpamOperatingRegion])) :*: S1 ('MetaSel ('Just "ipamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyIpam Source #

Arguments

:: Text

ModifyIpam

-> ModifyIpam 

Create a value of ModifyIpam 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:addOperatingRegions:ModifyIpam', modifyIpam_addOperatingRegions - Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

ModifyIpam, modifyIpam_description - The description of the IPAM you want to modify.

$sel:dryRun:ModifyIpam', modifyIpam_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:removeOperatingRegions:ModifyIpam', modifyIpam_removeOperatingRegions - The operating Regions to remove.

ModifyIpam, modifyIpam_ipamId - The ID of the IPAM you want to modify.

Request Lenses

modifyIpam_addOperatingRegions :: Lens' ModifyIpam (Maybe [AddIpamOperatingRegion]) Source #

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

modifyIpam_description :: Lens' ModifyIpam (Maybe Text) Source #

The description of the IPAM you want to modify.

modifyIpam_dryRun :: Lens' ModifyIpam (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.

modifyIpam_removeOperatingRegions :: Lens' ModifyIpam (Maybe [RemoveIpamOperatingRegion]) Source #

The operating Regions to remove.

modifyIpam_ipamId :: Lens' ModifyIpam Text Source #

The ID of the IPAM you want to modify.

Destructuring the Response

data ModifyIpamResponse Source #

See: newModifyIpamResponse smart constructor.

Constructors

ModifyIpamResponse' 

Fields

Instances

Instances details
Generic ModifyIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Associated Types

type Rep ModifyIpamResponse :: Type -> Type #

Methods

from :: ModifyIpamResponse -> Rep ModifyIpamResponse x #

to :: Rep ModifyIpamResponse x -> ModifyIpamResponse #

Read ModifyIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

readsPrec :: Int -> ReadS ModifyIpamResponse #

readList :: ReadS [ModifyIpamResponse] #

readPrec :: ReadPrec ModifyIpamResponse #

readListPrec :: ReadPrec [ModifyIpamResponse] #

Show ModifyIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

showsPrec :: Int -> ModifyIpamResponse -> ShowS #

show :: ModifyIpamResponse -> String #

showList :: [ModifyIpamResponse] -> ShowS #

NFData ModifyIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

rnf :: ModifyIpamResponse -> () #

Eq ModifyIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

Methods

(==) :: ModifyIpamResponse -> ModifyIpamResponse -> Bool #

(/=) :: ModifyIpamResponse -> ModifyIpamResponse -> Bool #

type Rep ModifyIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyIpam

type Rep ModifyIpamResponse = D1 ('MetaData "ModifyIpamResponse" "Amazonka.EC2.ModifyIpam" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyIpamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Ipam)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyIpamResponse Source #

Arguments

:: Int

$sel:httpStatus:ModifyIpamResponse'

-> ModifyIpamResponse 

Create a value of ModifyIpamResponse 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:ipam:ModifyIpamResponse', modifyIpamResponse_ipam - The results of the modification.

$sel:httpStatus:ModifyIpamResponse', modifyIpamResponse_httpStatus - The response's http status code.

Response Lenses

modifyIpamResponse_ipam :: Lens' ModifyIpamResponse (Maybe Ipam) Source #

The results of the modification.

modifyIpamResponse_httpStatus :: Lens' ModifyIpamResponse Int Source #

The response's http status code.