:doc:`EC2 <../../ec2>` / Client / modify_ipam

***********
modify_ipam
***********



.. py:method:: EC2.Client.modify_ipam(**kwargs)

  

  Modify the configurations of an IPAM.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpam>`_  


  **Request Syntax**
  ::

    response = client.modify_ipam(
        DryRun=True|False,
        IpamId='string',
        Description='string',
        AddOperatingRegions=[
            {
                'RegionName': 'string'
            },
        ],
        RemoveOperatingRegions=[
            {
                'RegionName': 'string'
            },
        ],
        Tier='free'|'advanced',
        EnablePrivateGua=True|False,
        MeteredAccount='ipam-owner'|'resource-owner'
    )
    
  :type DryRun: boolean
  :param 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``.

    

  
  :type IpamId: string
  :param IpamId: **[REQUIRED]** 

    The ID of the IPAM you want to modify.

    

  
  :type Description: string
  :param Description: 

    The description of the IPAM you want to modify.

    

  
  :type AddOperatingRegions: list
  :param 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 <https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html>`__ 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 <https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html>`__ in the *Amazon VPC IPAM User Guide*.

      

    
      - **RegionName** *(string) --* 

        The name of the operating Region.

        

      
    

  :type RemoveOperatingRegions: list
  :param RemoveOperatingRegions: 

    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 <https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html>`__ in the *Amazon VPC IPAM User Guide*

      

    
      - **RegionName** *(string) --* 

        The name of the operating Region you want to remove.

        

      
    

  :type Tier: string
  :param Tier: 

    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 <http://aws.amazon.com/vpc/pricing/>`__.

    

  
  :type EnablePrivateGua: boolean
  :param EnablePrivateGua: 

    Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

    

  
  :type MeteredAccount: string
  :param MeteredAccount: 

    A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see `Enable cost distribution <https://docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html>`__ in the *Amazon VPC IPAM User Guide*.

     

    Possible values:

     

    
    * ``ipam-owner`` (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
     
    * ``resource-owner``: The Amazon Web Services account that owns the IP address is charged for the active IP address.
    

    

  
  
  :rtype: 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',
              'EnablePrivateGua': True|False,
              'MeteredAccount': 'ipam-owner'|'resource-owner'
          }
      }
      
    **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 <https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html>`__ 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 <https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html>`__ 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 <https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html>`__ 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 <http://aws.amazon.com/vpc/pricing/>`__.

          
        

        - **EnablePrivateGua** *(boolean) --* 

          Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

          
        

        - **MeteredAccount** *(string) --* 

          A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see `Enable cost distribution <https://docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html>`__ in the *Amazon VPC IPAM User Guide*.

           

          Possible values:

           

          
          * ``ipam-owner`` (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
           
          * ``resource-owner``: The Amazon Web Services account that owns the IP address is charged for the active IP address.
          

          
    
  