Skip to content

NetworkManagerClient#

Index > NetworkManager > NetworkManagerClient

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

NetworkManagerClient#

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

# NetworkManagerClient usage example

from boto3.session import Session
from types_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 types_boto3_networkmanager.client import Exceptions

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

Methods#

can_paginate#

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

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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: AcceptAttachmentRequestTypeDef = {  # (1)
    "AttachmentId": ...,
}

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

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: AssociateConnectPeerRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "ConnectPeerId": ...,
    "DeviceId": ...,
}

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

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: AssociateCustomerGatewayRequestTypeDef = {  # (1)
    "CustomerGatewayArn": ...,
    "GlobalNetworkId": ...,
    "DeviceId": ...,
}

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

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: AssociateLinkRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "DeviceId": ...,
    "LinkId": ...,
}

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

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: AssociateTransitGatewayConnectPeerRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "TransitGatewayConnectPeerArn": ...,
    "DeviceId": ...,
}

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

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 Sequence[TagTypeDef]
  3. See CreateConnectAttachmentResponseTypeDef
# create_connect_attachment method usage example with argument unpacking

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

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

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,
    CoreNetworkAddress: str = ...,
    BgpOptions: BgpOptionsTypeDef = ...,  # (1)
    InsideCidrBlocks: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientToken: str = ...,
    SubnetArn: str = ...,
) -> CreateConnectPeerResponseTypeDef:  # (3)
    ...
  1. See BgpOptionsTypeDef
  2. See Sequence[TagTypeDef]
  3. See CreateConnectPeerResponseTypeDef
# create_connect_peer method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  2. See CreateConnectionResponseTypeDef
# create_connection method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  2. See CreateCoreNetworkResponseTypeDef
# create_core_network method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  4. See CreateDeviceResponseTypeDef
# create_device method usage example with argument unpacking

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

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

create_direct_connect_gateway_attachment#

Creates an Amazon Web Services Direct Connect gateway attachment.

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

# create_direct_connect_gateway_attachment method definition

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

kwargs: CreateDirectConnectGatewayAttachmentRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
    "DirectConnectGatewayArn": ...,
    "EdgeLocations": ...,
}

parent.create_direct_connect_gateway_attachment(**kwargs)
  1. See CreateDirectConnectGatewayAttachmentRequestTypeDef

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 Sequence[TagTypeDef]
  2. See CreateGlobalNetworkResponseTypeDef
# create_global_network method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  3. See CreateLinkResponseTypeDef
# create_link method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  3. See CreateSiteResponseTypeDef
# create_site method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  2. See CreateSiteToSiteVpnAttachmentResponseTypeDef
# create_site_to_site_vpn_attachment method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  2. See CreateTransitGatewayPeeringResponseTypeDef
# create_transit_gateway_peering method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  2. See CreateTransitGatewayRouteTableAttachmentResponseTypeDef
# create_transit_gateway_route_table_attachment method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  3. See CreateVpcAttachmentResponseTypeDef
# create_vpc_attachment method usage example with argument unpacking

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

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

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: DeleteAttachmentRequestTypeDef = {  # (1)
    "AttachmentId": ...,
}

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

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: DeleteConnectPeerRequestTypeDef = {  # (1)
    "ConnectPeerId": ...,
}

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

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: DeleteConnectionRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "ConnectionId": ...,
}

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

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: DeleteCoreNetworkRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
}

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

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: DeleteCoreNetworkPolicyVersionRequestTypeDef = {  # (1)
    "CoreNetworkId": ...,
    "PolicyVersionId": ...,
}

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

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
# delete_device method usage example with argument unpacking

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

parent.delete_device(**kwargs)
  1. See DeleteDeviceRequestTypeDef

delete_global_network#

Deletes an existing global network.

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

# delete_global_network method definition

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

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

parent.delete_global_network(**kwargs)
  1. See DeleteGlobalNetworkRequestTypeDef

Deletes an existing link.

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

# delete_link method definition

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

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

parent.delete_link(**kwargs)
  1. See DeleteLinkRequestTypeDef

delete_peering#

Deletes an existing peering connection.

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

# delete_peering method definition

def delete_peering(
    self,
    *,
    PeeringId: str,
) -> DeletePeeringResponseTypeDef:  # (1)
    ...
  1. See DeletePeeringResponseTypeDef
