Skip to content

NetworkManagerClient#

Index > NetworkManager > NetworkManagerClient

Auto-generated documentation for NetworkManager type annotations stubs module mypy-boto3-networkmanager.

NetworkManagerClient#

Type annotations and code completion for boto3.client("networkmanager"). boto3 documentation

# NetworkManagerClient usage example

from boto3.session import Session
from mypy_boto3_networkmanager.client import NetworkManagerClient

def get_networkmanager_client() -> NetworkManagerClient:
    return Session().client("networkmanager")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("networkmanager").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("networkmanager")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.CoreNetworkPolicyException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_networkmanager.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

accept_attachment#

Accepts a core network attachment request.

Type annotations and code completion for boto3.client("networkmanager").accept_attachment method. boto3 documentation

# accept_attachment method definition

def accept_attachment(
    self,
    *,
    AttachmentId: str,
) -> AcceptAttachmentResponseTypeDef:  # (1)
    ...
  1. See AcceptAttachmentResponseTypeDef
# accept_attachment method usage example with argument unpacking

kwargs: AcceptAttachmentRequestRequestTypeDef = {  # (1)
    "AttachmentId": ...,
}

parent.accept_attachment(**kwargs)
  1. See AcceptAttachmentRequestRequestTypeDef

associate_connect_peer#

Associates a core network Connect peer with a device and optionally, with a link.

Type annotations and code completion for boto3.client("networkmanager").associate_connect_peer method. boto3 documentation

# associate_connect_peer method definition

def associate_connect_peer(
    self,
    *,
    GlobalNetworkId: str,
    ConnectPeerId: str,
    DeviceId: str,
    LinkId: str = ...,
) -> AssociateConnectPeerResponseTypeDef:  # (1)
    ...
  1. See AssociateConnectPeerResponseTypeDef
# associate_connect_peer method usage example with argument unpacking

kwargs: AssociateConnectPeerRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "ConnectPeerId": ...,
    "DeviceId": ...,
}

parent.associate_connect_peer(**kwargs)
  1. See AssociateConnectPeerRequestRequestTypeDef

associate_customer_gateway#

Associates a customer gateway with a device and optionally, with a link.

Type annotations and code completion for boto3.client("networkmanager").associate_customer_gateway method. boto3 documentation

# associate_customer_gateway method definition

def associate_customer_gateway(
    self,
    *,
    CustomerGatewayArn: str,
    GlobalNetworkId: str,
    DeviceId: str,
    LinkId: str = ...,
) -> AssociateCustomerGatewayResponseTypeDef:  # (1)
    ...
  1. See AssociateCustomerGatewayResponseTypeDef
# associate_customer_gateway method usage example with argument unpacking

kwargs: AssociateCustomerGatewayRequestRequestTypeDef = {  # (1)
    "CustomerGatewayArn": ...,
    "GlobalNetworkId": ...,
    "DeviceId": ...,
}

parent.associate_customer_gateway(**kwargs)
  1. See AssociateCustomerGatewayRequestRequestTypeDef

Associates a link to a device.

Type annotations and code completion for boto3.client("networkmanager").associate_link method. boto3 documentation

# associate_link method definition

def associate_link(
    self,
    *,
    GlobalNetworkId: str,
    DeviceId: str,
    LinkId: str,
) -> AssociateLinkResponseTypeDef:  # (1)
    ...
  1. See AssociateLinkResponseTypeDef
# associate_link method usage example with argument unpacking

kwargs: AssociateLinkRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "DeviceId": ...,
    "LinkId": ...,
}

parent.associate_link(**kwargs)
  1. See AssociateLinkRequestRequestTypeDef

associate_transit_gateway_connect_peer#

Associates a transit gateway Connect peer with a device, and optionally, with a link.

Type annotations and code completion for boto3.client("networkmanager").associate_transit_gateway_connect_peer method. boto3 documentation

# associate_transit_gateway_connect_peer method definition

def associate_transit_gateway_connect_peer(
    self,
    *,
    GlobalNetworkId: str,
    TransitGatewayConnectPeerArn: str,
    DeviceId: str,
    LinkId: str = ...,
) -> AssociateTransitGatewayConnectPeerResponseTypeDef:  # (1)
    ...
  1. See AssociateTransitGatewayConnectPeerResponseTypeDef
# associate_transit_gateway_connect_peer method usage example with argument unpacking

kwargs: AssociateTransitGatewayConnectPeerRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "TransitGatewayConnectPeerArn": ...,
    "DeviceId": ...,
}

parent.associate_transit_gateway_connect_peer(**kwargs)
  1. See AssociateTransitGatewayConnectPeerRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("networkmanager").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("networkman