You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoSync::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Cognito Sync. To construct a client, you need to configure a :region and :credentials.

cognitosync = Aws::CognitoSync::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::CognitoSync::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::CognitoSync::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#bulk_publish(options = {}) ⇒ Types::BulkPublishResponse

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.

Examples:

Request syntax with placeholder values


resp = client.bulk_publish({
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.identity_pool_id #=> String

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

See Also:

#delete_dataset(options = {}) ⇒ Types::DeleteDatasetResponse

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.

Examples:

Request syntax with placeholder values


resp = client.delete_dataset({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
})

Response structure


resp.dataset.identity_id #=> String
resp.dataset.dataset_name #=> String
resp.dataset.creation_date #=> Time
resp.dataset.last_modified_date #=> Time
resp.dataset.last_modified_by #=> String
resp.dataset.data_storage #=> Integer
resp.dataset.num_records #=> Integer

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :identity_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :dataset_name (required, String)

    A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, \'_\' (underscore), \'-\' (dash), and \'.\' (dot).

Returns:

See Also:

#describe_dataset(options = {}) ⇒ Types::DescribeDatasetResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_dataset({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
})

Response structure


resp.dataset.identity_id #=> String
resp.dataset.dataset_name #=> String
resp.dataset.creation_date #=> Time
resp.dataset.last_modified_date #=> Time
resp.dataset.last_modified_by #=> String
resp.dataset.data_storage #=> Integer
resp.dataset.num_records #=> Integer

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :identity_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :dataset_name (required, String)

    A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, \'_\' (underscore), \'-\' (dash), and \'.\' (dot).

Returns:

See Also:

#describe_identity_pool_usage(options = {}) ⇒ Types::DescribeIdentityPoolUsageResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_identity_pool_usage({
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.identity_pool_usage.identity_pool_id #=> String
resp.identity_pool_usage.sync_sessions_count #=> Integer
resp.identity_pool_usage.data_storage #=> Integer
resp.identity_pool_usage.last_modified_date #=> Time

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

See Also:

#describe_identity_usage(options = {}) ⇒ Types::DescribeIdentityUsageResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_identity_usage({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
})

Response structure


resp.identity_usage.identity_id #=> String
resp.identity_usage.identity_pool_id #=> String
resp.identity_usage.last_modified_date #=> Time
resp.identity_usage.dataset_count #=> Integer
resp.identity_usage.data_storage #=> Integer

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :identity_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

See Also:

#get_bulk_publish_details(options = {}) ⇒ Types::GetBulkPublishDetailsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_bulk_publish_details({
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.identity_pool_id #=> String
resp.bulk_publish_start_time #=> Time
resp.bulk_publish_complete_time #=> Time
resp.bulk_publish_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "SUCCEEDED"
resp.failure_message #=> String

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

See Also:

#get_cognito_events(options = {}) ⇒ Types::GetCognitoEventsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_cognito_events({
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.events #=> Hash
resp.events["CognitoEventType"] #=> String

Options Hash (options):

  • :identity_pool_id (required, String)

    The Cognito Identity Pool ID for the request

Returns:

See Also:

#get_identity_pool_configuration(options = {}) ⇒ Types::GetIdentityPoolConfigurationResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_identity_pool_configuration({
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.identity_pool_id #=> String
resp.push_sync.application_arns #=> Array
resp.push_sync.application_arns[0] #=> String
resp.push_sync.role_arn #=> String
resp.cognito_streams.stream_name #=> String
resp.cognito_streams.role_arn #=> String
resp.cognito_streams.streaming_status #=> String, one of "ENABLED", "DISABLED"

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.

Returns:

See Also:

#list_datasets(options = {}) ⇒ Types::ListDatasetsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.list_datasets({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.datasets #=> Array
resp.datasets[0].identity_id #=> String
resp.datasets[0].dataset_name #=> String
resp.datasets[0].creation_date #=> Time
resp.datasets[0].last_modified_date #=> Time
resp.datasets[0].last_modified_by #=> String
resp.datasets[0].data_storage #=> Integer
resp.datasets[0].num_records #=> Integer
resp.count #=> Integer
resp.next_token #=> String

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :identity_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :next_token (String)

    A pagination token for obtaining the next page of results.

  • :max_results (Integer)

    The maximum number of results to be returned.

Returns:

See Also:

#list_identity_pool_usage(options = {}) ⇒ Types::ListIdentityPoolUsageResponse

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.

Examples:

Request syntax with placeholder values


resp = client.list_identity_pool_usage({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.identity_pool_usages #=> Array
resp.identity_pool_usages[0].identity_pool_id #=> String
resp.identity_pool_usages[0].sync_sessions_count #=> Integer
resp.identity_pool_usages[0].data_storage #=> Integer
resp.identity_pool_usages[0].last_modified_date #=> Time
resp.max_results #=> Integer
resp.count #=> Integer
resp.next_token #=> String

Options Hash (options):

  • :next_token (String)

    A pagination token for obtaining the next page of results.

  • :max_results (Integer)

    The maximum number of results to be returned.

Returns:

See Also:

#list_records(options = {}) ⇒ Types::ListRecordsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.list_records({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
  last_sync_count: 1,
  next_token: "String",
  max_results: 1,
  sync_session_token: "SyncSessionToken",
})