# delete_peering method usage example with argument unpacking

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

parent.delete_peering(**kwargs)
  1. See DeletePeeringRequestTypeDef

delete_resource_policy#

Deletes a resource policy for the specified resource.

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyRequestTypeDef

delete_site#

Deletes an existing site.

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

# delete_site method definition

def delete_site(
    self,
    *,
    GlobalNetworkId: str,
    SiteId: str,
) -> DeleteSiteResponseTypeDef:  # (1)
    ...
  1. See DeleteSiteResponseTypeDef
# delete_site method usage example with argument unpacking

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

parent.delete_site(**kwargs)
  1. See DeleteSiteRequestTypeDef

deregister_transit_gateway#

Deregisters a transit gateway from your global network.

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

# deregister_transit_gateway method definition

def deregister_transit_gateway(
    self,
    *,
    GlobalNetworkId: str,
    TransitGatewayArn: str,
) -> DeregisterTransitGatewayResponseTypeDef:  # (1)
    ...
  1. See DeregisterTransitGatewayResponseTypeDef
# deregister_transit_gateway method usage example with argument unpacking

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

parent.deregister_transit_gateway(**kwargs)
  1. See DeregisterTransitGatewayRequestTypeDef

describe_global_networks#

Describes one or more global networks.

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

# describe_global_networks method definition

