UpdateResourceServer
Updates the name and scopes of resource server. All other fields are read-only.
Important
If you don't provide a value for an attribute, it is set to the default value.
Request Syntax
{
"Identifier": "string
",
"Name": "string
",
"Scopes": [
{
"ScopeDescription": "string
",
"ScopeName": "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.
- Identifier
-
The identifier for the resource server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\x21\x23-\x5B\x5D-\x7E]+
Required: Yes
- Name
-
The name of the resource server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\w\s+=,.@-]+
Required: Yes
- Scopes
-
The scope values to be set for the resource server.
Type: Array of ResourceServerScopeType objects
Array Members: Maximum number of 100 items.
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
{
"ResourceServer": {
"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.
- ResourceServer
-
The resource server.
Type: ResourceServerType object
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 isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't 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: