AWS CLI Command Reference

[ aws . lambda-core ]

get-network-connector

Description

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.

See also: AWS API Documentation

Synopsis

  get-network-connector
--identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--identifier (string) [required]

A flexible identifier that accepts a network connector ID, name, or ARN

Constraints:

  • min: 1
  • max: 140

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

Arn -> (string)

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

Constraints:

  • min: 1
  • max: 140
  • pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?)

Name -> (string)

The name of the network connector.

Constraints:

  • min: 1
  • max: 140
  • pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?)|[a-zA-Z0-9_-]{1,64}

Id -> (string)

The unique identifier for a network connector, assigned by the service at creation time

Constraints:

  • min: 1
  • max: 140

Version -> (long)

The version number of the connector configuration, incremented on each update.

Constraints:

  • min: 0

Configuration -> (tagged union structure)

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 can be set: VpcEgressConfiguration.

VpcEgressConfiguration -> (structure)

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.

Constraints:

  • min: 1
  • max: 16

(string)

Constraints:

  • min: 0
  • max: 1024
  • pattern: subnet-[0-9a-z]*

SecurityGroupIds -> (list)

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

Constraints:

  • min: 0
  • max: 5

(string)

Constraints:

  • min: 0
  • max: 1024
  • pattern: sg-[0-9a-zA-Z]*

NetworkProtocol -> (string)

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

Possible values:

  • IPv4
  • DualStack

AssociatedComputeResourceTypes -> (list)

The types of Lambda compute resources that can use this connector. Currently, only MicroVm is supported.

Constraints:

  • min: 1
  • max: 1

(string)

Possible values:

  • MicroVm

OperatorRole -> (string)

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

Constraints:

  • min: 0
  • max: 10000
  • pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

State -> (string)

The current state of the network connector.

Possible values:

  • PENDING
  • ACTIVE
  • INACTIVE
  • FAILED
  • DELETING
  • DELETE_FAILED

StateReason -> (string)

A human-readable explanation of the current state, populated when the state is FAILED or DELETE_FAILED .

StateReasonCode -> (string)

A machine-readable code indicating the reason for the current state. Use this for programmatic error handling.

Possible values:

  • DisallowedByVpcEncryptionControl
  • Ec2RequestLimitExceeded
  • InsufficientRolePermissions
  • InternalError
  • InvalidSecurityGroup
  • InvalidSubnet
  • SubnetOutOfIPAddresses

LastUpdateStatus -> (string)

The status of the most recent update operation (Successful , Failed , or InProgress ).

Possible values:

  • Successful
  • Failed
  • InProgress

LastUpdateStatusReason -> (string)

A human-readable explanation of the last update status.

LastUpdateStatusReasonCode -> (string)

A machine-readable code indicating the reason for the last update status. Use this for programmatic error handling.

Possible values:

  • DisallowedByVpcEncryptionControl
  • Ec2RequestLimitExceeded
  • InsufficientRolePermissions
  • InternalError
  • InvalidSecurityGroup
  • InvalidSubnet
  • SubnetOutOfIPAddresses

LastModified -> (timestamp)

The date and time when the connector configuration was last modified.
© Copyright 2026, Amazon Web Services. Created using Sphinx.