LambdaCore / Client / list_network_connectors
list_network_connectors¶
- LambdaCore.Client.list_network_connectors(**kwargs)¶
Returns a paginated list of network connectors in your account for the current Region. You can optionally filter results by connector state. Use the
Markerparameter 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.See also: AWS API Documentation
Request Syntax
response = client.list_network_connectors( State='PENDING'|'ACTIVE'|'INACTIVE'|'FAILED'|'DELETING'|'DELETE_FAILED', Marker='string', MaxItems=123 )
- Parameters:
State (string) – Optional filter to return only connectors in the specified state (for example,
ACTIVEorFAILED).Marker (string) – The pagination token from a previous
ListNetworkConnectorsresponse. Use this value to retrieve the next page of results.MaxItems (integer) – The maximum number of connectors to return per page. Valid range: 1 to 100.
- Return type:
dict
- Returns:
Response Syntax
{ 'NetworkConnectors': [ { 'Arn': 'string', 'Name': 'string', 'Id': 'string', 'Type': 'VPC_EGRESS', 'State': 'PENDING'|'ACTIVE'|'INACTIVE'|'FAILED'|'DELETING'|'DELETE_FAILED', 'LastModified': datetime(2015, 1, 1), 'LatestVersionArn': 'string', 'LatestVersion': 123 }, ], 'NextMarker': 'string' }
Response Structure
(dict) –
NetworkConnectors (list) –
A list of network connector summaries for the current page of results.
(dict) –
Summary information about a network connector returned by
ListNetworkConnectors. Contains identifying fields and current state. To retrieve full configuration details, useGetNetworkConnector.Arn (string) –
The ARN of the network connector.
Name (string) –
The name of the network connector.
Id (string) –
The unique identifier of the network connector.
Type (string) –
The type of the network connector (
VPC_EGRESS).State (string) –
The current state of the network connector.
LastModified (datetime) –
The date and time when the connector was last modified.
LatestVersionArn (string) –
The qualified ARN of the connector’s latest version, including the immutable version suffix.
LatestVersion (integer) –
The version number of the connector’s latest version. Each configuration update creates a new immutable version; this attribute exposes the most recent one.
NextMarker (string) –
The pagination token to include in a subsequent request to retrieve the next page. This value is null when there are no more results.
Exceptions