Private5GClient
Auto-generated documentation for Private5G type annotations stubs module mypy-boto3-privatenetworks.
Private5GClient
Type annotations and code completion for boto3.client("privatenetworks")
.
boto3 documentation
from boto3.session import Session
from mypy_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.
client = boto3.client("privatenetworks")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.InternalServerException,
client.LimitExceededException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_privatenetworks.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
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
def acknowledge_order_receipt(
self,
*,
orderArn: str,
) -> AcknowledgeOrderReceiptResponseTypeDef: # (1)
...
kwargs: AcknowledgeOrderReceiptRequestRequestTypeDef = { # (1)
"orderArn": ...,
}
parent.acknowledge_order_receipt(**kwargs)
activate_device_identifier
Activates the specified device identifier.
Type annotations and code completion for boto3.client("privatenetworks").activate_device_identifier
method.
boto3 documentation
def activate_device_identifier(
self,
*,
deviceIdentifierArn: str,
clientToken: str = ...,
) -> ActivateDeviceIdentifierResponseTypeDef: # (1)
...
kwargs: ActivateDeviceIdentifierRequestRequestTypeDef = { # (1)
"deviceIdentifierArn": ...,
}
parent.activate_device_identifier(**kwargs)
activate_network_site
Activates the specified network site.
Type annotations and code completion for boto3.client("privatenetworks").activate_network_site
method.
boto3 documentation
def activate_network_site(
self,
*,
networkSiteArn: str,
shippingAddress: AddressTypeDef, # (1)
clientToken: str = ...,
) -> ActivateNetworkSiteResponseTypeDef: # (2)
...
kwargs: ActivateNetworkSiteRequestRequestTypeDef = { # (1)
"networkSiteArn": ...,
"shippingAddress": ...,
}
parent.activate_network_site(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("privatenetworks").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("privatenetworks").close
method.
boto3 documentation
configure_access_point
Configures the specified network resource.
Type annotations and code completion for boto3.client("privatenetworks").configure_access_point
method.
boto3 documentation
def configure_access_point(
self,
*,
accessPointArn: str,
cpiSecretKey: str = ...,
cpiUserId: str = ...,
cpiUserPassword: str = ...,
cpiUsername: str = ...,
position: PositionTypeDef = ..., # (1)
) -> ConfigureAccessPointResponseTypeDef: # (2)
...
kwargs: ConfigureAccessPointRequestRequestTypeDef = { # (1)
"accessPointArn": ...,
}
parent.configure_access_point(**kwargs)
create_network
Creates a network.
Type annotations and code completion for boto3.client("privatenetworks").create_network
method.
boto3 documentation
def create_network(
self,
*,
networkName: str,
clientToken: str = ...,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateNetworkResponseTypeDef: # (1)
...
kwargs: CreateNetworkRequestRequestTypeDef = { # (1)
"networkName": ...,
}
parent.create_network(**kwargs)
create_network_site
Creates a network site.
Type annotations and code completion for boto3.client("privatenetworks").create_network_site
method.
boto3 documentation
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)
...
kwargs: CreateNetworkSiteRequestRequestTypeDef = { # (1)
"networkArn": ...,
"networkSiteName": ...,
}
parent.create_network_site(**kwargs)
deactivate_device_identifier
Deactivates the specified device identifier.
Type annotations and code completion for boto3.client("privatenetworks").deactivate_device_identifier
method.
boto3 documentation
def deactivate_device_identifier(
self,
*,
deviceIdentifierArn: str,
clientToken: str = ...,
) -> DeactivateDeviceIdentifierResponseTypeDef: # (1)
...
kwargs: DeactivateDeviceIdentifierRequestRequestTypeDef = { # (1)
"deviceIdentifierArn": ...,
}
parent.deactivate_device_identifier(**kwargs)
delete_network
Deletes the specified network.
Type annotations and code completion for boto3.client("privatenetworks").delete_network
method.
boto3 documentation
def delete_network(
self,
*,
networkArn: str,
clientToken: str = ...,
) -> DeleteNetworkResponseTypeDef: # (1)
...
kwargs: DeleteNetworkRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.delete_network(**kwargs)
delete_network_site
Deletes the specified network site.
Type annotations and code completion for boto3.client("privatenetworks").delete_network_site
method.
boto3 documentation
def delete_network_site(
self,
*,
networkSiteArn: str,
clientToken: str = ...,
) -> DeleteNetworkSiteResponseTypeDef: # (1)
...
kwargs: DeleteNetworkSiteRequestRequestTypeDef = { # (1)
"networkSiteArn": ...,
}
parent.delete_network_site(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("privatenetworks").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_device_identifier
Gets the specified device identifier.
Type annotations and code completion for boto3.client("privatenetworks").get_device_identifier
method.
boto3 documentation
def get_device_identifier(
self,
*,
deviceIdentifierArn: str,
) -> GetDeviceIdentifierResponseTypeDef: # (1)
...
kwargs: GetDeviceIdentifierRequestRequestTypeDef = { # (1)
"deviceIdentifierArn": ...,
}
parent.get_device_identifier(**kwargs)
get_network
Gets the specified network.
Type annotations and code completion for boto3.client("privatenetworks").get_network
method.
boto3 documentation
def get_network(
self,
*,
networkArn: str,
) -> GetNetworkResponseTypeDef: # (1)
...
kwargs: GetNetworkRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.get_network(**kwargs)
get_network_resource
Gets the specified network resource.
Type annotations and code completion for boto3.client("privatenetworks").get_network_resource
method.
boto3 documentation
def get_network_resource(
self,
*,
networkResourceArn: str,
) -> GetNetworkResourceResponseTypeDef: # (1)
...
kwargs: GetNetworkResourceRequestRequestTypeDef = { # (1)
"networkResourceArn": ...,
}
parent.get_network_resource(**kwargs)
get_network_site
Gets the specified network site.
Type annotations and code completion for boto3.client("privatenetworks").get_network_site
method.
boto3 documentation
def get_network_site(
self,
*,
networkSiteArn: str,
) -> GetNetworkSiteResponseTypeDef: # (1)
...
kwargs: GetNetworkSiteRequestRequestTypeDef = { # (1)
"networkSiteArn": ...,
}
parent.get_network_site(**kwargs)
get_order
Gets the specified order.
Type annotations and code completion for boto3.client("privatenetworks").get_order
method.
boto3 documentation
kwargs: GetOrderRequestRequestTypeDef = { # (1)
"orderArn": ...,
}
parent.get_order(**kwargs)
list_device_identifiers
Lists device identifiers.
Type annotations and code completion for boto3.client("privatenetworks").list_device_identifiers
method.
boto3 documentation
def list_device_identifiers(
self,
*,
networkArn: str,
filters: Mapping[DeviceIdentifierFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListDeviceIdentifiersResponseTypeDef: # (2)
...
kwargs: ListDeviceIdentifiersRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.list_device_identifiers(**kwargs)
list_network_resources
Lists network resources.
Type annotations and code completion for boto3.client("privatenetworks").list_network_resources
method.
boto3 documentation
def list_network_resources(
self,
*,
networkArn: str,
filters: Mapping[NetworkResourceFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListNetworkResourcesResponseTypeDef: # (2)
...
kwargs: ListNetworkResourcesRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.list_network_resources(**kwargs)
list_network_sites
Lists network sites.
Type annotations and code completion for boto3.client("privatenetworks").list_network_sites
method.
boto3 documentation
def list_network_sites(
self,
*,
networkArn: str,
filters: Mapping[NetworkSiteFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListNetworkSitesResponseTypeDef: # (2)
...
kwargs: ListNetworkSitesRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.list_network_sites(**kwargs)
list_networks
Lists networks.
Type annotations and code completion for boto3.client("privatenetworks").list_networks
method.
boto3 documentation
def list_networks(
self,
*,
filters: Mapping[NetworkFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListNetworksResponseTypeDef: # (2)
...
kwargs: ListNetworksRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.list_networks(**kwargs)
list_orders
Lists orders.
Type annotations and code completion for boto3.client("privatenetworks").list_orders
method.
boto3 documentation
def list_orders(
self,
*,
networkArn: str,
filters: Mapping[OrderFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListOrdersResponseTypeDef: # (2)
...
kwargs: ListOrdersRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.list_orders(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
ping
Checks the health of the service.
Type annotations and code completion for boto3.client("privatenetworks").ping
method.
boto3 documentation
start_network_resource_update
Starts an update of the specified network resource.
Type annotations and code completion for boto3.client("privatenetworks").start_network_resource_update
method.
boto3 documentation
def start_network_resource_update(
self,
*,
networkResourceArn: str,
updateType: UpdateTypeType, # (1)
returnReason: str = ...,
shippingAddress: AddressTypeDef = ..., # (2)
) -> StartNetworkResourceUpdateResponseTypeDef: # (3)
...
kwargs: StartNetworkResourceUpdateRequestRequestTypeDef = { # (1)
"networkResourceArn": ...,
"updateType": ...,
}
parent.start_network_resource_update(**kwargs)
tag_resource
Adds tags to the specified resource.
Type annotations and code completion for boto3.client("privatenetworks").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from the specified resource.
Type annotations and code completion for boto3.client("privatenetworks").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_network_site
Updates the specified network site.
Type annotations and code completion for boto3.client("privatenetworks").update_network_site
method.
boto3 documentation
def update_network_site(
self,
*,
networkSiteArn: str,
clientToken: str = ...,
description: str = ...,
) -> UpdateNetworkSiteResponseTypeDef: # (1)
...
kwargs: UpdateNetworkSiteRequestRequestTypeDef = { # (1)
"networkSiteArn": ...,
}
parent.update_network_site(**kwargs)
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
def update_network_site_plan(
self,
*,
networkSiteArn: str,
pendingPlan: SitePlanTypeDef, # (1)
clientToken: str = ...,
) -> UpdateNetworkSiteResponseTypeDef: # (2)
...
kwargs: UpdateNetworkSitePlanRequestRequestTypeDef = { # (1)
"networkSiteArn": ...,
"pendingPlan": ...,
}
parent.update_network_site_plan(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("privatenetworks").get_paginator
method with overloads.
client.get_paginator("list_device_identifiers")
-> ListDeviceIdentifiersPaginatorclient.get_paginator("list_network_resources")
-> ListNetworkResourcesPaginatorclient.get_paginator("list_network_sites")
-> ListNetworkSitesPaginatorclient.get_paginator("list_networks")
-> ListNetworksPaginatorclient.get_paginator("list_orders")
-> ListOrdersPaginator