EC2 / Client / delete_ipam_routing_policy_registration

delete_ipam_routing_policy_registration

EC2.Client.delete_ipam_routing_policy_registration(**kwargs)

Deletes a routing policy registration for a specified CIDR prefix.

See also: AWS API Documentation

Request Syntax

response = client.delete_ipam_routing_policy_registration(
    DryRun=True|False,
    IpamInternetRegistryAssociationId='string',
    Cidr='string',
    Force=True|False,
    ClientToken='string'
)
Parameters:

  • DryRun (boolean) – Checks whether you have the required permissions for the operation, 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.

  • IpamInternetRegistryAssociationId (string) –

    [REQUIRED]

    The ID of the IPAM internet registry association.

  • Cidr (string) –

    [REQUIRED]

    The IP address prefix in CIDR notation identifying the routing policy registration to delete.

  • Force (boolean) – Forces the deletion even if it conflicts with an announced route. Default: false.

  • ClientToken (string) –

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'IpamRoutingPolicyRegistrationDelta': {
        'DeltaId': 'string',
        'DeltaJson': 'string',
        'State': 'pending'|'published'|'failed',
        'StateMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • IpamRoutingPolicyRegistrationDelta (dict) –

      Information about the routing policy registration delta created by this deletion.

      • DeltaId (string) –

        The unique identifier of the delta.

      • DeltaJson (string) –

        The JSON specification describing the changes applied in this delta.

      • State (string) –

        The state of the delta. Valid values: pending | published | failed.

      • StateMessage (string) –

        A message describing the current state, including error information if the delta failed.