find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-cognito:amazon-cognito-user-pool-replica-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Cognito Identity Provider User Pool Replica API
  version: '2016-04-18'
  description: Generated from AWS's published Smithy model for Amazon Cognito Identity Provider. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cognito-idp.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: User Pool Replica
paths:
  /#CreateUserPoolReplica:
    post:
      operationId: CreateUserPoolReplica
      summary: Create User Pool Replica
      description: Creates a replica of an existing user pool in a specified Amazon Web Services Region. The replica enables multi-region replication for high availability and disaster recovery. To create a replica, you must have permissions to create user pools in the target Region. 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/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateUserPoolReplicaResponse'
              example:
                UserPoolReplica:
                  RegionName: ap-south-1
                  Status: CREATING
                  Role: SECONDARY
                  UserPoolArn: arn:aws:cognito-idp:ap-south-1:123456789012:userpool/us-east-1_abcd12345
        '403':
          description: FeatureUnavailableInTierException; NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FeatureUnavailableInTierException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; LimitExceededException; OperationNotEnabledException; UserPoolTaggingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.CreateUserPoolReplica
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateUserPoolReplicaRequest'
            example:
              UserPoolId: us-east-1_abcd12345
              RegionName: ap-south-1
      tags:
      - User Pool Replica
  /#DeleteUserPoolReplica:
    post:
      operationId: DeleteUserPoolReplica
      summary: Delete User Pool Replica
      description: Deletes a secondary replica user pool. You can only delete replicas that are in the INACTIVE status. This operation must be called from the primary Region. 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/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteUserPoolReplicaResponse'
              example:
                UserPoolReplica:
                  RegionName: us-east-2
                  Status: DELETING
                  Role: SECONDARY
                  UserPoolArn: arn:aws:cognito-idp:us-east-2:123456789012:userpool/us-west-2_abcd12345
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.DeleteUserPoolReplica
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteUserPoolReplicaRequest'
            example:
              UserPoolId: us-west-2_abcd12345
              RegionName: us-east-2
      tags:
      - User Pool Replica
  /#ListUserPoolReplicas:
    post:
      operationId: ListUserPoolReplicas
      summary: List User Pool Replicas
      description: Lists all replicas for a user pool, including both primary and secondary replicas. We recommend using pagination to ensure that the operation returns quickly and successfully. 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/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListUserPoolReplicasResponse'
              example:
                UserPoolReplicas:
                - RegionName: ap-south-1
                  Status: CREATING
                  Role: SECONDARY
                  UserPoolArn: arn:aws:cognito-idp:ap-south-1:123456789012:userpool/eu-north-1_abcd12345
                - RegionName: eu-north-1
                  Status: ACTIVE
                  Role: PRIMARY
                  UserPoolArn: arn:aws:cognito-idp:eu-north-1:123456789012:userpool/eu-north-1_abcd12345
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.ListUserPoolReplicas
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListUserPoolReplicasRequest'
            example:
              UserPoolId: eu-north-1_abcd12345
      tags:
      - User Pool Replica
  /#UpdateUserPoolReplica:
    post:
      operationId: UpdateUserPoolReplica
      summary: Update User Pool Replica
      description: Updates replica-specific settings for a user pool replica. You can modify the status to activate or deactivate the replica. This request can be made in both primary and secondary regions of the user pool. 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/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateUserPoolReplicaResponse'
              example:
                UserPoolReplica:
                  RegionName: us-east-1
                  Status: ACTIVE
                  Role: SECONDARY
                  UserPoolArn: arn:aws:cognito-idp:us-east-1:123456789012:userpool/ap-south-1_abcd12345
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.UpdateUserPoolReplica
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateUserPoolReplicaRequest'
            example:
              UserPoolId: ap-south-1_abcd12345
              RegionName: us-east-1
              Status: ACTIVE
      tags:
      - User Pool Replica
components:
  schemas:
    ListUserPoolReplicasRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool for which to list replicas.
        NextToken:
          type: string
          description: A pagination token for retrieving the next page of results. If this parameter is omitted, the operation returns the first page of results.
      required:
      - UserPoolId
    DeleteUserPoolReplicaResponse:
      type: object
      properties:
        UserPoolReplica:
          $ref: '#/components/schemas/UserPoolReplicaType'
    TooManyRequestsException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a too many requests exception.
    UpdateUserPoolReplicaResponse:
      type: object
      properties:
        UserPoolReplica:
          $ref: '#/components/schemas/UserPoolReplicaType'
    UpdateUserPoolReplicaRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the replica to update.
        RegionName:
          type: string
          description: The Amazon Web Services Region of the replica to update.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The status to set for the replica. Valid values are ACTIVE and INACTIVE.
      required:
      - UserPoolId
      - RegionName
      - Status
    FeatureUnavailableInTierException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a resource not found exception.
    DeleteUserPoolReplicaRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the replica to delete.
        RegionName:
          type: string
          description: The Amazon Web Services Region of the replica to delete.
      required:
      - UserPoolId
      - RegionName
    ListUserPoolReplicasResponse:
      type: object
      properties:
        UserPoolReplicas:
          type: array
          items:
            $ref: '#/components/schemas/UserPoolReplicaType'
          description: A list of user pool replicas, including information about their status, role, and Region.
        NextToken:
          type: string
          description: A pagination token for retrieving the next page of results. If this value is null, there are no more results to retrieve.
    NotAuthorizedException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a not authorized exception.
    CreateUserPoolReplicaRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool to replicate.
        RegionName:
          type: string
          description: The Amazon Web Services Region where you want to create the replica user pool.
        UserPoolTags:
          type: object
          additionalProperties:
            type: string
          description: A map of tags to assign to the replica user pool. Each tag consists of a key and an optional value, both of which you define. You can maintain tags independently on replica user pools.
      required:
      - UserPoolId
      - RegionName
    InternalErrorException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when Amazon Cognito throws an internal error exception.
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service throws an invalid parameter exception.
        reasonCode:
          type: string
          description: The reason code of the exception.
    UserPoolReplicaType:
      type: object
      properties:
        RegionName:
          type: string
          description: The Amazon Web Services Region where the replica is located.
        Status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - DELETING
          description: The current status of the replica. CREATING The replica is being created. INACTIVE The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported. ACTIVE The replica is available for both end-user and administrator operations. DELETING The replica is being deleted.
        Role:
          type: string
          enum:
          - PRIMARY
          - SECONDARY
          description: The role of the user pool replica that determines which API operations are enabled. PRIMARY The primary replica supports all end user and administrator operations. SECONDARY The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.
        UserPoolArn:
          type: string
          description: The Amazon Resource Name (ARN) of the replica user pool.
    CreateUserPoolReplicaResponse:
      type: object
      properties:
        UserPoolReplica:
          $ref: '#/components/schemas/UserPoolReplicaType'
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cognito-idp
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)