EC2 / Client / modify_ipam_scope

modify_ipam_scope¶

EC2.Client.modify_ipam_scope(**kwargs)¶

Modify an IPAM scope.

Request Syntax

response = client.modify_ipam_scope(
    DryRun=True|False,
    IpamScopeId='string',
    Description='string',
    ExternalAuthorityConfiguration={
        'Type': 'infoblox',
        'ExternalResourceIdentifier': 'string'
    },
    RemoveExternalAuthorityConfiguration=True|False
)

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

The ID of the scope you want to modify.
Description (string) – The description of the scope you want to modify.
ExternalAuthorityConfiguration (dict) –
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
- Type (string) –
  
  The type of external authority.
- ExternalResourceIdentifier (string) –
  
  The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.
RemoveExternalAuthorityConfiguration (boolean) – Remove the external authority configuration. true to remove.

Return type:

dict

Returns:

Response Syntax

{
    'IpamScope': {
        'OwnerId': 'string',
        'IpamScopeId': 'string',
        'IpamScopeArn': 'string',
        'IpamArn': 'string',
        'IpamRegion': 'string',
        'IpamScopeType': 'public'|'private',
        'IsDefault': True|False,
        'Description': 'string',
        'PoolCount': 123,
        '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'
            },
        ],
        'ExternalAuthorityConfiguration': {
            'Type': 'infoblox',
            'ExternalResourceIdentifier': 'string'
        }
    }
}

Response Structure

(dict) –
- IpamScope (dict) –
  
  The results of the modification.
  - OwnerId (string) –
    
    The Amazon Web Services account ID of the owner of the scope.
  - IpamScopeId (string) –
    
    The ID of the scope.
  - IpamScopeArn (string) –
    
    The Amazon Resource Name (ARN) of the scope.
  - IpamArn (string) –
    
    The ARN of the IPAM.
  - IpamRegion (string) –
    
    The Amazon Web Services Region of the IPAM scope.
  - IpamScopeType (string) –
    
    The type of the scope.
  - IsDefault (boolean) –
    
    Defines if the scope is the default scope or not.
  - Description (string) –
    
    The description of the scope.
  - PoolCount (integer) –
    
    The number of pools in the scope.
  - State (string) –
    
    The state of the IPAM scope.
  - 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.
  - ExternalAuthorityConfiguration (dict) –
    
    The external authority configuration for this IPAM scope, if configured.
    
    The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
    
    In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
    - Type (string) –
      
      The type of external authority managing this scope. Currently supports Infoblox for integration with Infoblox Universal DDI.
    - ExternalResourceIdentifier (string) –
      
      The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.