Skip to content

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

# IoTWirelessClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("iotwireless")

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

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

# associate_aws_account_with_partner_account method definition

def associate_aws_account_with_partner_account(
    self,
    *,
    Sidewalk: SidewalkAccountInfoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> AssociateAwsAccountWithPartnerAccountResponseTypeDef:  # (3)
    ...
  1. See SidewalkAccountInfoTypeDef
  2. See TagTypeDef
  3. See AssociateAwsAccountWithPartnerAccountResponseTypeDef 
# associate_aws_account_with_partner_account method usage example with argument unpacking

kwargs: AssociateAwsAccountWithPartnerAccountRequestRequestTypeDef = {  # (1)
    "Sidewalk": ...,
}

parent.associate_aws_account_with_partner_account(**kwargs)
  1. See AssociateAwsAccountWithPartnerAccountRequestRequestTypeDef

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

# associate_multicast_group_with_fuota_task method definition

def associate_multicast_group_with_fuota_task(
    self,
    *,
    Id: str,
    MulticastGroupId: str,
) -> Dict[str, Any]:
    ...
# associate_multicast_group_with_fuota_task method usage example with argument unpacking

kwargs: AssociateMulticastGroupWithFuotaTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "MulticastGroupId": ...,
}

parent.associate_multicast_group_with_fuota_task(**kwargs)
  1. See AssociateMulticastGroupWithFuotaTaskRequestRequestTypeDef

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

# associate_wireless_device_with_fuota_task method definition

def associate_wireless_device_with_fuota_task(
    self,
    *,
    Id: str,
    WirelessDeviceId: str,
) -> Dict[str, Any]:
    ...
# associate_wireless_device_with_fuota_task method usage example with argument unpacking

kwargs: AssociateWirelessDeviceWithFuotaTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "WirelessDeviceId": ...,
}

parent.associate_wireless_device_with_fuota_task(**kwargs)
  1. See AssociateWirelessDeviceWithFuotaTaskRequestRequestTypeDef

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

# associate_wireless_device_with_multicast_group method definition

def associate_wireless_device_with_multicast_group(
    self,
    *,
    Id: str,
    WirelessDeviceId: str,
) -> Dict[str, Any]:
    ...
# associate_wireless_device_with_multicast_group method usage example with argument unpacking

kwargs: AssociateWirelessDeviceWithMulticastGroupRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "WirelessDeviceId": ...,
}

parent.associate_wireless_device_with_multicast_group(**kwargs)
  1. See AssociateWirelessDeviceWithMulticastGroupRequestRequestTypeDef

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

# associate_wireless_device_with_thing method definition

def associate_wireless_device_with_thing(
    self,
    *,
    Id: str,
    ThingArn: str,
) -> Dict[str, Any]:
    ...
# associate_wireless_device_with_thing method usage example with argument unpacking

kwargs: AssociateWirelessDeviceWithThingRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "ThingArn": ...,
}

parent.associate_wireless_device_with_thing(**kwargs)
  1. See AssociateWirelessDeviceWithThingRequestRequestTypeDef

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

# associate_wireless_gateway_with_certificate method definition

def associate_wireless_gateway_with_certificate(
    self,
    *,
    Id: str,
    IotCertificateId: str,
) -> AssociateWirelessGatewayWithCertificateResponseTypeDef:  # (1)
    ...
  1. See AssociateWirelessGatewayWithCertificateResponseTypeDef 
# associate_wireless_gateway_with_certificate method usage example with argument unpacking

kwargs: AssociateWirelessGatewayWithCertificateRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IotCertificateId": ...,
}

parent.associate_wireless_gateway_with_certificate(**kwargs)
  1. See AssociateWirelessGatewayWithCertificateRequestRequestTypeDef

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

# associate_wireless_gateway_with_thing method definition

def associate_wireless_gateway_with_thing(
    self,
    *,
    Id: str,
    ThingArn: str,
) -> Dict[str, Any]:
    ...
# associate_wireless_gateway_with_thing method usage example with argument unpacking

kwargs: AssociateWirelessGatewayWithThingRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "ThingArn": ...,
}

parent.associate_wireless_gateway_with_thing(**kwargs)
  1. See AssociateWirelessGatewayWithThingRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("iotwireless").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

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

# cancel_multicast_group_session method definition

