SetCognitoEvents - Amazon Cognito Sync


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.

Request Syntax

POST /identitypools/IdentityPoolId/events HTTP/1.1 Content-type: application/json { "Events": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.


The Cognito Identity Pool to use when configuring Cognito Events

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.


The AWS Lambda Amazon Resource Name (ARN) that you want to set as your Cognito Events trigger. For example, "SyncTrigger" : "arn:aws:lambda:us-east-1:123456789012:function:my-function".

Type: String to string map

Map Entries: Maximum number of 1 item.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


Indicates an internal service error.

HTTP Status Code: 500


Thrown when a request parameter does not comply with the associated constraints.

HTTP Status Code: 400


Thrown when a user is not authorized to access the requested resource.

HTTP Status Code: 403


Thrown if the resource doesn't exist.

HTTP Status Code: 404


Thrown if the request is throttled.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: