Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 is set to the default value.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Synopsis¶

  update-resource-server
--user-pool-id <value>
--identifier <value>
--name <value>
[--scopes <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--user-pool-id (string)

The ID of the user pool.

--identifier (string)

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data . You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope . Longer scope-identifier strings increase the size of your access tokens.

--name (string)

The name of the resource server.

--scopes (list)

The scope values to be set for the resource server.

(structure)

One custom scope associated with a user pool resource server. This data type is a member of ResourceServerScopeType . For more information, see Scopes, M2M, and API authorization with resource servers .

This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer .

ScopeName -> (string)

The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .

ScopeDescription -> (string)

A friendly description of a custom scope.

Shorthand Syntax:

ScopeName=string,ScopeDescription=string ...

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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 ID of the user pool that contains the resource server configuration.

Identifier -> (string)

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data . You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope . Longer scope-identifier strings increase the size of your access tokens.

Name -> (string)

The name of the resource server.

Scopes -> (list)

A list of scopes that are defined for the resource server.

(structure)

One custom scope associated with a user pool resource server. This data type is a member of ResourceServerScopeType . For more information, see Scopes, M2M, and API authorization with resource servers .

This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer .

ScopeName -> (string)

The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .

ScopeDescription -> (string)

A friendly description of a custom scope.

Table Of Contents

Feedback

User Guide

Note:

update-resource-server¶

Description¶

Warning

Note

Synopsis¶

Options¶

Global Options¶

Examples¶

Note

Output¶