POST

/identitypools/{IdentityPoolId}/configuration

http://cognito-sync.{region}.amazonaws.com/identitypools/{IdentityPoolId}/configuration

<p>Sets the necessary configuration for push sync.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>

Access Token Required: API Key

Path Parameters

IdentityPoolIdstringrequired

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.

Body Params

PushSyncobject

Configuration options to be applied to the identity pool.

CognitoStreamsobject

Configuration options for configure Cognito streams.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://cognito-sync.{region}.amazonaws.com/identitypools/{IdentityPoolId}/configuration' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}