Struct Client

pub struct Client { /* private fields */ }

Client for Managed integrations for AWS IoT Device Management

Client for invoking operations on Managed integrations for AWS IoT Device Management. Each operation on Managed integrations for AWS IoT Device Management 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_iotmanagedintegrations::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 Builder 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_iotmanagedintegrations::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 CreateCredentialLocker operation has a Client::create_credential_locker, 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.create_credential_locker()
    .name("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 create_credential_locker(&self) -> CreateCredentialLockerFluentBuilder

Constructs a fluent builder for the CreateCredentialLocker operation.

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

    The name of the credential locker.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A set of key/value pairs that are used to manage the credential locker.

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

    The identifier of the credential locker creation request.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the credential locker.

  • created_at(Option<DateTime>):

    The timestamp value of when the credential locker request occurred.

• On failure, responds with SdkError<CreateCredentialLockerError>

impl Client

pub fn create_destination(&self) -> CreateDestinationFluentBuilder

Constructs a fluent builder for the CreateDestination operation.

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

    The Amazon Resource Name (ARN) of the customer-managed destination.

    
    
  • delivery_destination_type(DeliveryDestinationType) / set_delivery_destination_type(Option<DeliveryDestinationType>):
    required: true
    

    The destination type for the customer-managed destination.

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

    The name of the customer-managed destination.

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

    The Amazon Resource Name (ARN) of the delivery destination role.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

    The description of the customer-managed destination.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A set of key/value pairs that are used to manage the destination.

    
    
• On success, responds with CreateDestinationOutput with field(s):
  • name(Option<String>):

    The name of the customer-managed destination.

• On failure, responds with SdkError<CreateDestinationError>

impl Client

pub fn create_event_log_configuration( &self, ) -> CreateEventLogConfigurationFluentBuilder

Constructs a fluent builder for the CreateEventLogConfiguration operation.

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

    The type of resource for the event log configuration.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: false
    

    The identifier of the resource for the event log configuration.

    
    
  • event_log_level(LogLevel) / set_event_log_level(Option<LogLevel>):
    required: true
    

    The logging level for the event log configuration.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

    The identifier of the event log configuration request.

• On failure, responds with SdkError<CreateEventLogConfigurationError>

impl Client

pub fn create_managed_thing(&self) -> CreateManagedThingFluentBuilder

Constructs a fluent builder for the CreateManagedThing operation.

• The fluent builder is configurable:
  • role(Role) / set_role(Option<Role>):
    required: true
    

    The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

    
    
  • owner(impl Into<String>) / set_owner(Option<String>):
    required: false
    

    Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

    
    
  • credential_locker_id(impl Into<String>) / set_credential_locker_id(Option<String>):
    required: false
    

    The identifier of the credential for the managed thing.

    
    
  • authentication_material(impl Into<String>) / set_authentication_material(Option<String>):
    required: true
    

    The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.

    
    
  • authentication_material_type(AuthMaterialType) / set_authentication_material_type(Option<AuthMaterialType>):
    required: true
    

    The type of authentication material used for device connectivity setup requests.

    
    
  • serial_number(impl Into<String>) / set_serial_number(Option<String>):
    required: false
    

    The serial number of the device.

    
    
  • brand(impl Into<String>) / set_brand(Option<String>):
    required: false
    

    The brand of the device.

    
    
  • model(impl Into<String>) / set_model(Option<String>):
    required: false
    

    The model of the device.

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

    The name of the managed thing representing the physical device.

    
    
  • capability_report(CapabilityReport) / set_capability_report(Option<CapabilityReport>):
    required: false
    

    A report of the capabilities for the managed thing.

    
    
  • capabilities(impl Into<String>) / set_capabilities(Option<String>):
    required: false
    

    The capabilities of the device such as light bulb.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    
    
  • classification(impl Into<String>) / set_classification(Option<String>):
    required: false
    

    The classification of the managed thing such as light bulb or thermostat.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A set of key/value pairs that are used to manage the managed thing.

    
    
  • meta_data(impl Into<String>, impl Into<String>) / set_meta_data(Option<HashMap::<String, String>>):
    required: false
    

    The metadata for the managed thing.

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

    The id of the managed thing.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the managed thing.

  • created_at(Option<DateTime>):

    The timestamp value of when the device creation request occurred.

• On failure, responds with SdkError<CreateManagedThingError>

impl Client

pub fn create_notification_configuration( &self, ) -> CreateNotificationConfigurationFluentBuilder

Constructs a fluent builder for the CreateNotificationConfiguration operation.

• The fluent builder is configurable:
  • event_type(EventType) / set_event_type(Option<EventType>):
    required: true
    

    The type of event triggering a device notification to the customer-managed destination.

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

    The name of the destination for the notification configuration.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A set of key/value pairs that are used to manage the notification configuration.

    
    
• On success, responds with CreateNotificationConfigurationOutput with field(s):
  • event_type(Option<EventType>):

    The type of event triggering a device notification to the customer-managed destination.

• On failure, responds with SdkError<CreateNotificationConfigurationError>

impl Client

pub fn create_ota_task(&self) -> CreateOtaTaskFluentBuilder

Constructs a fluent builder for the CreateOtaTask operation.

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

    The description of the over-the-air (OTA) task.

    
    
  • s3_url(impl Into<String>) / set_s3_url(Option<String>):
    required: true
    

    The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

    
    
  • protocol(OtaProtocol) / set_protocol(Option<OtaProtocol>):
    required: false
    

    The connection protocol the over-the-air (OTA) task uses to update the device.

    
    
  • target(impl Into<String>) / set_target(Option<Vec::<String>>):
    required: false
    

    The device targeted for the over-the-air (OTA) task.

    
    
  • task_configuration_id(impl Into<String>) / set_task_configuration_id(Option<String>):
    required: false
    

    The identifier for the over-the-air (OTA) task configuration.

    
    
  • ota_mechanism(OtaMechanism) / set_ota_mechanism(Option<OtaMechanism>):
    required: false
    

    The deployment mechanism for the over-the-air (OTA) task.

    
    
  • ota_type(OtaType) / set_ota_type(Option<OtaType>):
    required: true
    

    The frequency type for the over-the-air (OTA) task.

    
    
  • ota_target_query_string(impl Into<String>) / set_ota_target_query_string(Option<String>):
    required: false
    

    The query string to add things to the thing group.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    
    
  • ota_scheduling_config(OtaTaskSchedulingConfig) / set_ota_scheduling_config(Option<OtaTaskSchedulingConfig>):
    required: false
    

    Over-the-air (OTA) task scheduling config.

    
    
  • ota_task_execution_retry_config(OtaTaskExecutionRetryConfig) / set_ota_task_execution_retry_config(Option<OtaTaskExecutionRetryConfig>):
    required: false
    

    Over-the-air (OTA) task retry config.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A set of key/value pairs that are used to manage the over-the-air (OTA) task.

    
    
• On success, responds with CreateOtaTaskOutput with field(s):
  • task_id(Option<String>):

    The identifier of the over-the-air (OTA) task.

  • task_arn(Option<String>):

    The Amazon Resource Name (ARN) of the over-the-air (OTA) task.

  • description(Option<String>):

    A description of the over-the-air (OTA) task.

• On failure, responds with SdkError<CreateOtaTaskError>

impl Client

pub fn create_ota_task_configuration( &self, ) -> CreateOtaTaskConfigurationFluentBuilder

Constructs a fluent builder for the CreateOtaTaskConfiguration operation.

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

    A description of the over-the-air (OTA) task configuration.

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

    The name of the over-the-air (OTA) task.

    
    
  • push_config(PushConfig) / set_push_config(Option<PushConfig>):
    required: false
    

    Describes the type of configuration used for the over-the-air (OTA) task.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    
    
• On success, responds with CreateOtaTaskConfigurationOutput with field(s):
  • task_configuration_id(Option<String>):

    The identifier of the over-the-air (OTA) task configuration.

• On failure, responds with SdkError<CreateOtaTaskConfigurationError>

impl Client

pub fn create_provisioning_profile( &self, ) -> CreateProvisioningProfileFluentBuilder

Constructs a fluent builder for the CreateProvisioningProfile operation.

• The fluent builder is configurable:
  • provisioning_type(ProvisioningType) / set_provisioning_type(Option<ProvisioningType>):
    required: true
    

    The type of provisioning workflow the device uses for onboarding to IoT managed integrations.

    
    
  • ca_certificate(impl Into<String>) / set_ca_certificate(Option<String>):
    required: false
    

    The id of the certificate authority (CA) certificate.

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

    The name of the provisioning template.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A set of key/value pairs that are used to manage the provisioning profile.

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

    The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.

  • name(Option<String>):

    The name of the provisioning template.

  • provisioning_type(Option<ProvisioningType>):

    The type of provisioning workflow the device uses for onboarding to IoT managed integrations.

  • id(Option<String>):

    The identifier of the provisioning profile.

  • claim_certificate(Option<String>):

    The id of the claim certificate.

  • claim_certificate_private_key(Option<String>):

    The private key of the claim certificate. This is stored securely on the device for validating the connection endpoint with IoT managed integrations using the public key.

• On failure, responds with SdkError<CreateProvisioningProfileError>

impl Client

pub fn delete_credential_locker(&self) -> DeleteCredentialLockerFluentBuilder

Constructs a fluent builder for the DeleteCredentialLocker operation.

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

    The identifier of the credential locker.

    
    
• On success, responds with DeleteCredentialLockerOutput
• On failure, responds with SdkError<DeleteCredentialLockerError>

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 id of the customer-managed destination.

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

impl Client

pub fn delete_event_log_configuration( &self, ) -> DeleteEventLogConfigurationFluentBuilder

Constructs a fluent builder for the DeleteEventLogConfiguration operation.

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

    The identifier of the event log configuration.

    
    
• On success, responds with DeleteEventLogConfigurationOutput
• On failure, responds with SdkError<DeleteEventLogConfigurationError>

impl Client

pub fn delete_managed_thing(&self) -> DeleteManagedThingFluentBuilder

Constructs a fluent builder for the DeleteManagedThing operation.

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

    The id of the managed thing.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    When set to TRUE, a forceful deteletion of the managed thing will occur. When set to FALSE, a non-forceful deletion of the managed thing will occur.

    
    
• On success, responds with DeleteManagedThingOutput
• On failure, responds with SdkError<DeleteManagedThingError>

impl Client

pub fn delete_notification_configuration( &self, ) -> DeleteNotificationConfigurationFluentBuilder

Constructs a fluent builder for the DeleteNotificationConfiguration operation.

• The fluent builder is configurable:
  • event_type(EventType) / set_event_type(Option<EventType>):
    required: true
    

    The type of event triggering a device notification to the customer-managed destination.

    
    
• On success, responds with DeleteNotificationConfigurationOutput
• On failure, responds with SdkError<DeleteNotificationConfigurationError>

impl Client

pub fn delete_ota_task(&self) -> DeleteOtaTaskFluentBuilder

Constructs a fluent builder for the DeleteOtaTask operation.

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

    The identifier of the over-the-air (OTA) task.

    
    
• On success, responds with DeleteOtaTaskOutput
• On failure, responds with SdkError<DeleteOtaTaskError>

impl Client

pub fn delete_ota_task_configuration( &self, ) -> DeleteOtaTaskConfigurationFluentBuilder

Constructs a fluent builder for the DeleteOtaTaskConfiguration operation.

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

    The identifier of the over-the-air (OTA) task configuration.

    
    
• On success, responds with DeleteOtaTaskConfigurationOutput
• On failure, responds with SdkError<DeleteOtaTaskConfigurationError>

impl Client

pub fn delete_provisioning_profile( &self, ) -> DeleteProvisioningProfileFluentBuilder

Constructs a fluent builder for the DeleteProvisioningProfile operation.

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

    The name of the provisioning template.

    
    
• On success, responds with DeleteProvisioningProfileOutput
• On failure, responds with SdkError<DeleteProvisioningProfileError>

impl Client

pub fn get_credential_locker(&self) -> GetCredentialLockerFluentBuilder

Constructs a fluent builder for the GetCredentialLocker operation.

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

    The identifier of the credential locker.

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

    The identifier of the credential locker.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the credential locker.

  • name(Option<String>):

    The name of the credential locker.

  • created_at(Option<DateTime>):

    The timestamp value of when the credential locker requset occurred.

  • tags(Option<HashMap::<String, String>>):

    A set of key/value pairs that are used to manage the credential locker.

• On failure, responds with SdkError<GetCredentialLockerError>

impl Client

pub fn get_custom_endpoint(&self) -> GetCustomEndpointFluentBuilder

Constructs a fluent builder for the GetCustomEndpoint operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetCustomEndpointOutput with field(s):
  • endpoint_address(String):

    The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.

• On failure, responds with SdkError<GetCustomEndpointError>

impl Client

pub fn get_default_encryption_configuration( &self, ) -> GetDefaultEncryptionConfigurationFluentBuilder

Constructs a fluent builder for the GetDefaultEncryptionConfiguration operation.

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

    Provides the status of the default encryption configuration for an Amazon Web Services account.

  • encryption_type(EncryptionType):

    The type of encryption used for the encryption configuration.

  • kms_key_arn(Option<String>):

    The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.

• On failure, responds with SdkError<GetDefaultEncryptionConfigurationError>

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 customer-managed destination.

    
    
• On success, responds with GetDestinationOutput with field(s):
  • description(Option<String>):

    The description of the customer-managed destination.

  • delivery_destination_arn(Option<String>):

    The Amazon Resource Name (ARN) of the customer-managed destination.

  • delivery_destination_type(Option<DeliveryDestinationType>):

    The destination type for the customer-managed destination.

  • name(Option<String>):

    The name of the customer-managed destination.

  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the delivery destination role.

  • created_at(Option<DateTime>):

    The timestamp value of when the destination creation requset occurred.

  • updated_at(Option<DateTime>):

    The timestamp value of when the destination update requset occurred.

  • tags(Option<HashMap::<String, String>>):

    A set of key/value pairs that are used to manage the customer-managed destination.

• On failure, responds with SdkError<GetDestinationError>

impl Client

pub fn get_device_discovery(&self) -> GetDeviceDiscoveryFluentBuilder

Constructs a fluent builder for the GetDeviceDiscovery operation.

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

    The id of the device discovery job request.

    
    
• On success, responds with GetDeviceDiscoveryOutput with field(s):
  • id(String):

    The id of the device discovery job request.

  • arn(String):

    The Amazon Resource Name (ARN) of the device discovery job request.

  • discovery_type(DiscoveryType):

    The discovery type supporting the type of device to be discovered in the device discovery job request.

  • status(DeviceDiscoveryStatus):

    The status of the device discovery job request.

  • started_at(DateTime):

    The timestamp value for the start time of the device discovery.

  • controller_id(Option<String>):

    The id of the end-user’s IoT hub.

  • connector_association_id(Option<String>):

    The ID tracking the current discovery process for one connector association.

  • finished_at(Option<DateTime>):

    The timestamp value for the completion time of the device discovery.

  • tags(Option<HashMap::<String, String>>):

    A set of key/value pairs that are used to manage the device discovery request.

• On failure, responds with SdkError<GetDeviceDiscoveryError>

impl Client

pub fn get_event_log_configuration( &self, ) -> GetEventLogConfigurationFluentBuilder

Constructs a fluent builder for the GetEventLogConfiguration operation.

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

    The identifier of the event log configuration.

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

    The identifier of the event log configuration.

  • resource_type(Option<String>):

    The type of resource for the event log configuration.

  • resource_id(Option<String>):

    The identifier of the resource for the event log configuration.

  • event_log_level(Option<LogLevel>):

    The logging level for the event log configuration.

• On failure, responds with SdkError<GetEventLogConfigurationError>

impl Client

pub fn get_hub_configuration(&self) -> GetHubConfigurationFluentBuilder

Constructs a fluent builder for the GetHubConfiguration operation.

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

    A user-defined integer value that represents the hub token timer expiry setting in seconds.

  • updated_at(Option<DateTime>):

    The timestamp value of when the hub configuration was updated.

• On failure, responds with SdkError<GetHubConfigurationError>

impl Client

pub fn get_managed_thing(&self) -> GetManagedThingFluentBuilder

Constructs a fluent builder for the GetManagedThing operation.

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

    The id of the managed thing.

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

    The id of the managed thing.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the managed thing.

  • owner(Option<String>):

    Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

  • credential_locker_id(Option<String>):

    The identifier of the credential locker for the managed thing.

  • advertised_product_id(Option<String>):

    The id of the advertised product.

  • role(Option<Role>):

    The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

  • provisioning_status(Option<ProvisioningStatus>):

    The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.

  • name(Option<String>):

    The name of the managed thing representing the physical device.

  • model(Option<String>):

    The model of the device.

  • brand(Option<String>):

    The brand of the device.

  • serial_number(Option<String>):

    The serial number of the device.

  • universal_product_code(Option<String>):

    The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.

  • international_article_number(Option<String>):

    The unique 13 digit number that identifies the managed thing.

  • connector_policy_id(Option<String>):

    The id of the connector policy.

    This parameter is used for cloud-to-cloud devices only.

  • connector_device_id(Option<String>):

    The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

    This parameter is used for cloud-to-cloud devices only.

  • device_specific_key(Option<String>):

    A Zwave device-specific key used during device activation.

    This parameter is used for Zwave devices only.

  • mac_address(Option<String>):

    The media access control (MAC) address for the device represented by the managed thing.

    This parameter is used for Zigbee devices only.

  • parent_controller_id(Option<String>):

    Id of the controller device used for the discovery job.

  • classification(Option<String>):

    The classification of the managed thing such as light bulb or thermostat.

  • created_at(Option<DateTime>):

    The timestamp value of when the device creation request occurred.

  • updated_at(Option<DateTime>):

    The timestamp value of when the managed thing was last updated at.

  • activated_at(Option<DateTime>):

    The timestampe value of when the device was activated.

  • hub_network_mode(Option<HubNetworkMode>):

    The network mode for the hub-connected device.

  • meta_data(Option<HashMap::<String, String>>):

    The metadata for the managed thing.

  • tags(Option<HashMap::<String, String>>):

    A set of key/value pairs that are used to manage the managed thing.

• On failure, responds with SdkError<GetManagedThingError>

impl Client

pub fn get_managed_thing_capabilities( &self, ) -> GetManagedThingCapabilitiesFluentBuilder

Constructs a fluent builder for the GetManagedThingCapabilities operation.

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

    The id of the device.

    
    
• On success, responds with GetManagedThingCapabilitiesOutput with field(s):
  • managed_thing_id(Option<String>):

    The id of the device.

  • capabilities(Option<String>):

    The capabilities of the device such as light bulb.

  • capability_report(Option<CapabilityReport>):

    A report of the capabilities for the managed thing.

• On failure, responds with SdkError<GetManagedThingCapabilitiesError>

impl Client

pub fn get_managed_thing_connectivity_data( &self, ) -> GetManagedThingConnectivityDataFluentBuilder

Constructs a fluent builder for the GetManagedThingConnectivityData operation.

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

    The identifier of a managed thing.

    
    
• On success, responds with GetManagedThingConnectivityDataOutput with field(s):
  • managed_thing_id(Option<String>):

    The id of a managed thing.

  • connected(Option<bool>):

    The connectivity status for a managed thing.

  • timestamp(Option<DateTime>):

    The timestamp value of when the connectivity status for a managed thing was last taken.

  • disconnect_reason(Option<DisconnectReasonValue>):

    The reason for the connectivity disconnect with the managed thing.

• On failure, responds with SdkError<GetManagedThingConnectivityDataError>

impl Client

pub fn get_managed_thing_meta_data( &self, ) -> GetManagedThingMetaDataFluentBuilder

Constructs a fluent builder for the GetManagedThingMetaData operation.

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

    The managed thing id.

    
    
• On success, responds with GetManagedThingMetaDataOutput with field(s):
  • managed_thing_id(Option<String>):

    The managed thing id.

  • meta_data(Option<HashMap::<String, String>>):

    The metadata for the managed thing.

• On failure, responds with SdkError<GetManagedThingMetaDataError>

impl Client

pub fn get_managed_thing_state(&self) -> GetManagedThingStateFluentBuilder

Constructs a fluent builder for the GetManagedThingState operation.

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

    The id of the device.

    
    
• On success, responds with GetManagedThingStateOutput with field(s):
  • endpoints(Vec::<StateEndpoint>):

    The device endpoint.

• On failure, responds with SdkError<GetManagedThingStateError>

impl Client

pub fn get_notification_configuration( &self, ) -> GetNotificationConfigurationFluentBuilder

Constructs a fluent builder for the GetNotificationConfiguration operation.

• The fluent builder is configurable:
  • event_type(EventType) / set_event_type(Option<EventType>):
    required: true
    

    The type of event triggering a device notification to the customer-managed destination.

    
    
• On success, responds with GetNotificationConfigurationOutput with field(s):
  • event_type(Option<EventType>):

    The type of event triggering a device notification to the customer-managed destination.

  • destination_name(Option<String>):

    The name of the destination for the notification configuration.

  • created_at(Option<DateTime>):

    The timestamp value of when the notification configuration was created.

  • updated_at(Option<DateTime>):

    The timestamp value of when the notification configuration was last updated.

  • tags(Option<HashMap::<String, String>>):

    A set of key/value pairs that are used to manage the notification configuration.

• On failure, responds with SdkError<GetNotificationConfigurationError>

impl Client

pub fn get_ota_task(&self) -> GetOtaTaskFluentBuilder

Constructs a fluent builder for the GetOtaTask operation.

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

    The over-the-air (OTA) task id.

    
    
• On success, responds with GetOtaTaskOutput with field(s):
  • task_id(Option<String>):

    The id of the over-the-air (OTA) task.

  • task_arn(Option<String>):

    The Amazon Resource Name (ARN) of the over-the-air (OTA) task

  • description(Option<String>):

    The description of the over-the-air (OTA) task.

  • s3_url(Option<String>):

    The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

  • protocol(Option<OtaProtocol>):

    The connection protocol the over-the-air (OTA) task uses to update the device.

  • ota_type(Option<OtaType>):

    The frequency type for the over-the-air (OTA) task.

  • ota_target_query_string(Option<String>):

    The query string to add things to the thing group.

  • ota_mechanism(Option<OtaMechanism>):

    The deployment mechanism for the over-the-air (OTA) task.

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

    The device targeted for the over-the-air (OTA) task.

  • created_at(Option<DateTime>):

    The timestamp value of when the over-the-air (OTA) task was created.

  • last_updated_at(Option<DateTime>):

    The timestamp value of when the over-the-air (OTA) task was last updated at.

  • task_configuration_id(Option<String>):

    The identifier for the over-the-air (OTA) task configuration.

  • task_processing_details(Option<TaskProcessingDetails>):

    The processing details of all over-the-air (OTA) tasks.

  • ota_scheduling_config(Option<OtaTaskSchedulingConfig>):

    Over-the-air (OTA) task scheduling config.

  • ota_task_execution_retry_config(Option<OtaTaskExecutionRetryConfig>):

    Over-the-air (OTA) task retry config.

  • status(Option<OtaStatus>):

    The status of the over-the-air (OTA) task.

• On failure, responds with SdkError<GetOtaTaskError>

impl Client

pub fn get_ota_task_configuration(&self) -> GetOtaTaskConfigurationFluentBuilder

Constructs a fluent builder for the GetOtaTaskConfiguration operation.

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

    The over-the-air (OTA) task configuration id.

    
    
• On success, responds with GetOtaTaskConfigurationOutput with field(s):
  • task_configuration_id(Option<String>):

    The over-the-air (OTA) task configuration id.

  • name(Option<String>):

    The name of the over-the-air (OTA) task configuration.

  • push_config(Option<PushConfig>):

    Describes the type of configuration used for the over-the-air (OTA) task.

  • description(Option<String>):

    A description of the over-the-air (OTA) task configuration.

  • created_at(Option<DateTime>):

    The timestamp value of when the over-the-air (OTA) task configuration was created at.

• On failure, responds with SdkError<GetOtaTaskConfigurationError>

impl Client

pub fn get_provisioning_profile(&self) -> GetProvisioningProfileFluentBuilder

Constructs a fluent builder for the GetProvisioningProfile operation.

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

    The provisioning template the device uses for the provisioning process.

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

    The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.

  • name(Option<String>):

    The name of the provisioning template.

  • provisioning_type(Option<ProvisioningType>):

    The type of provisioning workflow the device uses for onboarding to IoT managed integrations.

  • id(Option<String>):

    The provisioning profile id..

  • claim_certificate(Option<String>):

    The id of the claim certificate.

  • tags(Option<HashMap::<String, String>>):

    A set of key/value pairs that are used to manage the provisioning profile.

• On failure, responds with SdkError<GetProvisioningProfileError>

impl Client

pub fn get_runtime_log_configuration( &self, ) -> GetRuntimeLogConfigurationFluentBuilder

Constructs a fluent builder for the GetRuntimeLogConfiguration operation.

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

    The id for a managed thing.

    
    
• On success, responds with GetRuntimeLogConfigurationOutput with field(s):
  • managed_thing_id(Option<String>):

    The id for a managed thing.

  • runtime_log_configurations(Option<RuntimeLogConfigurations>):

    The runtime log configuration for a managed thing.

• On failure, responds with SdkError<GetRuntimeLogConfigurationError>

impl Client

pub fn get_schema_version(&self) -> GetSchemaVersionFluentBuilder

Constructs a fluent builder for the GetSchemaVersion operation.

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

    The type of schema version.

    
    
  • schema_versioned_id(impl Into<String>) / set_schema_versioned_id(Option<String>):
    required: true
    

    Schema id with a version specified. If the version is missing, it defaults to latest version.

    
    
  • format(SchemaVersionFormat) / set_format(Option<SchemaVersionFormat>):
    required: false
    

    The format of the schema version.

    
    
• On success, responds with GetSchemaVersionOutput with field(s):
  • schema_id(Option<String>):

    The id of the schema version.

  • r#type(Option<SchemaVersionType>):

    The type of schema version.

  • description(Option<String>):

    The description of the schema version.

  • namespace(Option<String>):

    The name of the schema version.

  • semantic_version(Option<String>):

    The schema version. If this is left blank, it defaults to the latest version.

  • visibility(Option<SchemaVersionVisibility>):

    The visibility of the schema version.

  • schema(Option<Document>):

    The schema of the schema version.

• On failure, responds with SdkError<GetSchemaVersionError>

impl Client

pub fn list_credential_lockers(&self) -> ListCredentialLockersFluentBuilder

Constructs a fluent builder for the ListCredentialLockers 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
    

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListCredentialLockersOutput with field(s):
  • items(Option<Vec::<CredentialLockerSummary>>):

    The list of credential lockers.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListCredentialLockersError>

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:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListDestinationsOutput with field(s):
  • destination_list(Option<Vec::<DestinationSummary>>):

    The list of destinations.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListDestinationsError>

impl Client

pub fn list_event_log_configurations( &self, ) -> ListEventLogConfigurationsFluentBuilder

Constructs a fluent builder for the ListEventLogConfigurations 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
    

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListEventLogConfigurationsOutput with field(s):
  • event_log_configuration_list(Option<Vec::<EventLogConfigurationSummary>>):

    A list of each event log configuration and pertinent information.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListEventLogConfigurationsError>

impl Client

pub fn list_managed_thing_schemas(&self) -> ListManagedThingSchemasFluentBuilder

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

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

    The managed thing id.

    
    
  • endpoint_id_filter(impl Into<String>) / set_endpoint_id_filter(Option<String>):
    required: false
    

    Filter on an endpoint id.

    
    
  • capability_id_filter(impl Into<String>) / set_capability_id_filter(Option<String>):
    required: false
    

    Filter on a capability id.

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

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListManagedThingSchemasOutput with field(s):
  • items(Option<Vec::<ManagedThingSchemaListItem>>):

    The list of managed thing schemas.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListManagedThingSchemasError>

impl Client

pub fn list_managed_things(&self) -> ListManagedThingsFluentBuilder

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

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

    Filter on device owners when listing managed things.

    
    
  • credential_locker_filter(impl Into<String>) / set_credential_locker_filter(Option<String>):
    required: false
    

    Filter on a credential locker for a managed thing.

    
    
  • role_filter(Role) / set_role_filter(Option<Role>):
    required: false
    

    Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

    
    
  • parent_controller_identifier_filter(impl Into<String>) / set_parent_controller_identifier_filter(Option<String>):
    required: false
    

    Filter on a parent controller id for a managed thing.

    
    
  • connector_policy_id_filter(impl Into<String>) / set_connector_policy_id_filter(Option<String>):
    required: false
    

    Filter on a connector policy id for a managed thing.

    
    
  • serial_number_filter(impl Into<String>) / set_serial_number_filter(Option<String>):
    required: false
    

    Filter on the serial number of the device.

    
    
  • provisioning_status_filter(ProvisioningStatus) / set_provisioning_status_filter(Option<ProvisioningStatus>):
    required: false
    

    Filter on the status of the device.

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

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListManagedThingsOutput with field(s):
  • items(Option<Vec::<ManagedThingSummary>>):

    The list of managed things.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListManagedThingsError>

impl Client

pub fn list_notification_configurations( &self, ) -> ListNotificationConfigurationsFluentBuilder

Constructs a fluent builder for the ListNotificationConfigurations 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 at one time.

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

    A token that can be used to retrieve the next set of results.

    
    
• On success, responds with ListNotificationConfigurationsOutput with field(s):
  • notification_configuration_list(Option<Vec::<NotificationConfigurationSummary>>):

    The list of notification configurations.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListNotificationConfigurationsError>

impl Client

pub fn list_ota_task_configurations( &self, ) -> ListOtaTaskConfigurationsFluentBuilder

Constructs a fluent builder for the ListOtaTaskConfigurations 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
    

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListOtaTaskConfigurationsOutput with field(s):
  • items(Option<Vec::<OtaTaskConfigurationSummary>>):

    The list of the over-the-air (OTA) task configurations.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListOtaTaskConfigurationsError>

impl Client

pub fn list_ota_task_executions(&self) -> ListOtaTaskExecutionsFluentBuilder

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

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

    The over-the-air (OTA) task id.

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

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListOtaTaskExecutionsOutput with field(s):
  • execution_summaries(Option<Vec::<OtaTaskExecutionSummaries>>):

    A list of all of the over-the-air (OTA) task executions.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListOtaTaskExecutionsError>

impl Client

pub fn list_ota_tasks(&self) -> ListOtaTasksFluentBuilder

Constructs a fluent builder for the ListOtaTasks 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
    

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListOtaTasksOutput with field(s):
  • tasks(Option<Vec::<OtaTaskSummary>>):

    A list of all of the over-the-air (OTA) tasks.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListOtaTasksError>

impl Client

pub fn list_provisioning_profiles( &self, ) -> ListProvisioningProfilesFluentBuilder

Constructs a fluent builder for the ListProvisioningProfiles 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
    

    A token that can be used to retrieve the next set of results.

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

    The maximum number of results to return at one time.

    
    
• On success, responds with ListProvisioningProfilesOutput with field(s):
  • items(Option<Vec::<ProvisioningProfileSummary>>):

    The list of provisioning profiles.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListProvisioningProfilesError>

impl Client

pub fn list_schema_versions(&self) -> ListSchemaVersionsFluentBuilder

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

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

    Filter on the type of schema version.

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

    The maximum number of results to return at one time.

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

    A token that can be used to retrieve the next set of results.

    
    
  • schema_id(impl Into<String>) / set_schema_id(Option<String>):
    required: false
    

    Filter on the id of the schema version.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    Filter on the name of the schema version.

    
    
  • visibility(SchemaVersionVisibility) / set_visibility(Option<SchemaVersionVisibility>):
    required: false
    

    The visibility of the schema version.

    
    
  • semantic_version(impl Into<String>) / set_semantic_version(Option<String>):
    required: false
    

    The schema version. If this is left blank, it defaults to the latest version.

    
    
• On success, responds with ListSchemaVersionsOutput with field(s):
  • items(Option<Vec::<SchemaVersionListItem>>):

    The list of schema versions.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results.

• On failure, responds with SdkError<ListSchemaVersionsError>

impl Client

pub fn put_default_encryption_configuration( &self, ) -> PutDefaultEncryptionConfigurationFluentBuilder

Constructs a fluent builder for the PutDefaultEncryptionConfiguration operation.

• The fluent builder is configurable:
  • encryption_type(EncryptionType) / set_encryption_type(Option<EncryptionType>):
    required: true
    

    The type of encryption used for the encryption configuration.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.

    
    
• On success, responds with PutDefaultEncryptionConfigurationOutput with field(s):
  • configuration_status(Option<ConfigurationStatus>):

    Provides the status of the default encryption configuration for an Amazon Web Services account.

  • encryption_type(EncryptionType):

    The type of encryption used for the encryption configuration.

  • kms_key_arn(Option<String>):

    The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.

• On failure, responds with SdkError<PutDefaultEncryptionConfigurationError>

impl Client

pub fn put_hub_configuration(&self) -> PutHubConfigurationFluentBuilder

Constructs a fluent builder for the PutHubConfiguration operation.

• The fluent builder is configurable:
  • hub_token_timer_expiry_setting_in_seconds(i64) / set_hub_token_timer_expiry_setting_in_seconds(Option<i64>):
    required: true
    

    A user-defined integer value that represents the hub token timer expiry setting in seconds.

    
    
• On success, responds with PutHubConfigurationOutput with field(s):
  • hub_token_timer_expiry_setting_in_seconds(Option<i64>):

    A user-defined integer value that represents the hub token timer expiry setting in seconds.

• On failure, responds with SdkError<PutHubConfigurationError>

impl Client

pub fn put_runtime_log_configuration( &self, ) -> PutRuntimeLogConfigurationFluentBuilder

Constructs a fluent builder for the PutRuntimeLogConfiguration operation.

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

    The id for a managed thing.

    
    
  • runtime_log_configurations(RuntimeLogConfigurations) / set_runtime_log_configurations(Option<RuntimeLogConfigurations>):
    required: true
    

    The runtime log configuration for a managed thing.

    
    
• On success, responds with PutRuntimeLogConfigurationOutput
• On failure, responds with SdkError<PutRuntimeLogConfigurationError>

impl Client

pub fn register_custom_endpoint(&self) -> RegisterCustomEndpointFluentBuilder

Constructs a fluent builder for the RegisterCustomEndpoint operation.

• The fluent builder takes no input, just send it.
• On success, responds with RegisterCustomEndpointOutput with field(s):
  • endpoint_address(String):

    The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.

• On failure, responds with SdkError<RegisterCustomEndpointError>

impl Client

pub fn reset_runtime_log_configuration( &self, ) -> ResetRuntimeLogConfigurationFluentBuilder

Constructs a fluent builder for the ResetRuntimeLogConfiguration operation.

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

    The id of a managed thing.

    
    
• On success, responds with ResetRuntimeLogConfigurationOutput
• On failure, responds with SdkError<ResetRuntimeLogConfigurationError>

impl Client

pub fn send_managed_thing_command(&self) -> SendManagedThingCommandFluentBuilder

Constructs a fluent builder for the SendManagedThingCommand operation.

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

    The id of the device.

    
    
  • endpoints(CommandEndpoint) / set_endpoints(Option<Vec::<CommandEndpoint>>):
    required: true
    

    The device endpoint.

    
    
  • connector_association_id(impl Into<String>) / set_connector_association_id(Option<String>):
    required: false
    

    The ID tracking the current discovery process for one connector association.

    
    
• On success, responds with SendManagedThingCommandOutput with field(s):
  • trace_id(Option<String>):

    The trace request identifier. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.

• On failure, responds with SdkError<SendManagedThingCommandError>

impl Client

pub fn start_device_discovery(&self) -> StartDeviceDiscoveryFluentBuilder

Constructs a fluent builder for the StartDeviceDiscovery operation.

• The fluent builder is configurable:
  • discovery_type(DiscoveryType) / set_discovery_type(Option<DiscoveryType>):
    required: true
    

    The discovery type supporting the type of device to be discovered in the device discovery job request.

    
    
  • controller_identifier(impl Into<String>) / set_controller_identifier(Option<String>):
    required: false
    

    The id of the end-user’s IoT hub.

    
    
  • connector_association_identifier(impl Into<String>) / set_connector_association_identifier(Option<String>):
    required: false
    

    The id of the connector association.

    
    
  • authentication_material(impl Into<String>) / set_authentication_material(Option<String>):
    required: false
    

    The authentication material required to start the local device discovery job request.

    
    
  • authentication_material_type(DiscoveryAuthMaterialType) / set_authentication_material_type(Option<DiscoveryAuthMaterialType>):
    required: false
    

    The type of authentication material used for device discovery jobs.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A set of key/value pairs that are used to manage the device discovery request.

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

    The id of the device discovery job request.

  • started_at(Option<DateTime>):

    The timestamp value for the start time of the device discovery.

• On failure, responds with SdkError<StartDeviceDiscoveryError>

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 name of the customer-managed destination.

    
    
  • delivery_destination_arn(impl Into<String>) / set_delivery_destination_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the customer-managed destination.

    
    
  • delivery_destination_type(DeliveryDestinationType) / set_delivery_destination_type(Option<DeliveryDestinationType>):
    required: false
    

    The destination type for the customer-managed destination.

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

    The Amazon Resource Name (ARN) of the delivery destination role.

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

    The description of the customer-managed destination.

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

impl Client

pub fn update_event_log_configuration( &self, ) -> UpdateEventLogConfigurationFluentBuilder

Constructs a fluent builder for the UpdateEventLogConfiguration operation.

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

    The log configuration id.

    
    
  • event_log_level(LogLevel) / set_event_log_level(Option<LogLevel>):
    required: true
    

    The log level for the event in terms of severity.

    
    
• On success, responds with UpdateEventLogConfigurationOutput
• On failure, responds with SdkError<UpdateEventLogConfigurationError>

impl Client

pub fn update_managed_thing(&self) -> UpdateManagedThingFluentBuilder

Constructs a fluent builder for the UpdateManagedThing operation.

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

    The id of the managed thing.

    
    
  • owner(impl Into<String>) / set_owner(Option<String>):
    required: false
    

    Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

    
    
  • credential_locker_id(impl Into<String>) / set_credential_locker_id(Option<String>):
    required: false
    

    The identifier of the credential for the managed thing.

    
    
  • serial_number(impl Into<String>) / set_serial_number(Option<String>):
    required: false
    

    The serial number of the device.

    
    
  • brand(impl Into<String>) / set_brand(Option<String>):
    required: false
    

    The brand of the device.

    
    
  • model(impl Into<String>) / set_model(Option<String>):
    required: false
    

    The model of the device.

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

    The name of the managed thing representing the physical device.

    
    
  • capability_report(CapabilityReport) / set_capability_report(Option<CapabilityReport>):
    required: false
    

    A report of the capabilities for the managed thing.

    
    
  • capabilities(impl Into<String>) / set_capabilities(Option<String>):
    required: false
    

    The capabilities of the device such as light bulb.

    
    
  • classification(impl Into<String>) / set_classification(Option<String>):
    required: false
    

    The classification of the managed thing such as light bulb or thermostat.

    
    
  • hub_network_mode(HubNetworkMode) / set_hub_network_mode(Option<HubNetworkMode>):
    required: false
    

    The network mode for the hub-connected device.

    
    
  • meta_data(impl Into<String>, impl Into<String>) / set_meta_data(Option<HashMap::<String, String>>):
    required: false
    

    The metadata for the managed thing.

    
    
• On success, responds with UpdateManagedThingOutput
• On failure, responds with SdkError<UpdateManagedThingError>

impl Client

pub fn update_notification_configuration( &self, ) -> UpdateNotificationConfigurationFluentBuilder

Constructs a fluent builder for the UpdateNotificationConfiguration operation.

• The fluent builder is configurable:
  • event_type(EventType) / set_event_type(Option<EventType>):
    required: true
    

    The type of event triggering a device notification to the customer-managed destination.

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

    The name of the destination for the notification configuration.

    
    
• On success, responds with UpdateNotificationConfigurationOutput
• On failure, responds with SdkError<UpdateNotificationConfigurationError>

impl Client

pub fn update_ota_task(&self) -> UpdateOtaTaskFluentBuilder

Constructs a fluent builder for the UpdateOtaTask operation.

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

    The over-the-air (OTA) task id.

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

    The description of the over-the-air (OTA) task.

    
    
  • task_configuration_id(impl Into<String>) / set_task_configuration_id(Option<String>):
    required: false
    

    The identifier for the over-the-air (OTA) task configuration.

    
    
• On success, responds with UpdateOtaTaskOutput
• On failure, responds with SdkError<UpdateOtaTaskError>

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.