GetIdentityPoolConfiguration
Gets the configuration settings of an identity pool.
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
GET /identitypools/IdentityPoolId
/configuration HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- IdentityPoolId
-
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.
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CognitoStreams": {
"DisabledReason": "string",
"RoleArn": "string",
"StreamingStatus": "string",
"StreamName": "string"
},
"IdentityPoolId": "string",
"PushSync": {
"ApplicationArns": [ "string" ],
"RoleArn": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CognitoStreams
-
Options to apply to this identity pool for Amazon Cognito streams.
Type: CognitoStreams object
- IdentityPoolId
-
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+
- PushSync
-
Options to apply to this identity pool for push synchronization.
Type: PushSync object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
Indicates an internal service error.
HTTP Status Code: 500
- InvalidParameterException
-
Thrown when a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- NotAuthorizedException
-
Thrown when a user is not authorized to access the requested resource.
HTTP Status Code: 403
- ResourceNotFoundException
-
Thrown if the resource doesn't exist.
HTTP Status Code: 404
- TooManyRequestsException
-
Thrown if the request is throttled.
HTTP Status Code: 429
Examples
GetIdentityPoolConfiguration
The following examples have been edited for readability.
Sample Request
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: b1cfdd4b-f620-4fe4-be0f-02024a1d33da
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.GetIdentityPoolConfiguration
HOST: cognito-sync.us-east-1.amazonaws.com
X-AMZ-DATE: 20141004T195722Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
{
"IdentityPoolId": "ID_POOL_ID"
}
Sample Response
1.1 200 OK
x-amzn-requestid: b1cfdd4b-f620-4fe4-be0f-02024a1d33da
date: Sat, 04 Oct 2014 19:57:22 GMT
content-type: application/json
content-length: 332
{
"IdentityPoolId": "ID_POOL_ID",
"PushSync":
{
"ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
"RoleArn": "ROLEARN"
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: