Struct rusoto_cognito_sync::CognitoSyncClient

pub struct CognitoSyncClient { /* fields omitted */ }

A client for the Amazon Cognito Sync API.

Implementations

impl CognitoSyncClient

pub fn new(region: Region) -> CognitoSyncClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> CognitoSyncClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> CognitoSyncClient

Trait Implementations

impl Clone for CognitoSyncClient

pub fn clone(&self) -> CognitoSyncClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CognitoSync for CognitoSyncClient

pub fn bulk_publish<'life0, 'async_trait>(
    &'life0 self,
    input: BulkPublishRequest
) -> Pin<Box<dyn Future<Output = Result<BulkPublishResponse, RusotoError<BulkPublishError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

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

pub fn delete_dataset<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteDatasetRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteDatasetResponse, RusotoError<DeleteDatasetError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

pub fn describe_dataset<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeDatasetRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeDatasetResponse, RusotoError<DescribeDatasetError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

pub fn describe_identity_pool_usage<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeIdentityPoolUsageRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeIdentityPoolUsageResponse, RusotoError<DescribeIdentityPoolUsageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets usage details (for example, data storage) about a particular identity pool.

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

pub fn describe_identity_usage<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeIdentityUsageRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeIdentityUsageResponse, RusotoError<DescribeIdentityUsageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

pub fn get_bulk_publish_details<'life0, 'async_trait>(
    &'life0 self,
    input: GetBulkPublishDetailsRequest
) -> Pin<Box<dyn Future<Output = Result<GetBulkPublishDetailsResponse, RusotoError<GetBulkPublishDetailsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the status of the last BulkPublish operation for an identity pool.

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

pub fn get_cognito_events<'life0, 'async_trait>(
    &'life0 self,
    input: GetCognitoEventsRequest
) -> Pin<Box<dyn Future<Output = Result<GetCognitoEventsResponse, RusotoError<GetCognitoEventsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets the events and the corresponding Lambda functions associated with an identity pool.

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

pub fn get_identity_pool_configuration<'life0, 'async_trait>(
    &'life0 self,
    input: GetIdentityPoolConfigurationRequest
) -> Pin<Box<dyn Future<Output = Result<GetIdentityPoolConfigurationResponse, RusotoError<GetIdentityPoolConfigurationError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets the configuration settings of an identity pool.

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

pub fn list_datasets<'life0, 'async_trait>(
    &'life0 self,
    input: ListDatasetsRequest
) -> Pin<Box<dyn Future<Output = Result<ListDatasetsResponse, RusotoError<ListDatasetsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

pub fn list_identity_pool_usage<'life0, 'async_trait>(
    &'life0 self,
    input: ListIdentityPoolUsageRequest
) -> Pin<Box<dyn Future<Output = Result<ListIdentityPoolUsageResponse, RusotoError<ListIdentityPoolUsageError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

pub fn list_records<'life0, 'async_trait>(
    &'life0 self,
    input: ListRecordsRequest
) -> Pin<Box<dyn Future<Output = Result<ListRecordsResponse, RusotoError<ListRecordsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

pub fn register_device<'life0, 'async_trait>(
    &'life0 self,
    input: RegisterDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<RegisterDeviceResponse, RusotoError<RegisterDeviceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn set_cognito_events<'life0, 'async_trait>(
    &'life0 self,
    input: SetCognitoEventsRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<SetCognitoEventsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

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

pub fn set_identity_pool_configuration<'life0, 'async_trait>(
    &'life0 self,
    input: SetIdentityPoolConfigurationRequest
) -> Pin<Box<dyn Future<Output = Result<SetIdentityPoolConfigurationResponse, RusotoError<SetIdentityPoolConfigurationError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sets the necessary configuration for push sync.

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

pub fn subscribe_to_dataset<'life0, 'async_trait>(
    &'life0 self,
    input: SubscribeToDatasetRequest
) -> Pin<Box<dyn Future<Output = Result<SubscribeToDatasetResponse, RusotoError<SubscribeToDatasetError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Subscribes to receive notifications when a dataset is modified by another device.

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

pub fn unsubscribe_from_dataset<'life0, 'async_trait>(
    &'life0 self,
    input: UnsubscribeFromDatasetRequest
) -> Pin<Box<dyn Future<Output = Result<UnsubscribeFromDatasetResponse, RusotoError<UnsubscribeFromDatasetError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Unsubscribes from receiving notifications when a dataset is modified by another device.

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

pub fn update_records<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateRecordsRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateRecordsResponse, RusotoError<UpdateRecordsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.