Struct aws_sdk_iotwireless::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_iotwireless::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_iotwireless::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateAwsAccountWithPartnerAccount operation has a Client::associate_aws_account_with_partner_account, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_aws_account_with_partner_account()
    .client_request_token("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_aws_account_with_partner_account( &self ) -> AssociateAwsAccountWithPartnerAccountFluentBuilder

Constructs a fluent builder for the AssociateAwsAccountWithPartnerAccount operation.

• The fluent builder is configurable:
  • sidewalk(SidewalkAccountInfo) / set_sidewalk(Option<SidewalkAccountInfo>):
    required: true
    

    The Sidewalk account credentials.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>

impl Client

pub fn associate_multicast_group_with_fuota_task( &self ) -> AssociateMulticastGroupWithFuotaTaskFluentBuilder

Constructs a fluent builder for the AssociateMulticastGroupWithFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a FUOTA task.

    
    
  • multicast_group_id(impl Into<String>) / set_multicast_group_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
• On success, responds with AssociateMulticastGroupWithFuotaTaskOutput
• On failure, responds with SdkError<AssociateMulticastGroupWithFuotaTaskError>

impl Client

pub fn associate_wireless_device_with_fuota_task( &self ) -> AssociateWirelessDeviceWithFuotaTaskFluentBuilder

Constructs a fluent builder for the AssociateWirelessDeviceWithFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a FUOTA task.

    
    
  • wireless_device_id(impl Into<String>) / set_wireless_device_id(Option<String>):
    required: true
    

    The ID of the wireless device.

    
    
• On success, responds with AssociateWirelessDeviceWithFuotaTaskOutput
• On failure, responds with SdkError<AssociateWirelessDeviceWithFuotaTaskError>

impl Client

pub fn associate_wireless_device_with_multicast_group( &self ) -> AssociateWirelessDeviceWithMulticastGroupFluentBuilder

Constructs a fluent builder for the AssociateWirelessDeviceWithMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
  • wireless_device_id(impl Into<String>) / set_wireless_device_id(Option<String>):
    required: true
    

    The ID of the wireless device.

    
    
• On success, responds with AssociateWirelessDeviceWithMulticastGroupOutput
• On failure, responds with SdkError<AssociateWirelessDeviceWithMulticastGroupError>

impl Client

pub fn associate_wireless_device_with_thing( &self ) -> AssociateWirelessDeviceWithThingFluentBuilder

Constructs a fluent builder for the AssociateWirelessDeviceWithThing operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
  • thing_arn(impl Into<String>) / set_thing_arn(Option<String>):
    required: true
    

    The ARN of the thing to associate with the wireless device.

    
    
• On success, responds with AssociateWirelessDeviceWithThingOutput
• On failure, responds with SdkError<AssociateWirelessDeviceWithThingError>

impl Client

pub fn associate_wireless_gateway_with_certificate( &self ) -> AssociateWirelessGatewayWithCertificateFluentBuilder

Constructs a fluent builder for the AssociateWirelessGatewayWithCertificate operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
  • iot_certificate_id(impl Into<String>) / set_iot_certificate_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn associate_wireless_gateway_with_thing( &self ) -> AssociateWirelessGatewayWithThingFluentBuilder

Constructs a fluent builder for the AssociateWirelessGatewayWithThing operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
  • thing_arn(impl Into<String>) / set_thing_arn(Option<String>):
    required: true
    

    The ARN of the thing to associate with the wireless gateway.

    
    
• On success, responds with AssociateWirelessGatewayWithThingOutput
• On failure, responds with SdkError<AssociateWirelessGatewayWithThingError>

impl Client

pub fn cancel_multicast_group_session( &self ) -> CancelMulticastGroupSessionFluentBuilder

Constructs a fluent builder for the CancelMulticastGroupSession operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
• On success, responds with CancelMulticastGroupSessionOutput
• On failure, responds with SdkError<CancelMulticastGroupSessionError>

impl Client

pub fn create_destination(&self) -> CreateDestinationFluentBuilder

Constructs a fluent builder for the CreateDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the new resource.

    
    
  • expression_type(ExpressionType) / set_expression_type(Option<ExpressionType>):
    required: true
    

    The type of value in Expression.

    
    
  • expression(impl Into<String>) / set_expression(Option<String>):
    required: true
    

    The rule name or topic rule to send messages to.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM Role that authorizes the destination.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

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

impl Client

pub fn create_device_profile(&self) -> CreateDeviceProfileFluentBuilder

Constructs a fluent builder for the CreateDeviceProfile operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the new resource.

    
    
  • lo_ra_wan(LoRaWanDeviceProfile) / set_lo_ra_wan(Option<LoRaWanDeviceProfile>):
    required: false
    

    The device profile information to use to create the device profile.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • sidewalk(SidewalkCreateDeviceProfile) / set_sidewalk(Option<SidewalkCreateDeviceProfile>):
    required: false
    

    The Sidewalk-related information for creating the Sidewalk device profile.

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

impl Client

pub fn create_fuota_task(&self) -> CreateFuotaTaskFluentBuilder

Constructs a fluent builder for the CreateFuotaTask operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of a FUOTA task.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • lo_ra_wan(LoRaWanFuotaTask) / set_lo_ra_wan(Option<LoRaWanFuotaTask>):
    required: false
    

    The LoRaWAN information used with a FUOTA task.

    
    
  • firmware_update_image(impl Into<String>) / set_firmware_update_image(Option<String>):
    required: true
    

    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>):
    required: true
    

    The firmware update role that is to be used with a FUOTA task.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

    
    
  • redundancy_percent(i32) / set_redundancy_percent(Option<i32>):
    required: false
    

    The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

    
    
  • fragment_size_bytes(i32) / set_fragment_size_bytes(Option<i32>):
    required: false
    

    The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

    
    
  • fragment_interval_ms(i32) / set_fragment_interval_ms(Option<i32>):
    required: false
    

    The interval for sending fragments in milliseconds, rounded to the nearest second.

    This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device’s class and the communication delay with the cloud.

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

impl Client

pub fn create_multicast_group(&self) -> CreateMulticastGroupFluentBuilder

Constructs a fluent builder for the CreateMulticastGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the multicast group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the multicast group.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • lo_ra_wan(LoRaWanMulticast) / set_lo_ra_wan(Option<LoRaWanMulticast>):
    required: true
    

    The LoRaWAN information that is to be used with the multicast group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>

impl Client

pub fn create_network_analyzer_configuration( &self ) -> CreateNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the CreateNetworkAnalyzerConfiguration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of the network analyzer configuration.

    
    
  • trace_content(TraceContent) / set_trace_content(Option<TraceContent>):
    required: false
    

    Trace content for your wireless devices, gateways, and multicast groups.

    
    
  • wireless_devices(impl Into<String>) / set_wireless_devices(Option<Vec::<String>>):
    required: false
    

    Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

    
    
  • wireless_gateways(impl Into<String>) / set_wireless_gateways(Option<Vec::<String>>):
    required: false
    

    Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • multicast_groups(impl Into<String>) / set_multicast_groups(Option<Vec::<String>>):
    required: false
    

    Multicast Group resources to add to the network analyzer configruation. Provide the MulticastGroupId of the resource to add in the input array.

    
    
