LambdaCore / Client / get_network_connector

get_network_connector

LambdaCore.Client.get_network_connector(**kwargs)

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

Request Syntax

response = client.get_network_connector(
    Identifier='string'
)
Parameters:

Identifier (string) –

[REQUIRED]

The identifier of the network connector to retrieve. You can specify the connector ID, name, or ARN. Provide an unqualified ARN (or an ID or name) to retrieve the connector’s latest version, or a version-qualified ARN — one that includes the immutable version suffix — to retrieve a specific historical version.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Id': 'string',
    'VersionArn': 'string',
    'Version': 123,
    'LatestVersionArn': 'string',
    'LatestVersion': 123,
    'Configuration': {
        'VpcEgressConfiguration': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ],
            'NetworkProtocol': 'IPv4'|'DualStack',
            'AssociatedComputeResourceTypes': [
                'MicroVm'|'WebFunction',
            ]
        }
    },
    'OperatorRole': 'string',
    'State': 'PENDING'|'ACTIVE'|'INACTIVE'|'FAILED'|'DELETING'|'DELETE_FAILED',
    'StateReason': 'string',
    'StateReasonCode': 'DisallowedByVpcEncryptionControl'|'Ec2RequestLimitExceeded'|'InsufficientRolePermissions'|'InternalError'|'InvalidSecurityGroup'|'InvalidSubnet'|'SecurityGroupsPerInterfaceLimitExceeded'|'SubnetOutOfIPAddresses',
    'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
    'LastUpdateStatusReason': 'string',
    'LastUpdateStatusReasonCode': 'DisallowedByVpcEncryptionControl'|'Ec2RequestLimitExceeded'|'InsufficientRolePermissions'|'InternalError'|'InvalidSecurityGroup'|'InvalidSubnet'|'SecurityGroupsPerInterfaceLimitExceeded'|'SubnetOutOfIPAddresses',
    'LastModified': datetime(2015, 1, 1)
}

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 specific connector version returned by this request, including the immutable version suffix. This is populated only when you supply a version-qualified identifier. On a standard (unqualified) request, this field is not populated; the connector’s latest active version is returned instead through the LatestVersionArn and LatestVersion fields described below.

    • Version (integer) –

      The version number of the network connector. On a standard (unqualified) request, this is the connector’s current version; each configuration update increments it. When you supply a version-qualified identifier, this is the specific version you requested.

    • LatestVersionArn (string) –

      The qualified ARN of the connector’s latest active version, including the immutable version suffix. This field is returned only on a standard (unqualified) request; when you supply a version-qualified identifier it is not returned, and VersionArn is returned instead.

    • LatestVersion (integer) –

      The version number of the connector’s latest active version. Each configuration update creates a new immutable version; this attribute exposes the most recent one. This field is returned only on a standard (unqualified) 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.

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

    • LastUpdateStatus (string) –

      The status of the most recent update operation ( Successful, Failed, or 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.

    • LastModified (datetime) –

      The date and time when the connector configuration was last modified.

Exceptions