EC2 / Client / modify_ipam

modify_ipam#

EC2.Client.modify_ipam(**kwargs)#

Modify the configurations of an IPAM.

Request Syntax

response = client.modify_ipam(
    DryRun=True|False,
    IpamId='string',
    Description='string',
    AddOperatingRegions=[
        {
            'RegionName': 'string'
        },
    ],
    RemoveOperatingRegions=[
        {
            'RegionName': 'string'
        },
    ],
    Tier='free'|'advanced'
)

Parameters:

DryRun (boolean) – 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.
IpamId (string) –
[REQUIRED]

The ID of the IPAM you want to modify.
Description (string) – The description of the IPAM you want to modify.
AddOperatingRegions (list) –
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.
- (dict) –
  
  Add an operating Region to an 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.
  - RegionName (string) –
    
    The name of the operating Region.
RemoveOperatingRegions (list) –
The operating Regions to remove.
- (dict) –
  
  Remove an operating Region from an 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
  - RegionName (string) –
    
    The name of the operating Region you want to remove.
Tier (string) – IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

Return type:

dict

Returns:

Response Syntax

{
    'Ipam': {
        'OwnerId': 'string',
        'IpamId': 'string',
        'IpamArn': 'string',
        'IpamRegion': 'string',
        'PublicDefaultScopeId': 'string',
        'PrivateDefaultScopeId': 'string',
        'ScopeCount': 123,
        'Description': 'string',
        'OperatingRegions': [
            {
                'RegionName': 'string'
            },
        ],
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'DefaultResourceDiscoveryId': 'string',
        'DefaultResourceDiscoveryAssociationId': 'string',
        'ResourceDiscoveryAssociationCount': 123,
        'StateMessage': 'string',
        'Tier': 'free'|'advanced'
    }
}

Response Structure

(dict) –
- Ipam (dict) –
  
  The results of the modification.
  - OwnerId (string) –
    
    The Amazon Web Services account ID of the owner of the IPAM.
  - IpamId (string) –
    
    The ID of the IPAM.
  - IpamArn (string) –
    
    The Amazon Resource Name (ARN) of the IPAM.
  - IpamRegion (string) –
    
    The Amazon Web Services Region of the IPAM.
  - PublicDefaultScopeId (string) –
    
    The ID of the IPAM’s default public scope.
  - PrivateDefaultScopeId (string) –
    
    The ID of the IPAM’s default private scope.
  - ScopeCount (integer) –
    
    The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
  - Description (string) –
    
    The description for the IPAM.
  - OperatingRegions (list) –
    
    The operating Regions for an 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.
    - (dict) –
      
      The operating Regions for an 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.
      - RegionName (string) –
        
        The name of the operating Region.
  - State (string) –
    
    The state of the IPAM.
  - Tags (list) –
    
    The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - DefaultResourceDiscoveryId (string) –
    
    The IPAM’s default resource discovery ID.
  - DefaultResourceDiscoveryAssociationId (string) –
    
    The IPAM’s default resource discovery association ID.
  - ResourceDiscoveryAssociationCount (integer) –
    
    The IPAM’s resource discovery association count.
  - StateMessage (string) –
    
    The state message.
  - Tier (string) –
    
    IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.