aws_sdk_cognitosync/client/
register_device.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 [`RegisterDevice`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identity_pool_id(impl Into<String>)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::identity_pool_id) / [`set_identity_pool_id(Option<String>)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::set_identity_pool_id):<br>required: **true**<br><p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.</p><br>
7    ///   - [`identity_id(impl Into<String>)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::identity_id) / [`set_identity_id(Option<String>)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::set_identity_id):<br>required: **true**<br><p>The unique ID for this identity.</p><br>
8    ///   - [`platform(Platform)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::platform) / [`set_platform(Option<Platform>)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::set_platform):<br>required: **true**<br><p>The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).</p><br>
9    ///   - [`token(impl Into<String>)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::token) / [`set_token(Option<String>)`](crate::operation::register_device::builders::RegisterDeviceFluentBuilder::set_token):<br>required: **true**<br><p>The push token.</p><br>
10    /// - On success, responds with [`RegisterDeviceOutput`](crate::operation::register_device::RegisterDeviceOutput) with field(s):
11    ///   - [`device_id(Option<String>)`](crate::operation::register_device::RegisterDeviceOutput::device_id): <p>The unique ID generated for this device by Cognito.</p>
12    /// - On failure, responds with [`SdkError<RegisterDeviceError>`](crate::operation::register_device::RegisterDeviceError)
13    pub fn register_device(&self) -> crate::operation::register_device::builders::RegisterDeviceFluentBuilder {
14        crate::operation::register_device::builders::RegisterDeviceFluentBuilder::new(self.handle.clone())
15    }
16}