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 |
Modify the configurations of an IPAM.
Synopsis
- data ModifyIpam = ModifyIpam' {}
- newModifyIpam :: Text -> ModifyIpam
- modifyIpam_addOperatingRegions :: Lens' ModifyIpam (Maybe [AddIpamOperatingRegion])
- modifyIpam_description :: Lens' ModifyIpam (Maybe Text)
- modifyIpam_dryRun :: Lens' ModifyIpam (Maybe Bool)
- modifyIpam_removeOperatingRegions :: Lens' ModifyIpam (Maybe [RemoveIpamOperatingRegion])
- modifyIpam_ipamId :: Lens' ModifyIpam Text
- data ModifyIpamResponse = ModifyIpamResponse' {
- ipam :: Maybe Ipam
- httpStatus :: Int
- newModifyIpamResponse :: Int -> ModifyIpamResponse
- modifyIpamResponse_ipam :: Lens' ModifyIpamResponse (Maybe Ipam)
- modifyIpamResponse_httpStatus :: Lens' ModifyIpamResponse Int
Creating a Request
data ModifyIpam Source #
See: newModifyIpam
smart constructor.
ModifyIpam' | |
|
Instances
:: Text | |
-> 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.
ModifyIpamResponse' | |
|
Instances
newModifyIpamResponse Source #
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.