CreateNetworkConnector

$result = $client->createNetworkConnector([/* ... */]);
$promise = $client->createNetworkConnectorAsync([/* ... */]);

Creates a network connector that enables Lambda compute resources to route outbound traffic through your Amazon VPC. The network connector provisions elastic network interfaces (ENIs) in the subnets you specify, providing a managed network path to private resources such as databases, caches, and internal APIs.

This operation is asynchronous. The network connector starts in PENDING state while ENIs are provisioned in your VPC (provisioning typically takes up to 10 minutes). Use GetNetworkConnector to poll the connector state until it reaches ACTIVE. Once active, you can attach the connector to supported Lambda compute resources — such as MicroVMs and WebFunctions — at run time. For how to attach a connector, see the documentation for the specific compute type.

This operation is idempotent when you provide a ClientToken — if you retry a request that completed successfully using the same client token, the operation returns the existing connector without creating a duplicate.

Parameter Syntax

$result = $client->createNetworkConnector([
    'ClientToken' => '<string>',
    'Configuration' => [ // REQUIRED
        'VpcEgressConfiguration' => [
            'AssociatedComputeResourceTypes' => ['<string>', ...],
            'NetworkProtocol' => 'IPv4|DualStack',
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'OperatorRole' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Configuration' => [
        'VpcEgressConfiguration' => [
            'AssociatedComputeResourceTypes' => ['<string>', ...],
            'NetworkProtocol' => 'IPv4|DualStack',
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
    'Id' => '<string>',
    'Name' => '<string>',
    'OperatorRole' => '<string>',
    'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
    'Version' => <integer>,
    'VersionArn' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid. Check the error message for details about which parameter failed validation.

ResourceConflictException:

The request could not be completed due to a conflict with the current state of the resource. For example, attempting to update a connector that is not in ACTIVE state.

NetworkConnectorLimitExceededException:

The request would exceed a network connector limit. For CreateNetworkConnector, the account has reached the maximum number of network connectors allowed. For UpdateNetworkConnector, the connector has reached the maximum number of versions allowed.

ServiceException:

An internal service error occurred. Retry the request with exponential backoff.

TooManyRequestsException:

The request was throttled due to exceeding the allowed request rate. Retry the request after a brief wait using exponential backoff.

DeleteNetworkConnector

$result = $client->deleteNetworkConnector([/* ... */]);
$promise = $client->deleteNetworkConnectorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteNetworkConnector([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Configuration' => [
        'VpcEgressConfiguration' => [
            'AssociatedComputeResourceTypes' => ['<string>', ...],
            'NetworkProtocol' => 'IPv4|DualStack',
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
    'Id' => '<string>',
    'Name' => '<string>',
    'OperatorRole' => '<string>',
    'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
    'Version' => <integer>,
    'VersionArn' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid. Check the error message for details about which parameter failed validation.

ResourceConflictException:

The request could not be completed due to a conflict with the current state of the resource. For example, attempting to update a connector that is not in ACTIVE state.

ServiceException:

An internal service error occurred. Retry the request with exponential backoff.

TooManyRequestsException:

The request was throttled due to exceeding the allowed request rate. Retry the request after a brief wait using exponential backoff.

ResourceNotFoundException:

The specified network connector does not exist. Verify the identifier (ID, name, or ARN) and Region.

GetNetworkConnector

$result = $client->getNetworkConnector([/* ... */]);
$promise = $client->getNetworkConnectorAsync([/* ... */]);

Retrieves the current configuration, state, and metadata of a network connector. The Identifier parameter accepts the connector ID, name, or full ARN. Use this operation to poll connector state after creation or update, or to inspect the current VPC configuration and any failure reasons.

The response includes the full connector configuration, current state, and — if the connector has been updated — the LastUpdateStatus and LastUpdateStatusReasonCode fields that indicate whether the most recent update succeeded or failed.

Parameter Syntax

$result = $client->getNetworkConnector([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Configuration' => [
        'VpcEgressConfiguration' => [
            'AssociatedComputeResourceTypes' => ['<string>', ...],
            'NetworkProtocol' => 'IPv4|DualStack',
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
    'Id' => '<string>',
    'LastModified' => <DateTime>,
    'LastUpdateStatus' => 'Successful|Failed|InProgress',
    'LastUpdateStatusReason' => '<string>',
    'LastUpdateStatusReasonCode' => 'DisallowedByVpcEncryptionControl|Ec2RequestLimitExceeded|InsufficientRolePermissions|InternalError|InvalidSecurityGroup|InvalidSubnet|SecurityGroupsPerInterfaceLimitExceeded|SubnetOutOfIPAddresses',
    'LatestVersion' => <integer>,
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'OperatorRole' => '<string>',
    'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
    'StateReason' => '<string>',
    'StateReasonCode' => 'DisallowedByVpcEncryptionControl|Ec2RequestLimitExceeded|InsufficientRolePermissions|InternalError|InvalidSecurityGroup|InvalidSubnet|SecurityGroupsPerInterfaceLimitExceeded|SubnetOutOfIPAddresses',
    'Version' => <integer>,
    'VersionArn' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid. Check the error message for details about which parameter failed validation.

ServiceException:

An internal service error occurred. Retry the request with exponential backoff.

TooManyRequestsException:

The request was throttled due to exceeding the allowed request rate. Retry the request after a brief wait using exponential backoff.

ResourceNotFoundException:

The specified network connector does not exist. Verify the identifier (ID, name, or ARN) and Region.

ListNetworkConnectorVersions

$result = $client->listNetworkConnectorVersions([/* ... */]);
$promise = $client->listNetworkConnectorVersionsAsync([/* ... */]);

Returns a paginated list of the versions of a network connector. Each configuration update creates a new immutable version; this operation lists those versions for the connector you specify. You can optionally filter results by version state. Use the Marker parameter from a previous response to retrieve the next page of results.

Each item in the response includes the version-qualified ARN, version number, current state, and last modified timestamp for that version. To retrieve the current (latest) configuration of the connector, use GetNetworkConnector; to inspect a specific version, call GetNetworkConnector with a version-qualified identifier.

Parameter Syntax

$result = $client->listNetworkConnectorVersions([
    'Identifier' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxItems' => <integer>,
    'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
]);

Parameter Details

Result Syntax

[
    'NetworkConnectorVersions' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'LastModified' => <DateTime>,
            'Name' => '<string>',
            'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
            'StateReason' => '<string>',
            'StateReasonCode' => 'DisallowedByVpcEncryptionControl|Ec2RequestLimitExceeded|InsufficientRolePermissions|InternalError|InvalidSecurityGroup|InvalidSubnet|SecurityGroupsPerInterfaceLimitExceeded|SubnetOutOfIPAddresses',
            'Version' => <integer>,
            'VersionArn' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid. Check the error message for details about which parameter failed validation.

ServiceException:

An internal service error occurred. Retry the request with exponential backoff.

TooManyRequestsException:

The request was throttled due to exceeding the allowed request rate. Retry the request after a brief wait using exponential backoff.

ResourceNotFoundException:

The specified network connector does not exist. Verify the identifier (ID, name, or ARN) and Region.

ListNetworkConnectors

$result = $client->listNetworkConnectors([/* ... */]);
$promise = $client->listNetworkConnectorsAsync([/* ... */]);

Returns a paginated list of network connectors in your account for the current Region. You can optionally filter results by connector state. Use the Marker parameter from a previous response to retrieve the next page of results.

Each item in the response includes the connector ARN, name, ID, type, current state, and last modified timestamp. To retrieve full configuration details for a specific connector, use GetNetworkConnector.

Parameter Syntax

$result = $client->listNetworkConnectors([
    'Marker' => '<string>',
    'MaxItems' => <integer>,
    'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
]);

Parameter Details

Result Syntax

[
    'NetworkConnectors' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'LastModified' => <DateTime>,
            'LatestVersion' => <integer>,
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
            'Type' => 'VPC_EGRESS',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid. Check the error message for details about which parameter failed validation.

ServiceException:

An internal service error occurred. Retry the request with exponential backoff.

TooManyRequestsException:

The request was throttled due to exceeding the allowed request rate. Retry the request after a brief wait using exponential backoff.

UpdateNetworkConnector

$result = $client->updateNetworkConnector([/* ... */]);
$promise = $client->updateNetworkConnectorAsync([/* ... */]);

Updates the VPC configuration or operator role of an existing network connector. You can modify the subnet IDs, security group IDs, network protocol, or operator role. The connector must be in ACTIVE state to accept updates.

This operation is asynchronous. The connector remains in ACTIVE state during the update — existing workloads that reference this connector are not disrupted. Use GetNetworkConnector to monitor the LastUpdateStatus field, which transitions through InProgress to Successful or Failed. If the update fails, the LastUpdateStatusReasonCode field provides a specific error code for troubleshooting. This operation is idempotent when you provide a ClientToken.

Each successful configuration change creates a new immutable version. A connector can have a limited number of versions; once that limit is reached, further updates fail with NetworkConnectorLimitExceededException until you delete older versions.

Parameter Syntax

$result = $client->updateNetworkConnector([
    'ClientToken' => '<string>',
    'Configuration' => [
        'VpcEgressConfiguration' => [
            'AssociatedComputeResourceTypes' => ['<string>', ...],
            'NetworkProtocol' => 'IPv4|DualStack',
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
    'Identifier' => '<string>', // REQUIRED
    'OperatorRole' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Configuration' => [
        'VpcEgressConfiguration' => [
            'AssociatedComputeResourceTypes' => ['<string>', ...],
            'NetworkProtocol' => 'IPv4|DualStack',
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
    ],
    'Id' => '<string>',
    'LastModified' => <DateTime>,
    'LastUpdateStatus' => 'Successful|Failed|InProgress',
    'LastUpdateStatusReason' => '<string>',
    'Name' => '<string>',
    'OperatorRole' => '<string>',
    'State' => 'PENDING|ACTIVE|INACTIVE|FAILED|DELETING|DELETE_FAILED',
    'Version' => <integer>,
    'VersionArn' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One of the parameters in the request is not valid. Check the error message for details about which parameter failed validation.

ResourceConflictException:

The request could not be completed due to a conflict with the current state of the resource. For example, attempting to update a connector that is not in ACTIVE state.

NetworkConnectorLimitExceededException:

The request would exceed a network connector limit. For CreateNetworkConnector, the account has reached the maximum number of network connectors allowed. For UpdateNetworkConnector, the connector has reached the maximum number of versions allowed.

ServiceException:

An internal service error occurred. Retry the request with exponential backoff.

TooManyRequestsException:

The request was throttled due to exceeding the allowed request rate. Retry the request after a brief wait using exponential backoff.

ResourceNotFoundException:

The specified network connector does not exist. Verify the identifier (ID, name, or ARN) and Region.