Struct aws_sdk_iotwireless::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description
Client for AWS IoT Wireless
Client for invoking operations on AWS IoT Wireless. Each operation on AWS IoT Wireless is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_iotwireless::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_iotwireless::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_iotwireless::Client::from_conf(config);
Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub fn associate_aws_account_with_partner_account(
&self
) -> AssociateAwsAccountWithPartnerAccount<C, M, R>
pub fn associate_aws_account_with_partner_account(
&self
) -> AssociateAwsAccountWithPartnerAccount<C, M, R>
Constructs a fluent builder for the AssociateAwsAccountWithPartnerAccount
operation.
- The fluent builder is configurable:
sidewalk(SidewalkAccountInfo)
/set_sidewalk(Option<SidewalkAccountInfo>)
:The Sidewalk account credentials.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- On success, responds with
AssociateAwsAccountWithPartnerAccountOutput
with field(s):sidewalk(Option<SidewalkAccountInfo>)
:The Sidewalk account credentials.
arn(Option<String>)
:The Amazon Resource Name of the resource.
- On failure, responds with
SdkError<AssociateAwsAccountWithPartnerAccountError>
pub fn associate_multicast_group_with_fuota_task(
&self
) -> AssociateMulticastGroupWithFuotaTask<C, M, R>
pub fn associate_multicast_group_with_fuota_task(
&self
) -> AssociateMulticastGroupWithFuotaTask<C, M, R>
Constructs a fluent builder for the AssociateMulticastGroupWithFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
multicast_group_id(impl Into<String>)
/set_multicast_group_id(Option<String>)
:The ID of the multicast group.
- On success, responds with
AssociateMulticastGroupWithFuotaTaskOutput
- On failure, responds with
SdkError<AssociateMulticastGroupWithFuotaTaskError>
pub fn associate_wireless_device_with_fuota_task(
&self
) -> AssociateWirelessDeviceWithFuotaTask<C, M, R>
pub fn associate_wireless_device_with_fuota_task(
&self
) -> AssociateWirelessDeviceWithFuotaTask<C, M, R>
Constructs a fluent builder for the AssociateWirelessDeviceWithFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
wireless_device_id(impl Into<String>)
/set_wireless_device_id(Option<String>)
:The ID of the wireless device.
- On success, responds with
AssociateWirelessDeviceWithFuotaTaskOutput
- On failure, responds with
SdkError<AssociateWirelessDeviceWithFuotaTaskError>
pub fn associate_wireless_device_with_multicast_group(
&self
) -> AssociateWirelessDeviceWithMulticastGroup<C, M, R>
pub fn associate_wireless_device_with_multicast_group(
&self
) -> AssociateWirelessDeviceWithMulticastGroup<C, M, R>
Constructs a fluent builder for the AssociateWirelessDeviceWithMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
wireless_device_id(impl Into<String>)
/set_wireless_device_id(Option<String>)
:The ID of the wireless device.
- On success, responds with
AssociateWirelessDeviceWithMulticastGroupOutput
- On failure, responds with
SdkError<AssociateWirelessDeviceWithMulticastGroupError>
pub fn associate_wireless_device_with_thing(
&self
) -> AssociateWirelessDeviceWithThing<C, M, R>
pub fn associate_wireless_device_with_thing(
&self
) -> AssociateWirelessDeviceWithThing<C, M, R>
Constructs a fluent builder for the AssociateWirelessDeviceWithThing
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
thing_arn(impl Into<String>)
/set_thing_arn(Option<String>)
:The ARN of the thing to associate with the wireless device.
- On success, responds with
AssociateWirelessDeviceWithThingOutput
- On failure, responds with
SdkError<AssociateWirelessDeviceWithThingError>
pub fn associate_wireless_gateway_with_certificate(
&self
) -> AssociateWirelessGatewayWithCertificate<C, M, R>
pub fn associate_wireless_gateway_with_certificate(
&self
) -> AssociateWirelessGatewayWithCertificate<C, M, R>
Constructs a fluent builder for the AssociateWirelessGatewayWithCertificate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
iot_certificate_id(impl Into<String>)
/set_iot_certificate_id(Option<String>)
:The ID of the certificate to associate with the wireless gateway.
- On success, responds with
AssociateWirelessGatewayWithCertificateOutput
with field(s):iot_certificate_id(Option<String>)
:The ID of the certificate associated with the wireless gateway.
- On failure, responds with
SdkError<AssociateWirelessGatewayWithCertificateError>
pub fn associate_wireless_gateway_with_thing(
&self
) -> AssociateWirelessGatewayWithThing<C, M, R>
pub fn associate_wireless_gateway_with_thing(
&self
) -> AssociateWirelessGatewayWithThing<C, M, R>
Constructs a fluent builder for the AssociateWirelessGatewayWithThing
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
thing_arn(impl Into<String>)
/set_thing_arn(Option<String>)
:The ARN of the thing to associate with the wireless gateway.
- On success, responds with
AssociateWirelessGatewayWithThingOutput
- On failure, responds with
SdkError<AssociateWirelessGatewayWithThingError>
Constructs a fluent builder for the CancelMulticastGroupSession
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
- On success, responds with
CancelMulticastGroupSessionOutput
- On failure, responds with
SdkError<CancelMulticastGroupSessionError>
Constructs a fluent builder for the CreateDestination
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the new resource.
expression_type(ExpressionType)
/set_expression_type(Option<ExpressionType>)
:The type of value in
Expression
.expression(impl Into<String>)
/set_expression(Option<String>)
:The rule name or topic rule to send messages to.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the new resource.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The ARN of the IAM Role that authorizes the destination.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
- On success, responds with
CreateDestinationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the new resource.
name(Option<String>)
:The name of the new resource.
- On failure, responds with
SdkError<CreateDestinationError>
Constructs a fluent builder for the CreateDeviceProfile
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the new resource.
lo_ra_wan(LoRaWanDeviceProfile)
/set_lo_ra_wan(Option<LoRaWanDeviceProfile>)
:The device profile information to use to create the device profile.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
- On success, responds with
CreateDeviceProfileOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the new resource.
id(Option<String>)
:The ID of the new device profile.
- On failure, responds with
SdkError<CreateDeviceProfileError>
Constructs a fluent builder for the CreateFuotaTask
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of a FUOTA task.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the new resource.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
lo_ra_wan(LoRaWanFuotaTask)
/set_lo_ra_wan(Option<LoRaWanFuotaTask>)
:The LoRaWAN information used with a FUOTA task.
firmware_update_image(impl Into<String>)
/set_firmware_update_image(Option<String>)
:The S3 URI points to a firmware update image that is to be used with a FUOTA task.
firmware_update_role(impl Into<String>)
/set_firmware_update_role(Option<String>)
:The firmware update role that is to be used with a FUOTA task.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- On success, responds with
CreateFuotaTaskOutput
with field(s):arn(Option<String>)
:The arn of a FUOTA task.
id(Option<String>)
:The ID of a FUOTA task.
- On failure, responds with
SdkError<CreateFuotaTaskError>
Constructs a fluent builder for the CreateMulticastGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the multicast group.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the multicast group.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
lo_ra_wan(LoRaWanMulticast)
/set_lo_ra_wan(Option<LoRaWanMulticast>)
:The LoRaWAN information that is to be used with the multicast group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- On success, responds with
CreateMulticastGroupOutput
with field(s):arn(Option<String>)
:The arn of the multicast group.
id(Option<String>)
:The ID of the multicast group.
- On failure, responds with
SdkError<CreateMulticastGroupError>
Constructs a fluent builder for the CreateServiceProfile
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the new resource.
lo_ra_wan(LoRaWanServiceProfile)
/set_lo_ra_wan(Option<LoRaWanServiceProfile>)
:The service profile information to use to create the service profile.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
- On success, responds with
CreateServiceProfileOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the new resource.
id(Option<String>)
:The ID of the new service profile.
- On failure, responds with
SdkError<CreateServiceProfileError>
Constructs a fluent builder for the CreateWirelessDevice
operation.
- The fluent builder is configurable:
r#type(WirelessDeviceType)
/set_type(Option<WirelessDeviceType>)
:The wireless device type.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the new resource.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the new resource.
destination_name(impl Into<String>)
/set_destination_name(Option<String>)
:The name of the destination to assign to the new wireless device.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
lo_ra_wan(LoRaWanDevice)
/set_lo_ra_wan(Option<LoRaWanDevice>)
:The device configuration information to use to create the wireless device.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
- On success, responds with
CreateWirelessDeviceOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the new resource.
id(Option<String>)
:The ID of the new wireless device.
- On failure, responds with
SdkError<CreateWirelessDeviceError>
Constructs a fluent builder for the CreateWirelessGateway
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the new resource.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the new resource.
lo_ra_wan(LoRaWanGateway)
/set_lo_ra_wan(Option<LoRaWanGateway>)
:The gateway configuration information to use to create the wireless gateway.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
- On success, responds with
CreateWirelessGatewayOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the new resource.
id(Option<String>)
:The ID of the new wireless gateway.
- On failure, responds with
SdkError<CreateWirelessGatewayError>
Constructs a fluent builder for the CreateWirelessGatewayTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
wireless_gateway_task_definition_id(impl Into<String>)
/set_wireless_gateway_task_definition_id(Option<String>)
:The ID of the WirelessGatewayTaskDefinition.
- On success, responds with
CreateWirelessGatewayTaskOutput
with field(s):wireless_gateway_task_definition_id(Option<String>)
:The ID of the WirelessGatewayTaskDefinition.
status(Option<WirelessGatewayTaskStatus>)
:The status of the request.
- On failure, responds with
SdkError<CreateWirelessGatewayTaskError>
pub fn create_wireless_gateway_task_definition(
&self
) -> CreateWirelessGatewayTaskDefinition<C, M, R>
pub fn create_wireless_gateway_task_definition(
&self
) -> CreateWirelessGatewayTaskDefinition<C, M, R>
Constructs a fluent builder for the CreateWirelessGatewayTaskDefinition
operation.
- The fluent builder is configurable:
auto_create_tasks(bool)
/set_auto_create_tasks(bool)
:Whether to automatically create tasks using this task definition for all gateways with the specified current version. If
false
, the task must me created by callingCreateWirelessGatewayTask
.name(impl Into<String>)
/set_name(Option<String>)
:The name of the new resource.
update(UpdateWirelessGatewayTaskCreate)
/set_update(Option<UpdateWirelessGatewayTaskCreate>)
:Information about the gateways to update.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- On success, responds with
CreateWirelessGatewayTaskDefinitionOutput
with field(s):id(Option<String>)
:The ID of the new wireless gateway task definition.
arn(Option<String>)
:The Amazon Resource Name of the resource.
- On failure, responds with
SdkError<CreateWirelessGatewayTaskDefinitionError>
Constructs a fluent builder for the DeleteDestination
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the resource to delete.
- On success, responds with
DeleteDestinationOutput
- On failure, responds with
SdkError<DeleteDestinationError>
Constructs a fluent builder for the DeleteDeviceProfile
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to delete.
- On success, responds with
DeleteDeviceProfileOutput
- On failure, responds with
SdkError<DeleteDeviceProfileError>
Constructs a fluent builder for the DeleteFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
- On success, responds with
DeleteFuotaTaskOutput
- On failure, responds with
SdkError<DeleteFuotaTaskError>
Constructs a fluent builder for the DeleteMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
- On success, responds with
DeleteMulticastGroupOutput
- On failure, responds with
SdkError<DeleteMulticastGroupError>
Constructs a fluent builder for the DeleteQueuedMessages
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:Id of a given wireless device which messages will be deleted
message_id(impl Into<String>)
/set_message_id(Option<String>)
:if messageID==“*”, the queue for a particular wireless deviceId will be purged, otherwise, the specific message with messageId will be deleted
wireless_device_type(WirelessDeviceType)
/set_wireless_device_type(Option<WirelessDeviceType>)
:The wireless device type, it is either Sidewalk or LoRaWAN.
- On success, responds with
DeleteQueuedMessagesOutput
- On failure, responds with
SdkError<DeleteQueuedMessagesError>
Constructs a fluent builder for the DeleteServiceProfile
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to delete.
- On success, responds with
DeleteServiceProfileOutput
- On failure, responds with
SdkError<DeleteServiceProfileError>
Constructs a fluent builder for the DeleteWirelessDevice
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to delete.
- On success, responds with
DeleteWirelessDeviceOutput
- On failure, responds with
SdkError<DeleteWirelessDeviceError>
Constructs a fluent builder for the DeleteWirelessGateway
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to delete.
- On success, responds with
DeleteWirelessGatewayOutput
- On failure, responds with
SdkError<DeleteWirelessGatewayError>
Constructs a fluent builder for the DeleteWirelessGatewayTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to delete.
- On success, responds with
DeleteWirelessGatewayTaskOutput
- On failure, responds with
SdkError<DeleteWirelessGatewayTaskError>
pub fn delete_wireless_gateway_task_definition(
&self
) -> DeleteWirelessGatewayTaskDefinition<C, M, R>
pub fn delete_wireless_gateway_task_definition(
&self
) -> DeleteWirelessGatewayTaskDefinition<C, M, R>
Constructs a fluent builder for the DeleteWirelessGatewayTaskDefinition
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to delete.
- On success, responds with
DeleteWirelessGatewayTaskDefinitionOutput
- On failure, responds with
SdkError<DeleteWirelessGatewayTaskDefinitionError>
pub fn disassociate_aws_account_from_partner_account(
&self
) -> DisassociateAwsAccountFromPartnerAccount<C, M, R>
pub fn disassociate_aws_account_from_partner_account(
&self
) -> DisassociateAwsAccountFromPartnerAccount<C, M, R>
Constructs a fluent builder for the DisassociateAwsAccountFromPartnerAccount
operation.
- The fluent builder is configurable:
partner_account_id(impl Into<String>)
/set_partner_account_id(Option<String>)
:The partner account ID to disassociate from the AWS account.
partner_type(PartnerType)
/set_partner_type(Option<PartnerType>)
:The partner type.
- On success, responds with
DisassociateAwsAccountFromPartnerAccountOutput
- On failure, responds with
SdkError<DisassociateAwsAccountFromPartnerAccountError>
pub fn disassociate_multicast_group_from_fuota_task(
&self
) -> DisassociateMulticastGroupFromFuotaTask<C, M, R>
pub fn disassociate_multicast_group_from_fuota_task(
&self
) -> DisassociateMulticastGroupFromFuotaTask<C, M, R>
Constructs a fluent builder for the DisassociateMulticastGroupFromFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
multicast_group_id(impl Into<String>)
/set_multicast_group_id(Option<String>)
:The ID of the multicast group.
- On success, responds with
DisassociateMulticastGroupFromFuotaTaskOutput
- On failure, responds with
SdkError<DisassociateMulticastGroupFromFuotaTaskError>
pub fn disassociate_wireless_device_from_fuota_task(
&self
) -> DisassociateWirelessDeviceFromFuotaTask<C, M, R>
pub fn disassociate_wireless_device_from_fuota_task(
&self
) -> DisassociateWirelessDeviceFromFuotaTask<C, M, R>
Constructs a fluent builder for the DisassociateWirelessDeviceFromFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
wireless_device_id(impl Into<String>)
/set_wireless_device_id(Option<String>)
:The ID of the wireless device.
- On success, responds with
DisassociateWirelessDeviceFromFuotaTaskOutput
- On failure, responds with
SdkError<DisassociateWirelessDeviceFromFuotaTaskError>
pub fn disassociate_wireless_device_from_multicast_group(
&self
) -> DisassociateWirelessDeviceFromMulticastGroup<C, M, R>
pub fn disassociate_wireless_device_from_multicast_group(
&self
) -> DisassociateWirelessDeviceFromMulticastGroup<C, M, R>
Constructs a fluent builder for the DisassociateWirelessDeviceFromMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
wireless_device_id(impl Into<String>)
/set_wireless_device_id(Option<String>)
:The ID of the wireless device.
- On success, responds with
DisassociateWirelessDeviceFromMulticastGroupOutput
- On failure, responds with
SdkError<DisassociateWirelessDeviceFromMulticastGroupError>
pub fn disassociate_wireless_device_from_thing(
&self
) -> DisassociateWirelessDeviceFromThing<C, M, R>
pub fn disassociate_wireless_device_from_thing(
&self
) -> DisassociateWirelessDeviceFromThing<C, M, R>
Constructs a fluent builder for the DisassociateWirelessDeviceFromThing
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
- On success, responds with
DisassociateWirelessDeviceFromThingOutput
- On failure, responds with
SdkError<DisassociateWirelessDeviceFromThingError>
pub fn disassociate_wireless_gateway_from_certificate(
&self
) -> DisassociateWirelessGatewayFromCertificate<C, M, R>
pub fn disassociate_wireless_gateway_from_certificate(
&self
) -> DisassociateWirelessGatewayFromCertificate<C, M, R>
Constructs a fluent builder for the DisassociateWirelessGatewayFromCertificate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
- On success, responds with
DisassociateWirelessGatewayFromCertificateOutput
- On failure, responds with
SdkError<DisassociateWirelessGatewayFromCertificateError>
pub fn disassociate_wireless_gateway_from_thing(
&self
) -> DisassociateWirelessGatewayFromThing<C, M, R>
pub fn disassociate_wireless_gateway_from_thing(
&self
) -> DisassociateWirelessGatewayFromThing<C, M, R>
Constructs a fluent builder for the DisassociateWirelessGatewayFromThing
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
- On success, responds with
DisassociateWirelessGatewayFromThingOutput
- On failure, responds with
SdkError<DisassociateWirelessGatewayFromThingError>
Constructs a fluent builder for the GetDestination
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the resource to get.
- On success, responds with
GetDestinationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the resource.
name(Option<String>)
:The name of the resource.
expression(Option<String>)
:The rule name or topic rule to send messages to.
expression_type(Option<ExpressionType>)
:The type of value in
Expression
.description(Option<String>)
:The description of the resource.
role_arn(Option<String>)
:The ARN of the IAM Role that authorizes the destination.
- On failure, responds with
SdkError<GetDestinationError>
Constructs a fluent builder for the GetDeviceProfile
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to get.
- On success, responds with
GetDeviceProfileOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the resource.
name(Option<String>)
:The name of the resource.
id(Option<String>)
:The ID of the device profile.
lo_ra_wan(Option<LoRaWanDeviceProfile>)
:Information about the device profile.
- On failure, responds with
SdkError<GetDeviceProfileError>
Constructs a fluent builder for the GetFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
- On success, responds with
GetFuotaTaskOutput
with field(s):arn(Option<String>)
:The arn of a FUOTA task.
id(Option<String>)
:The ID of a FUOTA task.
status(Option<FuotaTaskStatus>)
:The status of a FUOTA task.
name(Option<String>)
:The name of a FUOTA task.
description(Option<String>)
:The description of the new resource.
lo_ra_wan(Option<LoRaWanFuotaTaskGetInfo>)
:The LoRaWAN information returned from getting a FUOTA task.
firmware_update_image(Option<String>)
:The S3 URI points to a firmware update image that is to be used with a FUOTA task.
firmware_update_role(Option<String>)
:The firmware update role that is to be used with a FUOTA task.
created_at(Option<DateTime>)
:Created at timestamp for the resource.
- On failure, responds with
SdkError<GetFuotaTaskError>
Constructs a fluent builder for the GetLogLevelsByResourceTypes
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetLogLevelsByResourceTypesOutput
with field(s):default_log_level(Option<LogLevel>)
:The log level for a log message.
wireless_gateway_log_options(Option<Vec<WirelessGatewayLogOption>>)
:The list of wireless gateway log options.
wireless_device_log_options(Option<Vec<WirelessDeviceLogOption>>)
:The list of wireless device log options.
- On failure, responds with
SdkError<GetLogLevelsByResourceTypesError>
Constructs a fluent builder for the GetMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
- On success, responds with
GetMulticastGroupOutput
with field(s):arn(Option<String>)
:The arn of the multicast group.
id(Option<String>)
:The ID of the multicast group.
name(Option<String>)
:The name of the multicast group.
description(Option<String>)
:The description of the new resource.
status(Option<String>)
:The status of the multicast group.
lo_ra_wan(Option<LoRaWanMulticastGet>)
:The LoRaWAN information that is to be returned from getting multicast group information.
created_at(Option<DateTime>)
:Created at timestamp for the resource.
- On failure, responds with
SdkError<GetMulticastGroupError>
Constructs a fluent builder for the GetMulticastGroupSession
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
- On success, responds with
GetMulticastGroupSessionOutput
with field(s):lo_ra_wan(Option<LoRaWanMulticastSession>)
:The LoRaWAN information used with the multicast session.
- On failure, responds with
SdkError<GetMulticastGroupSessionError>
Constructs a fluent builder for the GetNetworkAnalyzerConfiguration
operation.
- The fluent builder is configurable:
configuration_name(impl Into<String>)
/set_configuration_name(Option<String>)
:NetworkAnalyzer configuration name.
- On success, responds with
GetNetworkAnalyzerConfigurationOutput
with field(s):trace_content(Option<TraceContent>)
:Trace Content for resources.
wireless_devices(Option<Vec<String>>)
:List of WirelessDevices in the NetworkAnalyzerConfiguration.
wireless_gateways(Option<Vec<String>>)
:List of WirelessGateways in the NetworkAnalyzerConfiguration.
- On failure, responds with
SdkError<GetNetworkAnalyzerConfigurationError>
Constructs a fluent builder for the GetPartnerAccount
operation.
- The fluent builder is configurable:
partner_account_id(impl Into<String>)
/set_partner_account_id(Option<String>)
:The partner account ID to disassociate from the AWS account.
partner_type(PartnerType)
/set_partner_type(Option<PartnerType>)
:The partner type.
- On success, responds with
GetPartnerAccountOutput
with field(s):sidewalk(Option<SidewalkAccountInfoWithFingerprint>)
:The Sidewalk account credentials.
account_linked(bool)
:Whether the partner account is linked to the AWS account.
- On failure, responds with
SdkError<GetPartnerAccountError>
Constructs a fluent builder for the GetResourceEventConfiguration
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:Resource identifier to opt in for event messaging.
identifier_type(IdentifierType)
/set_identifier_type(Option<IdentifierType>)
:Identifier type of the particular resource identifier for event configuration.
partner_type(EventNotificationPartnerType)
/set_partner_type(Option<EventNotificationPartnerType>)
:Partner type of the resource if the identifier type is PartnerAccountId.
- On success, responds with
GetResourceEventConfigurationOutput
with field(s):device_registration_state(Option<DeviceRegistrationStateEventConfiguration>)
:Event configuration for the device registration state event
proximity(Option<ProximityEventConfiguration>)
:Event configuration for the Proximity event
- On failure, responds with
SdkError<GetResourceEventConfigurationError>
Constructs a fluent builder for the GetResourceLogLevel
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:The type of the resource, which can be
WirelessDevice
orWirelessGateway
.
- On success, responds with
GetResourceLogLevelOutput
with field(s):log_level(Option<LogLevel>)
:The log level for a log message.
- On failure, responds with
SdkError<GetResourceLogLevelError>
Constructs a fluent builder for the GetServiceEndpoint
operation.
- The fluent builder is configurable:
service_type(WirelessGatewayServiceType)
/set_service_type(Option<WirelessGatewayServiceType>)
:The service type for which to get endpoint information about. Can be
CUPS
for the Configuration and Update Server endpoint, orLNS
for the LoRaWAN Network Server endpoint.
- On success, responds with
GetServiceEndpointOutput
with field(s):service_type(Option<WirelessGatewayServiceType>)
:The endpoint’s service type.
service_endpoint(Option<String>)
:The service endpoint value.
server_trust(Option<String>)
:The Root CA of the server trust certificate.
- On failure, responds with
SdkError<GetServiceEndpointError>
Constructs a fluent builder for the GetServiceProfile
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to get.
- On success, responds with
GetServiceProfileOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name of the resource.
name(Option<String>)
:The name of the resource.
id(Option<String>)
:The ID of the service profile.
lo_ra_wan(Option<LoRaWanGetServiceProfileInfo>)
:Information about the service profile.
- On failure, responds with
SdkError<GetServiceProfileError>
Constructs a fluent builder for the GetWirelessDevice
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:The identifier of the wireless device to get.
identifier_type(WirelessDeviceIdType)
/set_identifier_type(Option<WirelessDeviceIdType>)
:The type of identifier used in
identifier
.
- On success, responds with
GetWirelessDeviceOutput
with field(s):r#type(Option<WirelessDeviceType>)
:The wireless device type.
name(Option<String>)
:The name of the resource.
description(Option<String>)
:The description of the resource.
destination_name(Option<String>)
:The name of the destination to which the device is assigned.
id(Option<String>)
:The ID of the wireless device.
arn(Option<String>)
:The Amazon Resource Name of the resource.
thing_name(Option<String>)
:The name of the thing associated with the wireless device. The value is empty if a thing isn’t associated with the device.
thing_arn(Option<String>)
:The ARN of the thing associated with the wireless device.
lo_ra_wan(Option<LoRaWanDevice>)
:Information about the wireless device.
sidewalk(Option<SidewalkDevice>)
:Sidewalk device object.
- On failure, responds with
SdkError<GetWirelessDeviceError>
Constructs a fluent builder for the GetWirelessDeviceStatistics
operation.
- The fluent builder is configurable:
wireless_device_id(impl Into<String>)
/set_wireless_device_id(Option<String>)
:The ID of the wireless device for which to get the data.
- On success, responds with
GetWirelessDeviceStatisticsOutput
with field(s):wireless_device_id(Option<String>)
:The ID of the wireless device.
last_uplink_received_at(Option<String>)
:The date and time when the most recent uplink was received.
lo_ra_wan(Option<LoRaWanDeviceMetadata>)
:Information about the wireless device’s operations.
sidewalk(Option<SidewalkDeviceMetadata>)
:MetaData for Sidewalk device.
- On failure, responds with
SdkError<GetWirelessDeviceStatisticsError>
Constructs a fluent builder for the GetWirelessGateway
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:The identifier of the wireless gateway to get.
identifier_type(WirelessGatewayIdType)
/set_identifier_type(Option<WirelessGatewayIdType>)
:The type of identifier used in
identifier
.
- On success, responds with
GetWirelessGatewayOutput
with field(s):name(Option<String>)
:The name of the resource.
id(Option<String>)
:The ID of the wireless gateway.
description(Option<String>)
:The description of the resource.
lo_ra_wan(Option<LoRaWanGateway>)
:Information about the wireless gateway.
arn(Option<String>)
:The Amazon Resource Name of the resource.
thing_name(Option<String>)
:The name of the thing associated with the wireless gateway. The value is empty if a thing isn’t associated with the gateway.
thing_arn(Option<String>)
:The ARN of the thing associated with the wireless gateway.
- On failure, responds with
SdkError<GetWirelessGatewayError>
Constructs a fluent builder for the GetWirelessGatewayCertificate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to get.
- On success, responds with
GetWirelessGatewayCertificateOutput
with field(s):iot_certificate_id(Option<String>)
:The ID of the certificate associated with the wireless gateway.
lo_ra_wan_network_server_certificate_id(Option<String>)
:The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.
- On failure, responds with
SdkError<GetWirelessGatewayCertificateError>
pub fn get_wireless_gateway_firmware_information(
&self
) -> GetWirelessGatewayFirmwareInformation<C, M, R>
pub fn get_wireless_gateway_firmware_information(
&self
) -> GetWirelessGatewayFirmwareInformation<C, M, R>
Constructs a fluent builder for the GetWirelessGatewayFirmwareInformation
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to get.
- On success, responds with
GetWirelessGatewayFirmwareInformationOutput
with field(s):lo_ra_wan(Option<LoRaWanGatewayCurrentVersion>)
:Information about the wireless gateway’s firmware.
- On failure, responds with
SdkError<GetWirelessGatewayFirmwareInformationError>
Constructs a fluent builder for the GetWirelessGatewayStatistics
operation.
- The fluent builder is configurable:
wireless_gateway_id(impl Into<String>)
/set_wireless_gateway_id(Option<String>)
:The ID of the wireless gateway for which to get the data.
- On success, responds with
GetWirelessGatewayStatisticsOutput
with field(s):wireless_gateway_id(Option<String>)
:The ID of the wireless gateway.
last_uplink_received_at(Option<String>)
:The date and time when the most recent uplink was received.
connection_status(Option<ConnectionStatus>)
:The connection status of the wireless gateway.
- On failure, responds with
SdkError<GetWirelessGatewayStatisticsError>
Constructs a fluent builder for the GetWirelessGatewayTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to get.
- On success, responds with
GetWirelessGatewayTaskOutput
with field(s):wireless_gateway_id(Option<String>)
:The ID of the wireless gateway.
wireless_gateway_task_definition_id(Option<String>)
:The ID of the WirelessGatewayTask.
last_uplink_received_at(Option<String>)
:The date and time when the most recent uplink was received.
task_created_at(Option<String>)
:The date and time when the task was created.
status(Option<WirelessGatewayTaskStatus>)
:The status of the request.
- On failure, responds with
SdkError<GetWirelessGatewayTaskError>
pub fn get_wireless_gateway_task_definition(
&self
) -> GetWirelessGatewayTaskDefinition<C, M, R>
pub fn get_wireless_gateway_task_definition(
&self
) -> GetWirelessGatewayTaskDefinition<C, M, R>
Constructs a fluent builder for the GetWirelessGatewayTaskDefinition
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to get.
- On success, responds with
GetWirelessGatewayTaskDefinitionOutput
with field(s):auto_create_tasks(bool)
:Whether to automatically create tasks using this task definition for all gateways with the specified current version. If
false
, the task must me created by callingCreateWirelessGatewayTask
.name(Option<String>)
:The name of the resource.
update(Option<UpdateWirelessGatewayTaskCreate>)
:Information about the gateways to update.
arn(Option<String>)
:The Amazon Resource Name of the resource.
- On failure, responds with
SdkError<GetWirelessGatewayTaskDefinitionError>
Constructs a fluent builder for the ListDestinations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.
- On success, responds with
ListDestinationsOutput
with field(s):next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
destination_list(Option<Vec<Destinations>>)
:The list of destinations.
- On failure, responds with
SdkError<ListDestinationsError>
Constructs a fluent builder for the ListDeviceProfiles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
- On success, responds with
ListDeviceProfilesOutput
with field(s):next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
device_profile_list(Option<Vec<DeviceProfile>>)
:The list of device profiles.
- On failure, responds with
SdkError<ListDeviceProfilesError>
Constructs a fluent builder for the ListFuotaTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
- On success, responds with
ListFuotaTasksOutput
with field(s):next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.fuota_task_list(Option<Vec<FuotaTask>>)
:Lists the FUOTA tasks registered to your AWS account.
- On failure, responds with
SdkError<ListFuotaTasksError>
Constructs a fluent builder for the ListMulticastGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
- On success, responds with
ListMulticastGroupsOutput
with field(s):next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.multicast_group_list(Option<Vec<MulticastGroup>>)
:List of multicast groups.
- On failure, responds with
SdkError<ListMulticastGroupsError>
Constructs a fluent builder for the ListMulticastGroupsByFuotaTask
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
- On success, responds with
ListMulticastGroupsByFuotaTaskOutput
with field(s):next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.multicast_group_list(Option<Vec<MulticastGroupByFuotaTask>>)
:List of multicast groups associated with a FUOTA task.
- On failure, responds with
SdkError<ListMulticastGroupsByFuotaTaskError>
Constructs a fluent builder for the ListPartnerAccounts
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
- On success, responds with
ListPartnerAccountsOutput
with field(s):next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
sidewalk(Option<Vec<SidewalkAccountInfoWithFingerprint>>)
:The Sidewalk account credentials.
- On failure, responds with
SdkError<ListPartnerAccountsError>
Constructs a fluent builder for the ListQueuedMessages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:Id of a given wireless device which the downlink packets are targeted
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
wireless_device_type(WirelessDeviceType)
/set_wireless_device_type(Option<WirelessDeviceType>)
:The wireless device type, it is either Sidewalk or LoRaWAN.
- On success, responds with
ListQueuedMessagesOutput
with field(s):next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.downlink_queue_messages_list(Option<Vec<DownlinkQueueMessage>>)
:The messages in downlink queue.
- On failure, responds with
SdkError<ListQueuedMessagesError>
Constructs a fluent builder for the ListServiceProfiles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
- On success, responds with
ListServiceProfilesOutput
with field(s):next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
service_profile_list(Option<Vec<ServiceProfile>>)
:The list of service profiles.
- On failure, responds with
SdkError<ListServiceProfilesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource for which you want to list tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Constructs a fluent builder for the ListWirelessDevices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.destination_name(impl Into<String>)
/set_destination_name(Option<String>)
:A filter to list only the wireless devices that use this destination.
device_profile_id(impl Into<String>)
/set_device_profile_id(Option<String>)
:A filter to list only the wireless devices that use this device profile.
service_profile_id(impl Into<String>)
/set_service_profile_id(Option<String>)
:A filter to list only the wireless devices that use this service profile.
wireless_device_type(WirelessDeviceType)
/set_wireless_device_type(Option<WirelessDeviceType>)
:A filter to list only the wireless devices that use this wireless device type.
fuota_task_id(impl Into<String>)
/set_fuota_task_id(Option<String>)
:The ID of a FUOTA task.
multicast_group_id(impl Into<String>)
/set_multicast_group_id(Option<String>)
:The ID of the multicast group.
- On success, responds with
ListWirelessDevicesOutput
with field(s):next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
wireless_device_list(Option<Vec<WirelessDeviceStatistics>>)
:The ID of the wireless device.
- On failure, responds with
SdkError<ListWirelessDevicesError>
Constructs a fluent builder for the ListWirelessGateways
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
- On success, responds with
ListWirelessGatewaysOutput
with field(s):next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
wireless_gateway_list(Option<Vec<WirelessGatewayStatistics>>)
:The ID of the wireless gateway.
- On failure, responds with
SdkError<ListWirelessGatewaysError>
pub fn list_wireless_gateway_task_definitions(
&self
) -> ListWirelessGatewayTaskDefinitions<C, M, R>
pub fn list_wireless_gateway_task_definitions(
&self
) -> ListWirelessGatewayTaskDefinitions<C, M, R>
Constructs a fluent builder for the ListWirelessGatewayTaskDefinitions
operation.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in this operation.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.task_definition_type(WirelessGatewayTaskDefinitionType)
/set_task_definition_type(Option<WirelessGatewayTaskDefinitionType>)
:A filter to list only the wireless gateway task definitions that use this task definition type.
- On success, responds with
ListWirelessGatewayTaskDefinitionsOutput
with field(s):next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
task_definitions(Option<Vec<UpdateWirelessGatewayTaskEntry>>)
:The list of task definitions.
- On failure, responds with
SdkError<ListWirelessGatewayTaskDefinitionsError>
Constructs a fluent builder for the PutResourceLogLevel
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:The type of the resource, which can be
WirelessDevice
orWirelessGateway
.log_level(LogLevel)
/set_log_level(Option<LogLevel>)
:The log level for a log message.
- On success, responds with
PutResourceLogLevelOutput
- On failure, responds with
SdkError<PutResourceLogLevelError>
Constructs a fluent builder for the ResetAllResourceLogLevels
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ResetAllResourceLogLevelsOutput
- On failure, responds with
SdkError<ResetAllResourceLogLevelsError>
Constructs a fluent builder for the ResetResourceLogLevel
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:The type of the resource, which can be
WirelessDevice
orWirelessGateway
.
- On success, responds with
ResetResourceLogLevelOutput
- On failure, responds with
SdkError<ResetResourceLogLevelError>
Constructs a fluent builder for the SendDataToMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
payload_data(impl Into<String>)
/set_payload_data(Option<String>)
:The binary to be sent to the end device, encoded in base64.
wireless_metadata(MulticastWirelessMetadata)
/set_wireless_metadata(Option<MulticastWirelessMetadata>)
:Wireless metadata that is to be sent to multicast group.
- On success, responds with
SendDataToMulticastGroupOutput
with field(s):message_id(Option<String>)
:ID of a multicast group message.
- On failure, responds with
SdkError<SendDataToMulticastGroupError>
Constructs a fluent builder for the SendDataToWirelessDevice
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the wireless device to receive the data.
transmit_mode(i32)
/set_transmit_mode(Option<i32>)
:The transmit mode to use to send data to the wireless device. Can be:
0
for UM (unacknowledge mode) or1
for AM (acknowledge mode).payload_data(impl Into<String>)
/set_payload_data(Option<String>)
:The binary to be sent to the end device, encoded in base64.
wireless_metadata(WirelessMetadata)
/set_wireless_metadata(Option<WirelessMetadata>)
:Metadata about the message request.
- On success, responds with
SendDataToWirelessDeviceOutput
with field(s):message_id(Option<String>)
:The ID of the message sent to the wireless device.
- On failure, responds with
SdkError<SendDataToWirelessDeviceError>
Constructs a fluent builder for the StartBulkAssociateWirelessDeviceWithMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:Query string used to search for wireless devices as part of the bulk associate and disassociate process.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- On success, responds with
StartBulkAssociateWirelessDeviceWithMulticastGroupOutput
- On failure, responds with
SdkError<StartBulkAssociateWirelessDeviceWithMulticastGroupError>
Constructs a fluent builder for the StartBulkDisassociateWirelessDeviceFromMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:Query string used to search for wireless devices as part of the bulk associate and disassociate process.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- On success, responds with
StartBulkDisassociateWirelessDeviceFromMulticastGroupOutput
- On failure, responds with
SdkError<StartBulkDisassociateWirelessDeviceFromMulticastGroupError>
Constructs a fluent builder for the StartFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
lo_ra_wan(LoRaWanStartFuotaTask)
/set_lo_ra_wan(Option<LoRaWanStartFuotaTask>)
:The LoRaWAN information used to start a FUOTA task.
- On success, responds with
StartFuotaTaskOutput
- On failure, responds with
SdkError<StartFuotaTaskError>
Constructs a fluent builder for the StartMulticastGroupSession
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
lo_ra_wan(LoRaWanMulticastSession)
/set_lo_ra_wan(Option<LoRaWanMulticastSession>)
:The LoRaWAN information used with the multicast session.
- On success, responds with
StartMulticastGroupSessionOutput
- On failure, responds with
SdkError<StartMulticastGroupSessionError>
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource to add tags to.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the TestWirelessDevice
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the wireless device to test.
- On success, responds with
TestWirelessDeviceOutput
with field(s):result(Option<String>)
:The result returned by the test.
- On failure, responds with
SdkError<TestWirelessDeviceError>
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource to remove tags from.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A list of the keys of the tags to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Constructs a fluent builder for the UpdateDestination
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The new name of the resource.
expression_type(ExpressionType)
/set_expression_type(Option<ExpressionType>)
:The type of value in
Expression
.expression(impl Into<String>)
/set_expression(Option<String>)
:The new rule name or topic rule to send messages to.
description(impl Into<String>)
/set_description(Option<String>)
:A new description of the resource.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The ARN of the IAM Role that authorizes the destination.
- On success, responds with
UpdateDestinationOutput
- On failure, responds with
SdkError<UpdateDestinationError>
Constructs a fluent builder for the UpdateFuotaTask
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of a FUOTA task.
name(impl Into<String>)
/set_name(Option<String>)
:The name of a FUOTA task.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the new resource.
lo_ra_wan(LoRaWanFuotaTask)
/set_lo_ra_wan(Option<LoRaWanFuotaTask>)
:The LoRaWAN information used with a FUOTA task.
firmware_update_image(impl Into<String>)
/set_firmware_update_image(Option<String>)
:The S3 URI points to a firmware update image that is to be used with a FUOTA task.
firmware_update_role(impl Into<String>)
/set_firmware_update_role(Option<String>)
:The firmware update role that is to be used with a FUOTA task.
- On success, responds with
UpdateFuotaTaskOutput
- On failure, responds with
SdkError<UpdateFuotaTaskError>
Constructs a fluent builder for the UpdateLogLevelsByResourceTypes
operation.
- The fluent builder is configurable:
default_log_level(LogLevel)
/set_default_log_level(Option<LogLevel>)
:The log level for a log message.
wireless_device_log_options(Vec<WirelessDeviceLogOption>)
/set_wireless_device_log_options(Option<Vec<WirelessDeviceLogOption>>)
:The list of wireless device log options.
wireless_gateway_log_options(Vec<WirelessGatewayLogOption>)
/set_wireless_gateway_log_options(Option<Vec<WirelessGatewayLogOption>>)
:The list of wireless gateway log options.
- On success, responds with
UpdateLogLevelsByResourceTypesOutput
- On failure, responds with
SdkError<UpdateLogLevelsByResourceTypesError>
Constructs a fluent builder for the UpdateMulticastGroup
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the multicast group.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the multicast group.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the new resource.
lo_ra_wan(LoRaWanMulticast)
/set_lo_ra_wan(Option<LoRaWanMulticast>)
:The LoRaWAN information that is to be used with the multicast group.
- On success, responds with
UpdateMulticastGroupOutput
- On failure, responds with
SdkError<UpdateMulticastGroupError>
pub fn update_network_analyzer_configuration(
&self
) -> UpdateNetworkAnalyzerConfiguration<C, M, R>
pub fn update_network_analyzer_configuration(
&self
) -> UpdateNetworkAnalyzerConfiguration<C, M, R>
Constructs a fluent builder for the UpdateNetworkAnalyzerConfiguration
operation.
- The fluent builder is configurable:
configuration_name(impl Into<String>)
/set_configuration_name(Option<String>)
:NetworkAnalyzer configuration name.
trace_content(TraceContent)
/set_trace_content(Option<TraceContent>)
:Trace Content for resources.
wireless_devices_to_add(Vec<String>)
/set_wireless_devices_to_add(Option<Vec<String>>)
:WirelessDevices to add into NetworkAnalyzerConfiguration.
wireless_devices_to_remove(Vec<String>)
/set_wireless_devices_to_remove(Option<Vec<String>>)
:WirelessDevices to remove from NetworkAnalyzerConfiguration.
wireless_gateways_to_add(Vec<String>)
/set_wireless_gateways_to_add(Option<Vec<String>>)
:WirelessGateways to add into NetworkAnalyzerConfiguration.
wireless_gateways_to_remove(Vec<String>)
/set_wireless_gateways_to_remove(Option<Vec<String>>)
:WirelessGateways to remove from NetworkAnalyzerConfiguration.
- On success, responds with
UpdateNetworkAnalyzerConfigurationOutput
- On failure, responds with
SdkError<UpdateNetworkAnalyzerConfigurationError>
Constructs a fluent builder for the UpdatePartnerAccount
operation.
- The fluent builder is configurable:
sidewalk(SidewalkUpdateAccount)
/set_sidewalk(Option<SidewalkUpdateAccount>)
:The Sidewalk account credentials.
partner_account_id(impl Into<String>)
/set_partner_account_id(Option<String>)
:The ID of the partner account to update.
partner_type(PartnerType)
/set_partner_type(Option<PartnerType>)
:The partner type.
- On success, responds with
UpdatePartnerAccountOutput
- On failure, responds with
SdkError<UpdatePartnerAccountError>
pub fn update_resource_event_configuration(
&self
) -> UpdateResourceEventConfiguration<C, M, R>
pub fn update_resource_event_configuration(
&self
) -> UpdateResourceEventConfiguration<C, M, R>
Constructs a fluent builder for the UpdateResourceEventConfiguration
operation.
- The fluent builder is configurable:
identifier(impl Into<String>)
/set_identifier(Option<String>)
:Resource identifier to opt in for event messaging.
identifier_type(IdentifierType)
/set_identifier_type(Option<IdentifierType>)
:Identifier type of the particular resource identifier for event configuration.
partner_type(EventNotificationPartnerType)
/set_partner_type(Option<EventNotificationPartnerType>)
:Partner type of the resource if the identifier type is PartnerAccountId
device_registration_state(DeviceRegistrationStateEventConfiguration)
/set_device_registration_state(Option<DeviceRegistrationStateEventConfiguration>)
:Event configuration for the device registration state event
proximity(ProximityEventConfiguration)
/set_proximity(Option<ProximityEventConfiguration>)
:Event configuration for the Proximity event
- On success, responds with
UpdateResourceEventConfigurationOutput
- On failure, responds with
SdkError<UpdateResourceEventConfigurationError>
Constructs a fluent builder for the UpdateWirelessDevice
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
destination_name(impl Into<String>)
/set_destination_name(Option<String>)
:The name of the new destination for the device.
name(impl Into<String>)
/set_name(Option<String>)
:The new name of the resource.
description(impl Into<String>)
/set_description(Option<String>)
:A new description of the resource.
lo_ra_wan(LoRaWanUpdateDevice)
/set_lo_ra_wan(Option<LoRaWanUpdateDevice>)
:The updated wireless device’s configuration.
- On success, responds with
UpdateWirelessDeviceOutput
- On failure, responds with
SdkError<UpdateWirelessDeviceError>
Constructs a fluent builder for the UpdateWirelessGateway
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the resource to update.
name(impl Into<String>)
/set_name(Option<String>)
:The new name of the resource.
description(impl Into<String>)
/set_description(Option<String>)
:A new description of the resource.
join_eui_filters(Vec<Vec<String>>)
/set_join_eui_filters(Option<Vec<Vec<String>>>)
:A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
net_id_filters(Vec<String>)
/set_net_id_filters(Option<Vec<String>>)
:A list of NetId values that are used by LoRa gateways to filter the uplink frames.
- On success, responds with
UpdateWirelessGatewayOutput
- On failure, responds with
SdkError<UpdateWirelessGatewayError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more