aws_sdk_iotmanagedintegrations/client/
start_device_discovery.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StartDeviceDiscovery`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`discovery_type(DiscoveryType)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::discovery_type) / [`set_discovery_type(Option<DiscoveryType>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::set_discovery_type):<br>required: **true**<br><p>The discovery type supporting the type of device to be discovered in the device discovery job request.</p><br>
7    ///   - [`controller_identifier(impl Into<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::controller_identifier) / [`set_controller_identifier(Option<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::set_controller_identifier):<br>required: **false**<br><p>The id of the end-user's IoT hub.</p><br>
8    ///   - [`connector_association_identifier(impl Into<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::connector_association_identifier) / [`set_connector_association_identifier(Option<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::set_connector_association_identifier):<br>required: **false**<br><p>The id of the connector association.</p><br>
9    ///   - [`authentication_material(impl Into<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::authentication_material) / [`set_authentication_material(Option<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::set_authentication_material):<br>required: **false**<br><p>The authentication material required to start the local device discovery job request.</p><br>
10    ///   - [`authentication_material_type(DiscoveryAuthMaterialType)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::authentication_material_type) / [`set_authentication_material_type(Option<DiscoveryAuthMaterialType>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::set_authentication_material_type):<br>required: **false**<br><p>The type of authentication material used for device discovery jobs.</p><br>
11    ///   - [`client_token(impl Into<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::set_client_token):<br>required: **false**<br><p>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.</p><br>
12    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::set_tags):<br>required: **false**<br><p>A set of key/value pairs that are used to manage the device discovery request.</p><br>
13    /// - On success, responds with [`StartDeviceDiscoveryOutput`](crate::operation::start_device_discovery::StartDeviceDiscoveryOutput) with field(s):
14    ///   - [`id(Option<String>)`](crate::operation::start_device_discovery::StartDeviceDiscoveryOutput::id): <p>The id of the device discovery job request.</p>
15    ///   - [`started_at(Option<DateTime>)`](crate::operation::start_device_discovery::StartDeviceDiscoveryOutput::started_at): <p>The timestamp value for the start time of the device discovery.</p>
16    /// - On failure, responds with [`SdkError<StartDeviceDiscoveryError>`](crate::operation::start_device_discovery::StartDeviceDiscoveryError)
17    pub fn start_device_discovery(&self) -> crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder {
18        crate::operation::start_device_discovery::builders::StartDeviceDiscoveryFluentBuilder::new(self.handle.clone())
19    }
20}