Actions, resources, and condition keys for Amazon Cognito Sync
Amazon Cognito Sync (service prefix: cognito-sync) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Cognito Sync
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
BulkPublish |
Write |
|||
|
DeleteDataset |
Write |
|||
|
DescribeDataset |
Read |
|||
|
DescribeIdentityPoolUsage |
Read |
|||
|
DescribeIdentityUsage |
Read |
|||
|
GetBulkPublishDetails |
Read |
|||
|
GetCognitoEvents |
Read |
|||
|
GetIdentityPoolConfiguration |
Read |
|||
|
ListDatasets |
List |
|||
|
ListIdentityPoolUsage |
Read |
|||
|
ListRecords |
Read |
|||
|
RegisterDevice |
Write |
|||
|
SetCognitoEvents |
Write |
|||
|
SetIdentityPoolConfiguration |
Write |
|||
Write |
||||
|
SubscribeToDataset |
Write |
|||
|
UnsubscribeFromDataset |
Write |
|||
|
UpdateRecords |
Write |
Actions defined by Amazon Cognito Sync
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in AWS. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to initiate a bulk publish of all existing datasets for an Identity Pool to the configured stream |
Write |
|||
Grants permission to delete a specific dataset |
Write |
|||
Grants permission to get metadata about a dataset by identity and dataset name |
Read |
|||
Grants permission to get usage details (for example, data storage) about a particular identity pool |
Read |
|||
Grants permission to get usage information for an identity, including number of datasets and data usage |
Read |
|||
Grants permission to get the status of the last BulkPublish operation for an identity pool |
Read |
|||
Grants permission to get the events and the corresponding Lambda functions associated with an identity pool |
Read |
|||
Grants permission to get the configuration settings of an identity pool |
Read |
|||
Grants permission to list datasets for an identity |
List |
|||
Grants permission to get a list of identity pools registered with Cognito |
Read |
|||
Grants permission to get paginated records, optionally changed after a particular sync count for a dataset and identity |
Read |
|||
Grants permission to register a device to receive push sync notifications |
Write |
|||
Grants permission to set the AWS Lambda function for a given event type for an identity pool |
Write |
|||
Grants permission to set the necessary configuration for push sync |
Write |
|||
Grants permission to subscribe to receive notifications when a dataset is modified by another device |
Write |
|||
Grants permission to unsubscribe from receiving notifications when a dataset is modified by another device |
Write |
|||
Grants permission to post updates to records and add and delete records for a dataset and user |
Write |
Permission-only actions for Amazon Cognito Sync
The following actions are defined by Amazon Cognito Sync but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
|
QueryRecords |
Grants permission to query records |
Read |
||
|
SetDatasetConfiguration |
Grants permission to configure datasets |
Write |
Resource types defined by Amazon Cognito Sync
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:cognito-sync:${Region}:${Account}:identitypool/${IdentityPoolId}/identity/${IdentityId}/dataset/${DatasetName} |
||
arn:${Partition}:cognito-sync:${Region}:${Account}:identitypool/${IdentityPoolId}/identity/${IdentityId} |
||
arn:${Partition}:cognito-sync:${Region}:${Account}:identitypool/${IdentityPoolId} |
Condition keys for Amazon Cognito Sync
Amazon Cognito Sync has no service-specific condition keys that can be used in the
Condition element of policy statements.