• On success, responds with CreateNetworkAnalyzerConfigurationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name of the new resource.

  • name(Option<String>):

    Name of the network analyzer configuration.

• On failure, responds with SdkError<CreateNetworkAnalyzerConfigurationError>

impl Client

pub fn create_service_profile(&self) -> CreateServiceProfileFluentBuilder

Constructs a fluent builder for the CreateServiceProfile operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the new resource.

    
    
  • lo_ra_wan(LoRaWanServiceProfile) / set_lo_ra_wan(Option<LoRaWanServiceProfile>):
    required: false
    

    The service profile information to use to create the service profile.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

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

impl Client

pub fn create_wireless_device(&self) -> CreateWirelessDeviceFluentBuilder

Constructs a fluent builder for the CreateWirelessDevice operation.

• The fluent builder is configurable:
  • r#type(WirelessDeviceType) / set_type(Option<WirelessDeviceType>):
    required: true
    

    The wireless device type.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the new resource.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • destination_name(impl Into<String>) / set_destination_name(Option<String>):
    required: true
    

    The name of the destination to assign to the new wireless device.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • lo_ra_wan(LoRaWanDevice) / set_lo_ra_wan(Option<LoRaWanDevice>):
    required: false
    

    The device configuration information to use to create the wireless device.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.

    
    
  • positioning(PositioningConfigStatus) / set_positioning(Option<PositioningConfigStatus>):
    required: false
    

    FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

    
    
  • sidewalk(SidewalkCreateWirelessDevice) / set_sidewalk(Option<SidewalkCreateWirelessDevice>):
    required: false
    

    The device configuration information to use to create the Sidewalk device.

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

impl Client

pub fn create_wireless_gateway(&self) -> CreateWirelessGatewayFluentBuilder

Constructs a fluent builder for the CreateWirelessGateway operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the new resource.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • lo_ra_wan(LoRaWanGateway) / set_lo_ra_wan(Option<LoRaWanGateway>):
    required: true
    

    The gateway configuration information to use to create the wireless gateway.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

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

impl Client

pub fn create_wireless_gateway_task( &self ) -> CreateWirelessGatewayTaskFluentBuilder

Constructs a fluent builder for the CreateWirelessGatewayTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
  • wireless_gateway_task_definition_id(impl Into<String>) / set_wireless_gateway_task_definition_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn create_wireless_gateway_task_definition( &self ) -> CreateWirelessGatewayTaskDefinitionFluentBuilder

Constructs a fluent builder for the CreateWirelessGatewayTaskDefinition operation.

• The fluent builder is configurable:
  • auto_create_tasks(bool) / set_auto_create_tasks(Option<bool>):
    required: true
    

    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 calling CreateWirelessGatewayTask.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the new resource.

    
    
  • update(UpdateWirelessGatewayTaskCreate) / set_update(Option<UpdateWirelessGatewayTaskCreate>):
    required: false
    

    Information about the gateways to update.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>

impl Client

pub fn delete_destination(&self) -> DeleteDestinationFluentBuilder

Constructs a fluent builder for the DeleteDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the resource to delete.

    
    
• On success, responds with DeleteDestinationOutput
• On failure, responds with SdkError<DeleteDestinationError>

impl Client

pub fn delete_device_profile(&self) -> DeleteDeviceProfileFluentBuilder

Constructs a fluent builder for the DeleteDeviceProfile operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to delete.

    
    
• On success, responds with DeleteDeviceProfileOutput
• On failure, responds with SdkError<DeleteDeviceProfileError>

impl Client

pub fn delete_fuota_task(&self) -> DeleteFuotaTaskFluentBuilder

Constructs a fluent builder for the DeleteFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a FUOTA task.

    
    
• On success, responds with DeleteFuotaTaskOutput
• On failure, responds with SdkError<DeleteFuotaTaskError>

impl Client

pub fn delete_multicast_group(&self) -> DeleteMulticastGroupFluentBuilder

Constructs a fluent builder for the DeleteMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
• On success, responds with DeleteMulticastGroupOutput
• On failure, responds with SdkError<DeleteMulticastGroupError>

impl Client

pub fn delete_network_analyzer_configuration( &self ) -> DeleteNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the DeleteNetworkAnalyzerConfiguration operation.

• The fluent builder is configurable:
  • configuration_name(impl Into<String>) / set_configuration_name(Option<String>):
    required: true
    

    Name of the network analyzer configuration.

    
    
• On success, responds with DeleteNetworkAnalyzerConfigurationOutput
• On failure, responds with SdkError<DeleteNetworkAnalyzerConfigurationError>

impl Client

pub fn delete_queued_messages(&self) -> DeleteQueuedMessagesFluentBuilder

Constructs a fluent builder for the DeleteQueuedMessages operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a given wireless device for which downlink messages will be deleted.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    If message ID is “*”, it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.

    
    
  • wireless_device_type(WirelessDeviceType) / set_wireless_device_type(Option<WirelessDeviceType>):
    required: false
    

    The wireless device type, which can be either Sidewalk or LoRaWAN.

    
    
• On success, responds with DeleteQueuedMessagesOutput
• On failure, responds with SdkError<DeleteQueuedMessagesError>

impl Client

pub fn delete_service_profile(&self) -> DeleteServiceProfileFluentBuilder

Constructs a fluent builder for the DeleteServiceProfile operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to delete.

    
    
• On success, responds with DeleteServiceProfileOutput
• On failure, responds with SdkError<DeleteServiceProfileError>

impl Client

pub fn delete_wireless_device(&self) -> DeleteWirelessDeviceFluentBuilder

Constructs a fluent builder for the DeleteWirelessDevice operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to delete.

    
    
• On success, responds with DeleteWirelessDeviceOutput
• On failure, responds with SdkError<DeleteWirelessDeviceError>

impl Client

pub fn delete_wireless_device_import_task( &self ) -> DeleteWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the DeleteWirelessDeviceImportTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of the import task to be deleted.

    
    
• On success, responds with DeleteWirelessDeviceImportTaskOutput
• On failure, responds with SdkError<DeleteWirelessDeviceImportTaskError>

impl Client

pub fn delete_wireless_gateway(&self) -> DeleteWirelessGatewayFluentBuilder

Constructs a fluent builder for the DeleteWirelessGateway operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to delete.

    
    
• On success, responds with DeleteWirelessGatewayOutput
• On failure, responds with SdkError<DeleteWirelessGatewayError>

impl Client

pub fn delete_wireless_gateway_task( &self ) -> DeleteWirelessGatewayTaskFluentBuilder

Constructs a fluent builder for the DeleteWirelessGatewayTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to delete.

    
    
• On success, responds with DeleteWirelessGatewayTaskOutput
• On failure, responds with SdkError<DeleteWirelessGatewayTaskError>

impl Client

pub fn delete_wireless_gateway_task_definition( &self ) -> DeleteWirelessGatewayTaskDefinitionFluentBuilder

