Struct aws_sdk_cognitosync::client::fluent_builders::RegisterDevice

pub struct RegisterDevice<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to RegisterDevice.

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

RegisterDevice The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 368f9200-3eca-449e-93b3-7b9c08d8e185 X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.RegisterDevice HOST: cognito-sync.us-east-1.amazonaws.com X-AMZ-DATE: 20141004T194643Z X-AMZ-SECURITY-TOKEN: AUTHORIZATION: AWS4-HMAC-SHA256 Credential= , SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature= { "Operation": "com.amazonaws.cognito.sync.model#RegisterDevice", "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { "IdentityPoolId": "ID_POOL_ID", "IdentityId": "IDENTITY_ID", "Platform": "GCM", "Token": "PUSH_TOKEN" } } 1.1 200 OK x-amzn-requestid: 368f9200-3eca-449e-93b3-7b9c08d8e185 date: Sat, 04 Oct 2014 19:46:44 GMT content-type: application/json content-length: 145 { "Output": { "__type": "com.amazonaws.cognito.sync.model#RegisterDeviceResponse", "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014" }, "Version": "1.0" }

Implementations

impl<C, M, R> RegisterDevice<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<RegisterDeviceOutput, SdkError<RegisterDeviceError>> where
    R::Policy: SmithyRetryPolicy<RegisterDeviceInputOperationOutputAlias, RegisterDeviceOutput, RegisterDeviceError, RegisterDeviceInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn identity_pool_id(self, input: impl Into<String>) -> Self

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.

pub fn set_identity_pool_id(self, input: Option<String>) -> Self

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.

pub fn identity_id(self, input: impl Into<String>) -> Self

The unique ID for this identity.

pub fn set_identity_id(self, input: Option<String>) -> Self

The unique ID for this identity.

pub fn platform(self, input: Platform) -> Self

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

pub fn set_platform(self, input: Option<Platform>) -> Self

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

pub fn token(self, input: impl Into<String>) -> Self

The push token.

pub fn set_token(self, input: Option<String>) -> Self

The push token.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for RegisterDevice<C, M, R>

fn clone(&self) -> RegisterDevice<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for RegisterDevice<C, M, R>

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

Formats the value using the given formatter.