def cancel_multicast_group_session(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# cancel_multicast_group_session method usage example with argument unpacking

kwargs: CancelMulticastGroupSessionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.cancel_multicast_group_session(**kwargs)
  1. See CancelMulticastGroupSessionRequestRequestTypeDef

close#

Closes underlying endpoint connections.

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

# close method definition

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

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

# create_destination method definition

def create_destination(
    self,
    *,
    Name: str,
    ExpressionType: ExpressionTypeType,  # (1)
    Expression: str,
    RoleArn: str,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientRequestToken: str = ...,
) -> CreateDestinationResponseTypeDef:  # (3)
    ...
  1. See ExpressionTypeType
  2. See TagTypeDef
  3. See CreateDestinationResponseTypeDef 
# create_destination method usage example with argument unpacking

kwargs: CreateDestinationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ExpressionType": ...,
    "Expression": ...,
    "RoleArn": ...,
}

parent.create_destination(**kwargs)
  1. See CreateDestinationRequestRequestTypeDef

create_device_profile#

Creates a new device profile.

Type annotations and code completion for boto3.client("iotwireless").create_device_profile method. boto3 documentation

# create_device_profile method definition

def create_device_profile(
    self,
    *,
    Name: str = ...,
    LoRaWAN: LoRaWANDeviceProfileTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientRequestToken: str = ...,
    Sidewalk: Mapping[str, Any] = ...,
) -> CreateDeviceProfileResponseTypeDef:  # (3)
    ...
  1. See LoRaWANDeviceProfileTypeDef
  2. See TagTypeDef
  3. See CreateDeviceProfileResponseTypeDef 
# create_device_profile method usage example with argument unpacking

kwargs: CreateDeviceProfileRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_device_profile(**kwargs)
  1. See CreateDeviceProfileRequestRequestTypeDef

create_fuota_task#

Creates a FUOTA task.

Type annotations and code completion for boto3.client("iotwireless").create_fuota_task method. boto3 documentation

# create_fuota_task method definition

def create_fuota_task(
    self,
    *,
    FirmwareUpdateImage: str,
    FirmwareUpdateRole: str,
    Name: str = ...,
    Description: str = ...,
    ClientRequestToken: str = ...,
    LoRaWAN: LoRaWANFuotaTaskTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    RedundancyPercent: int = ...,
    FragmentSizeBytes: int = ...,
    FragmentIntervalMS: int = ...,
) -> CreateFuotaTaskResponseTypeDef:  # (3)
    ...
  1. See LoRaWANFuotaTaskTypeDef
  2. See TagTypeDef
  3. See CreateFuotaTaskResponseTypeDef 
# create_fuota_task method usage example with argument unpacking

kwargs: CreateFuotaTaskRequestRequestTypeDef = {  # (1)
    "FirmwareUpdateImage": ...,
    "FirmwareUpdateRole": ...,
}

parent.create_fuota_task(**kwargs)
  1. See CreateFuotaTaskRequestRequestTypeDef

create_multicast_group#

Creates a multicast group.

Type annotations and code completion for boto3.client("iotwireless").create_multicast_group method. boto3 documentation

# create_multicast_group method definition

def create_multicast_group(
    self,
    *,
    LoRaWAN: LoRaWANMulticastTypeDef,  # (1)
    Name: str = ...,
    Description: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMulticastGroupResponseTypeDef:  # (3)
    ...
  1. See LoRaWANMulticastTypeDef
  2. See TagTypeDef
  3. See CreateMulticastGroupResponseTypeDef 
# create_multicast_group method usage example with argument unpacking

kwargs: CreateMulticastGroupRequestRequestTypeDef = {  # (1)
    "LoRaWAN": ...,
}

parent.create_multicast_group(**kwargs)
  1. See CreateMulticastGroupRequestRequestTypeDef

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

# create_network_analyzer_configuration method definition

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 = ...,
    MulticastGroups: Sequence[str] = ...,
) -> CreateNetworkAnalyzerConfigurationResponseTypeDef:  # (3)
    ...
  1. See TraceContentTypeDef
  2. See TagTypeDef
  3. See CreateNetworkAnalyzerConfigurationResponseTypeDef 
# create_network_analyzer_configuration method usage example with argument unpacking

kwargs: CreateNetworkAnalyzerConfigurationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_network_analyzer_configuration(**kwargs)
  1. See CreateNetworkAnalyzerConfigurationRequestRequestTypeDef

create_service_profile#

Creates a new service profile.

Type annotations and code completion for boto3.client("iotwireless").create_service_profile method. boto3 documentation

# create_service_profile method definition

def create_service_profile(
    self,
    *,
    Name: str = ...,
    LoRaWAN: LoRaWANServiceProfileTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientRequestToken: str = ...,
) -> CreateServiceProfileResponseTypeDef:  # (3)
    ...
  1. See LoRaWANServiceProfileTypeDef
  2. See TagTypeDef
  3. See CreateServiceProfileResponseTypeDef 
