Private5GClient

Index > Private5G > 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

# Private5GClient usage example

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.

# 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 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

# 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

can_paginate

Check if an operation can be paginated.

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

close

Closes underlying endpoint connections.

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

# close method definition

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

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