EC2 / Client / delete_ipam_scope

delete_ipam_scope

EC2.Client.delete_ipam_scope(**kwargs)

Delete the scope for an IPAM. You cannot delete the default scopes.

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

See also: AWS API Documentation

Request Syntax

response = client.delete_ipam_scope(
    DryRun=True|False,
    IpamScopeId='string'
)

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 to delete.

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'
            },
        ]
    }
}

Response Structure

• (dict) –

  • IpamScope (dict) –

    Information about the results of the deletion.

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