EC2 / Client / delete_coip_pool

delete_coip_pool#

EC2.Client.delete_coip_pool(**kwargs)#

Deletes a pool of customer-owned IP (CoIP) addresses.

See also: AWS API Documentation

Request Syntax

response = client.delete_coip_pool(
    CoipPoolId='string',
    DryRun=True|False
)
Parameters:

  • CoipPoolId (string) –

    [REQUIRED]

    The ID of the CoIP pool that you want to delete.

  • DryRun (boolean) – Checks 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.

Return type:

dict

Returns:

Response Syntax

{
    'CoipPool': {
        'PoolId': 'string',
        'PoolCidrs': [
            'string',
        ],
        'LocalGatewayRouteTableId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'PoolArn': 'string'
    }
}

Response Structure

  • (dict) –

    • CoipPool (dict) –

      Information about the CoIP address pool.

      • PoolId (string) –

        The ID of the address pool.

      • PoolCidrs (list) –

        The address ranges of the address pool.

        • (string) –

      • LocalGatewayRouteTableId (string) –

        The ID of the local gateway route table.

      • Tags (list) –

        The tags.

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

      • PoolArn (string) –

        The ARN of the address pool.