EC2 / Client / delete_ipam

delete_ipam

EC2.Client.delete_ipam(**kwargs)

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_ipam(
    DryRun=True|False,
    IpamId='string',
    Cascade=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.

• IpamId (string) –

  [REQUIRED]

  The ID of the IPAM to delete.

• Cascade (boolean) –

  Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

  • Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  Note

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

  • Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

  • Deletes all IPAM pools in private scopes.

  • Deletes all non-default private scopes in the IPAM.

  • Deletes the default public and private scopes and the IPAM.

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
    }
}

Response Structure

• (dict) –

  • Ipam (dict) –

    Information about the results of the deletion.

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