CognitoIdentityProvider / Client / describe_resource_server

describe_resource_server#

CognitoIdentityProvider.Client.describe_resource_server(**kwargs)#

Describes a resource server.

Request Syntax

response = client.describe_resource_server(
    UserPoolId='string',
    Identifier='string'
)

Parameters:

UserPoolId (string) –
[REQUIRED]

The user pool ID for the user pool that hosts the resource server.
Identifier (string) –
[REQUIRED]

The identifier for the resource server

Return type:

dict

Returns:

Response Syntax

{
    'ResourceServer': {
        'UserPoolId': 'string',
        'Identifier': 'string',
        'Name': 'string',
        'Scopes': [
            {
                'ScopeName': 'string',
                'ScopeDescription': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- ResourceServer (dict) –
  
  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.
    - (dict) –
      
      A resource server scope.
      - ScopeName (string) –
        
        The name of the scope.
      - ScopeDescription (string) –
        
        A description of the scope.

Exceptions

CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.InternalErrorException