ListResourceServers
Lists the resource servers for a user pool.
Request Syntax
{ "MaxResults":number, "NextToken": "string", "UserPoolId": "string" }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of resource servers to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
A pagination token.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+Required: No
- UserPoolId
-
The user pool ID for the user pool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+Required: Yes
Response Syntax
{ "NextToken": "string", "ResourceServers": [ { "Identifier": "string", "Name": "string", "Scopes": [ { "ScopeDescription": "string", "ScopeName": "string" } ], "UserPoolId": "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.
- NextToken
-
A pagination token.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+ - ResourceServers
-
The resource servers.
Type: Array of ResourceServerType objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
