devices

Creates, updates, deletes, gets or lists a devices resource.

Overview

Name	devices
Type	Resource
Id	aws.cognito_sync.devices

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
register_device	insert	identity_pool_id, identity_id, region, Platform, Token		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identity_id	string	The unique ID for this identity.
identity_pool_id	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.
region	string	AWS region (default: us-east-1)

INSERT examples

register_device

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.

INSERT INTO aws.cognito_sync.devices (
Platform,
Token,
identity_pool_id,
identity_id,
region
)
SELECT 
'{{ Platform }}' /* required */,
'{{ Token }}' /* required */,
'{{ identity_pool_id }}',
'{{ identity_id }}',
'{{ region }}'
RETURNING
device_id
;

Manifest

# Description fields are for documentation purposes
- name: devices
props:
  - name: identity_pool_id
    value: "{{ identity_pool_id }}"
    description: Required parameter for the devices resource.
  - name: identity_id
    value: "{{ identity_id }}"
    description: Required parameter for the devices resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the devices resource.
  - name: Platform
    value: "{{ Platform }}"
    valid_values: ['APNS', 'APNS_SANDBOX', 'GCM', 'ADM']
  - name: Token
    value: "{{ Token }}"