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("networkmanager").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_connect_attachment#

Creates a core network Connect attachment from a specified core network attachment.

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

# create_connect_attachment method definition

def create_connect_attachment(
    self,
    *,
    CoreNetworkId: str,
    EdgeLocation: str,
    TransportAttachmentId: str,
    Options: ConnectAttachmentOptionsTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientToken: str = ...,
) -> CreateConnectAttachmentResponseTypeDef:  # (3)
    ...
  1. See ConnectAttachmentOptionsTypeDef
  2. See TagTypeDef
  3. See CreateConnectAttachmentResponseTypeDef 
# create_connect_attachment method usage example with argument unpacking

kwargs: CreateConnectAttachmentRequestRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
    "EdgeLocation": ...,
    "TransportAttachmentId": ...,
    "Options": ...,
}

parent.create_connect_attachment(**kwargs)
  1. See CreateConnectAttachmentRequestRequestTypeDef

create_connect_peer#

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance.

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

# create_connect_peer method definition

def create_connect_peer(
    self,
    *,
    ConnectAttachmentId: str,
    PeerAddress: str,
    InsideCidrBlocks: Sequence[str],
    CoreNetworkAddress: str = ...,
    BgpOptions: BgpOptionsTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientToken: str = ...,
) -> CreateConnectPeerResponseTypeDef:  # (3)
    ...
  1. See BgpOptionsTypeDef
  2. See TagTypeDef
  3. See CreateConnectPeerResponseTypeDef 
# create_connect_peer method usage example with argument unpacking

kwargs: CreateConnectPeerRequestRequestTypeDef = {  # (1)
    "ConnectAttachmentId": ...,
    "PeerAddress": ...,
    "InsideCidrBlocks": ...,
}

parent.create_connect_peer(**kwargs)
  1. See CreateConnectPeerRequestRequestTypeDef

create_connection#

Creates a connection between two devices.

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

# create_connection method definition

def create_connection(
    self,
    *,
    GlobalNetworkId: str,
    DeviceId: str,
    ConnectedDeviceId: str,
    LinkId: str = ...,
    ConnectedLinkId: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateConnectionResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateConnectionResponseTypeDef 
# create_connection method usage example with argument unpacking

kwargs: CreateConnectionRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "DeviceId": ...,
    "ConnectedDeviceId": ...,
}

parent.create_connection(**kwargs)
  1. See CreateConnectionRequestRequestTypeDef

create_core_network#

Creates a core network as part of your global network, and optionally, with a core network policy.

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

# create_core_network method definition

def create_core_network(
    self,
    *,
    GlobalNetworkId: str,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    PolicyDocument: str = ...,
    ClientToken: str = ...,
) -> CreateCoreNetworkResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateCoreNetworkResponseTypeDef 
# create_core_network method usage example with argument unpacking

kwargs: CreateCoreNetworkRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
}

parent.create_core_network(**kwargs)
  1. See CreateCoreNetworkRequestRequestTypeDef

create_device#

Creates a new device in a global network.

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

# create_device method definition

def create_device(
    self,
    *,
    GlobalNetworkId: str,
    AWSLocation: AWSLocationTypeDef = ...,  # (1)
    Description: str = ...,
    Type: str = ...,
    Vendor: str = ...,
    Model: str = ...,
    SerialNumber: str = ...,
    Location: LocationTypeDef = ...,  # (2)
    SiteId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateDeviceResponseTypeDef:  # (4)
    ...
  1. See AWSLocationTypeDef
  2. See LocationTypeDef
  3. See TagTypeDef
  4. See CreateDeviceResponseTypeDef 
# create_device method usage example with argument unpacking

kwargs: CreateDeviceRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
}

parent.create_device(**kwargs)
  1. See CreateDeviceRequestRequestTypeDef

create_global_network#

Creates a new, empty global network.

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

# create_global_network method definition

