IoTWirelessClient
Index > IoTWireless > IoTWirelessClient
Auto-generated documentation for IoTWireless type annotations stubs module mypy-boto3-iotwireless.
IoTWirelessClient
Type annotations and code completion for boto3.client("iotwireless")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_iotwireless.client import IoTWirelessClient
def get_iotwireless_client() -> IoTWirelessClient:
return Session().client("iotwireless")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("iotwireless").exceptions
structure.
client = boto3.client("iotwireless")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.TooManyTagsException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_iotwireless.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
associate_aws_account_with_partner_account
Associates a partner account with your AWS account.
Type annotations and code completion for boto3.client("iotwireless").associate_aws_account_with_partner_account
method.
boto3 documentation
def associate_aws_account_with_partner_account(
self,
*,
Sidewalk: SidewalkAccountInfoTypeDef, # (1)
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> AssociateAwsAccountWithPartnerAccountResponseTypeDef: # (3)
...
- See SidewalkAccountInfoTypeDef
- See TagTypeDef
- See AssociateAwsAccountWithPartnerAccountResponseTypeDef
kwargs: AssociateAwsAccountWithPartnerAccountRequestRequestTypeDef = { # (1)
"Sidewalk": ...,
}
parent.associate_aws_account_with_partner_account(**kwargs)
associate_multicast_group_with_fuota_task
Associate a multicast group with a FUOTA task.
Type annotations and code completion for boto3.client("iotwireless").associate_multicast_group_with_fuota_task
method.
boto3 documentation
def associate_multicast_group_with_fuota_task(
self,
*,
Id: str,
MulticastGroupId: str,
) -> Dict[str, Any]:
...
kwargs: AssociateMulticastGroupWithFuotaTaskRequestRequestTypeDef = { # (1)
"Id": ...,
"MulticastGroupId": ...,
}
parent.associate_multicast_group_with_fuota_task(**kwargs)
associate_wireless_device_with_fuota_task
Associate a wireless device with a FUOTA task.
Type annotations and code completion for boto3.client("iotwireless").associate_wireless_device_with_fuota_task
method.
boto3 documentation
def associate_wireless_device_with_fuota_task(
self,
*,
Id: str,
WirelessDeviceId: str,
) -> Dict[str, Any]:
...
kwargs: AssociateWirelessDeviceWithFuotaTaskRequestRequestTypeDef = { # (1)
"Id": ...,
"WirelessDeviceId": ...,
}
parent.associate_wireless_device_with_fuota_task(**kwargs)
associate_wireless_device_with_multicast_group
Associates a wireless device with a multicast group.
Type annotations and code completion for boto3.client("iotwireless").associate_wireless_device_with_multicast_group
method.
boto3 documentation
def associate_wireless_device_with_multicast_group(
self,
*,
Id: str,
WirelessDeviceId: str,
) -> Dict[str, Any]:
...
kwargs: AssociateWirelessDeviceWithMulticastGroupRequestRequestTypeDef = { # (1)
"Id": ...,
"WirelessDeviceId": ...,
}
parent.associate_wireless_device_with_multicast_group(**kwargs)
associate_wireless_device_with_thing
Associates a wireless device with a thing.
Type annotations and code completion for boto3.client("iotwireless").associate_wireless_device_with_thing
method.
boto3 documentation
def associate_wireless_device_with_thing(
self,
*,
Id: str,
ThingArn: str,
) -> Dict[str, Any]:
...
kwargs: AssociateWirelessDeviceWithThingRequestRequestTypeDef = { # (1)
"Id": ...,
"ThingArn": ...,
}
parent.associate_wireless_device_with_thing(**kwargs)
associate_wireless_gateway_with_certificate
Associates a wireless gateway with a certificate.
Type annotations and code completion for boto3.client("iotwireless").associate_wireless_gateway_with_certificate
method.
boto3 documentation
def associate_wireless_gateway_with_certificate(
self,
*,
Id: str,
IotCertificateId: str,
) -> AssociateWirelessGatewayWithCertificateResponseTypeDef: # (1)
...
kwargs: AssociateWirelessGatewayWithCertificateRequestRequestTypeDef = { # (1)
"Id": ...,
"IotCertificateId": ...,
}
parent.associate_wireless_gateway_with_certificate(**kwargs)
associate_wireless_gateway_with_thing
Associates a wireless gateway with a thing.
Type annotations and code completion for boto3.client("iotwireless").associate_wireless_gateway_with_thing
method.
boto3 documentation
def associate_wireless_gateway_with_thing(
self,
*,
Id: str,
ThingArn: str,
) -> Dict[str, Any]:
...
kwargs: AssociateWirelessGatewayWithThingRequestRequestTypeDef = { # (1)
"Id": ...,
"ThingArn": ...,
}
parent.associate_wireless_gateway_with_thing(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("iotwireless").can_paginate
method.
boto3 documentation
cancel_multicast_group_session
Cancels an existing multicast group session.
Type annotations and code completion for boto3.client("iotwireless").cancel_multicast_group_session
method.
boto3 documentation
kwargs: CancelMulticastGroupSessionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.cancel_multicast_group_session(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iotwireless").close
method.
boto3 documentation
create_destination
Creates a new destination that maps a device message to an AWS IoT rule.
Type annotations and code completion for boto3.client("iotwireless").create_destination
method.
boto3 documentation
def create_destination(
self,
*,
Name: str,
ExpressionType: ExpressionTypeType, # (1)
Expression: str,
RoleArn: str,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
ClientRequestToken: str = ...,
) -> CreateDestinationResponseTypeDef: # (3)
...
kwargs: CreateDestinationRequestRequestTypeDef = { # (1)
"Name": ...,
"ExpressionType": ...,
"Expression": ...,
"RoleArn": ...,
}
parent.create_destination(**kwargs)
create_device_profile
Creates a new device profile.
Type annotations and code completion for boto3.client("iotwireless").create_device_profile
method.
boto3 documentation
def create_device_profile(
self,
*,
Name: str = ...,
LoRaWAN: LoRaWANDeviceProfileTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
ClientRequestToken: str = ...,
) -> CreateDeviceProfileResponseTypeDef: # (3)
...
kwargs: CreateDeviceProfileRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_device_profile(**kwargs)
create_fuota_task
Creates a FUOTA task.
Type annotations and code completion for boto3.client("iotwireless").create_fuota_task
method.
boto3 documentation
def create_fuota_task(
self,
*,
FirmwareUpdateImage: str,
FirmwareUpdateRole: str,
Name: str = ...,
Description: str = ...,
ClientRequestToken: str = ...,
LoRaWAN: LoRaWANFuotaTaskTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateFuotaTaskResponseTypeDef: # (3)
...
kwargs: CreateFuotaTaskRequestRequestTypeDef = { # (1)
"FirmwareUpdateImage": ...,
"FirmwareUpdateRole": ...,
}
parent.create_fuota_task(**kwargs)
create_multicast_group
Creates a multicast group.
Type annotations and code completion for boto3.client("iotwireless").create_multicast_group
method.
boto3 documentation
def create_multicast_group(
self,
*,
LoRaWAN: LoRaWANMulticastTypeDef, # (1)
Name: str = ...,
Description: str = ...,
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateMulticastGroupResponseTypeDef: # (3)
...
kwargs: CreateMulticastGroupRequestRequestTypeDef = { # (1)
"LoRaWAN": ...,
}
parent.create_multicast_group(**kwargs)
create_network_analyzer_configuration
Creates a new network analyzer configuration.
Type annotations and code completion for boto3.client("iotwireless").create_network_analyzer_configuration
method.
boto3 documentation
def create_network_analyzer_configuration(
self,
*,
Name: str,
TraceContent: TraceContentTypeDef = ..., # (1)
WirelessDevices: Sequence[str] = ...,
WirelessGateways: Sequence[str] = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
ClientRequestToken: str = ...,
) -> CreateNetworkAnalyzerConfigurationResponseTypeDef: # (3)
...
kwargs: CreateNetworkAnalyzerConfigurationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_network_analyzer_configuration(**kwargs)
create_service_profile
Creates a new service profile.
Type annotations and code completion for boto3.client("iotwireless").create_service_profile
method.
boto3 documentation
def create_service_profile(
self,
*,
Name: str = ...,
LoRaWAN: LoRaWANServiceProfileTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
ClientRequestToken: str = ...,
) -> CreateServiceProfileResponseTypeDef: # (3)
...
kwargs: CreateServiceProfileRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_service_profile(**kwargs)
create_wireless_device
Provisions a wireless device.
Type annotations and code completion for boto3.client("iotwireless").create_wireless_device
method.
boto3 documentation
def create_wireless_device(
self,
*,
Type: WirelessDeviceTypeType, # (1)
DestinationName: str,
Name: str = ...,
Description: str = ...,
ClientRequestToken: str = ...,
LoRaWAN: LoRaWANDeviceTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
Positioning: PositioningConfigStatusType = ..., # (4)
) -> CreateWirelessDeviceResponseTypeDef: # (5)
...
- See WirelessDeviceTypeType
- See LoRaWANDeviceTypeDef
- See TagTypeDef
- See PositioningConfigStatusType
- See CreateWirelessDeviceResponseTypeDef
kwargs: CreateWirelessDeviceRequestRequestTypeDef = { # (1)
"Type": ...,
"DestinationName": ...,
}
parent.create_wireless_device(**kwargs)
create_wireless_gateway
Provisions a wireless gateway.
Type annotations and code completion for boto3.client("iotwireless").create_wireless_gateway
method.
boto3 documentation
def create_wireless_gateway(
self,
*,
LoRaWAN: LoRaWANGatewayTypeDef, # (1)
Name: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
ClientRequestToken: str = ...,
) -> CreateWirelessGatewayResponseTypeDef: # (3)
...
kwargs: CreateWirelessGatewayRequestRequestTypeDef = { # (1)
"LoRaWAN": ...,
}
parent.create_wireless_gateway(**kwargs)
create_wireless_gateway_task
Creates a task for a wireless gateway.
Type annotations and code completion for boto3.client("iotwireless").create_wireless_gateway_task
method.
boto3 documentation
def create_wireless_gateway_task(
self,
*,
Id: str,
WirelessGatewayTaskDefinitionId: str,
) -> CreateWirelessGatewayTaskResponseTypeDef: # (1)
...
kwargs: CreateWirelessGatewayTaskRequestRequestTypeDef = { # (1)
"Id": ...,
"WirelessGatewayTaskDefinitionId": ...,
}
parent.create_wireless_gateway_task(**kwargs)
create_wireless_gateway_task_definition
Creates a gateway task definition.
Type annotations and code completion for boto3.client("iotwireless").create_wireless_gateway_task_definition
method.
boto3 documentation
def create_wireless_gateway_task_definition(
self,
*,
AutoCreateTasks: bool,
Name: str = ...,
Update: UpdateWirelessGatewayTaskCreateTypeDef = ..., # (1)
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateWirelessGatewayTaskDefinitionResponseTypeDef: # (3)
...
- See UpdateWirelessGatewayTaskCreateTypeDef
- See TagTypeDef
- See CreateWirelessGatewayTaskDefinitionResponseTypeDef
kwargs: CreateWirelessGatewayTaskDefinitionRequestRequestTypeDef = { # (1)
"AutoCreateTasks": ...,
}
parent.create_wireless_gateway_task_definition(**kwargs)
delete_destination
Deletes a destination.
Type annotations and code completion for boto3.client("iotwireless").delete_destination
method.
boto3 documentation
kwargs: DeleteDestinationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_destination(**kwargs)
delete_device_profile
Deletes a device profile.
Type annotations and code completion for boto3.client("iotwireless").delete_device_profile
method.
boto3 documentation
kwargs: DeleteDeviceProfileRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_device_profile(**kwargs)
delete_fuota_task
Deletes a FUOTA task.
Type annotations and code completion for boto3.client("iotwireless").delete_fuota_task
method.
boto3 documentation
kwargs: DeleteFuotaTaskRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_fuota_task(**kwargs)
delete_multicast_group
Deletes a multicast group if it is not in use by a fuota task.
Type annotations and code completion for boto3.client("iotwireless").delete_multicast_group
method.
boto3 documentation
kwargs: DeleteMulticastGroupRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_multicast_group(**kwargs)
delete_network_analyzer_configuration
Deletes a network analyzer configuration.
Type annotations and code completion for boto3.client("iotwireless").delete_network_analyzer_configuration
method.
boto3 documentation
def delete_network_analyzer_configuration(
self,
*,
ConfigurationName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteNetworkAnalyzerConfigurationRequestRequestTypeDef = { # (1)
"ConfigurationName": ...,
}
parent.delete_network_analyzer_configuration(**kwargs)
delete_queued_messages
Remove queued messages from the downlink queue.
Type annotations and code completion for boto3.client("iotwireless").delete_queued_messages
method.
boto3 documentation
def delete_queued_messages(
self,
*,
Id: str,
MessageId: str,
WirelessDeviceType: WirelessDeviceTypeType = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: DeleteQueuedMessagesRequestRequestTypeDef = { # (1)
"Id": ...,
"MessageId": ...,
}
parent.delete_queued_messages(**kwargs)
delete_service_profile
Deletes a service profile.
Type annotations and code completion for boto3.client("iotwireless").delete_service_profile
method.
boto3 documentation
kwargs: DeleteServiceProfileRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_service_profile(**kwargs)
delete_wireless_device
Deletes a wireless device.
Type annotations and code completion for boto3.client("iotwireless").delete_wireless_device
method.
boto3 documentation
kwargs: DeleteWirelessDeviceRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_wireless_device(**kwargs)
delete_wireless_gateway
Deletes a wireless gateway.
Type annotations and code completion for boto3.client("iotwireless").delete_wireless_gateway
method.
boto3 documentation
kwargs: DeleteWirelessGatewayRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_wireless_gateway(**kwargs)
delete_wireless_gateway_task
Deletes a wireless gateway task.
Type annotations and code completion for boto3.client("iotwireless").delete_wireless_gateway_task
method.
boto3 documentation
kwargs: DeleteWirelessGatewayTaskRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_wireless_gateway_task(**kwargs)
delete_wireless_gateway_task_definition
Deletes a wireless gateway task definition.
Type annotations and code completion for boto3.client("iotwireless").delete_wireless_gateway_task_definition
method.
boto3 documentation
def delete_wireless_gateway_task_definition(
self,
*,
Id: str,
) -> Dict[str, Any]:
...
kwargs: DeleteWirelessGatewayTaskDefinitionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_wireless_gateway_task_definition(**kwargs)
disassociate_aws_account_from_partner_account
Disassociates your AWS account from a partner account.
Type annotations and code completion for boto3.client("iotwireless").disassociate_aws_account_from_partner_account
method.
boto3 documentation
def disassociate_aws_account_from_partner_account(
self,
*,
PartnerAccountId: str,
PartnerType: PartnerTypeType, # (1)
) -> Dict[str, Any]:
...
- See PartnerTypeType
kwargs: DisassociateAwsAccountFromPartnerAccountRequestRequestTypeDef = { # (1)
"PartnerAccountId": ...,
"PartnerType": ...,
}
parent.disassociate_aws_account_from_partner_account(**kwargs)
disassociate_multicast_group_from_fuota_task
Disassociates a multicast group from a fuota task.
Type annotations and code completion for boto3.client("iotwireless").disassociate_multicast_group_from_fuota_task
method.
boto3 documentation
def disassociate_multicast_group_from_fuota_task(
self,
*,
Id: str,
MulticastGroupId: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateMulticastGroupFromFuotaTaskRequestRequestTypeDef = { # (1)
"Id": ...,
"MulticastGroupId": ...,
}
parent.disassociate_multicast_group_from_fuota_task(**kwargs)
disassociate_wireless_device_from_fuota_task
Disassociates a wireless device from a FUOTA task.
Type annotations and code completion for boto3.client("iotwireless").disassociate_wireless_device_from_fuota_task
method.
boto3 documentation
def disassociate_wireless_device_from_fuota_task(
self,
*,
Id: str,
WirelessDeviceId: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateWirelessDeviceFromFuotaTaskRequestRequestTypeDef = { # (1)
"Id": ...,
"WirelessDeviceId": ...,
}
parent.disassociate_wireless_device_from_fuota_task(**kwargs)
disassociate_wireless_device_from_multicast_group
Disassociates a wireless device from a multicast group.
Type annotations and code completion for boto3.client("iotwireless").disassociate_wireless_device_from_multicast_group
method.
boto3 documentation
def disassociate_wireless_device_from_multicast_group(
self,
*,
Id: str,
WirelessDeviceId: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateWirelessDeviceFromMulticastGroupRequestRequestTypeDef = { # (1)
"Id": ...,
"WirelessDeviceId": ...,
}
parent.disassociate_wireless_device_from_multicast_group(**kwargs)
disassociate_wireless_device_from_thing
Disassociates a wireless device from its currently associated thing.
Type annotations and code completion for boto3.client("iotwireless").disassociate_wireless_device_from_thing
method.
boto3 documentation
def disassociate_wireless_device_from_thing(
self,
*,
Id: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateWirelessDeviceFromThingRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.disassociate_wireless_device_from_thing(**kwargs)
disassociate_wireless_gateway_from_certificate
Disassociates a wireless gateway from its currently associated certificate.
Type annotations and code completion for boto3.client("iotwireless").disassociate_wireless_gateway_from_certificate
method.
boto3 documentation
def disassociate_wireless_gateway_from_certificate(
self,
*,
Id: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateWirelessGatewayFromCertificateRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.disassociate_wireless_gateway_from_certificate(**kwargs)
disassociate_wireless_gateway_from_thing
Disassociates a wireless gateway from its currently associated thing.
Type annotations and code completion for boto3.client("iotwireless").disassociate_wireless_gateway_from_thing
method.
boto3 documentation
def disassociate_wireless_gateway_from_thing(
self,
*,
Id: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateWirelessGatewayFromThingRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.disassociate_wireless_gateway_from_thing(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("iotwireless").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_destination
Gets information about a destination.
Type annotations and code completion for boto3.client("iotwireless").get_destination
method.
boto3 documentation
def get_destination(
self,
*,
Name: str,
) -> GetDestinationResponseTypeDef: # (1)
...
kwargs: GetDestinationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_destination(**kwargs)
get_device_profile
Gets information about a device profile.
Type annotations and code completion for boto3.client("iotwireless").get_device_profile
method.
boto3 documentation
def get_device_profile(
self,
*,
Id: str,
) -> GetDeviceProfileResponseTypeDef: # (1)
...
kwargs: GetDeviceProfileRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_device_profile(**kwargs)
get_event_configuration_by_resource_types
Get the event configuration based on resource types.
Type annotations and code completion for boto3.client("iotwireless").get_event_configuration_by_resource_types
method.
boto3 documentation
def get_event_configuration_by_resource_types(
self,
) -> GetEventConfigurationByResourceTypesResponseTypeDef: # (1)
...
get_fuota_task
Gets information about a FUOTA task.
Type annotations and code completion for boto3.client("iotwireless").get_fuota_task
method.
boto3 documentation
kwargs: GetFuotaTaskRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_fuota_task(**kwargs)
get_log_levels_by_resource_types
Returns current default log levels or log levels by resource types.
Type annotations and code completion for boto3.client("iotwireless").get_log_levels_by_resource_types
method.
boto3 documentation
def get_log_levels_by_resource_types(
self,
) -> GetLogLevelsByResourceTypesResponseTypeDef: # (1)
...
get_multicast_group
Gets information about a multicast group.
Type annotations and code completion for boto3.client("iotwireless").get_multicast_group
method.
boto3 documentation
def get_multicast_group(
self,
*,
Id: str,
) -> GetMulticastGroupResponseTypeDef: # (1)
...
kwargs: GetMulticastGroupRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_multicast_group(**kwargs)
get_multicast_group_session
Gets information about a multicast group session.
Type annotations and code completion for boto3.client("iotwireless").get_multicast_group_session
method.
boto3 documentation