# create_service_profile method usage example with argument unpacking

kwargs: CreateServiceProfileRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_service_profile(**kwargs)
  1. See CreateServiceProfileRequestRequestTypeDef

create_wireless_device#

Provisions a wireless device.

Type annotations and code completion for boto3.client("iotwireless").create_wireless_device method. boto3 documentation

# create_wireless_device method definition

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)
    Sidewalk: SidewalkCreateWirelessDeviceTypeDef = ...,  # (5)
) -> CreateWirelessDeviceResponseTypeDef:  # (6)
    ...
  1. See WirelessDeviceTypeType
  2. See LoRaWANDeviceTypeDef
  3. See TagTypeDef
  4. See PositioningConfigStatusType
  5. See SidewalkCreateWirelessDeviceTypeDef
  6. See CreateWirelessDeviceResponseTypeDef 
# create_wireless_device method usage example with argument unpacking

kwargs: CreateWirelessDeviceRequestRequestTypeDef = {  # (1)
    "Type": ...,
    "DestinationName": ...,
}

parent.create_wireless_device(**kwargs)
  1. See CreateWirelessDeviceRequestRequestTypeDef

create_wireless_gateway#

Provisions a wireless gateway.

Type annotations and code completion for boto3.client("iotwireless").create_wireless_gateway method. boto3 documentation

# create_wireless_gateway method definition

def create_wireless_gateway(
    self,
    *,
    LoRaWAN: LoRaWANGatewayTypeDef,  # (1)
    Name: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientRequestToken: str = ...,
) -> CreateWirelessGatewayResponseTypeDef:  # (3)
    ...
  1. See LoRaWANGatewayTypeDef
  2. See TagTypeDef
  3. See CreateWirelessGatewayResponseTypeDef 
# create_wireless_gateway method usage example with argument unpacking

kwargs: CreateWirelessGatewayRequestRequestTypeDef = {  # (1)
    "LoRaWAN": ...,
}

parent.create_wireless_gateway(**kwargs)
  1. See CreateWirelessGatewayRequestRequestTypeDef

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

# create_wireless_gateway_task method definition

def create_wireless_gateway_task(
    self,
    *,
    Id: str,
    WirelessGatewayTaskDefinitionId: str,
) -> CreateWirelessGatewayTaskResponseTypeDef:  # (1)
    ...
  1. See CreateWirelessGatewayTaskResponseTypeDef 
# create_wireless_gateway_task method usage example with argument unpacking

kwargs: CreateWirelessGatewayTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "WirelessGatewayTaskDefinitionId": ...,
}

parent.create_wireless_gateway_task(**kwargs)
  1. See CreateWirelessGatewayTaskRequestRequestTypeDef

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

# create_wireless_gateway_task_definition method definition

