LambdaCore / Client / delete_network_connector

delete_network_connector

LambdaCore.Client.delete_network_connector(**kwargs)

Initiates deletion of a network connector. The connector transitions to DELETING state while elastic network interfaces are cleaned up asynchronously. After deletion completes, subsequent calls to GetNetworkConnector return ResourceNotFoundException.

This operation is idempotent — calling delete on a connector that is already deleting or has been deleted succeeds without error. You can delete connectors in ACTIVE or FAILED states. Before deleting a connector, ensure that no Lambda compute resources are using it, as they will lose VPC egress connectivity immediately.

Deleting with an unqualified identifier removes the connector and all of its versions. To remove a single historical version, supply its version-qualified ARN; the connector and its remaining versions are unaffected. You can’t delete the latest version on its own — delete the connector to remove it.

See also: AWS API Documentation

Request Syntax

response = client.delete_network_connector(
    Identifier='string'
)

Parameters:

Identifier (string) –

[REQUIRED]

The identifier of the network connector to delete. Provide an unqualified ARN (or an ID or name) to delete the entire connector and all of its versions, or a version-qualified ARN — one that includes the immutable version suffix — to delete a specific historical version. You can’t delete the latest version with a version-qualified identifier; delete the connector instead.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Id': 'string',
    'VersionArn': 'string',
    'Version': 123,
    'Configuration': {
        'VpcEgressConfiguration': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ],
            'NetworkProtocol': 'IPv4'|'DualStack',
            'AssociatedComputeResourceTypes': [
                'MicroVm'|'WebFunction',
            ]
        }
    },
    'OperatorRole': 'string',
    'State': 'PENDING'|'ACTIVE'|'INACTIVE'|'FAILED'|'DELETING'|'DELETE_FAILED'
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the network connector.

  • Name (string) –

    The name of the network connector.

  • Id (string) –

    The unique identifier of the network connector.

  • VersionArn (string) –

    The qualified ARN of the connector version affected by this request, including the immutable version suffix.

  • Version (integer) –

    The version number of the connector version affected by this request.

  • Configuration (dict) –

    The network configuration of the connector, including VPC subnets and security groups.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: VpcEgressConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • VpcEgressConfiguration (dict) –

      Configuration for a VPC egress network connector. Specifies the subnets, security groups, and network protocol for routing outbound traffic through your VPC.

      • SubnetIds (list) –

        The IDs of the VPC subnets where Lambda provisions elastic network interfaces (ENIs). Specify 1 to 16 subnets. All subnets must be in the same VPC.

        • (string) –

      • SecurityGroupIds (list) –

        The IDs of the VPC security groups to attach to the ENIs. All security groups must be in the same VPC as the subnets.

        • (string) –

      • NetworkProtocol (string) –

        The network protocol for the connector. Specify IPv4 for IPv4-only networking, or DualStack for both IPv4 and IPv6.

      • AssociatedComputeResourceTypes (list) –

        The types of Lambda compute resources that can use this connector. Valid values are MicroVm and WebFunction. Specify exactly one value.

        • (string) –

          The type of Lambda compute resource that can use a network connector.

  • OperatorRole (string) –

    The ARN of the IAM role that Lambda uses to manage the underlying ENI resources for this connector.

  • State (string) –

    The current state of the network connector. The State field is typically DELETING after this call.

Exceptions

• LambdaCore.Client.exceptions.InvalidParameterValueException

• LambdaCore.Client.exceptions.ResourceConflictException

• LambdaCore.Client.exceptions.ServiceException

• LambdaCore.Client.exceptions.TooManyRequestsException

• LambdaCore.Client.exceptions.ResourceNotFoundException