Skip to content

Private5GClient#

Index > Private5G > Private5GClient

Auto-generated documentation for Private5G type annotations stubs module types-boto3-privatenetworks.

Private5GClient#

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

# Private5GClient usage example

from boto3.session import Session
from types_boto3_privatenetworks.client import Private5GClient

def get_privatenetworks_client() -> Private5GClient:
    return Session().client("privatenetworks")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("privatenetworks")

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

from types_boto3_privatenetworks.client import Exceptions

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

Methods#

can_paginate#

Type annotations and code completion for boto3.client("privatenetworks").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("privatenetworks").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:
    ...

acknowledge_order_receipt#

Acknowledges that the specified network order was received.

Type annotations and code completion for boto3.client("privatenetworks").acknowledge_order_receipt method. boto3 documentation

# acknowledge_order_receipt method definition

def acknowledge_order_receipt(
    self,
    *,
    orderArn: str,
) -> AcknowledgeOrderReceiptResponseTypeDef:  # (1)
    ...
  1. See AcknowledgeOrderReceiptResponseTypeDef 
# acknowledge_order_receipt method usage example with argument unpacking

kwargs: AcknowledgeOrderReceiptRequestRequestTypeDef = {  # (1)
    "orderArn": ...,
}

parent.acknowledge_order_receipt(**kwargs)
  1. See AcknowledgeOrderReceiptRequestRequestTypeDef

activate_device_identifier#

Activates the specified device identifier.

Type annotations and code completion for boto3.client("privatenetworks").activate_device_identifier method. boto3 documentation

# activate_device_identifier method definition

def activate_device_identifier(
    self,
    *,
    deviceIdentifierArn: str,
    clientToken: str = ...,
) -> ActivateDeviceIdentifierResponseTypeDef:  # (1)
    ...
  1. See ActivateDeviceIdentifierResponseTypeDef 
# activate_device_identifier method usage example with argument unpacking

kwargs: ActivateDeviceIdentifierRequestRequestTypeDef = {  # (1)
    "deviceIdentifierArn": ...,
}

parent.activate_device_identifier(**kwargs)
  1. See ActivateDeviceIdentifierRequestRequestTypeDef

activate_network_site#

Activates the specified network site.

Type annotations and code completion for boto3.client("privatenetworks").activate_network_site method. boto3 documentation

# activate_network_site method definition

def activate_network_site(
    self,
    *,
    networkSiteArn: str,
    shippingAddress: AddressTypeDef,  # (1)
    clientToken: str = ...,
    commitmentConfiguration: CommitmentConfigurationTypeDef = ...,  # (2)
) -> ActivateNetworkSiteResponseTypeDef:  # (3)
    ...
  1. See AddressTypeDef
  2. See CommitmentConfigurationTypeDef
  3. See ActivateNetworkSiteResponseTypeDef 
# activate_network_site method usage example with argument unpacking

kwargs: ActivateNetworkSiteRequestRequestTypeDef = {  # (1)
    "networkSiteArn": ...,
    "shippingAddress": ...,
}

parent.activate_network_site(**kwargs)
  1. See ActivateNetworkSiteRequestRequestTypeDef

configure_access_point#

Configures the specified network resource.

Type annotations and code completion for boto3.client("privatenetworks").configure_access_point method. boto3 documentation

# configure_access_point method definition

def configure_access_point(
    self,
    *,
    accessPointArn: str,
    cpiSecretKey: str = ...,
    cpiUserId: str = ...,
    cpiUserPassword: str = ...,
    cpiUsername: str = ...,
    position: PositionTypeDef = ...,  # (1)
) -> ConfigureAccessPointResponseTypeDef:  # (2)
    ...
  1. See PositionTypeDef
  2. See ConfigureAccessPointResponseTypeDef 
# configure_access_point method usage example with argument unpacking

kwargs: ConfigureAccessPointRequestRequestTypeDef = {  # (1)
    "accessPointArn": ...,
}

parent.configure_access_point(**kwargs)
  1. See ConfigureAccessPointRequestRequestTypeDef

create_network#

Creates a network.

Type annotations and code completion for boto3.client("privatenetworks").create_network method. boto3 documentation

# create_network method definition