Constructs a fluent builder for the DeleteWirelessGatewayTaskDefinition operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to delete.

    
    
• On success, responds with DeleteWirelessGatewayTaskDefinitionOutput
• On failure, responds with SdkError<DeleteWirelessGatewayTaskDefinitionError>

impl Client

pub fn deregister_wireless_device( &self ) -> DeregisterWirelessDeviceFluentBuilder

Constructs a fluent builder for the DeregisterWirelessDevice operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The identifier of the wireless device to deregister from AWS IoT Wireless.

    
    
  • wireless_device_type(WirelessDeviceType) / set_wireless_device_type(Option<WirelessDeviceType>):
    required: false
    

    The type of wireless device to deregister from AWS IoT Wireless, which can be LoRaWAN or Sidewalk.

    
    
• On success, responds with DeregisterWirelessDeviceOutput
• On failure, responds with SdkError<DeregisterWirelessDeviceError>

impl Client

pub fn disassociate_aws_account_from_partner_account( &self ) -> DisassociateAwsAccountFromPartnerAccountFluentBuilder

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>):
    required: true
    

    The partner account ID to disassociate from the AWS account.

    
    
  • partner_type(PartnerType) / set_partner_type(Option<PartnerType>):
    required: true
    

    The partner type.

    
    
• On success, responds with DisassociateAwsAccountFromPartnerAccountOutput
• On failure, responds with SdkError<DisassociateAwsAccountFromPartnerAccountError>

impl Client

pub fn disassociate_multicast_group_from_fuota_task( &self ) -> DisassociateMulticastGroupFromFuotaTaskFluentBuilder

Constructs a fluent builder for the DisassociateMulticastGroupFromFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a FUOTA task.

    
    
  • multicast_group_id(impl Into<String>) / set_multicast_group_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
• On success, responds with DisassociateMulticastGroupFromFuotaTaskOutput
• On failure, responds with SdkError<DisassociateMulticastGroupFromFuotaTaskError>

impl Client

pub fn disassociate_wireless_device_from_fuota_task( &self ) -> DisassociateWirelessDeviceFromFuotaTaskFluentBuilder

Constructs a fluent builder for the DisassociateWirelessDeviceFromFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a FUOTA task.

    
    
  • wireless_device_id(impl Into<String>) / set_wireless_device_id(Option<String>):
    required: true
    

    The ID of the wireless device.

    
    
• On success, responds with DisassociateWirelessDeviceFromFuotaTaskOutput
• On failure, responds with SdkError<DisassociateWirelessDeviceFromFuotaTaskError>

impl Client

pub fn disassociate_wireless_device_from_multicast_group( &self ) -> DisassociateWirelessDeviceFromMulticastGroupFluentBuilder

Constructs a fluent builder for the DisassociateWirelessDeviceFromMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
  • wireless_device_id(impl Into<String>) / set_wireless_device_id(Option<String>):
    required: true
    

    The ID of the wireless device.

    
    
• On success, responds with DisassociateWirelessDeviceFromMulticastGroupOutput
• On failure, responds with SdkError<DisassociateWirelessDeviceFromMulticastGroupError>

impl Client

pub fn disassociate_wireless_device_from_thing( &self ) -> DisassociateWirelessDeviceFromThingFluentBuilder

Constructs a fluent builder for the DisassociateWirelessDeviceFromThing operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
• On success, responds with DisassociateWirelessDeviceFromThingOutput
• On failure, responds with SdkError<DisassociateWirelessDeviceFromThingError>

impl Client

pub fn disassociate_wireless_gateway_from_certificate( &self ) -> DisassociateWirelessGatewayFromCertificateFluentBuilder

Constructs a fluent builder for the DisassociateWirelessGatewayFromCertificate operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
• On success, responds with DisassociateWirelessGatewayFromCertificateOutput
• On failure, responds with SdkError<DisassociateWirelessGatewayFromCertificateError>

impl Client

pub fn disassociate_wireless_gateway_from_thing( &self ) -> DisassociateWirelessGatewayFromThingFluentBuilder

Constructs a fluent builder for the DisassociateWirelessGatewayFromThing operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
• On success, responds with DisassociateWirelessGatewayFromThingOutput
• On failure, responds with SdkError<DisassociateWirelessGatewayFromThingError>

impl Client

pub fn get_destination(&self) -> GetDestinationFluentBuilder

Constructs a fluent builder for the GetDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn get_device_profile(&self) -> GetDeviceProfileFluentBuilder

Constructs a fluent builder for the GetDeviceProfile operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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.

  • sidewalk(Option<SidewalkGetDeviceProfile>):

    Information about the Sidewalk parameters in the device profile.

• On failure, responds with SdkError<GetDeviceProfileError>

impl Client

pub fn get_event_configuration_by_resource_types( &self ) -> GetEventConfigurationByResourceTypesFluentBuilder

Constructs a fluent builder for the GetEventConfigurationByResourceTypes operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetEventConfigurationByResourceTypesOutput with field(s):
  • device_registration_state(Option<DeviceRegistrationStateResourceTypeEventConfiguration>):

    Resource type event configuration for the device registration state event.

  • proximity(Option<ProximityResourceTypeEventConfiguration>):

    Resource type event configuration for the proximity event.

  • join(Option<JoinResourceTypeEventConfiguration>):

    Resource type event configuration for the join event.

  • connection_status(Option<ConnectionStatusResourceTypeEventConfiguration>):

    Resource type event configuration for the connection status event.

  • message_delivery_status(Option<MessageDeliveryStatusResourceTypeEventConfiguration>):

    Resource type event configuration object for the message delivery status event.

• On failure, responds with SdkError<GetEventConfigurationByResourceTypesError>

impl Client

pub fn get_fuota_task(&self) -> GetFuotaTaskFluentBuilder

Constructs a fluent builder for the GetFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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.

  • redundancy_percent(Option<i32>):

    The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

  • fragment_size_bytes(Option<i32>):

    The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

  • fragment_interval_ms(Option<i32>):

    The interval for sending fragments in milliseconds, rounded to the nearest second.

    This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device’s class and the communication delay with the cloud.

• On failure, responds with SdkError<GetFuotaTaskError>

impl Client

pub fn get_log_levels_by_resource_types( &self ) -> GetLogLevelsByResourceTypesFluentBuilder

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. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

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

impl Client

pub fn get_metric_configuration(&self) -> GetMetricConfigurationFluentBuilder

Constructs a fluent builder for the GetMetricConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetMetricConfigurationOutput with field(s):
  • summary_metric(Option<SummaryMetricConfiguration>):

    The configuration status of the AWS account for summary metric aggregation.

• On failure, responds with SdkError<GetMetricConfigurationError>

impl Client

pub fn get_metrics(&self) -> GetMetricsFluentBuilder

Constructs a fluent builder for the GetMetrics operation.

• The fluent builder is configurable:
  • summary_metric_queries(SummaryMetricQuery) / set_summary_metric_queries(Option<Vec::<SummaryMetricQuery>>):
    required: false
    

    The list of queries to retrieve the summary metrics.

    
    