def create_global_network(
    self,
    *,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateGlobalNetworkResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateGlobalNetworkResponseTypeDef 
# create_global_network method usage example with argument unpacking

kwargs: CreateGlobalNetworkRequestRequestTypeDef = {  # (1)
    "Description": ...,
}

parent.create_global_network(**kwargs)
  1. See CreateGlobalNetworkRequestRequestTypeDef

Creates a new link for a specified site.

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

# create_link method definition

def create_link(
    self,
    *,
    GlobalNetworkId: str,
    Bandwidth: BandwidthTypeDef,  # (1)
    SiteId: str,
    Description: str = ...,
    Type: str = ...,
    Provider: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateLinkResponseTypeDef:  # (3)
    ...
  1. See BandwidthTypeDef
  2. See TagTypeDef
  3. See CreateLinkResponseTypeDef 
# create_link method usage example with argument unpacking

kwargs: CreateLinkRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "Bandwidth": ...,
    "SiteId": ...,
}

parent.create_link(**kwargs)
  1. See CreateLinkRequestRequestTypeDef

create_site#

Creates a new site in a global network.

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

# create_site method definition

def create_site(
    self,
    *,
    GlobalNetworkId: str,
    Description: str = ...,
    Location: LocationTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateSiteResponseTypeDef:  # (3)
    ...
  1. See LocationTypeDef
  2. See TagTypeDef
  3. See CreateSiteResponseTypeDef 
# create_site method usage example with argument unpacking

kwargs: CreateSiteRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
}

parent.create_site(**kwargs)
  1. See CreateSiteRequestRequestTypeDef

create_site_to_site_vpn_attachment#

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

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

# create_site_to_site_vpn_attachment method definition

def create_site_to_site_vpn_attachment(
    self,
    *,
    CoreNetworkId: str,
    VpnConnectionArn: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateSiteToSiteVpnAttachmentResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateSiteToSiteVpnAttachmentResponseTypeDef 
# create_site_to_site_vpn_attachment method usage example with argument unpacking

kwargs: CreateSiteToSiteVpnAttachmentRequestRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
    "VpnConnectionArn": ...,
}

parent.create_site_to_site_vpn_attachment(**kwargs)
  1. See CreateSiteToSiteVpnAttachmentRequestRequestTypeDef

create_transit_gateway_peering#

Creates a transit gateway peering connection.

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

# create_transit_gateway_peering method definition

def create_transit_gateway_peering(
    self,
    *,
    CoreNetworkId: str,
    TransitGatewayArn: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateTransitGatewayPeeringResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateTransitGatewayPeeringResponseTypeDef 
# create_transit_gateway_peering method usage example with argument unpacking

kwargs: CreateTransitGatewayPeeringRequestRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
    "TransitGatewayArn": ...,
}

parent.create_transit_gateway_peering(**kwargs)
  1. See CreateTransitGatewayPeeringRequestRequestTypeDef

create_transit_gateway_route_table_attachment#

Creates a transit gateway route table attachment.

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

# create_transit_gateway_route_table_attachment method definition

def create_transit_gateway_route_table_attachment(
    self,
    *,
    PeeringId: str,
    TransitGatewayRouteTableArn: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    ClientToken: str = ...,
) -> CreateTransitGatewayRouteTableAttachmentResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateTransitGatewayRouteTableAttachmentResponseTypeDef 
# create_transit_gateway_route_table_attachment method usage example with argument unpacking

kwargs: CreateTransitGatewayRouteTableAttachmentRequestRequestTypeDef = {  # (1)
    "PeeringId": ...,
    "TransitGatewayRouteTableArn": ...,
}

parent.create_transit_gateway_route_table_attachment(**kwargs)
  1. See CreateTransitGatewayRouteTableAttachmentRequestRequestTypeDef

create_vpc_attachment#

Creates a VPC attachment on an edge location of a core network.

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

# create_vpc_attachment method definition

def create_vpc_attachment(
    self,
    *,
    CoreNetworkId: str,
    VpcArn: str,
    SubnetArns: Sequence[str],
    Options: VpcOptionsTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientToken: str = ...,
) -> CreateVpcAttachmentResponseTypeDef:  # (3)
    ...
  1. See VpcOptionsTypeDef
  2. See TagTypeDef
  3. See CreateVpcAttachmentResponseTypeDef 
# create_vpc_attachment method usage example with argument unpacking

kwargs: CreateVpcAttachmentRequestRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
    "VpcArn": ...,
    "SubnetArns": ...,
}

parent.create_vpc_attachment(**kwargs)
  1. See CreateVpcAttachmentRequestRequestTypeDef

delete_attachment#

Deletes an attachment.

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

# delete_attachment method definition

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

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

parent.delete_attachment(**kwargs)
  1. See DeleteAttachmentRequestRequestTypeDef

delete_connect_peer#

Deletes a Connect peer.

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

# delete_connect_peer method definition

def delete_connect_peer(
    self,
    *,
    ConnectPeerId: str,
) -> DeleteConnectPeerResponseTypeDef:  # (1)
    ...
  1. See DeleteConnectPeerResponseTypeDef 
# delete_connect_peer method usage example with argument unpacking

kwargs: DeleteConnectPeerRequestRequestTypeDef = {  # (1)
    "ConnectPeerId": ...,
}

parent.delete_connect_peer(**kwargs)
  1. See DeleteConnectPeerRequestRequestTypeDef

delete_connection#

Deletes the specified connection in your global network.

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

# delete_connection method definition

def delete_connection(
    self,
    *,
    GlobalNetworkId: str,
    ConnectionId: str,
) -> DeleteConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteConnectionResponseTypeDef 
# delete_connection method usage example with argument unpacking

kwargs: DeleteConnectionRequestRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "ConnectionId": ...,
}

parent.delete_connection(**kwargs)
  1. See DeleteConnectionRequestRequestTypeDef

delete_core_network#

Deletes a core network along with all core network policies.

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

# delete_core_network method definition

def delete_core_network(
    self,
    *,
    CoreNetworkId: str,
) -> DeleteCoreNetworkResponseTypeDef:  # (1)
    ...
  1. See DeleteCoreNetworkResponseTypeDef 
# delete_core_network method usage example with argument unpacking

kwargs: DeleteCoreNetworkRequestRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
}

parent.delete_core_network(**kwargs)
  1. See DeleteCoreNetworkRequestRequestTypeDef

delete_core_network_policy_version#

Deletes a policy version from a core network.

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

# delete_core_network_policy_version method definition

def delete_core_network_policy_version(
    self,
    *,
    CoreNetworkId: str,
    PolicyVersionId: int,
) -> DeleteCoreNetworkPolicyVersionResponseTypeDef:  # (1)
    ...
  1. See DeleteCoreNetworkPolicyVersionResponseTypeDef 
# delete_core_network_policy_version method usage example with argument unpacking

kwargs: DeleteCoreNetworkPolicyVersionRequestRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
    "PolicyVersionId": ...,
}

parent.delete_core_network_policy_version(**kwargs)
  1. See DeleteCoreNetworkPolicyVersionRequestRequestTypeDef

delete_device#

Deletes an existing device.

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

# delete_device method definition

def delete_device(
    self,
    *,
    GlobalNetworkId: str,
    DeviceId: str,
) -> DeleteDeviceResponseTypeDef:  # (1)
    ...
  1. See DeleteDeviceResponseTypeDef