def describe_global_networks(
    self,
    *,
    GlobalNetworkIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeGlobalNetworksResponseTypeDef:  # (1)
    ...
  1. See DescribeGlobalNetworksResponseTypeDef
# describe_global_networks method usage example with argument unpacking

kwargs: DescribeGlobalNetworksRequestTypeDef = {  # (1)
    "GlobalNetworkIds": ...,
}

parent.describe_global_networks(**kwargs)
  1. See DescribeGlobalNetworksRequestTypeDef

disassociate_connect_peer#

Disassociates a core network Connect peer from a device and a link.

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

# disassociate_connect_peer method definition

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

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

parent.disassociate_connect_peer(**kwargs)
  1. See DisassociateConnectPeerRequestTypeDef

disassociate_customer_gateway#

Disassociates a customer gateway from a device and a link.

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

# disassociate_customer_gateway method definition

def disassociate_customer_gateway(
    self,
    *,
    GlobalNetworkId: str,
    CustomerGatewayArn: str,
) -> DisassociateCustomerGatewayResponseTypeDef:  # (1)
    ...
  1. See DisassociateCustomerGatewayResponseTypeDef
# disassociate_customer_gateway method usage example with argument unpacking

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

parent.disassociate_customer_gateway(**kwargs)
  1. See DisassociateCustomerGatewayRequestTypeDef

Disassociates an existing device from a link.

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

# disassociate_link method definition

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

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

parent.disassociate_link(**kwargs)
  1. See DisassociateLinkRequestTypeDef

disassociate_transit_gateway_connect_peer#

Disassociates a transit gateway Connect peer from a device and link.

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

# disassociate_transit_gateway_connect_peer method definition

def disassociate_transit_gateway_connect_peer(
    self,
    *,
    GlobalNetworkId: str,
    TransitGatewayConnectPeerArn: str,
) -> DisassociateTransitGatewayConnectPeerResponseTypeDef:  # (1)
    ...
  1. See DisassociateTransitGatewayConnectPeerResponseTypeDef
# disassociate_transit_gateway_connect_peer method usage example with argument unpacking

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

parent.disassociate_transit_gateway_connect_peer(**kwargs)
  1. See DisassociateTransitGatewayConnectPeerRequestTypeDef

execute_core_network_change_set#

Executes a change set on your core network.

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

# execute_core_network_change_set method definition

def execute_core_network_change_set(
    self,
    *,
    CoreNetworkId: str,
    PolicyVersionId: int,
) -> Dict[str, Any]:
    ...
# execute_core_network_change_set method usage example with argument unpacking

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

parent.execute_core_network_change_set(**kwargs)
  1. See ExecuteCoreNetworkChangeSetRequestTypeDef

get_connect_attachment#

Returns information about a core network Connect attachment.

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

# get_connect_attachment method definition

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

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

parent.get_connect_attachment(**kwargs)
  1. See GetConnectAttachmentRequestTypeDef

get_connect_peer#

Returns information about a core network Connect peer.

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

# get_connect_peer method definition

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

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

parent.get_connect_peer(**kwargs)
  1. See GetConnectPeerRequestTypeDef

get_connect_peer_associations#

Returns information about a core network Connect peer associations.

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

# get_connect_peer_associations method definition

def get_connect_peer_associations(
    self,
    *,
    GlobalNetworkId: str,
    ConnectPeerIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetConnectPeerAssociationsResponseTypeDef:  # (1)
    ...
  1. See GetConnectPeerAssociationsResponseTypeDef
# get_connect_peer_associations method usage example with argument unpacking

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

parent.get_connect_peer_associations(**kwargs)
  1. See GetConnectPeerAssociationsRequestTypeDef

get_connections#

Gets information about one or more of your connections in a global network.

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

# get_connections method definition

def get_connections(
    self,
    *,
    GlobalNetworkId: str,
    ConnectionIds: Sequence[str] = ...,
    DeviceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetConnectionsResponseTypeDef:  # (1)
    ...
  1. See GetConnectionsResponseTypeDef
# get_connections method usage example with argument unpacking

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

parent.get_connections(**kwargs)
  1. See GetConnectionsRequestTypeDef

get_core_network#

Returns information about the LIVE policy for a core network.

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

# get_core_network method definition

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

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

parent.get_core_network(**kwargs)
  1. See GetCoreNetworkRequestTypeDef

get_core_network_change_events#

Returns information about a core network change event.

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

# get_core_network_change_events method definition

def get_core_network_change_events(
    self,
    *,
    CoreNetworkId: str,
    PolicyVersionId: int,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetCoreNetworkChangeEventsResponseTypeDef:  # (1)
    ...
  1. See GetCoreNetworkChangeEventsResponseTypeDef
# get_core_network_change_events method usage example with argument unpacking

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

parent.get_core_network_change_events(**kwargs)
  1. See GetCoreNetworkChangeEventsRequestTypeDef

get_core_network_change_set#

Returns a change set between the LIVE core network policy and a submitted policy.

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

# get_core_network_change_set method definition

def get_core_network_change_set(
    self,
    *,
    CoreNetworkId: str,
    PolicyVersionId: int,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetCoreNetworkChangeSetResponseTypeDef:  # (1)
    ...
  1. See GetCoreNetworkChangeSetResponseTypeDef
# get_core_network_change_set method usage example with argument unpacking

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

parent.get_core_network_change_set(**kwargs)
  1. See GetCoreNetworkChangeSetRequestTypeDef

get_core_network_policy#

Returns details about a core network policy.

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

# get_core_network_policy method definition

def get_core_network_policy(
    self,
    *,
    CoreNetworkId: str,
    PolicyVersionId: int = ...,
    Alias: CoreNetworkPolicyAliasType = ...,  # (1)
) -> GetCoreNetworkPolicyResponseTypeDef:  # (2)
    ...
  1. See CoreNetworkPolicyAliasType
  2. See GetCoreNetworkPolicyResponseTypeDef
# get_core_network_policy method usage example with argument unpacking

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

parent.get_core_network_policy(**kwargs)
  1. See GetCoreNetworkPolicyRequestTypeDef

get_customer_gateway_associations#

Gets the association information for customer gateways that are associated with devices and links in your global network.

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

# get_customer_gateway_associations method definition

def get_customer_gateway_associations(
    self,
    *,
    GlobalNetworkId: str,
    CustomerGatewayArns: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetCustomerGatewayAssociationsResponseTypeDef:  # (1)
    ...
  1. See GetCustomerGatewayAssociationsResponseTypeDef
# get_customer_gateway_associations method usage example with argument unpacking

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

parent.get_customer_gateway_associations(**kwargs)
  1. See GetCustomerGatewayAssociationsRequestTypeDef

get_devices#

Gets information about one or more of your devices in a global network.

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

# get_devices method definition

def get_devices(
    self,
    *,
    GlobalNetworkId: str,
    DeviceIds: Sequence[str] = ...,
    SiteId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetDevicesResponseTypeDef:  # (1)
    ...
  1. See GetDevicesResponseTypeDef
# get_devices method usage example with argument unpacking

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

parent.get_devices(**kwargs)
  1. See GetDevicesRequestTypeDef

get_direct_connect_gateway_attachment#

Returns information about a specific Amazon Web Services Direct Connect gateway attachment.

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

# get_direct_connect_gateway_attachment method definition

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

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

parent.get_direct_connect_gateway_attachment(**kwargs)
  1. See GetDirectConnectGatewayAttachmentRequestTypeDef

Gets the link associations for a device or a link.

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

# get_link_associations method definition

def get_link_associations(
    self,
    *,
    GlobalNetworkId: str,
    DeviceId: str = ...,
    LinkId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetLinkAssociationsResponseTypeDef:  # (1)
    ...
  1. See GetLinkAssociationsResponseTypeDef
# get_link_associations method usage example with argument unpacking

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

parent.get_link_associations(**kwargs)
  1. See GetLinkAssociationsRequestTypeDef

Gets information about one or more links in a specified global network.

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

# get_links method definition

def get_links(
    self,
    *,
    GlobalNetworkId: str,
    LinkIds: Sequence[str] = ...,
    SiteId: str = ...,
    Type: str = ...,
    Provider: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetLinksResponseTypeDef:  # (1)
    ...
  1. See GetLinksResponseTypeDef
# get_links method usage example with argument unpacking

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

parent.get_links(**kwargs)
  1. See GetLinksRequestTypeDef

get_network_resource_counts#

Gets the count of network resources, by resource type, for the specified global network.

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

# get_network_resource_counts method definition

def get_network_resource_counts(
    self,
    *,
    GlobalNetworkId: str,
    ResourceType: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetNetworkResourceCountsResponseTypeDef:  # (1)
    ...
  1. See GetNetworkResourceCountsResponseTypeDef
# get_network_resource_counts method usage example with argument unpacking

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

parent.get_network_resource_counts(**kwargs)
  1. See GetNetworkResourceCountsRequestTypeDef

get_network_resource_relationships#

Gets the network resource relationships for the specified global network.

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

# get_network_resource_relationships method definition

def get_network_resource_relationships(
    self,
    *,
    GlobalNetworkId: str,
    CoreNetworkId: str = ...,
    RegisteredGatewayArn: str = ...,
    AwsRegion: str = ...,
    AccountId: str = ...,
    ResourceType: str = ...,
    ResourceArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetNetworkResourceRelationshipsResponseTypeDef:  # (1)
    ...
  1. See GetNetworkResourceRelationshipsResponseTypeDef
# get_network_resource_relationships method usage example with argument unpacking

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

parent.get_network_resource_relationships(**kwargs)
  1. See GetNetworkResourceRelationshipsRequestTypeDef

get_network_resources#

Describes the network resources for the specified global network.

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

# get_network_resources method definition

def get_network_resources(
    self,
    *,
    GlobalNetworkId: str,
    CoreNetworkId: str = ...,
    RegisteredGatewayArn: str = ...,
    AwsRegion: str = ...,
    AccountId: str = ...,
    ResourceType: str = ...,
    ResourceArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetNetworkResourcesResponseTypeDef:  # (1)
    ...
  1. See GetNetworkResourcesResponseTypeDef
# get_network_resources method usage example with argument unpacking

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

parent.get_network_resources(**kwargs)
  1. See GetNetworkResourcesRequestTypeDef

get_network_routes#

Gets the network routes of the specified global network.

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

# get_network_routes method definition

def get_network_routes(
    self,
    *,
    GlobalNetworkId: str,
    RouteTableIdentifier: RouteTableIdentifierTypeDef,  # (1)
    ExactCidrMatches: Sequence[str] = ...,
    LongestPrefixMatches: Sequence[str] = ...,
    SubnetOfMatches: Sequence[str] = ...,
    SupernetOfMatches: Sequence[str] = ...,
    PrefixListIds: Sequence[str] = ...,
    States: Sequence[RouteStateType] = ...,  # (2)
    Types: Sequence[RouteTypeType] = ...,  # (3)
    DestinationFilters: Mapping[str, Sequence[str]] = ...,
) -> GetNetworkRoutesResponseTypeDef:  # (4)
    ...
  1. See RouteTableIdentifierTypeDef
  2. See Sequence[RouteStateType]
  3. See Sequence[RouteTypeType]
  4. See GetNetworkRoutesResponseTypeDef
# get_network_routes method usage example with argument unpacking

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

parent.get_network_routes(**kwargs)
  1. See GetNetworkRoutesRequestTypeDef

get_network_telemetry#

Gets the network telemetry of the specified global network.

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

# get_network_telemetry method definition

def get_network_telemetry(
    self,
    *,
    GlobalNetworkId: str,
    CoreNetworkId: str = ...,
    RegisteredGatewayArn: str = ...,
    AwsRegion: str = ...,
    AccountId: str = ...,
    ResourceType: str = ...,
    ResourceArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetNetworkTelemetryResponseTypeDef:  # (1)
    ...
  1. See GetNetworkTelemetryResponseTypeDef
# get_network_telemetry method usage example with argument unpacking

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

parent.get_network_telemetry(**kwargs)
  1. See GetNetworkTelemetryRequestTypeDef

get_resource_policy#

Returns information about a resource policy.

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

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> GetResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See GetResourcePolicyResponseTypeDef
# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policy(**kwargs)
  1. See GetResourcePolicyRequestTypeDef

get_route_analysis#

Gets information about the specified route analysis.

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

# get_route_analysis method definition

def get_route_analysis(
    self,
    *,
    GlobalNetworkId: str,
    RouteAnalysisId: str,
) -> GetRouteAnalysisResponseTypeDef:  # (1)
    ...
  1. See GetRouteAnalysisResponseTypeDef
# get_route_analysis method usage example with argument unpacking

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

parent.get_route_analysis(**kwargs)
  1. See GetRouteAnalysisRequestTypeDef

get_site_to_site_vpn_attachment#

Returns information about a site-to-site VPN attachment.

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

# get_site_to_site_vpn_attachment method definition

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

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

parent.get_site_to_site_vpn_attachment(**kwargs)
  1. See GetSiteToSiteVpnAttachmentRequestTypeDef

get_sites#

Gets information about one or more of your sites in a global network.

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

# get_sites method definition

def get_sites(
    self,
    *,
    GlobalNetworkId: str,
    SiteIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetSitesResponseTypeDef:  # (1)
    ...
  1. See GetSitesResponseTypeDef
# get_sites method usage example with argument unpacking

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

parent.get_sites(**kwargs)
  1. See GetSitesRequestTypeDef

get_transit_gateway_connect_peer_associations#

Gets information about one or more of your transit gateway Connect peer associations in a global network.

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

# get_transit_gateway_connect_peer_associations method definition

def get_transit_gateway_connect_peer_associations(
    self,
    *,
    GlobalNetworkId: str,
    TransitGatewayConnectPeerArns: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetTransitGatewayConnectPeerAssociationsResponseTypeDef:  # (1)
    ...
  1. See GetTransitGatewayConnectPeerAssociationsResponseTypeDef
# get_transit_gateway_connect_peer_associations method usage example with argument unpacking

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

parent.get_transit_gateway_connect_peer_associations(**kwargs)
  1. See GetTransitGatewayConnectPeerAssociationsRequestTypeDef

get_transit_gateway_peering#

Returns information about a transit gateway peer.

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

# get_transit_gateway_peering method definition

def get_transit_gateway_peering(
    self,
    *,
    PeeringId: str,
) -> GetTransitGatewayPeeringResponseTypeDef:  # (1)
    ...
  1. See GetTransitGatewayPeeringResponseTypeDef
# get_transit_gateway_peering method usage example with argument unpacking

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

parent.get_transit_gateway_peering(**kwargs)
  1. See GetTransitGatewayPeeringRequestTypeDef

get_transit_gateway_registrations#

Gets information about the transit gateway registrations in a specified global network.

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

# get_transit_gateway_registrations method definition

def get_transit_gateway_registrations(
    self,
    *,
    GlobalNetworkId: str,
    TransitGatewayArns: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetTransitGatewayRegistrationsResponseTypeDef:  # (1)
    ...
  1. See GetTransitGatewayRegistrationsResponseTypeDef
# get_transit_gateway_registrations method usage example with argument unpacking

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

parent.get_transit_gateway_registrations(**kwargs)
  1. See GetTransitGatewayRegistrationsRequestTypeDef

get_transit_gateway_route_table_attachment#

Returns information about a transit gateway route table attachment.

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

# get_transit_gateway_route_table_attachment method definition

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

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

parent.get_transit_gateway_route_table_attachment(**kwargs)
  1. See GetTransitGatewayRouteTableAttachmentRequestTypeDef

get_vpc_attachment#

Returns information about a VPC attachment.

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

# get_vpc_attachment method definition

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

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

parent.get_vpc_attachment(**kwargs)
  1. See GetVpcAttachmentRequestTypeDef

list_attachments#

Returns a list of core network attachments.

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

# list_attachments method definition

def list_attachments(
    self,
    *,
    CoreNetworkId: str = ...,
    AttachmentType: AttachmentTypeType = ...,  # (1)
    EdgeLocation: str = ...,
    State: AttachmentStateType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAttachmentsResponseTypeDef:  # (3)
    ...
  1. See AttachmentTypeType
  2. See AttachmentStateType
  3. See ListAttachmentsResponseTypeDef
# list_attachments method usage example with argument unpacking

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

parent.list_attachments(**kwargs)
  1. See ListAttachmentsRequestTypeDef

list_connect_peers#

Returns a list of core network Connect peers.

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

# list_connect_peers method definition

def list_connect_peers(
    self,
    *,
    CoreNetworkId: str = ...,
    ConnectAttachmentId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConnectPeersResponseTypeDef:  # (1)
    ...
  1. See ListConnectPeersResponseTypeDef
# list_connect_peers method usage example with argument unpacking

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

parent.list_connect_peers(**kwargs)
  1. See ListConnectPeersRequestTypeDef

list_core_network_policy_versions#

Returns a list of core network policy versions.

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

# list_core_network_policy_versions method definition

def list_core_network_policy_versions(
    self,
    *,
    CoreNetworkId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCoreNetworkPolicyVersionsResponseTypeDef:  # (1)
    ...
  1. See ListCoreNetworkPolicyVersionsResponseTypeDef
# list_core_network_policy_versions method usage example with argument unpacking

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

parent.list_core_network_policy_versions(**kwargs)
  1. See ListCoreNetworkPolicyVersionsRequestTypeDef

list_core_networks#

Returns a list of owned and shared core networks.

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

# list_core_networks method definition

def list_core_networks(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCoreNetworksResponseTypeDef:  # (1)
    ...
  1. See ListCoreNetworksResponseTypeDef
# list_core_networks method usage example with argument unpacking

kwargs: ListCoreNetworksRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_core_networks(**kwargs)
  1. See ListCoreNetworksRequestTypeDef

list_organization_service_access_status#

Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

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

# list_organization_service_access_status method definition

def list_organization_service_access_status(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOrganizationServiceAccessStatusResponseTypeDef:  # (1)
    ...
  1. See ListOrganizationServiceAccessStatusResponseTypeDef
# list_organization_service_access_status method usage example with argument unpacking

kwargs: ListOrganizationServiceAccessStatusRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_organization_service_access_status(**kwargs)
  1. See ListOrganizationServiceAccessStatusRequestTypeDef

list_peerings#

Lists the peerings for a core network.

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

# list_peerings method definition

def list_peerings(
    self,
    *,
    CoreNetworkId: str = ...,
    PeeringType: PeeringTypeType = ...,  # (1)
    EdgeLocation: str = ...,
    State: PeeringStateType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPeeringsResponseTypeDef:  # (3)
    ...
  1. See PeeringTypeType
  2. See PeeringStateType
  3. See ListPeeringsResponseTypeDef
# list_peerings method usage example with argument unpacking

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

parent.list_peerings(**kwargs)
  1. See ListPeeringsRequestTypeDef

list_tags_for_resource#

Lists the tags for a specified resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

put_core_network_policy#

Creates a new, immutable version of a core network policy.

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

# put_core_network_policy method definition

def put_core_network_policy(
    self,
    *,
    CoreNetworkId: str,
    PolicyDocument: str,
    Description: str = ...,
    LatestVersionId: int = ...,
    ClientToken: str = ...,
) -> PutCoreNetworkPolicyResponseTypeDef:  # (1)
    ...
  1. See PutCoreNetworkPolicyResponseTypeDef
# put_core_network_policy method usage example with argument unpacking

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

parent.put_core_network_policy(**kwargs)
  1. See PutCoreNetworkPolicyRequestTypeDef

put_resource_policy#

Creates or updates a resource policy.

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

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    PolicyDocument: str,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyRequestTypeDef = {  # (1)
    "PolicyDocument": ...,
    "ResourceArn": ...,
}

parent.put_resource_policy(**kwargs)
  1. See PutResourcePolicyRequestTypeDef

register_transit_gateway#

Registers a transit gateway in your global network.

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

# register_transit_gateway method definition

def register_transit_gateway(
    self,
    *,
    GlobalNetworkId: str,
    TransitGatewayArn: str,
) -> RegisterTransitGatewayResponseTypeDef:  # (1)
    ...
  1. See RegisterTransitGatewayResponseTypeDef
# register_transit_gateway method usage example with argument unpacking

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

parent.register_transit_gateway(**kwargs)
  1. See RegisterTransitGatewayRequestTypeDef

reject_attachment#

Rejects a core network attachment request.

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

# reject_attachment method definition

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

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

parent.reject_attachment(**kwargs)
  1. See RejectAttachmentRequestTypeDef

restore_core_network_policy_version#

Restores a previous policy version as a new, immutable version of a core network policy.

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

# restore_core_network_policy_version method definition

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

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

parent.restore_core_network_policy_version(**kwargs)
  1. See RestoreCoreNetworkPolicyVersionRequestTypeDef

start_organization_service_access_update#

Enables the Network Manager service for an Amazon Web Services Organization.

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

# start_organization_service_access_update method definition

def start_organization_service_access_update(
    self,
    *,
    Action: str,
) -> StartOrganizationServiceAccessUpdateResponseTypeDef:  # (1)
    ...
  1. See StartOrganizationServiceAccessUpdateResponseTypeDef
# start_organization_service_access_update method usage example with argument unpacking

kwargs: StartOrganizationServiceAccessUpdateRequestTypeDef = {  # (1)
    "Action": ...,
}

parent.start_organization_service_access_update(**kwargs)
  1. See StartOrganizationServiceAccessUpdateRequestTypeDef

start_route_analysis#

Starts analyzing the routing path between the specified source and destination.

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

# start_route_analysis method definition

def start_route_analysis(
    self,
    *,
    GlobalNetworkId: str,
    Source: RouteAnalysisEndpointOptionsSpecificationTypeDef,  # (1)
    Destination: RouteAnalysisEndpointOptionsSpecificationTypeDef,  # (1)
    IncludeReturnPath: bool = ...,
    UseMiddleboxes: bool = ...,
) -> StartRouteAnalysisResponseTypeDef:  # (3)
    ...
  1. See RouteAnalysisEndpointOptionsSpecificationTypeDef
  2. See RouteAnalysisEndpointOptionsSpecificationTypeDef
  3. See StartRouteAnalysisResponseTypeDef
# start_route_analysis method usage example with argument unpacking

kwargs: StartRouteAnalysisRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "Source": ...,
    "Destination": ...,
}

parent.start_route_analysis(**kwargs)
  1. See StartRouteAnalysisRequestTypeDef

tag_resource#

Tags a specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes tags from a specified resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_connection#

Updates the information for an existing connection.

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

# update_connection method definition

def update_connection(
    self,
    *,
    GlobalNetworkId: str,
    ConnectionId: str,
    LinkId: str = ...,
    ConnectedLinkId: str = ...,
    Description: str = ...,
) -> UpdateConnectionResponseTypeDef:  # (1)
    ...
  1. See UpdateConnectionResponseTypeDef
# update_connection method usage example with argument unpacking

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

parent.update_connection(**kwargs)
  1. See UpdateConnectionRequestTypeDef

update_core_network#

Updates the description of a core network.

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

# update_core_network method definition

def update_core_network(
    self,
    *,
    CoreNetworkId: str,
    Description: str = ...,
) -> UpdateCoreNetworkResponseTypeDef:  # (1)
    ...
  1. See UpdateCoreNetworkResponseTypeDef
# update_core_network method usage example with argument unpacking

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

parent.update_core_network(**kwargs)
  1. See UpdateCoreNetworkRequestTypeDef

update_device#

Updates the details for an existing device.

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

# update_device method definition

def update_device(
    self,
    *,
    GlobalNetworkId: str,
    DeviceId: str,
    AWSLocation: AWSLocationTypeDef = ...,  # (1)
    Description: str = ...,
    Type: str = ...,
    Vendor: str = ...,
    Model: str = ...,
    SerialNumber: str = ...,
    Location: LocationTypeDef = ...,  # (2)
    SiteId: str = ...,
) -> UpdateDeviceResponseTypeDef:  # (3)
    ...
  1. See AWSLocationTypeDef
  2. See LocationTypeDef
  3. See UpdateDeviceResponseTypeDef
# update_device method usage example with argument unpacking

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

parent.update_device(**kwargs)
  1. See UpdateDeviceRequestTypeDef

update_direct_connect_gateway_attachment#

Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.

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

# update_direct_connect_gateway_attachment method definition

def update_direct_connect_gateway_attachment(
    self,
    *,
    AttachmentId: str,
    EdgeLocations: Sequence[str] = ...,
) -> UpdateDirectConnectGatewayAttachmentResponseTypeDef:  # (1)
    ...
  1. See UpdateDirectConnectGatewayAttachmentResponseTypeDef
# update_direct_connect_gateway_attachment method usage example with argument unpacking

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

parent.update_direct_connect_gateway_attachment(**kwargs)
  1. See UpdateDirectConnectGatewayAttachmentRequestTypeDef

update_global_network#

Updates an existing global network.

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

# update_global_network method definition

def update_global_network(
    self,
    *,
    GlobalNetworkId: str,
    Description: str = ...,
) -> UpdateGlobalNetworkResponseTypeDef:  # (1)
    ...
  1. See UpdateGlobalNetworkResponseTypeDef
# update_global_network method usage example with argument unpacking

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

parent.update_global_network(**kwargs)
  1. See UpdateGlobalNetworkRequestTypeDef

Updates the details for an existing link.

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

# update_link method definition

def update_link(
    self,
    *,
    GlobalNetworkId: str,
    LinkId: str,
    Description: str = ...,
    Type: str = ...,
    Bandwidth: BandwidthTypeDef = ...,  # (1)
    Provider: str = ...,
) -> UpdateLinkResponseTypeDef:  # (2)
    ...
  1. See BandwidthTypeDef
  2. See UpdateLinkResponseTypeDef
# update_link method usage example with argument unpacking

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

parent.update_link(**kwargs)
  1. See UpdateLinkRequestTypeDef

update_network_resource_metadata#

Updates the resource metadata for the specified global network.

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

# update_network_resource_metadata method definition

def update_network_resource_metadata(
    self,
    *,
    GlobalNetworkId: str,
    ResourceArn: str,
    Metadata: Mapping[str, str],
) -> UpdateNetworkResourceMetadataResponseTypeDef:  # (1)
    ...
  1. See UpdateNetworkResourceMetadataResponseTypeDef
# update_network_resource_metadata method usage example with argument unpacking

kwargs: UpdateNetworkResourceMetadataRequestTypeDef = {  # (1)
    "GlobalNetworkId": ...,
    "ResourceArn": ...,
    "Metadata": ...,
}

parent.update_network_resource_metadata(**kwargs)
  1. See UpdateNetworkResourceMetadataRequestTypeDef

update_site#

Updates the information for an existing site.

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

# update_site method definition

def update_site(
    self,
    *,
    GlobalNetworkId: str,
    SiteId: str,
    Description: str = ...,
    Location: LocationTypeDef = ...,  # (1)
) -> UpdateSiteResponseTypeDef:  # (2)
    ...
  1. See LocationTypeDef
  2. See UpdateSiteResponseTypeDef
# update_site method usage example with argument unpacking

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

parent.update_site(**kwargs)
  1. See UpdateSiteRequestTypeDef

update_vpc_attachment#

Updates a VPC attachment.

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

# update_vpc_attachment method definition

def update_vpc_attachment(
    self,
    *,
    AttachmentId: str,
    AddSubnetArns: Sequence[str] = ...,
    RemoveSubnetArns: Sequence[str] = ...,
    Options: VpcOptionsTypeDef = ...,  # (1)
) -> UpdateVpcAttachmentResponseTypeDef:  # (2)
    ...
  1. See VpcOptionsTypeDef
  2. See UpdateVpcAttachmentResponseTypeDef
# update_vpc_attachment method usage example with argument unpacking

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

parent.update_vpc_attachment(**kwargs)
  1. See UpdateVpcAttachmentRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("networkmanager").get_paginator method with overloads.