• On success, responds with GetMetricsOutput with field(s):
  • summary_metric_query_results(Option<Vec::<SummaryMetricQueryResult>>):

    The list of summary metrics that were retrieved.

• On failure, responds with SdkError<GetMetricsError>

impl Client

pub fn get_multicast_group(&self) -> GetMulticastGroupFluentBuilder

Constructs a fluent builder for the GetMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn get_multicast_group_session( &self ) -> GetMulticastGroupSessionFluentBuilder

Constructs a fluent builder for the GetMulticastGroupSession operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn get_network_analyzer_configuration( &self ) -> GetNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the GetNetworkAnalyzerConfiguration operation.

• The fluent builder is configurable:
  • configuration_name(impl Into<String>) / set_configuration_name(Option<String>):
    required: true
    

    Name of the network analyzer configuration.

    
    
• On success, responds with GetNetworkAnalyzerConfigurationOutput with field(s):
  • trace_content(Option<TraceContent>):

    Trace content for your wireless devices, gateways, and multicast groups.

  • wireless_devices(Option<Vec::<String>>):

    List of wireless device resources that have been added to the network analyzer configuration.

  • wireless_gateways(Option<Vec::<String>>):

    List of wireless gateway resources that have been added to the network analyzer configuration.

  • description(Option<String>):

    The description of the new resource.

  • arn(Option<String>):

    The Amazon Resource Name of the new resource.

  • name(Option<String>):

    Name of the network analyzer configuration.

  • multicast_groups(Option<Vec::<String>>):

    List of multicast group resources that have been added to the network analyzer configuration.

• On failure, responds with SdkError<GetNetworkAnalyzerConfigurationError>

impl Client

pub fn get_partner_account(&self) -> GetPartnerAccountFluentBuilder

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>):
    required: true
    

    The partner account ID to disassociate from the AWS account.

    
    
  • partner_type(PartnerType) / set_partner_type(Option<PartnerType>):
    required: true
    

    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>

impl Client

pub fn get_position(&self) -> GetPositionFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the GetPosition operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    Resource identifier used to retrieve the position information.

    
    
  • resource_type(PositionResourceType) / set_resource_type(Option<PositionResourceType>):
    required: true
    

    Resource type of the resource for which position information is retrieved.

    
    
• On success, responds with GetPositionOutput with field(s):
  • position(Option<Vec::<f32>>):

    The position information of the resource.

  • accuracy(Option<Accuracy>):

    The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

  • solver_type(Option<PositionSolverType>):

    The type of solver used to identify the position of the resource.

  • solver_provider(Option<PositionSolverProvider>):

    The vendor of the positioning solver.

  • solver_version(Option<String>):

    The version of the positioning solver.

  • timestamp(Option<String>):

    The timestamp at which the device’s position was determined.

• On failure, responds with SdkError<GetPositionError>

impl Client

pub fn get_position_configuration( &self ) -> GetPositionConfigurationFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the GetPositionConfiguration operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    Resource identifier used in a position configuration.

    
    
  • resource_type(PositionResourceType) / set_resource_type(Option<PositionResourceType>):
    required: true
    

    Resource type of the resource for which position configuration is retrieved.

    
    
• On success, responds with GetPositionConfigurationOutput with field(s):
  • solvers(Option<PositionSolverDetails>):

    The wrapper for the solver configuration details object.

  • destination(Option<String>):

    The position data destination that describes the AWS IoT rule that processes the device’s position data for use by AWS IoT Core for LoRaWAN.

• On failure, responds with SdkError<GetPositionConfigurationError>

impl Client

pub fn get_position_estimate(&self) -> GetPositionEstimateFluentBuilder

Constructs a fluent builder for the GetPositionEstimate operation.

• The fluent builder is configurable:
  • wi_fi_access_points(WiFiAccessPoint) / set_wi_fi_access_points(Option<Vec::<WiFiAccessPoint>>):
    required: false
    

    Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE’s Wi-Fi based solver.

    
    
  • cell_towers(CellTowers) / set_cell_towers(Option<CellTowers>):
    required: false
    

    Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE’s cellular-based solver.

    
    
  • ip(Ip) / set_ip(Option<Ip>):
    required: false
    

    Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind’s IP-based solver.

    
    
  • gnss(Gnss) / set_gnss(Option<Gnss>):
    required: false
    

    Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.

    
    
  • timestamp(DateTime) / set_timestamp(Option<DateTime>):
    required: false
    

    Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.

    
    
• On success, responds with GetPositionEstimateOutput with field(s):
  • geo_json_payload(Option<Blob>):

    The position information of the resource, displayed as a JSON payload. The payload is of type blob and uses the GeoJSON format, which a format that’s used to encode geographic data structures. A sample payload contains the timestamp information, the WGS84 coordinates of the location, and the accuracy and confidence level. For more information and examples, see Resolve device location (console).

• On failure, responds with SdkError<GetPositionEstimateError>

impl Client

pub fn get_resource_event_configuration( &self ) -> GetResourceEventConfigurationFluentBuilder

Constructs a fluent builder for the GetResourceEventConfiguration operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    Resource identifier to opt in for event messaging.

    
    
  • identifier_type(IdentifierType) / set_identifier_type(Option<IdentifierType>):
    required: true
    

    Identifier type of the particular resource identifier for event configuration.

    
    
  • partner_type(EventNotificationPartnerType) / set_partner_type(Option<EventNotificationPartnerType>):
    required: false
    

    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.

  • join(Option<JoinEventConfiguration>):

    Event configuration for the join event.

  • connection_status(Option<ConnectionStatusEventConfiguration>):

    Event configuration for the connection status event.

  • message_delivery_status(Option<MessageDeliveryStatusEventConfiguration>):

    Event configuration for the message delivery status event.

• On failure, responds with SdkError<GetResourceEventConfigurationError>

impl Client

pub fn get_resource_log_level(&self) -> GetResourceLogLevelFluentBuilder

Constructs a fluent builder for the GetResourceLogLevel operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    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>):
    required: true
    

    The type of the resource, which can be WirelessDevice or WirelessGateway.

    
    
• On success, responds with GetResourceLogLevelOutput with field(s):
  • log_level(Option<LogLevel>):

    The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

• On failure, responds with SdkError<GetResourceLogLevelError>

impl Client

pub fn get_resource_position(&self) -> GetResourcePositionFluentBuilder

Constructs a fluent builder for the GetResourcePosition operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    The identifier of the resource for which position information is retrieved. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

    
    
  • resource_type(PositionResourceType) / set_resource_type(Option<PositionResourceType>):
    required: true
    

    The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.

    
    
• On success, responds with GetResourcePositionOutput with field(s):
  • geo_json_payload(Option<Blob>):

    The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that’s used to encode geographic data structures. For more information, see GeoJSON.

• On failure, responds with SdkError<GetResourcePositionError>

impl Client

pub fn get_service_endpoint(&self) -> GetServiceEndpointFluentBuilder

Constructs a fluent builder for the GetServiceEndpoint operation.

• The fluent builder is configurable:
  • service_type(WirelessGatewayServiceType) / set_service_type(Option<WirelessGatewayServiceType>):
    required: false
    

    The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or CLAIM for the global 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>