def create_wireless_gateway_task_definition(
    self,
    *,
    AutoCreateTasks: bool,
    Name: str = ...,
    Update: UpdateWirelessGatewayTaskCreateTypeDef = ...,  # (1)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateWirelessGatewayTaskDefinitionResponseTypeDef:  # (3)
    ...
  1. See UpdateWirelessGatewayTaskCreateTypeDef
  2. See TagTypeDef
  3. See CreateWirelessGatewayTaskDefinitionResponseTypeDef 
# create_wireless_gateway_task_definition method usage example with argument unpacking

kwargs: CreateWirelessGatewayTaskDefinitionRequestRequestTypeDef = {  # (1)
    "AutoCreateTasks": ...,
}

parent.create_wireless_gateway_task_definition(**kwargs)
  1. See CreateWirelessGatewayTaskDefinitionRequestRequestTypeDef

delete_destination#

Deletes a destination.

Type annotations and code completion for boto3.client("iotwireless").delete_destination method. boto3 documentation

# delete_destination method definition

def delete_destination(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_destination method usage example with argument unpacking

kwargs: DeleteDestinationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_destination(**kwargs)
  1. See DeleteDestinationRequestRequestTypeDef

delete_device_profile#

Deletes a device profile.

Type annotations and code completion for boto3.client("iotwireless").delete_device_profile method. boto3 documentation

# delete_device_profile method definition

def delete_device_profile(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_device_profile method usage example with argument unpacking

kwargs: DeleteDeviceProfileRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_device_profile(**kwargs)
  1. See DeleteDeviceProfileRequestRequestTypeDef

delete_fuota_task#

Deletes a FUOTA task.

Type annotations and code completion for boto3.client("iotwireless").delete_fuota_task method. boto3 documentation

# delete_fuota_task method definition

def delete_fuota_task(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_fuota_task method usage example with argument unpacking

kwargs: DeleteFuotaTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_fuota_task(**kwargs)
  1. See DeleteFuotaTaskRequestRequestTypeDef

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

# delete_multicast_group method definition

def delete_multicast_group(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_multicast_group method usage example with argument unpacking

kwargs: DeleteMulticastGroupRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_multicast_group(**kwargs)
  1. See DeleteMulticastGroupRequestRequestTypeDef

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

# delete_network_analyzer_configuration method definition

def delete_network_analyzer_configuration(
    self,
    *,
    ConfigurationName: str,
) -> Dict[str, Any]:
    ...
# delete_network_analyzer_configuration method usage example with argument unpacking

kwargs: DeleteNetworkAnalyzerConfigurationRequestRequestTypeDef = {  # (1)
    "ConfigurationName": ...,
}

parent.delete_network_analyzer_configuration(**kwargs)
  1. See DeleteNetworkAnalyzerConfigurationRequestRequestTypeDef

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

# delete_queued_messages method definition

def delete_queued_messages(
    self,
    *,
    Id: str,
    MessageId: str,
    WirelessDeviceType: WirelessDeviceTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See WirelessDeviceTypeType 
# delete_queued_messages method usage example with argument unpacking

kwargs: DeleteQueuedMessagesRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "MessageId": ...,
}

parent.delete_queued_messages(**kwargs)
  1. See DeleteQueuedMessagesRequestRequestTypeDef

delete_service_profile#

Deletes a service profile.

Type annotations and code completion for boto3.client("iotwireless").delete_service_profile method. boto3 documentation

# delete_service_profile method definition

def delete_service_profile(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_service_profile method usage example with argument unpacking

kwargs: DeleteServiceProfileRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_service_profile(**kwargs)
  1. See DeleteServiceProfileRequestRequestTypeDef

delete_wireless_device#

Deletes a wireless device.

Type annotations and code completion for boto3.client("iotwireless").delete_wireless_device method. boto3 documentation

# delete_wireless_device method definition

def delete_wireless_device(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_wireless_device method usage example with argument unpacking

kwargs: DeleteWirelessDeviceRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_wireless_device(**kwargs)
  1. See DeleteWirelessDeviceRequestRequestTypeDef

delete_wireless_device_import_task#

Delete an import task.

Type annotations and code completion for boto3.client("iotwireless").delete_wireless_device_import_task method. boto3 documentation

# delete_wireless_device_import_task method definition

def delete_wireless_device_import_task(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_wireless_device_import_task method usage example with argument unpacking

kwargs: DeleteWirelessDeviceImportTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_wireless_device_import_task(**kwargs)
  1. See DeleteWirelessDeviceImportTaskRequestRequestTypeDef

delete_wireless_gateway#

Deletes a wireless gateway.

Type annotations and code completion for boto3.client("iotwireless").delete_wireless_gateway method. boto3 documentation

# delete_wireless_gateway method definition

def delete_wireless_gateway(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_wireless_gateway method usage example with argument unpacking

kwargs: DeleteWirelessGatewayRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_wireless_gateway(**kwargs)
  1. See DeleteWirelessGatewayRequestRequestTypeDef

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

# delete_wireless_gateway_task method definition

def delete_wireless_gateway_task(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_wireless_gateway_task method usage example with argument unpacking

kwargs: DeleteWirelessGatewayTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_wireless_gateway_task(**kwargs)
  1. See DeleteWirelessGatewayTaskRequestRequestTypeDef

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

# delete_wireless_gateway_task_definition method definition

def delete_wireless_gateway_task_definition(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_wireless_gateway_task_definition method usage example with argument unpacking

kwargs: DeleteWirelessGatewayTaskDefinitionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_wireless_gateway_task_definition(**kwargs)
  1. See DeleteWirelessGatewayTaskDefinitionRequestRequestTypeDef

deregister_wireless_device#

Deregister a wireless device from AWS IoT Wireless.

Type annotations and code completion for boto3.client("iotwireless").deregister_wireless_device method. boto3 documentation

# deregister_wireless_device method definition

def deregister_wireless_device(
    self,
    *,
    Identifier: str,
    WirelessDeviceType: WirelessDeviceTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See WirelessDeviceTypeType 
# deregister_wireless_device method usage example with argument unpacking

kwargs: DeregisterWirelessDeviceRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.deregister_wireless_device(**kwargs)
  1. See DeregisterWirelessDeviceRequestRequestTypeDef

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

# disassociate_aws_account_from_partner_account method definition

def disassociate_aws_account_from_partner_account(
    self,
    *,
    PartnerAccountId: str,
    PartnerType: PartnerTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See PartnerTypeType 
# disassociate_aws_account_from_partner_account method usage example with argument unpacking

kwargs: DisassociateAwsAccountFromPartnerAccountRequestRequestTypeDef = {  # (1)
    "PartnerAccountId": ...,
    "PartnerType": ...,
}

parent.disassociate_aws_account_from_partner_account(**kwargs)
  1. See DisassociateAwsAccountFromPartnerAccountRequestRequestTypeDef

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

# disassociate_multicast_group_from_fuota_task method definition

def disassociate_multicast_group_from_fuota_task(
    self,
    *,
    Id: str,
    MulticastGroupId: str,
) -> Dict[str, Any]:
    ...
# disassociate_multicast_group_from_fuota_task method usage example with argument unpacking

kwargs: DisassociateMulticastGroupFromFuotaTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "MulticastGroupId": ...,
}

parent.disassociate_multicast_group_from_fuota_task(**kwargs)
  1. See DisassociateMulticastGroupFromFuotaTaskRequestRequestTypeDef

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

# disassociate_wireless_device_from_fuota_task method definition

def disassociate_wireless_device_from_fuota_task(
    self,
    *,
    Id: str,
    WirelessDeviceId: str,
) -> Dict[str, Any]:
    ...
# disassociate_wireless_device_from_fuota_task method usage example with argument unpacking

kwargs: DisassociateWirelessDeviceFromFuotaTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "WirelessDeviceId": ...,
}

parent.disassociate_wireless_device_from_fuota_task(**kwargs)
  1. See DisassociateWirelessDeviceFromFuotaTaskRequestRequestTypeDef

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

# disassociate_wireless_device_from_multicast_group method definition

def disassociate_wireless_device_from_multicast_group(
    self,
    *,
    Id: str,
    WirelessDeviceId: str,
) -> Dict[str, Any]:
    ...
# disassociate_wireless_device_from_multicast_group method usage example with argument unpacking

kwargs: DisassociateWirelessDeviceFromMulticastGroupRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "WirelessDeviceId": ...,
}

parent.disassociate_wireless_device_from_multicast_group(**kwargs)
  1. See DisassociateWirelessDeviceFromMulticastGroupRequestRequestTypeDef

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

# disassociate_wireless_device_from_thing method definition

def disassociate_wireless_device_from_thing(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# disassociate_wireless_device_from_thing method usage example with argument unpacking

kwargs: DisassociateWirelessDeviceFromThingRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.disassociate_wireless_device_from_thing(**kwargs)
  1. See DisassociateWirelessDeviceFromThingRequestRequestTypeDef

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

# disassociate_wireless_gateway_from_certificate method definition

def disassociate_wireless_gateway_from_certificate(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# disassociate_wireless_gateway_from_certificate method usage example with argument unpacking

kwargs: DisassociateWirelessGatewayFromCertificateRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.disassociate_wireless_gateway_from_certificate(**kwargs)
  1. See DisassociateWirelessGatewayFromCertificateRequestRequestTypeDef

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

# disassociate_wireless_gateway_from_thing method definition

def disassociate_wireless_gateway_from_thing(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# disassociate_wireless_gateway_from_thing method usage example with argument unpacking

kwargs: DisassociateWirelessGatewayFromThingRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.disassociate_wireless_gateway_from_thing(**kwargs)
  1. See DisassociateWirelessGatewayFromThingRequestRequestTypeDef

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

# generate_presigned_url method definition

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

# get_destination method definition

def get_destination(
    self,
    *,
    Name: str,
) -> GetDestinationResponseTypeDef:  # (1)
    ...
  1. See GetDestinationResponseTypeDef 
# get_destination method usage example with argument unpacking

kwargs: GetDestinationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_destination(**kwargs)
  1. See GetDestinationRequestRequestTypeDef

get_device_profile#

Gets information about a device profile.

Type annotations and code completion for boto3.client("iotwireless").get_device_profile method. boto3 documentation

# get_device_profile method definition

def get_device_profile(
    self,
    *,
    Id: str,
) -> GetDeviceProfileResponseTypeDef:  # (1)
    ...
  1. See GetDeviceProfileResponseTypeDef 
# get_device_profile method usage example with argument unpacking

kwargs: GetDeviceProfileRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_device_profile(**kwargs)
  1. See GetDeviceProfileRequestRequestTypeDef

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

# get_event_configuration_by_resource_types method definition

def get_event_configuration_by_resource_types(
    self,
) -> GetEventConfigurationByResourceTypesResponseTypeDef:  # (1)
    ...
  1. See GetEventConfigurationByResourceTypesResponseTypeDef

get_fuota_task#

Gets information about a FUOTA task.

Type annotations and code completion for boto3.client("iotwireless").get_fuota_task method. boto3 documentation

# get_fuota_task method definition

def get_fuota_task(
    self,
    *,
    Id: str,
) -> GetFuotaTaskResponseTypeDef:  # (1)
    ...
  1. See GetFuotaTaskResponseTypeDef 
# get_fuota_task method usage example with argument unpacking

kwargs: GetFuotaTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_fuota_task(**kwargs)
  1. See GetFuotaTaskRequestRequestTypeDef

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

# get_log_levels_by_resource_types method definition

def get_log_levels_by_resource_types(
    self,
) -> GetLogLevelsByResourceTypesResponseTypeDef:  # (1)
    ...
  1. See GetLogLevelsByResourceTypesResponseTypeDef

get_multicast_group#

Gets information about a multicast group.

Type annotations and code completion for boto3.client("iotwireless").get_multicast_group method. boto3 documentation

# get_multicast_group method definition

def get_multicast_group(
    self,
    *,
    Id: str,
) -> GetMulticastGroupResponseTypeDef:  # (1)
    ...
  1. See GetMulticastGroupResponseTypeDef 
# get_multicast_group method usage example with argument unpacking

kwargs: GetMulticastGroupRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_multicast_group(**kwargs)
  1. See GetMulticastGroupRequestRequestTypeDef

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

# get_multicast_group_session method definition

def get_multicast_group_session(
    self,
    *,
    Id: str,
) -> GetMulticastGroupSessionResponseTypeDef:  # (1)
    ...
  1. See GetMulticastGroupSessionResponseTypeDef 
# get_multicast_group_session method usage example with argument unpacking

kwargs: GetMulticastGroupSessionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_multicast_group_session(**kwargs)
  1. See GetMulticastGroupSessionRequestRequestTypeDef

get_network_analyzer_configuration#

Get network analyzer configuration.

Type annotations and code completion for boto3.client("iotwireless").get_network_analyzer_configuration method. boto3 documentation

# get_network_analyzer_configuration method definition

def get_network_analyzer_configuration(
    self,
    *,
    ConfigurationName: str,
) -> GetNetworkAnalyzerConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetNetworkAnalyzerConfigurationResponseTypeDef 
# get_network_analyzer_configuration method usage example with argument unpacking

kwargs: GetNetworkAnalyzerConfigurationRequestRequestTypeDef = {  # (1)
    "ConfigurationName": ...,
}

parent.get_network_analyzer_configuration(**kwargs)
  1. See GetNetworkAnalyzerConfigurationRequestRequestTypeDef

get_partner_account#

Gets information about a partner account.

Type annotations and code completion for boto3.client("iotwireless").get_partner_account method. boto3 documentation

# get_partner_account method definition

def get_partner_account(
    self,
    *,
    PartnerAccountId: str,
    PartnerType: PartnerTypeType,  # (1)
) -> GetPartnerAccountResponseTypeDef:  # (2)
    ...
  1. See PartnerTypeType
  2. See GetPartnerAccountResponseTypeDef 
# get_partner_account method usage example with argument unpacking

kwargs: GetPartnerAccountRequestRequestTypeDef = {  # (1)
    "PartnerAccountId": ...,
    "PartnerType": ...,
}

parent.get_partner_account(**kwargs)
  1. See GetPartnerAccountRequestRequestTypeDef

get_position#

Get the position information for a given resource.

Type annotations and code completion for boto3.client("iotwireless").get_position method. boto3 documentation

# get_position method definition

def get_position(
    self,
    *,
    ResourceIdentifier: str,
    ResourceType: PositionResourceTypeType,  # (1)
) -> GetPositionResponseTypeDef:  # (2)
    ...
  1. See PositionResourceTypeType
  2. See GetPositionResponseTypeDef 
# get_position method usage example with argument unpacking

kwargs: GetPositionRequestRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
    "ResourceType": ...,
}

parent.get_position(**kwargs)
  1. See GetPositionRequestRequestTypeDef

get_position_configuration#

Get position configuration for a given resource.

Type annotations and code completion for boto3.client("iotwireless").get_position_configuration method. boto3 documentation

# get_position_configuration method definition

def get_position_configuration(
    self,
    *,
    ResourceIdentifier: str,
    ResourceType: PositionResourceTypeType,  # (1)
) -> GetPositionConfigurationResponseTypeDef:  # (2)
    ...
  1. See PositionResourceTypeType
  2. See GetPositionConfigurationResponseTypeDef 
# get_position_configuration method usage example with argument unpacking

kwargs: GetPositionConfigurationRequestRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
    "ResourceType": ...,
}

parent.get_position_configuration(**kwargs)
  1. See GetPositionConfigurationRequestRequestTypeDef

get_position_estimate#

Get estimated position information as a payload in GeoJSON format.

Type annotations and code completion for boto3.client("iotwireless").get_position_estimate method. boto3 documentation

# get_position_estimate method definition

def get_position_estimate(
    self,
    *,
    WiFiAccessPoints: Sequence[WiFiAccessPointTypeDef] = ...,  # (1)
    CellTowers: CellTowersTypeDef = ...,  # (2)
    Ip: IpTypeDef = ...,  # (3)
    Gnss: GnssTypeDef = ...,  # (4)
    Timestamp: Union[datetime, str] = ...,
) -> GetPositionEstimateResponseTypeDef:  # (5)
    ...
  1. See WiFiAccessPointTypeDef
  2. See CellTowersTypeDef
  3. See IpTypeDef
  4. See GnssTypeDef
  5. See GetPositionEstimateResponseTypeDef 
# get_position_estimate method usage example with argument unpacking

kwargs: GetPositionEstimateRequestRequestTypeDef = {  # (1)
    "WiFiAccessPoints": ...,
}

parent.get_position_estimate(**kwargs)
  1. See GetPositionEstimateRequestRequestTypeDef

get_resource_event_configuration#

Get the event configuration for a particular resource identifier.

Type annotations and code completion for boto3.client("iotwireless").get_resource_event_configuration method. boto3 documentation

# get_resource_event_configuration method definition

def get_resource_event_configuration(
    self,
    *,
    Identifier: str,
    IdentifierType: IdentifierTypeType,  # (1)
    PartnerType: EventNotificationPartnerTypeType = ...,  # (2)
) -> GetResourceEventConfigurationResponseTypeDef:  # (3)
    ...
  1. See IdentifierTypeType
  2. See EventNotificationPartnerTypeType
  3. See GetResourceEventConfigurationResponseTypeDef 
# get_resource_event_configuration method usage example with argument unpacking

kwargs: GetResourceEventConfigurationRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "IdentifierType": ...,
}

parent.get_resource_event_configuration(**kwargs)
  1. See GetResourceEventConfigurationRequestRequestTypeDef

get_resource_log_level#

Fetches the log-level override, if any, for a given resource-ID and resource- type.

Type annotations and code completion for boto3.client("iotwireless").get_resource_log_level method. boto3 documentation

# get_resource_log_level method definition

def get_resource_log_level(
    self,
    *,
    ResourceIdentifier: str,
    ResourceType: str,
) -> GetResourceLogLevelResponseTypeDef:  # (1)
    ...
  1. See GetResourceLogLevelResponseTypeDef 
# get_resource_log_level method usage example with argument unpacking

kwargs: GetResourceLogLevelRequestRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
    "ResourceType": ...,
}

parent.get_resource_log_level(**kwargs)
  1. See GetResourceLogLevelRequestRequestTypeDef

get_resource_position#

Get the position information for a given wireless device or a wireless gateway resource.

Type annotations and code completion for boto3.client("iotwireless").get_resource_position method. boto3 documentation

# get_resource_position method definition

def get_resource_position(
    self,
    *,
    ResourceIdentifier: str,
    ResourceType: PositionResourceTypeType,  # (1)
) -> GetResourcePositionResponseTypeDef:  # (2)
    ...
  1. See PositionResourceTypeType
  2. See GetResourcePositionResponseTypeDef 
# get_resource_position method usage example with argument unpacking

kwargs: GetResourcePositionRequestRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
    "ResourceType": ...,
}

parent.get_resource_position(**kwargs)
  1. See GetResourcePositionRequestRequestTypeDef

get_service_endpoint#

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

Type annotations and code completion for boto3.client("iotwireless").get_service_endpoint method. boto3 documentation

# get_service_endpoint method definition

def get_service_endpoint(
    self,
    *,
    ServiceType: WirelessGatewayServiceTypeType = ...,  # (1)
) -> GetServiceEndpointResponseTypeDef:  # (2)
    ...
  1. See WirelessGatewayServiceTypeType
  2. See GetServiceEndpointResponseTypeDef 
# get_service_endpoint method usage example with argument unpacking

kwargs: GetServiceEndpointRequestRequestTypeDef = {  # (1)
    "ServiceType": ...,
}

parent.get_service_endpoint(**kwargs)
  1. See GetServiceEndpointRequestRequestTypeDef

get_service_profile#

Gets information about a service profile.

Type annotations and code completion for boto3.client("iotwireless").get_service_profile method. boto3 documentation

# get_service_profile method definition

def get_service_profile(
    self,
    *,
    Id: str,
) -> GetServiceProfileResponseTypeDef:  # (1)
    ...
  1. See GetServiceProfileResponseTypeDef 
# get_service_profile method usage example with argument unpacking

kwargs: GetServiceProfileRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_service_profile(**kwargs)
  1. See GetServiceProfileRequestRequestTypeDef

get_wireless_device#

Gets information about a wireless device.

Type annotations and code completion for boto3.client("iotwireless").get_wireless_device method. boto3 documentation

# get_wireless_device method definition

def get_wireless_device(
    self,
    *,
    Identifier: str,
    IdentifierType: WirelessDeviceIdTypeType,  # (1)
) -> GetWirelessDeviceResponseTypeDef:  # (2)
    ...
  1. See WirelessDeviceIdTypeType
  2. See GetWirelessDeviceResponseTypeDef 
# get_wireless_device method usage example with argument unpacking

kwargs: GetWirelessDeviceRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "IdentifierType": ...,
}

parent.get_wireless_device(**kwargs)
  1. See GetWirelessDeviceRequestRequestTypeDef

get_wireless_device_import_task#

Get information about an import task and count of device onboarding summary information for the import task.

Type annotations and code completion for boto3.client("iotwireless").get_wireless_device_import_task method. boto3 documentation

# get_wireless_device_import_task method definition

def get_wireless_device_import_task(
    self,
    *,
    Id: str,
) -> GetWirelessDeviceImportTaskResponseTypeDef:  # (1)
    ...
  1. See GetWirelessDeviceImportTaskResponseTypeDef 
# get_wireless_device_import_task method usage example with argument unpacking

kwargs: GetWirelessDeviceImportTaskRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_wireless_device_import_task(**kwargs)
  1. See GetWirelessDeviceImportTaskRequestRequestTypeDef

get_wireless_device_statistics#

Gets operating information about a wireless device.

Type annotations and code completion for boto3.client("iotwireless").get_wireless_device_statistics method. boto3 documentation

# get_wireless_device_statistics method definition

def get_wireless_device_statistics(
    self,
    *,
    WirelessDeviceId: str,
) -> GetWirelessDeviceStatisticsResponseTypeDef:  # (1)
    ...
  1. See GetWirelessDeviceStatisticsResponseTypeDef 
# get_wireless_device_statistics method usage example with argument unpacking

kwargs: GetWirelessDeviceStatisticsRequestRequestTypeDef = {  # (1)
    "WirelessDeviceId": ...,
}

parent.get_wireless_device_statistics(**kwargs)
  1. See GetWirelessDeviceStatisticsRequestRequestTypeDef

get_wireless_gateway#

Gets information about a wireless gateway.

Type annotations and code completion for boto3.client("iotwireless").get_wireless_gateway method. boto3 documentation

# get_wireless_gateway method definition

def get_wireless_gateway(
    self,
    *,
    Identifier: str,
    IdentifierType: WirelessGatewayIdTypeType,  # (1)
) -> GetWirelessGatewayResponseTypeDef:  # (2)
    ...
  1. See WirelessGatewayIdTypeType
  2. See GetWirelessGatewayResponseTypeDef 
# get_wireless_gateway method usage example with argument unpacking

kwargs: GetWirelessGatewayRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "IdentifierType": ...,
}

parent.get_wireless_gateway(**kwargs)
  1. See GetWirelessGatewayRequestRequestTypeDef

get_wireless_gateway_certificate#

Gets the ID of the certificate that is currently associated with a wireless gateway.

Type annotations and code completion for boto3.client("iotwireless").get_wireless_gateway_certificate method. boto3 documentation

# get_wireless_gateway_certificate method definition

def get_wireless_gateway_certificate(
    self,
    *,
    Id: str,
) -> GetWirelessGatewayCertificateResponseTypeDef:  # (1)
    ...
  1. See GetWirelessGatewayCertificateResponseTypeDef 
# get_wireless_gateway_certificate method usage example with argument unpacking

kwargs: GetWirelessGatewayCertificateRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_wireless_gateway_certificate(**kwargs)
  1. See