def create_network(
    self,
    *,
    networkName: str,
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateNetworkResponseTypeDef:  # (1)
    ...
  1. See CreateNetworkResponseTypeDef 
# create_network method usage example with argument unpacking

kwargs: CreateNetworkRequestRequestTypeDef = {  # (1)
    "networkName": ...,
}

parent.create_network(**kwargs)
  1. See CreateNetworkRequestRequestTypeDef

create_network_site#

Creates a network site.

Type annotations and code completion for boto3.client("privatenetworks").create_network_site method. boto3 documentation

# create_network_site method definition

def create_network_site(
    self,
    *,
    networkArn: str,
    networkSiteName: str,
    availabilityZone: str = ...,
    availabilityZoneId: str = ...,
    clientToken: str = ...,
    description: str = ...,
    pendingPlan: SitePlanTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateNetworkSiteResponseTypeDef:  # (2)
    ...
  1. See SitePlanTypeDef
  2. See CreateNetworkSiteResponseTypeDef 
# create_network_site method usage example with argument unpacking

kwargs: CreateNetworkSiteRequestRequestTypeDef = {  # (1)
    "networkArn": ...,
    "networkSiteName": ...,
}

parent.create_network_site(**kwargs)
  1. See CreateNetworkSiteRequestRequestTypeDef

deactivate_device_identifier#

Deactivates the specified device identifier.

Type annotations and code completion for boto3.client("privatenetworks").deactivate_device_identifier method. boto3 documentation

# deactivate_device_identifier method definition

def deactivate_device_identifier(
    self,
    *,
    deviceIdentifierArn: str,
    clientToken: str = ...,
) -> DeactivateDeviceIdentifierResponseTypeDef:  # (1)
    ...
  1. See DeactivateDeviceIdentifierResponseTypeDef 
# deactivate_device_identifier method usage example with argument unpacking

kwargs: DeactivateDeviceIdentifierRequestRequestTypeDef = {  # (1)
    "deviceIdentifierArn": ...,
}

parent.deactivate_device_identifier(**kwargs)
  1. See DeactivateDeviceIdentifierRequestRequestTypeDef

delete_network#

Deletes the specified network.

Type annotations and code completion for boto3.client("privatenetworks").delete_network method. boto3 documentation

# delete_network method definition

def delete_network(
    self,
    *,
    networkArn: str,
    clientToken: str = ...,
) -> DeleteNetworkResponseTypeDef:  # (1)
    ...
  1. See DeleteNetworkResponseTypeDef 
# delete_network method usage example with argument unpacking

kwargs: DeleteNetworkRequestRequestTypeDef = {  # (1)
    "networkArn": ...,
}

parent.delete_network(**kwargs)
  1. See DeleteNetworkRequestRequestTypeDef

delete_network_site#

Deletes the specified network site.

Type annotations and code completion for boto3.client("privatenetworks").delete_network_site method. boto3 documentation

# delete_network_site method definition

def delete_network_site(
    self,
    *,
    networkSiteArn: str,
    clientToken: str = ...,
) -> DeleteNetworkSiteResponseTypeDef:  # (1)
    ...
  1. See DeleteNetworkSiteResponseTypeDef 
# delete_network_site method usage example with argument unpacking

kwargs: DeleteNetworkSiteRequestRequestTypeDef = {  # (1)
    "networkSiteArn": ...,
}

parent.delete_network_site(**kwargs)
  1. See DeleteNetworkSiteRequestRequestTypeDef

get_device_identifier#

Gets the specified device identifier.

Type annotations and code completion for boto3.client("privatenetworks").get_device_identifier method. boto3 documentation

# get_device_identifier method definition

def get_device_identifier(
    self,
    *,
    deviceIdentifierArn: str,
) -> GetDeviceIdentifierResponseTypeDef:  # (1)
    ...
  1. See GetDeviceIdentifierResponseTypeDef 
# get_device_identifier method usage example with argument unpacking

kwargs: GetDeviceIdentifierRequestRequestTypeDef = {  # (1)
    "deviceIdentifierArn": ...,
}

parent.get_device_identifier(**kwargs)
  1. See GetDeviceIdentifierRequestRequestTypeDef

get_network#

Gets the specified network.

Type annotations and code completion for boto3.client("privatenetworks").get_network method. boto3 documentation

# get_network method definition

def get_network(
    self,
    *,
    networkArn: str,
) -> GetNetworkResponseTypeDef:  # (1)
    ...
  1. See GetNetworkResponseTypeDef 
# get_network method usage example with argument unpacking

kwargs: GetNetworkRequestRequestTypeDef = {  # (1)
    "networkArn": ...,
}

parent.get_network(**kwargs)
  1. See GetNetworkRequestRequestTypeDef

get_network_resource#

Gets the specified network resource.

Type annotations and code completion for boto3.client("privatenetworks").get_network_resource method. boto3 documentation

# get_network_resource method definition

def get_network_resource(
    self,
    *,
    networkResourceArn: str,
) -> GetNetworkResourceResponseTypeDef:  # (1)
    ...
  1. See GetNetworkResourceResponseTypeDef 
# get_network_resource method usage example with argument unpacking

kwargs: GetNetworkResourceRequestRequestTypeDef = {  # (1)
    "networkResourceArn": ...,
}

parent.get_network_resource(**kwargs)
  1. See GetNetworkResourceRequestRequestTypeDef

get_network_site#

Gets the specified network site.

Type annotations and code completion for boto3.client("privatenetworks").get_network_site method. boto3 documentation

# get_network_site method definition

def get_network_site(
    self,
    *,
    networkSiteArn: str,
) -> GetNetworkSiteResponseTypeDef:  # (1)
    ...
  1. See GetNetworkSiteResponseTypeDef 
# get_network_site method usage example with argument unpacking

kwargs: GetNetworkSiteRequestRequestTypeDef = {  # (1)
    "networkSiteArn": ...,
}

parent.get_network_site(**kwargs)
  1. See GetNetworkSiteRequestRequestTypeDef

get_order#

Gets the specified order.

Type annotations and code completion for boto3.client("privatenetworks").get_order method. boto3 documentation

# get_order method definition

def get_order(
    self,
    *,
    orderArn: str,
) -> GetOrderResponseTypeDef:  # (1)
    ...
  1. See GetOrderResponseTypeDef 
# get_order method usage example with argument unpacking

kwargs: GetOrderRequestRequestTypeDef = {  # (1)
    "orderArn": ...,
}

parent.get_order(**kwargs)
  1. See GetOrderRequestRequestTypeDef

list_device_identifiers#

Lists device identifiers.

Type annotations and code completion for boto3.client("privatenetworks").list_device_identifiers method. boto3 documentation

# list_device_identifiers method definition

def list_device_identifiers(
    self,
    *,
    networkArn: str,
    filters: Mapping[DeviceIdentifierFilterKeysType, Sequence[str]] = ...,  # (1)
    maxResults: int = ...,
    startToken: str = ...,
) -> ListDeviceIdentifiersResponseTypeDef:  # (2)
    ...
  1. See DeviceIdentifierFilterKeysType
  2. See ListDeviceIdentifiersResponseTypeDef 
# list_device_identifiers method usage example with argument unpacking

kwargs: ListDeviceIdentifiersRequestRequestTypeDef = {  # (1)
    "networkArn": ...,
}

parent.list_device_identifiers(**kwargs)
  1. See ListDeviceIdentifiersRequestRequestTypeDef

list_network_resources#

Lists network resources.

Type annotations and code completion for boto3.client("privatenetworks").list_network_resources method. boto3 documentation

# list_network_resources method definition

def list_network_resources(
    self,
    *,
    networkArn: str,
    filters: Mapping[NetworkResourceFilterKeysType, Sequence[str]] = ...,  # (1)
    maxResults: int = ...,
    startToken: str = ...,
) -> ListNetworkResourcesResponseTypeDef:  # (2)
    ...
  1. See NetworkResourceFilterKeysType
  2. See ListNetworkResourcesResponseTypeDef 
# list_network_resources method usage example with argument unpacking

kwargs: ListNetworkResourcesRequestRequestTypeDef = {  # (1)
    "networkArn": ...,
}

parent.list_network_resources(**kwargs)
  1. See ListNetworkResourcesRequestRequestTypeDef

list_network_sites#

Lists network sites.

Type annotations and code completion for boto3.client("privatenetworks").list_network_sites method. boto3 documentation

# list_network_sites method definition

def list_network_sites(
    self,
    *,
    networkArn: str,
    filters: Mapping[NetworkSiteFilterKeysType, Sequence[str]] = ...,  # (1)
    maxResults: int = ...,
    startToken: str = ...,
) -> ListNetworkSitesResponseTypeDef:  # (2)
    ...
  1. See NetworkSiteFilterKeysType
  2. See ListNetworkSitesResponseTypeDef 
# list_network_sites method usage example with argument unpacking

kwargs: ListNetworkSitesRequestRequestTypeDef = {  # (1)
    "networkArn": ...,
}

parent.list_network_sites(**kwargs)
  1. See ListNetworkSitesRequestRequestTypeDef

list_networks#

Lists networks.

Type annotations and code completion for boto3.client("privatenetworks").list_networks method. boto3 documentation

# list_networks method definition

def list_networks(
    self,
    *,
    filters: Mapping[NetworkFilterKeysType, Sequence[str]] = ...,  # (1)
    maxResults: int = ...,
    startToken: str = ...,
) -> ListNetworksResponseTypeDef:  # (2)
    ...
  1. See NetworkFilterKeysType
  2. See ListNetworksResponseTypeDef 
# list_networks method usage example with argument unpacking

kwargs: ListNetworksRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_networks(**kwargs)
  1. See ListNetworksRequestRequestTypeDef

list_orders#

Lists orders.

Type annotations and code completion for boto3.client("privatenetworks").list_orders method. boto3 documentation

# list_orders method definition

def list_orders(
    self,
    *,
    networkArn: str,
    filters: Mapping[OrderFilterKeysType, Sequence[str]] = ...,  # (1)
    maxResults: int = ...,
    startToken: str = ...,
) -> ListOrdersResponseTypeDef:  # (2)
    ...
  1. See OrderFilterKeysType
  2. See ListOrdersResponseTypeDef 
# list_orders method usage example with argument unpacking

kwargs: ListOrdersRequestRequestTypeDef = {  # (1)
    "networkArn": ...,
}

parent.list_orders(**kwargs)
  1. See ListOrdersRequestRequestTypeDef

list_tags_for_resource#

Lists the tags for the specified resource.

Type annotations and code completion for boto3.client("privatenetworks").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: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

ping#

Checks the health of the service.

Type annotations and code completion for boto3.client("privatenetworks").ping method. boto3 documentation

# ping method definition

def ping(
    self,
) -> PingResponseTypeDef:  # (1)
    ...
  1. See PingResponseTypeDef

start_network_resource_update#

Use this action to do the following tasks:.

Type annotations and code completion for boto3.client("privatenetworks").start_network_resource_update method. boto3 documentation

# start_network_resource_update method definition

def start_network_resource_update(
    self,
    *,
    networkResourceArn: str,
    updateType: UpdateTypeType,  # (1)
    commitmentConfiguration: CommitmentConfigurationTypeDef = ...,  # (2)
    returnReason: str = ...,
    shippingAddress: AddressTypeDef = ...,  # (3)
) -> StartNetworkResourceUpdateResponseTypeDef:  # (4)
    ...
  1. See UpdateTypeType
  2. See CommitmentConfigurationTypeDef
  3. See AddressTypeDef
  4. See StartNetworkResourceUpdateResponseTypeDef 
# start_network_resource_update method usage example with argument unpacking

kwargs: StartNetworkResourceUpdateRequestRequestTypeDef = {  # (1)
    "networkResourceArn": ...,
    "updateType": ...,
}

parent.start_network_resource_update(**kwargs)
  1. See StartNetworkResourceUpdateRequestRequestTypeDef

tag_resource#

Adds tags to the specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

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

untag_resource#

Removes tags from the specified resource.

Type annotations and code completion for boto3.client("privatenetworks").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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

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

update_network_site#

Updates the specified network site.

Type annotations and code completion for boto3.client("privatenetworks").update_network_site method. boto3 documentation

# update_network_site method definition

def update_network_site(
    self,
    *,
    networkSiteArn: str,
    clientToken: str = ...,
    description: str = ...,
) -> UpdateNetworkSiteResponseTypeDef:  # (1)
    ...
  1. See UpdateNetworkSiteResponseTypeDef 
# update_network_site method usage example with argument unpacking

kwargs: UpdateNetworkSiteRequestRequestTypeDef = {  # (1)
    "networkSiteArn": ...,
}

parent.update_network_site(**kwargs)
  1. See UpdateNetworkSiteRequestRequestTypeDef

update_network_site_plan#

Updates the specified network site plan.

Type annotations and code completion for boto3.client("privatenetworks").update_network_site_plan method. boto3 documentation

# update_network_site_plan method definition

def update_network_site_plan(
    self,
    *,
    networkSiteArn: str,
    pendingPlan: SitePlanTypeDef,  # (1)
    clientToken: str = ...,
) -> UpdateNetworkSiteResponseTypeDef:  # (2)
    ...
  1. See SitePlanTypeDef
  2. See UpdateNetworkSiteResponseTypeDef 
# update_network_site_plan method usage example with argument unpacking

kwargs: UpdateNetworkSitePlanRequestRequestTypeDef = {  # (1)
    "networkSiteArn": ...,
    "pendingPlan": ...,
}

parent.update_network_site_plan(**kwargs)
  1. See UpdateNetworkSitePlanRequestRequestTypeDef

get_paginator#

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