impl Client

pub fn get_service_profile(&self) -> GetServiceProfileFluentBuilder

Constructs a fluent builder for the GetServiceProfile operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn get_wireless_device(&self) -> GetWirelessDeviceFluentBuilder

Constructs a fluent builder for the GetWirelessDevice operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The identifier of the wireless device to get.

    
    
  • identifier_type(WirelessDeviceIdType) / set_identifier_type(Option<WirelessDeviceIdType>):
    required: true
    

    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.

  • positioning(Option<PositioningConfigStatus>):

    FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

• On failure, responds with SdkError<GetWirelessDeviceError>

impl Client

pub fn get_wireless_device_import_task( &self ) -> GetWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the GetWirelessDeviceImportTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the import task for which information is requested.

    
    
• On success, responds with GetWirelessDeviceImportTaskOutput with field(s):
  • id(Option<String>):

    The identifier of the import task for which information is retrieved.

  • arn(Option<String>):

    The ARN (Amazon Resource Name) of the import task.

  • destination_name(Option<String>):

    The name of the destination that’s assigned to the wireless devices in the import task.

  • sidewalk(Option<SidewalkGetStartImportInfo>):

    The Sidewalk-related information about an import task.

  • creation_time(Option<DateTime>):

    The time at which the import task was created.

  • status(Option<ImportTaskStatus>):

    The import task status.

  • status_reason(Option<String>):

    The reason for the provided status information, such as a validation error that causes the import task to fail.

  • initialized_imported_device_count(Option<i64>):

    The number of devices in the import task that are waiting for the control log to start processing.

  • pending_imported_device_count(Option<i64>):

    The number of devices in the import task that are waiting in the import task queue to be onboarded.

  • onboarded_imported_device_count(Option<i64>):

    The number of devices in the import task that have been onboarded to the import task.

  • failed_imported_device_count(Option<i64>):

    The number of devices in the import task that failed to onboard to the import task.

• On failure, responds with SdkError<GetWirelessDeviceImportTaskError>

impl Client

pub fn get_wireless_device_statistics( &self ) -> GetWirelessDeviceStatisticsFluentBuilder

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>):
    required: true
    

    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.

    This value is only valid for 3 months.

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

impl Client

pub fn get_wireless_gateway(&self) -> GetWirelessGatewayFluentBuilder

Constructs a fluent builder for the GetWirelessGateway operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The identifier of the wireless gateway to get.

    
    
  • identifier_type(WirelessGatewayIdType) / set_identifier_type(Option<WirelessGatewayIdType>):
    required: true
    

    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>

impl Client

pub fn get_wireless_gateway_certificate( &self ) -> GetWirelessGatewayCertificateFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayCertificate operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn get_wireless_gateway_firmware_information( &self ) -> GetWirelessGatewayFirmwareInformationFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayFirmwareInformation operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn get_wireless_gateway_statistics( &self ) -> GetWirelessGatewayStatisticsFluentBuilder

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>):
    required: true
    

    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.

    This value is only valid for 3 months.

  • connection_status(Option<ConnectionStatus>):

    The connection status of the wireless gateway.

• On failure, responds with SdkError<GetWirelessGatewayStatisticsError>

impl Client

pub fn get_wireless_gateway_task(&self) -> GetWirelessGatewayTaskFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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.

    This value is only valid for 3 months.

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

impl Client

pub fn get_wireless_gateway_task_definition( &self ) -> GetWirelessGatewayTaskDefinitionFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayTaskDefinition operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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 calling CreateWirelessGatewayTask.

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

impl Client

pub fn list_destinations(&self) -> ListDestinationsFluentBuilder

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(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_device_profiles(&self) -> ListDeviceProfilesFluentBuilder

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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • device_profile_type(DeviceProfileType) / set_device_profile_type(Option<DeviceProfileType>):
    required: false
    

    A filter to list only device profiles that use this type, which can be LoRaWAN or Sidewalk.

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

impl Client

pub fn list_devices_for_wireless_device_import_task( &self ) -> ListDevicesForWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the ListDevicesForWirelessDeviceImportTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the import task for which wireless devices are listed.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • status(OnboardStatus) / set_status(Option<OnboardStatus>):
    required: false
    

    The status of the devices in the import task.

    
    
• On success, responds with ListDevicesForWirelessDeviceImportTaskOutput 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_name(Option<String>):

    The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.

  • imported_wireless_device_list(Option<Vec::<ImportedWirelessDevice>>):

    List of wireless devices in an import task and their onboarding status.

• On failure, responds with SdkError<ListDevicesForWirelessDeviceImportTaskError>

impl Client

pub fn list_event_configurations(&self) -> ListEventConfigurationsFluentBuilder

Constructs a fluent builder for the ListEventConfigurations operation.

• The fluent builder is configurable:
  • resource_type(EventNotificationResourceType) / set_resource_type(Option<EventNotificationResourceType>):
    required: true
    

    Resource type to filter event configurations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

  • event_configurations_list(Option<Vec::<EventConfigurationItem>>):

    Event configurations of all events for a single resource.

• On failure, responds with SdkError<ListEventConfigurationsError>

impl Client

pub fn list_fuota_tasks(&self) -> ListFuotaTasksFluentBuilder

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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_multicast_groups(&self) -> ListMulticastGroupsFluentBuilder

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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_multicast_groups_by_fuota_task( &self ) -> ListMulticastGroupsByFuotaTaskFluentBuilder

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>):
    required: true
    

    The ID of a FUOTA task.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_network_analyzer_configurations( &self ) -> ListNetworkAnalyzerConfigurationsFluentBuilder

Constructs a fluent builder for the ListNetworkAnalyzerConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

  • network_analyzer_configuration_list(Option<Vec::<NetworkAnalyzerConfigurations>>):

    The list of network analyzer configurations.

• On failure, responds with SdkError<ListNetworkAnalyzerConfigurationsError>

impl Client

pub fn list_partner_accounts(&self) -> ListPartnerAccountsFluentBuilder

Constructs a fluent builder for the ListPartnerAccounts operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_position_configurations( &self ) -> ListPositionConfigurationsFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the ListPositionConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_type(PositionResourceType) / set_resource_type(Option<PositionResourceType>):
    required: false
    

    Resource type for which position configurations are listed.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 ListPositionConfigurationsOutput with field(s):
  • position_configuration_list(Option<Vec::<PositionConfigurationItem>>):

    A list of position configurations.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListPositionConfigurationsError>

impl Client

pub fn list_queued_messages(&self) -> ListQueuedMessagesFluentBuilder

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>):
    required: true
    

    The ID of a given wireless device which the downlink message packets are being sent.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • wireless_device_type(WirelessDeviceType) / set_wireless_device_type(Option<WirelessDeviceType>):
    required: false
    

    The wireless device type, whic can be 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 the downlink queue.

• On failure, responds with SdkError<ListQueuedMessagesError>

impl Client

pub fn list_service_profiles(&self) -> ListServiceProfilesFluentBuilder

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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>

impl Client

pub fn list_wireless_device_import_tasks( &self ) -> ListWirelessDeviceImportTasksFluentBuilder

