[ aws . cognito-idp ]

update-resource-server

Description

Updates the name and scopes of resource server. All other fields are read-only.

Warning

If you don’t provide a value for an attribute, it will be set to the default value.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-resource-server
--user-pool-id <value>
--identifier <value>
--name <value>
[--scopes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID for the user pool.

--identifier (string)

The identifier for the resource server.

--name (string)

The name of the resource server.

--scopes (list)

The scope values to be set for the resource server.

(structure)

A resource server scope.

ScopeName -> (string)

The name of the scope.

ScopeDescription -> (string)

A description of the scope.

Shorthand Syntax:

ScopeName=string,ScopeDescription=string ...

JSON Syntax:

[
  {
    "ScopeName": "string",
    "ScopeDescription": "string"
  }
  ...
]

--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.

Examples

To update a resource server

This example updates the the resource server Weather. It adds a new scope.

Command:

aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description"

Output:

{
  "ResourceServer": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Identifier": "weather.example.com",
      "Name": "Happy",
      "Scopes": [
          {
              "ScopeName": "NewScope",
              "ScopeDescription": "New scope description"
          }
      ]
  }
}

Output

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.