|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/cognito/sync/__pycache__/ |
Upload File : |
o
ckF[�R � @ sP d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z G dd� de�Z
dS ) � )�json)�JSONResponseError)�AWSAuthConnection)�
RegionInfo)�
exceptionsc s� e Zd ZdZdZdZdZeZe j
e j e j e j
e je je je jd�Z� fdd�Zdd � Zd
d � Zd d
� Zdd� Zdd� Zdd� Z d(dd�Zd(dd�Z d)dd�Z dd � Z d*d d �Z d d � Z d!d"� Z d+d#d$�Z! % d,d&d'�Z"� Z#S )-�CognitoSyncConnectiona�
Amazon Cognito Sync
Amazon Cognito Sync provides an AWS service and client library
that enable cross-device syncing of application-related user data.
High-level client libraries are available for both iOS and
Android. You can use these libraries to persist data locally so
that it's available even if the device is offline. Developer
credentials don't need to be stored on the mobile device to access
the service. You can use Amazon Cognito to obtain a normalized
user ID and credentials. User data is persisted in a dataset that
can store up to 1 MB of key-value pairs, and you can have up to 20
datasets per user identity.
With Amazon Cognito Sync, the data stored for each identity is
accessible only to credentials assigned to that identity. In order
to use the Cognito Sync service, you need to make API calls using
credentials retrieved with `Amazon Cognito Identity service`_.
z
2014-06-30z us-east-1z$cognito-sync.us-east-1.amazonaws.com)�LimitExceededException�ResourceConflictException� InvalidConfigurationException�TooManyRequestsException�InvalidParameterException�ResourceNotFoundException�InternalErrorException�NotAuthorizedExceptionc sP |� d�}|st| | j| j�}n|d= |j|d< tt| �jdi |�� || _d S )N�region�host� ) �getr �DefaultRegionName�DefaultRegionEndpoint�endpoint�superr �__init__r )�self�kwargsr �� __class__r �:/usr/lib/python3/dist-packages/boto/cognito/sync/layer1.pyr A s
�
z CognitoSyncConnection.__init__c C s dgS )Nzhmac-v4r )r r r r �_required_auth_capabilityL s z/CognitoSyncConnection._required_auth_capabilityc C � d� |||�}| jd|dd�S )a�
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 consequent operation on this dataset will result in a
ResourceNotFoundException.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: 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.
:type dataset_name: string
:param dataset_name: A string of up to 128 characters. Allowed
characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
(dot).
�./identitypools/{0}/identities/{1}/datasets/{2}�DELETE�� ��expected_status��format� make_request�r �identity_pool_id� identity_id� dataset_name�urir r r �delete_datasetO s �z$CognitoSyncConnection.delete_datasetc C r )a6
Gets metadata about a dataset by identity and dataset name.
The credentials used to make this API call need to have access
to the identity data. With Amazon Cognito Sync, each identity
has access only to its own data. You should use Amazon Cognito
Identity service to retrieve the credentials necessary to make
this API call.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: 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.
:type dataset_name: string
:param dataset_name: A string of up to 128 characters. Allowed
characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
(dot).
r �GETr" r# r% r( r r r �describe_datasetl s �z&CognitoSyncConnection.describe_datasetc C � d� |�}| jd|dd�S )ad
Gets usage details (for example, data storage) about a
particular identity pool.
:type identity_pool_id: string
:param identity_pool_id: 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.
z/identitypools/{0}r. r" r# r% �r r) r, r r r � describe_identity_pool_usage� �
z2CognitoSyncConnection.describe_identity_pool_usagec C s d� ||�}| jd|dd�S )aW
Gets usage information for an identity, including number of
datasets and data usage.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: 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.
z!/identitypools/{0}/identities/{1}r. r" r# r% )r r) r* r, r r r �describe_identity_usage� s �z-CognitoSyncConnection.describe_identity_usagec C r0 )aa
Gets the configuration settings of an identity pool.
:type identity_pool_id: string
:param identity_pool_id: 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.
� /identitypools/{0}/configurationr. r" r# r% r1 r r r � get_identity_pool_configuration� r3 z5CognitoSyncConnection.get_identity_pool_configurationNc C sT d� ||�}i }i }i }|dur||d< |dur ||d< | jd|dt�|�||d�S )a6
Lists datasets for an identity. The credentials used to make
this API call need to have access to the identity data. With
Amazon Cognito Sync, each identity has access only to its own
data. You should use Amazon Cognito Identity service to
retrieve the credentials necessary to make this API call.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: 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.
:type next_token: string
:param next_token: A pagination token for obtaining the next page of
results.
:type max_results: integer
:param max_results: The maximum number of results to be returned.
z*/identitypools/{0}/identities/{1}/datasetsN� nextToken�
maxResultsr. r" �r$ �data�headers�params�r& r' r �dumps) r r) r* �
next_token� max_resultsr, r< r; � query_paramsr r r �
list_datasets� s �
�z#CognitoSyncConnection.list_datasetsc C sL d}i }i }i }|dur||d< |dur||d< | j d|dt�|�||d�S )a;
Gets a list of identity pools registered with Cognito.
:type next_token: string
:param next_token: A pagination token for obtaining the next page of
results.
:type max_results: integer
:param max_results: The maximum number of results to be returned.
z/identitypoolsNr7 r8 r. r" r9 )r' r r> )r r? r@ r, r< r; rA r r r �list_identity_pool_usage� s
�z.CognitoSyncConnection.list_identity_pool_usagec C sv d� |||�}i } i }
i } |dur|| d< |dur || d< |dur%|| d< |dur-|| d< | jd|dt�| �|
| d �S )
aY
Gets paginated records, optionally changed after a particular
sync count for a dataset and identity. The credentials used to
make this API call need to have access to the identity data.
With Amazon Cognito Sync, each identity has access only to its
own data. You should use Amazon Cognito Identity service to
retrieve the credentials necessary to make this API call.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: 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.
:type dataset_name: string
:param dataset_name: A string of up to 128 characters. Allowed
characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
(dot).
:type last_sync_count: long
:param last_sync_count: The last server sync count for this record.
:type next_token: string
:param next_token: A pagination token for obtaining the next page of
results.
:type max_results: integer
:param max_results: The maximum number of results to be returned.
:type sync_session_token: string
:param sync_session_token: A token containing a session ID, identity
ID, and expiration.
z6/identitypools/{0}/identities/{1}/datasets/{2}/recordsN�
lastSyncCountr7 r8 �syncSessionTokenr. r" r9 r= ) r r) r* r+ �last_sync_countr? r@ �sync_session_tokenr, r< r; rA r r r � list_records� s$ *�
�z"CognitoSyncConnection.list_recordsc C s: d� ||�}||d�}i }i }| jd|dt�|�||d�S )aq
Registers a device to receive push sync notifications.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: The unique ID for this identity.
:type platform: string
:param platform: The SNS platform type (e.g. GCM, SDM, APNS,
APNS_SANDBOX).
:type token: string
:param token: The push token.
z&/identitypools/{0}/identity/{1}/device)�Platform�Token�POSTr" r9 r= ) r r) r* �platform�tokenr, r< r; rA r r r �register_device: s �
�z%CognitoSyncConnection.register_devicec C sB d� |�}i }i }i }|dur||d< | jd|dt�|�||d�S )a�
Sets the necessary configuration for push sync.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type push_sync: dict
:param push_sync: Configuration options to be applied to the identity
pool.
r5 N�PushSyncrK r" r9 r= )r r) � push_syncr, r< r; rA r r r � set_identity_pool_configurationX s
�z5CognitoSyncConnection.set_identity_pool_configurationc C � d� ||||�}| jd|dd�S )a�
Subscribes to receive notifications when a dataset is modified
by another device.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: Unique ID for this identity.
:type dataset_name: string
:param dataset_name: The name of the dataset to subcribe to.
:type device_id: string
:param device_id: The unique ID generated for this device by Cognito.
�@/identitypools/{0}/identities/{1}/datasets/{2}/subscriptions/{3}rK r" r# r% �r r) r* r+ � device_idr, r r r �subscribe_to_datasetr � �z*CognitoSyncConnection.subscribe_to_datasetc C rR )a�
Unsubscribe from receiving notifications when a dataset is
modified by another device.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: Unique ID for this identity.
:type dataset_name: string
:param dataset_name: The name of the dataset from which to unsubcribe.
:type device_id: string
:param device_id: The unique ID generated for this device by Cognito.
rS r! r" r# r% rT r r r �unsubscribe_from_dataset� rW z.CognitoSyncConnection.unsubscribe_from_datasetc C sz d� |||�}d|i} i }
i } |dur|| d< |dur || d< |dur'||
d< |dur/||
d< | jd|dt�| �|
| d �S )
a�
Posts updates to records and add and delete records for a
dataset and user. The credentials used to make this API call
need to have access to the identity data. With Amazon Cognito
Sync, each identity has access only to its own data. You
should use Amazon Cognito Identity service to retrieve the
credentials necessary to make this API call.
:type identity_pool_id: string
:param identity_pool_id: 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.
:type identity_id: string
:param identity_id: 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.
:type dataset_name: string
:param dataset_name: A string of up to 128 characters. Allowed
characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
(dot).
:type device_id: string
:param device_id: The unique ID generated for this device by Cognito.
:type record_patches: list
:param record_patches: A list of patch operations.
:type sync_session_token: string
:param sync_session_token: The SyncSessionToken returned by a previous
call to ListRecords for this dataset and identity.
:type client_context: string
:param client_context: Intended to supply a device ID that will
populate the `lastModifiedBy` field referenced in other methods.
The `ClientContext` field is not yet implemented.
r �SyncSessionTokenN�DeviceId�
RecordPatcheszx-amz-Client-ContextrK r" r9 r= ) r r) r* r+ rG rU �record_patches�client_contextr, r< r; rA r r r �update_records� s$ +�
�z$CognitoSyncConnection.update_records� c C sx |d u ri }t j| |||||d�}t�|�� �d��}|j|kr"|S |�d��d�d } | j �
| | j �}
|
|j|j |��)N)r; r: r< zutf-8zx-amzn-ErrorType�:r )
r r' r �loads�read�decode�status� getheader�split�_faultsr �
ResponseError�reason) r �verb�resourcer; r: r$ r< �response�body�
error_type� error_classr r r r' � s �
z"CognitoSyncConnection.make_request)NN)NNNN)N)NNN)Nr_ NN)$�__name__�
__module__� __qualname__�__doc__�
APIVersionr r r rh r r r r
r r r
r r rg r r r- r/ r2 r4 r6 rB rC rH rN rQ rV rX r^ r' �
__classcell__r r r r r sP �
�
)
�;
�
�<�r N) � boto.compatr �boto.exceptionr �boto.connectionr �boto.regioninfor �boto.cognito.syncr r r r r r �<module> s