Constructs a fluent builder for the ListWirelessDeviceImportTasks operation.

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 ListWirelessDeviceImportTasksOutput 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_import_task_list(Option<Vec::<WirelessDeviceImportTask>>):

    List of import tasks and summary information of onboarding status of devices in each import task.

• On failure, responds with SdkError<ListWirelessDeviceImportTasksError>

impl Client

pub fn list_wireless_devices(&self) -> ListWirelessDevicesFluentBuilder

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(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>):
    required: false
    

    A filter to list only the wireless devices that use this destination.

    
    
  • device_profile_id(impl Into<String>) / set_device_profile_id(Option<String>):
    required: false
    

    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>):
    required: false
    

    A filter to list only the wireless devices that use this service profile.

    
    
  • wireless_device_type(WirelessDeviceType) / set_wireless_device_type(Option<WirelessDeviceType>):
    required: false
    

    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>):
    required: false
    

    The ID of a FUOTA task.

    
    
  • multicast_group_id(impl Into<String>) / set_multicast_group_id(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_wireless_gateway_task_definitions( &self ) -> ListWirelessGatewayTaskDefinitionsFluentBuilder

Constructs a fluent builder for the ListWirelessGatewayTaskDefinitions operation.

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn list_wireless_gateways(&self) -> ListWirelessGatewaysFluentBuilder

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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn put_position_configuration( &self ) -> PutPositionConfigurationFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the PutPositionConfiguration operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    Resource identifier used to update the position configuration.

    
    
  • resource_type(PositionResourceType) / set_resource_type(Option<PositionResourceType>):
    required: true
    

    Resource type of the resource for which you want to update the position configuration.

    
    
  • solvers(PositionSolverConfigurations) / set_solvers(Option<PositionSolverConfigurations>):
    required: false
    

    The positioning solvers used to update the position configuration of the resource.

    
    
  • destination(impl Into<String>) / set_destination(Option<String>):
    required: false
    

    The position data destination that describes the AWS IoT rule that processes the device’s position data for use by AWS IoT Core for LoRaWAN.

    
    
• On success, responds with PutPositionConfigurationOutput
• On failure, responds with SdkError<PutPositionConfigurationError>

impl Client

pub fn put_resource_log_level(&self) -> PutResourceLogLevelFluentBuilder

Constructs a fluent builder for the PutResourceLogLevel operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    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>):
    required: true
    

    The type of the resource, which can be WirelessDevice or WirelessGateway.

    
    
  • log_level(LogLevel) / set_log_level(Option<LogLevel>):
    required: true
    

    The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

    
    
• On success, responds with PutResourceLogLevelOutput
• On failure, responds with SdkError<PutResourceLogLevelError>

impl Client

pub fn reset_all_resource_log_levels( &self ) -> ResetAllResourceLogLevelsFluentBuilder

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>

impl Client

pub fn reset_resource_log_level(&self) -> ResetResourceLogLevelFluentBuilder

Constructs a fluent builder for the ResetResourceLogLevel operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    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>):
    required: true
    

    The type of the resource, which can be WirelessDevice or WirelessGateway.

    
    
• On success, responds with ResetResourceLogLevelOutput
• On failure, responds with SdkError<ResetResourceLogLevelError>

impl Client

pub fn send_data_to_multicast_group( &self ) -> SendDataToMulticastGroupFluentBuilder

Constructs a fluent builder for the SendDataToMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
  • payload_data(impl Into<String>) / set_payload_data(Option<String>):
    required: true
    

    The binary to be sent to the end device, encoded in base64.

    
    
  • wireless_metadata(MulticastWirelessMetadata) / set_wireless_metadata(Option<MulticastWirelessMetadata>):
    required: true
    

    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>

impl Client

pub fn send_data_to_wireless_device( &self ) -> SendDataToWirelessDeviceFluentBuilder

Constructs a fluent builder for the SendDataToWirelessDevice operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the wireless device to receive the data.

    
    
  • transmit_mode(i32) / set_transmit_mode(Option<i32>):
    required: true
    

    The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

    
    
  • payload_data(impl Into<String>) / set_payload_data(Option<String>):
    required: true
    

    The binary to be sent to the end device, encoded in base64.

    
    
  • wireless_metadata(WirelessMetadata) / set_wireless_metadata(Option<WirelessMetadata>):
    required: false
    

    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>

impl Client

pub fn start_bulk_associate_wireless_device_with_multicast_group( &self ) -> StartBulkAssociateWirelessDeviceWithMulticastGroupFluentBuilder

Constructs a fluent builder for the StartBulkAssociateWirelessDeviceWithMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: false
    

    Query string used to search for wireless devices as part of the bulk associate and disassociate process.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>

impl Client

pub fn start_bulk_disassociate_wireless_device_from_multicast_group( &self ) -> StartBulkDisassociateWirelessDeviceFromMulticastGroupFluentBuilder

Constructs a fluent builder for the StartBulkDisassociateWirelessDeviceFromMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: false
    

    Query string used to search for wireless devices as part of the bulk associate and disassociate process.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>

impl Client

pub fn start_fuota_task(&self) -> StartFuotaTaskFluentBuilder

Constructs a fluent builder for the StartFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a FUOTA task.

    
    
  • lo_ra_wan(LoRaWanStartFuotaTask) / set_lo_ra_wan(Option<LoRaWanStartFuotaTask>):
    required: false
    

    The LoRaWAN information used to start a FUOTA task.

    
    
• On success, responds with StartFuotaTaskOutput
• On failure, responds with SdkError<StartFuotaTaskError>

impl Client

pub fn start_multicast_group_session( &self ) -> StartMulticastGroupSessionFluentBuilder

Constructs a fluent builder for the StartMulticastGroupSession operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
  • lo_ra_wan(LoRaWanMulticastSession) / set_lo_ra_wan(Option<LoRaWanMulticastSession>):
    required: true
    

    The LoRaWAN information used with the multicast session.

    
    
• On success, responds with StartMulticastGroupSessionOutput
• On failure, responds with SdkError<StartMulticastGroupSessionError>

impl Client

pub fn start_single_wireless_device_import_task( &self ) -> StartSingleWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the StartSingleWirelessDeviceImportTask operation.

• The fluent builder is configurable:
  • destination_name(impl Into<String>) / set_destination_name(Option<String>):
    required: true
    

    The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • device_name(impl Into<String>) / set_device_name(Option<String>):
    required: false
    

    The name of the wireless device for which an import task is being started.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

    
    
  • sidewalk(SidewalkSingleStartImportInfo) / set_sidewalk(Option<SidewalkSingleStartImportInfo>):
    required: true
    

    The Sidewalk-related parameters for importing a single wireless device.

    
    
• On success, responds with StartSingleWirelessDeviceImportTaskOutput with field(s):
  • id(Option<String>):

    The import task ID.

  • arn(Option<String>):

    The ARN (Amazon Resource Name) of the import task.

• On failure, responds with SdkError<StartSingleWirelessDeviceImportTaskError>

impl Client

pub fn start_wireless_device_import_task( &self ) -> StartWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the StartWirelessDeviceImportTask operation.