Response structure


resp.records #=> Array
resp.records[0].key #=> String
resp.records[0].value #=> String
resp.records[0].sync_count #=> Integer
resp.records[0].last_modified_date #=> Time
resp.records[0].last_modified_by #=> String
resp.records[0].device_last_modified_date #=> Time
resp.next_token #=> String
resp.count #=> Integer
resp.dataset_sync_count #=> Integer
resp.last_modified_by #=> String
resp.merged_dataset_names #=> Array
resp.merged_dataset_names[0] #=> String
resp.dataset_exists #=> true/false
resp.dataset_deleted_after_requested_sync_count #=> true/false
resp.sync_session_token #=> String

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :identity_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :dataset_name (required, String)

    A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, \'_\' (underscore), \'-\' (dash), and \'.\' (dot).

  • :last_sync_count (Integer)

    The last server sync count for this record.

  • :next_token (String)

    A pagination token for obtaining the next page of results.

  • :max_results (Integer)

    The maximum number of results to be returned.

  • :sync_session_token (String)

    A token containing a session ID, identity ID, and expiration.

Returns:

See Also:

#register_device(options = {}) ⇒ Types::RegisterDeviceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.register_device({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  platform: "APNS", # required, accepts APNS, APNS_SANDBOX, GCM, ADM
  token: "PushToken", # required
})

Response structure


resp.device_id #=> String

Options Hash (options):

  • :identity_pool_id (required, String)

    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.

  • :identity_id (required, String)

    The unique ID for this identity.

  • :platform (required, String)

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

  • :token (required, String)

    The push token.

Returns:

See Also:

#set_cognito_events(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.set_cognito_events({
  identity_pool_id: "IdentityPoolId", # required
  events: { # required
    "CognitoEventType" => "LambdaFunctionArn",
  },
})

Options Hash (options):

  • :identity_pool_id (required, String)

    The Cognito Identity Pool to use when configuring Cognito Events

  • :events (required, Hash<String,String>)

    The events to configure

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#set_identity_pool_configuration(options = {}) ⇒ Types::SetIdentityPoolConfigurationResponse

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.

Examples:

Request syntax with placeholder values


resp = client.set_identity_pool_configuration({
  identity_pool_id: "IdentityPoolId", # required
  push_sync: {
    application_arns: ["ApplicationArn"],
    role_arn: "AssumeRoleArn",
  },
  cognito_streams: {
    stream_name: "StreamName",
    role_arn: "AssumeRoleArn",
    streaming_status: "ENABLED", # accepts ENABLED, DISABLED
  },
})

Response structure


resp.identity_pool_id #=> String
resp.push_sync.application_arns #=> Array
resp.push_sync.application_arns[0] #=> String
resp.push_sync.role_arn #=> String
resp.cognito_streams.stream_name #=> String
resp.cognito_streams.role_arn #=> String
resp.cognito_streams.streaming_status #=> String, one of "ENABLED", "DISABLED"

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.

  • :push_sync (Types::PushSync)

    Options to apply to this identity pool for push synchronization.

  • :cognito_streams (Types::CognitoStreams)

    Options to apply to this identity pool for Amazon Cognito streams.

Returns:

See Also:

#subscribe_to_dataset(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.subscribe_to_dataset({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
  device_id: "DeviceId", # required
})

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.

  • :identity_id (required, String)

    Unique ID for this identity.

  • :dataset_name (required, String)

    The name of the dataset to subcribe to.

  • :device_id (required, String)

    The unique ID generated for this device by Cognito.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#unsubscribe_from_dataset(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.unsubscribe_from_dataset({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
  device_id: "DeviceId", # required
})

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.

  • :identity_id (required, String)

    Unique ID for this identity.

  • :dataset_name (required, String)

    The name of the dataset from which to unsubcribe.

  • :device_id (required, String)

    The unique ID generated for this device by Cognito.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_records(options = {}) ⇒ Types::UpdateRecordsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_records({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
  device_id: "DeviceId",
  record_patches: [
    {
      op: "replace", # required, accepts replace, remove
      key: "RecordKey", # required
      value: "RecordValue",
      sync_count: 1, # required
      device_last_modified_date: Time.now,
    },
  ],
  sync_session_token: "SyncSessionToken", # required
  client_context: "ClientContext",
})

Response structure


resp.records #=> Array
resp.records[0].key #=> String
resp.records[0].value #=> String
resp.records[0].sync_count #=> Integer
resp.records[0].last_modified_date #=> Time
resp.records[0].last_modified_by #=> String
resp.records[0].device_last_modified_date #=> Time

Options Hash (options):

  • :identity_pool_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :identity_id (required, String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

  • :dataset_name (required, String)

    A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, \'_\' (underscore), \'-\' (dash), and \'.\' (dot).

  • :device_id (String)

    The unique ID generated for this device by Cognito.

  • :record_patches (Array<Types::RecordPatch>)

    A list of patch operations.

  • :sync_session_token (required, String)

    The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

  • :client_context (String)

    Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.