Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.UpdateResourceServer API

openapi: 3.2.0
info:
  version: '2016-04-18'
  x-release: v4
  title: 'Amazon Cognito Identity Provider #X Amz…'
  description: With the Amazon Cognito user pools API, you can set up user pools and app clients, and authenticate users.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: cognito-idp
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-idp-2016-04-18.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://cognito-idp.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity Provider multi-region endpoint
- url: https://cognito-idp.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity Provider multi-region endpoint
- url: http://cognito-idp.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity Provider endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-idp.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity Provider endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.UpdateResourceServer'
paths:
  /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateResourceServer:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: UpdateResourceServer
      description: 'Updates the name and scopes of resource server. All other fields are read-only.


        If you don''t provide a value for an attribute, it is set to the default value.


        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


        Signing Amazon Web Services API Requests


        Using the Amazon Cognito user pools API and user pool endpoints'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateResourceServerResponse'
              examples:
                UpdateResourceServer200Example:
                  summary: Default UpdateResourceServer 200 response
                  x-microcks-default: true
                  value:
                    ResourceServer: example
        '480':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
              examples:
                UpdateResourceServer480Example:
                  summary: Default UpdateResourceServer 480 response
                  x-microcks-default: true
                  value: example
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                UpdateResourceServer481Example:
                  summary: Default UpdateResourceServer 481 response
                  x-microcks-default: true
                  value: example
        '482':
          description: NotAuthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
              examples:
                UpdateResourceServer482Example:
                  summary: Default UpdateResourceServer 482 response
                  x-microcks-default: true
                  value: example
        '483':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                UpdateResourceServer483Example:
                  summary: Default UpdateResourceServer 483 response
                  x-microcks-default: true
                  value: example
        '484':
          description: InternalErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
              examples:
                UpdateResourceServer484Example:
                  summary: Default UpdateResourceServer 484 response
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateResourceServerRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.UpdateResourceServer
      summary: Amazon Cognito Update Resource Server
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSCognitoIdentityProviderService.UpdateResourceServer'
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    ResourceServerType:
      type: object
      properties:
        UserPoolId:
          allOf:
          - $ref: '#/components/schemas/UserPoolIdType'
          - description: The user pool ID for the user pool that hosts the resource server.
        Identifier:
          allOf:
          - $ref: '#/components/schemas/ResourceServerIdentifierType'
          - description: The identifier for the resource server.
        Name:
          allOf:
          - $ref: '#/components/schemas/ResourceServerNameType'
          - description: The name of the resource server.
        Scopes:
          allOf:
          - $ref: '#/components/schemas/ResourceServerScopeListType'
          - description: A list of scopes that are defined for the resource server.
      description: A container for information about a resource server for a user pool.
    UpdateResourceServerResponse:
      type: object
      required:
      - ResourceServer
      properties:
        ResourceServer:
          allOf:
          - $ref: '#/components/schemas/ResourceServerType'
          - description: The resource server.
    UserPoolIdType:
      type: string
      pattern: '[\w-]+_[0-9a-zA-Z]+'
      minLength: 1
      maxLength: 55
    ResourceServerScopeNameType:
      type: string
      pattern: '[\x21\x23-\x2E\x30-\x5B\x5D-\x7E]+'
      minLength: 1
      maxLength: 256
    UpdateResourceServerRequest:
      type: object
      required:
      - UserPoolId
      - Identifier
      - Name
      title: UpdateResourceServerRequest
      properties:
        UserPoolId:
          allOf:
          - $ref: '#/components/schemas/UserPoolIdType'
          - description: The user pool ID for the user pool.
        Identifier:
          allOf:
          - $ref: '#/components/schemas/ResourceServerIdentifierType'
          - description: The identifier for the resource server.
        Name:
          allOf:
          - $ref: '#/components/schemas/ResourceServerNameType'
          - description: The name of the resource server.
        Scopes:
          allOf:
          - $ref: '#/components/schemas/ResourceServerScopeListType'
          - description: The scope values to be set for the resource server.
    ResourceServerScopeListType:
      type: array
      items:
        $ref: '#/components/schemas/ResourceServerScopeType'
      maxItems: 100
    ResourceNotFoundException: {}
    ResourceServerIdentifierType:
      type: string
      pattern: '[\x21\x23-\x5B\x5D-\x7E]+'
      minLength: 1
      maxLength: 256
    NotAuthorizedException: {}
    ResourceServerScopeDescriptionType:
      type: string
      minLength: 1
      maxLength: 256
    TooManyRequestsException: {}
    ResourceServerNameType:
      type: string
      pattern: '[\w\s+=,.@-]+'
      minLength: 1
      maxLength: 256
    InternalErrorException: {}
    InvalidParameterException: {}
    ResourceServerScopeType:
      type: object
      required:
      - ScopeName
      - ScopeDescription
      properties:
        ScopeName:
          allOf:
          - $ref: '#/components/schemas/ResourceServerScopeNameType'
          - description: The name of the scope.
        ScopeDescription:
          allOf:
          - $ref: '#/components/schemas/ResourceServerScopeDescriptionType'
          - description: A description of the scope.
      description: A resource server scope.
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/cognito-idp/
x-hasEquivalentPaths: true