• The fluent builder is configurable:
  • destination_name(impl Into<String>) / set_destination_name(Option<String>):
    required: true
    

    The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

    
    
  • sidewalk(SidewalkStartImportInfo) / set_sidewalk(Option<SidewalkStartImportInfo>):
    required: true
    

    The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.

    
    
• On success, responds with StartWirelessDeviceImportTaskOutput with field(s):
  • id(Option<String>):

    The import task ID.

  • arn(Option<String>):

    The ARN (Amazon Resource Name) of the import task.

• On failure, responds with SdkError<StartWirelessDeviceImportTaskError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to add tags to.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    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>

impl Client

pub fn test_wireless_device(&self) -> TestWirelessDeviceFluentBuilder

Constructs a fluent builder for the TestWirelessDevice operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A list of the keys of the tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_destination(&self) -> UpdateDestinationFluentBuilder

Constructs a fluent builder for the UpdateDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The new name of the resource.

    
    
  • expression_type(ExpressionType) / set_expression_type(Option<ExpressionType>):
    required: false
    

    The type of value in Expression.

    
    
  • expression(impl Into<String>) / set_expression(Option<String>):
    required: false
    

    The new rule name or topic rule to send messages to.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A new description of the resource.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The ARN of the IAM Role that authorizes the destination.

    
    
• On success, responds with UpdateDestinationOutput
• On failure, responds with SdkError<UpdateDestinationError>

impl Client

pub fn update_event_configuration_by_resource_types( &self ) -> UpdateEventConfigurationByResourceTypesFluentBuilder

Constructs a fluent builder for the UpdateEventConfigurationByResourceTypes operation.

• The fluent builder is configurable:
  • device_registration_state(DeviceRegistrationStateResourceTypeEventConfiguration) / set_device_registration_state(Option<DeviceRegistrationStateResourceTypeEventConfiguration>):
    required: false
    

    Device registration state resource type event configuration object for enabling and disabling wireless gateway topic.

    
    
  • proximity(ProximityResourceTypeEventConfiguration) / set_proximity(Option<ProximityResourceTypeEventConfiguration>):
    required: false
    

    Proximity resource type event configuration object for enabling and disabling wireless gateway topic.

    
    
  • join(JoinResourceTypeEventConfiguration) / set_join(Option<JoinResourceTypeEventConfiguration>):
    required: false
    

    Join resource type event configuration object for enabling and disabling wireless device topic.

    
    
  • connection_status(ConnectionStatusResourceTypeEventConfiguration) / set_connection_status(Option<ConnectionStatusResourceTypeEventConfiguration>):
    required: false
    

    Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

    
    
  • message_delivery_status(MessageDeliveryStatusResourceTypeEventConfiguration) / set_message_delivery_status(Option<MessageDeliveryStatusResourceTypeEventConfiguration>):
    required: false
    

    Message delivery status resource type event configuration object for enabling and disabling wireless device topic.

    
    
• On success, responds with UpdateEventConfigurationByResourceTypesOutput
• On failure, responds with SdkError<UpdateEventConfigurationByResourceTypesError>

impl Client

pub fn update_fuota_task(&self) -> UpdateFuotaTaskFluentBuilder

Constructs a fluent builder for the UpdateFuotaTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of a FUOTA task.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of a FUOTA task.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • lo_ra_wan(LoRaWanFuotaTask) / set_lo_ra_wan(Option<LoRaWanFuotaTask>):
    required: false
    

    The LoRaWAN information used with a FUOTA task.

    
    
  • firmware_update_image(impl Into<String>) / set_firmware_update_image(Option<String>):
    required: false
    

    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>):
    required: false
    

    The firmware update role that is to be used with a FUOTA task.

    
    
  • redundancy_percent(i32) / set_redundancy_percent(Option<i32>):
    required: false
    

    The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

    
    
  • fragment_size_bytes(i32) / set_fragment_size_bytes(Option<i32>):
    required: false
    

    The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

    
    
  • fragment_interval_ms(i32) / set_fragment_interval_ms(Option<i32>):
    required: false
    

    The interval for sending fragments in milliseconds, rounded to the nearest second.

    This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device’s class and the communication delay with the cloud.

    
    
• On success, responds with UpdateFuotaTaskOutput
• On failure, responds with SdkError<UpdateFuotaTaskError>

impl Client

pub fn update_log_levels_by_resource_types( &self ) -> UpdateLogLevelsByResourceTypesFluentBuilder

Constructs a fluent builder for the UpdateLogLevelsByResourceTypes operation.

• The fluent builder is configurable:
  • default_log_level(LogLevel) / set_default_log_level(Option<LogLevel>):
    required: false
    

    The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

    
    
  • wireless_device_log_options(WirelessDeviceLogOption) / set_wireless_device_log_options(Option<Vec::<WirelessDeviceLogOption>>):
    required: false
    

    The list of wireless device log options.

    
    
  • wireless_gateway_log_options(WirelessGatewayLogOption) / set_wireless_gateway_log_options(Option<Vec::<WirelessGatewayLogOption>>):
    required: false
    

    The list of wireless gateway log options.

    
    
• On success, responds with UpdateLogLevelsByResourceTypesOutput
• On failure, responds with SdkError<UpdateLogLevelsByResourceTypesError>

impl Client

pub fn update_metric_configuration( &self ) -> UpdateMetricConfigurationFluentBuilder

Constructs a fluent builder for the UpdateMetricConfiguration operation.

• The fluent builder is configurable:
  • summary_metric(SummaryMetricConfiguration) / set_summary_metric(Option<SummaryMetricConfiguration>):
    required: false
    

    The value to be used to set summary metric configuration.

    
    
• On success, responds with UpdateMetricConfigurationOutput
• On failure, responds with SdkError<UpdateMetricConfigurationError>

impl Client

pub fn update_multicast_group(&self) -> UpdateMulticastGroupFluentBuilder

Constructs a fluent builder for the UpdateMulticastGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the multicast group.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the multicast group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • lo_ra_wan(LoRaWanMulticast) / set_lo_ra_wan(Option<LoRaWanMulticast>):
    required: false
    

    The LoRaWAN information that is to be used with the multicast group.

    
    
• On success, responds with UpdateMulticastGroupOutput
• On failure, responds with SdkError<UpdateMulticastGroupError>

impl Client

pub fn update_network_analyzer_configuration( &self ) -> UpdateNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the UpdateNetworkAnalyzerConfiguration operation.

