[ aws . cognito-idp ]
Describes a resource server.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-resource-server
--user-pool-id <value>
--identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--user-pool-id
(string)
The user pool ID for the user pool that hosts the resource server.
--identifier
(string)
The identifier for the resource server
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe a resource server
This example describes the resource server weather.example.com.
Command:
aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com
Output:
{
"ResourceServer": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"Identifier": "weather.example.com",
"Name": "Weather",
"Scopes": [
{
"ScopeName": "weather.update",
"ScopeDescription": "Update weather forecast"
},
{
"ScopeName": "weather.read",
"ScopeDescription": "Read weather forecasts"
},
{
"ScopeName": "weather.delete",
"ScopeDescription": "Delete a weather forecast"
}
]
}
}
ResourceServer -> (structure)
The resource server.
UserPoolId -> (string)
The user pool ID for the user pool that hosts the resource server.
Identifier -> (string)
The identifier for the resource server.
Name -> (string)
The name of the resource server.
Scopes -> (list)
A list of scopes that are defined for the resource server.
(structure)
A resource server scope.
ScopeName -> (string)
The name of the scope.
ScopeDescription -> (string)
A description of the scope.