Private5GClient#
Auto-generated documentation for Private5G type annotations stubs module types-aiobotocore-privatenetworks.
Private5GClient#
Type annotations and code completion for session.create_client("privatenetworks")
boto3 documentation
Private5GClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_privatenetworks.client import Private5GClient
session = get_session()
async with session.create_client("privatenetworks") as client:
client: Private5GClientExceptions#
aiobotocore client exceptions are generated in runtime.
This class provides code completion for session.create_client("privatenetworks").exceptions structure.
Private5GClient.exceptions usage example
async with session.create_client("privatenetworks") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.InternalServerException,
client.LimitExceededException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)Private5GClient usage type checking example
from types_aiobotocore_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 session.create_client("privatenetworks").acknowledge_order_receipt method.
boto3 documentation
# acknowledge_order_receipt method definition
await def acknowledge_order_receipt(
self,
*,
orderArn: str,
) -> AcknowledgeOrderReceiptResponseTypeDef: # (1)
...# acknowledge_order_receipt method usage example with argument unpacking
kwargs: AcknowledgeOrderReceiptRequestRequestTypeDef = { # (1)
"orderArn": ...,
}
parent.acknowledge_order_receipt(**kwargs)activate_device_identifier#
Activates the specified device identifier.
Type annotations and code completion for session.create_client("privatenetworks").activate_device_identifier method.
boto3 documentation
# activate_device_identifier method definition
await def activate_device_identifier(
self,
*,
deviceIdentifierArn: str,
clientToken: str = ...,
) -> ActivateDeviceIdentifierResponseTypeDef: # (1)
...# activate_device_identifier method usage example with argument unpacking
kwargs: ActivateDeviceIdentifierRequestRequestTypeDef = { # (1)
"deviceIdentifierArn": ...,
}
parent.activate_device_identifier(**kwargs)activate_network_site#
Activates the specified network site.
Type annotations and code completion for session.create_client("privatenetworks").activate_network_site method.
boto3 documentation
# activate_network_site method definition
await def activate_network_site(
self,
*,
networkSiteArn: str,
shippingAddress: AddressTypeDef, # (1)
clientToken: str = ...,
commitmentConfiguration: CommitmentConfigurationTypeDef = ..., # (2)
) -> ActivateNetworkSiteResponseTypeDef: # (3)
...# activate_network_site method usage example with argument unpacking
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 session.create_client("privatenetworks").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("privatenetworks").close method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...configure_access_point#
Configures the specified network resource.
Type annotations and code completion for session.create_client("privatenetworks").configure_access_point method.
boto3 documentation
# configure_access_point method definition
await def configure_access_point(
self,
*,
accessPointArn: str,
cpiSecretKey: str = ...,
cpiUserId: str = ...,
cpiUserPassword: str = ...,
cpiUsername: str = ...,
position: PositionTypeDef = ..., # (1)
) -> ConfigureAccessPointResponseTypeDef: # (2)
...# configure_access_point method usage example with argument unpacking
kwargs: ConfigureAccessPointRequestRequestTypeDef = { # (1)
"accessPointArn": ...,
}
parent.configure_access_point(**kwargs)create_network#
Creates a network.
Type annotations and code completion for session.create_client("privatenetworks").create_network method.
boto3 documentation
# create_network method definition
await def create_network(
self,
*,
networkName: str,
clientToken: str = ...,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateNetworkResponseTypeDef: # (1)
...# create_network method usage example with argument unpacking
kwargs: CreateNetworkRequestRequestTypeDef = { # (1)
"networkName": ...,
}
parent.create_network(**kwargs)create_network_site#
Creates a network site.
Type annotations and code completion for session.create_client("privatenetworks").create_network_site method.
boto3 documentation
# create_network_site method definition
await 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)
...# create_network_site method usage example with argument unpacking
kwargs: CreateNetworkSiteRequestRequestTypeDef = { # (1)
"networkArn": ...,
"networkSiteName": ...,
}
parent.create_network_site(**kwargs)deactivate_device_identifier#
Deactivates the specified device identifier.
Type annotations and code completion for session.create_client("privatenetworks").deactivate_device_identifier method.
boto3 documentation
# deactivate_device_identifier method definition
await def deactivate_device_identifier(
self,
*,
deviceIdentifierArn: str,
clientToken: str = ...,
) -> DeactivateDeviceIdentifierResponseTypeDef: # (1)
...# deactivate_device_identifier method usage example with argument unpacking
kwargs: DeactivateDeviceIdentifierRequestRequestTypeDef = { # (1)
"deviceIdentifierArn": ...,
}
parent.deactivate_device_identifier(**kwargs)delete_network#
Deletes the specified network.
Type annotations and code completion for session.create_client("privatenetworks").delete_network method.
boto3 documentation
# delete_network method definition
await def delete_network(
self,
*,
networkArn: str,
clientToken: str = ...,
) -> DeleteNetworkResponseTypeDef: # (1)
...# delete_network method usage example with argument unpacking
kwargs: DeleteNetworkRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.delete_network(**kwargs)delete_network_site#
Deletes the specified network site.
Type annotations and code completion for session.create_client("privatenetworks").delete_network_site method.
boto3 documentation
# delete_network_site method definition
await def delete_network_site(
self,
*,
networkSiteArn: str,
clientToken: str = ...,
) -> DeleteNetworkSiteResponseTypeDef: # (1)
...# delete_network_site method usage example with argument unpacking
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 session.create_client("privatenetworks").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("privatenetworks").get_device_identifier method.
boto3 documentation
# get_device_identifier method definition
await def get_device_identifier(
self,
*,
deviceIdentifierArn: str,
) -> GetDeviceIdentifierResponseTypeDef: # (1)
...# get_device_identifier method usage example with argument unpacking
kwargs: GetDeviceIdentifierRequestRequestTypeDef = { # (1)
"deviceIdentifierArn": ...,
}
parent.get_device_identifier(**kwargs)get_network#
Gets the specified network.
Type annotations and code completion for session.create_client("privatenetworks").get_network method.
boto3 documentation
# get_network method definition
await def get_network(
self,
*,
networkArn: str,
) -> GetNetworkResponseTypeDef: # (1)
...# get_network method usage example with argument unpacking
kwargs: GetNetworkRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.get_network(**kwargs)get_network_resource#
Gets the specified network resource.
Type annotations and code completion for session.create_client("privatenetworks").get_network_resource method.
boto3 documentation
# get_network_resource method definition
await def get_network_resource(
self,
*,
networkResourceArn: str,
) -> GetNetworkResourceResponseTypeDef: # (1)
...# get_network_resource method usage example with argument unpacking
kwargs: GetNetworkResourceRequestRequestTypeDef = { # (1)
"networkResourceArn": ...,
}
parent.get_network_resource(**kwargs)get_network_site#
Gets the specified network site.
Type annotations and code completion for session.create_client("privatenetworks").get_network_site method.
boto3 documentation
# get_network_site method definition
await def get_network_site(
self,
*,
networkSiteArn: str,
) -> GetNetworkSiteResponseTypeDef: # (1)
...# get_network_site method usage example with argument unpacking
kwargs: GetNetworkSiteRequestRequestTypeDef = { # (1)
"networkSiteArn": ...,
}
parent.get_network_site(**kwargs)get_order#
Gets the specified order.
Type annotations and code completion for session.create_client("privatenetworks").get_order method.
boto3 documentation
# get_order method definition
await def get_order(
self,
*,
orderArn: str,
) -> GetOrderResponseTypeDef: # (1)
...# get_order method usage example with argument unpacking
kwargs: GetOrderRequestRequestTypeDef = { # (1)
"orderArn": ...,
}
parent.get_order(**kwargs)list_device_identifiers#
Lists device identifiers.
Type annotations and code completion for session.create_client("privatenetworks").list_device_identifiers method.
boto3 documentation
# list_device_identifiers method definition
await def list_device_identifiers(
self,
*,
networkArn: str,
filters: Mapping[DeviceIdentifierFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListDeviceIdentifiersResponseTypeDef: # (2)
...# list_device_identifiers method usage example with argument unpacking
kwargs: ListDeviceIdentifiersRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.list_device_identifiers(**kwargs)list_network_resources#
Lists network resources.
Type annotations and code completion for session.create_client("privatenetworks").list_network_resources method.
boto3 documentation
# list_network_resources method definition
await def list_network_resources(
self,
*,
networkArn: str,
filters: Mapping[NetworkResourceFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListNetworkResourcesResponseTypeDef: # (2)
...# list_network_resources method usage example with argument unpacking
kwargs: ListNetworkResourcesRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.list_network_resources(**kwargs)list_network_sites#
Lists network sites.
Type annotations and code completion for session.create_client("privatenetworks").list_network_sites method.
boto3 documentation
# list_network_sites method definition
await def list_network_sites(
self,
*,
networkArn: str,
filters: Mapping[NetworkSiteFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListNetworkSitesResponseTypeDef: # (2)
...# list_network_sites method usage example with argument unpacking
kwargs: ListNetworkSitesRequestRequestTypeDef = { # (1)
"networkArn": ...,
}
parent.list_network_sites(**kwargs)list_networks#
Lists networks.
Type annotations and code completion for session.create_client("privatenetworks").list_networks method.
boto3 documentation
# list_networks method definition
await def list_networks(
self,
*,
filters: Mapping[NetworkFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListNetworksResponseTypeDef: # (2)
...# list_networks method usage example with argument unpacking
kwargs: ListNetworksRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.list_networks(**kwargs)list_orders#
Lists orders.
Type annotations and code completion for session.create_client("privatenetworks").list_orders method.
boto3 documentation
# list_orders method definition
await def list_orders(
self,
*,
networkArn: str,
filters: Mapping[OrderFilterKeysType, Sequence[str]] = ..., # (1)
maxResults: int = ...,
startToken: str = ...,
) -> ListOrdersResponseTypeDef: # (2)
...# list_orders method usage example with argument unpacking
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 session.create_client("privatenetworks").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)ping#
Checks the health of the service.
Type annotations and code completion for session.create_client("privatenetworks").ping method.
boto3 documentation
# ping method definition
await def ping(
self,
) -> PingResponseTypeDef: # (1)
...start_network_resource_update#
Use this action to do the following tasks: * Update the duration and renewal status of the commitment period for a radio unit.
Type annotations and code completion for session.create_client("privatenetworks").start_network_resource_update method.
boto3 documentation
# start_network_resource_update method definition
await def start_network_resource_update(
self,
*,
networkResourceArn: str,
updateType: UpdateTypeType, # (1)
commitmentConfiguration: CommitmentConfigurationTypeDef = ..., # (2)
returnReason: str = ...,
shippingAddress: AddressTypeDef = ..., # (3)
) -> StartNetworkResourceUpdateResponseTypeDef: # (4)
...- See UpdateTypeType
- See CommitmentConfigurationTypeDef
- See AddressTypeDef
- See StartNetworkResourceUpdateResponseTypeDef
# start_network_resource_update method usage example with argument unpacking
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 session.create_client("privatenetworks").tag_resource method.
boto3 documentation
# tag_resource method definition
await 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)untag_resource#
Removes tags from the specified resource.
Type annotations and code completion for session.create_client("privatenetworks").untag_resource method.
boto3 documentation
# untag_resource method definition
await 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)update_network_site#
Updates the specified network site.
Type annotations and code completion for session.create_client("privatenetworks").update_network_site method.
boto3 documentation
# update_network_site method definition
await def update_network_site(
self,
*,
networkSiteArn: str,
clientToken: str = ...,
description: str = ...,
) -> UpdateNetworkSiteResponseTypeDef: # (1)
...# update_network_site method usage example with argument unpacking
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 session.create_client("privatenetworks").update_network_site_plan method.
boto3 documentation
# update_network_site_plan method definition
await def update_network_site_plan(
self,
*,
networkSiteArn: str,
pendingPlan: SitePlanTypeDef, # (1)
clientToken: str = ...,
) -> UpdateNetworkSiteResponseTypeDef: # (2)
...# update_network_site_plan method usage example with argument unpacking
kwargs: UpdateNetworkSitePlanRequestRequestTypeDef = { # (1)
"networkSiteArn": ...,
"pendingPlan": ...,
}
parent.update_network_site_plan(**kwargs)__aenter__#
Type annotations and code completion for session.create_client("privatenetworks").__aenter__ method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> Private5GClient:
...__aexit__#
Type annotations and code completion for session.create_client("privatenetworks").__aexit__ method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...get_paginator#
Type annotations and code completion for session.create_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