• The fluent builder is configurable:
  • configuration_name(impl Into<String>) / set_configuration_name(Option<String>):
    required: true
    

    Name of the network analyzer configuration.

    
    
  • trace_content(TraceContent) / set_trace_content(Option<TraceContent>):
    required: false
    

    Trace content for your wireless devices, gateways, and multicast groups.

    
    
  • wireless_devices_to_add(impl Into<String>) / set_wireless_devices_to_add(Option<Vec::<String>>):
    required: false
    

    Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

    
    
  • wireless_devices_to_remove(impl Into<String>) / set_wireless_devices_to_remove(Option<Vec::<String>>):
    required: false
    

    Wireless device resources to remove from the network analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the input array.

    
    
  • wireless_gateways_to_add(impl Into<String>) / set_wireless_gateways_to_add(Option<Vec::<String>>):
    required: false
    

    Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

    
    
  • wireless_gateways_to_remove(impl Into<String>) / set_wireless_gateways_to_remove(Option<Vec::<String>>):
    required: false
    

    Wireless gateway resources to remove from the network analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the input array.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new resource.

    
    
  • multicast_groups_to_add(impl Into<String>) / set_multicast_groups_to_add(Option<Vec::<String>>):
    required: false
    

    Multicast group resources to add to the network analyzer configuration. Provide the MulticastGroupId of the resource to add in the input array.

    
    
  • multicast_groups_to_remove(impl Into<String>) / set_multicast_groups_to_remove(Option<Vec::<String>>):
    required: false
    

    Multicast group resources to remove from the network analyzer configuration. Provide the MulticastGroupId of the resources to remove in the input array.

    
    
• On success, responds with UpdateNetworkAnalyzerConfigurationOutput
• On failure, responds with SdkError<UpdateNetworkAnalyzerConfigurationError>

impl Client

pub fn update_partner_account(&self) -> UpdatePartnerAccountFluentBuilder

Constructs a fluent builder for the UpdatePartnerAccount operation.

• The fluent builder is configurable:
  • sidewalk(SidewalkUpdateAccount) / set_sidewalk(Option<SidewalkUpdateAccount>):
    required: true
    

    The Sidewalk account credentials.

    
    
  • partner_account_id(impl Into<String>) / set_partner_account_id(Option<String>):
    required: true
    

    The ID of the partner account to update.

    
    
  • partner_type(PartnerType) / set_partner_type(Option<PartnerType>):
    required: true
    

    The partner type.

    
    
• On success, responds with UpdatePartnerAccountOutput
• On failure, responds with SdkError<UpdatePartnerAccountError>

impl Client

pub fn update_position(&self) -> UpdatePositionFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the UpdatePosition operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    Resource identifier of the resource for which position is updated.

    
    
  • resource_type(PositionResourceType) / set_resource_type(Option<PositionResourceType>):
    required: true
    

    Resource type of the resource for which position is updated.

    
    
  • position(f32) / set_position(Option<Vec::<f32>>):
    required: true
    

    The position information of the resource.

    
    
• On success, responds with UpdatePositionOutput
• On failure, responds with SdkError<UpdatePositionError>

impl Client

pub fn update_resource_event_configuration( &self ) -> UpdateResourceEventConfigurationFluentBuilder

Constructs a fluent builder for the UpdateResourceEventConfiguration operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    Resource identifier to opt in for event messaging.

    
    
  • identifier_type(IdentifierType) / set_identifier_type(Option<IdentifierType>):
    required: true
    

    Identifier type of the particular resource identifier for event configuration.

    
    
  • partner_type(EventNotificationPartnerType) / set_partner_type(Option<EventNotificationPartnerType>):
    required: false
    

    Partner type of the resource if the identifier type is PartnerAccountId

    
    
  • device_registration_state(DeviceRegistrationStateEventConfiguration) / set_device_registration_state(Option<DeviceRegistrationStateEventConfiguration>):
    required: false
    

    Event configuration for the device registration state event.

    
    
  • proximity(ProximityEventConfiguration) / set_proximity(Option<ProximityEventConfiguration>):
    required: false
    

    Event configuration for the proximity event.

    
    
  • join(JoinEventConfiguration) / set_join(Option<JoinEventConfiguration>):
    required: false
    

    Event configuration for the join event.

    
    
  • connection_status(ConnectionStatusEventConfiguration) / set_connection_status(Option<ConnectionStatusEventConfiguration>):
    required: false
    

    Event configuration for the connection status event.

    
    
  • message_delivery_status(MessageDeliveryStatusEventConfiguration) / set_message_delivery_status(Option<MessageDeliveryStatusEventConfiguration>):
    required: false
    

    Event configuration for the message delivery status event.

    
    
• On success, responds with UpdateResourceEventConfigurationOutput
• On failure, responds with SdkError<UpdateResourceEventConfigurationError>

impl Client

pub fn update_resource_position(&self) -> UpdateResourcePositionFluentBuilder

Constructs a fluent builder for the UpdateResourcePosition operation.

• The fluent builder is configurable:
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: true
    

    The identifier of the resource for which position information is updated. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

    
    
  • resource_type(PositionResourceType) / set_resource_type(Option<PositionResourceType>):
    required: true
    

    The type of resource for which position information is updated, which can be a wireless device or a wireless gateway.

    
    
  • geo_json_payload(Blob) / set_geo_json_payload(Option<Blob>):
    required: false
    

    The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that’s used to encode geographic data structures. For more information, see GeoJSON.

    
    
• On success, responds with UpdateResourcePositionOutput
• On failure, responds with SdkError<UpdateResourcePositionError>

impl Client

pub fn update_wireless_device(&self) -> UpdateWirelessDeviceFluentBuilder

Constructs a fluent builder for the UpdateWirelessDevice operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
  • destination_name(impl Into<String>) / set_destination_name(Option<String>):
    required: false
    

    The name of the new destination for the device.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name of the resource.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A new description of the resource.

    
    
  • lo_ra_wan(LoRaWanUpdateDevice) / set_lo_ra_wan(Option<LoRaWanUpdateDevice>):
    required: false
    

    The updated wireless device’s configuration.

    
    
  • positioning(PositioningConfigStatus) / set_positioning(Option<PositioningConfigStatus>):
    required: false
    

    FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

    
    
• On success, responds with UpdateWirelessDeviceOutput
• On failure, responds with SdkError<UpdateWirelessDeviceError>

impl Client

pub fn update_wireless_device_import_task( &self ) -> UpdateWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the UpdateWirelessDeviceImportTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the import task to be updated.

    
    
  • sidewalk(SidewalkUpdateImportInfo) / set_sidewalk(Option<SidewalkUpdateImportInfo>):
    required: true
    

    The Sidewalk-related parameters of the import task to be updated.

    
    
• On success, responds with UpdateWirelessDeviceImportTaskOutput
• On failure, responds with SdkError<UpdateWirelessDeviceImportTaskError>

impl Client

pub fn update_wireless_gateway(&self) -> UpdateWirelessGatewayFluentBuilder

Constructs a fluent builder for the UpdateWirelessGateway operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the resource to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name of the resource.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A new description of the resource.

    
    
  • join_eui_filters(Vec::<String>) / set_join_eui_filters(Option<Vec::<Vec::<String>>>):
    required: false
    

    A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

    
    
  • net_id_filters(impl Into<String>) / set_net_id_filters(Option<Vec::<String>>):
    required: false
    

    A list of NetId values that are used by LoRa gateways to filter the uplink frames.

    
    
  • max_eirp(f32) / set_max_eirp(Option<f32>):
    required: false
    

    The MaxEIRP value.

    
    
• On success, responds with UpdateWirelessGatewayOutput
• On failure, responds with SdkError<UpdateWirelessGatewayError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.