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-iam-identity-center:amazon-iam-identity-center-region-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: AWS Single Sign-On Admin Region API
  version: '2020-07-20'
  description: Generated from AWS's published Smithy model for AWS Single Sign-On Admin. 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://sso.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Region
paths:
  /#AddRegion:
    post:
      operationId: AddRegion
      summary: Add Region
      description: 'Adds a Region to an IAM Identity Center instance. This operation initiates an asynchronous workflow to replicate the IAM Identity Center instance to the target Region. The Region status is set to ADDING at first and changes to ACTIVE when the workflow completes. To use this operation, your IAM Identity Center instance and the target Region must meet the requirements described in the IAM Identity Center User Guide. The following actions are related to AddRegion: RemoveRegion DescribeRegion ListRegions'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AddRegionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.AddRegion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AddRegionRequest'
      tags:
      - Region
  /#DescribeRegion:
    post:
      operationId: DescribeRegion
      summary: Describe Region
      description: 'Retrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status (ACTIVE, ADDING, or REMOVING), the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of the IAM Identity Center instance. The following actions are related to DescribeRegion: AddRegion RemoveRegion ListRegions'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeRegionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.DescribeRegion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeRegionRequest'
      tags:
      - Region
  /#ListRegions:
    post:
      operationId: ListRegions
      summary: List Regions
      description: 'Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status. The following actions are related to ListRegions: AddRegion RemoveRegion DescribeRegion'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListRegionsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.ListRegions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListRegionsRequest'
      tags:
      - Region
  /#RemoveRegion:
    post:
      operationId: RemoveRegion
      summary: Remove Region
      description: 'Removes an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The request must be made from the primary Region. The target Region cannot be the primary Region, and no other add or remove Region workflows can be in progress. The following actions are related to RemoveRegion: AddRegion DescribeRegion ListRegions'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RemoveRegionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SWBExternalService.RemoveRegion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/RemoveRegionRequest'
      tags:
      - Region
components:
  schemas:
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_ThrottlingException
          description: The reason for the throttling exception.
    DescribeRegionResponse:
      type: object
      properties:
        RegionName:
          type: string
          description: The Amazon Web Services Region name.
        Status:
          type: string
          enum:
          - ACTIVE
          - ADDING
          - REMOVING
          description: The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region replication workflow is in progress), or REMOVING (Region removal workflow is in progress).
        AddedDate:
          type: string
          format: date-time
          description: The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the IAM Identity Center instance creation time.
        IsPrimaryRegion:
          type: boolean
          description: Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. For more information on the difference between the primary Region and additional Regions, see IAM Identity Center User Guide
    AddRegionResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - ACTIVE
          - ADDING
          - REMOVING
          description: The status of the Region after the Add operation. The status is ADDING when the asynchronous workflow is in progress and changes to ACTIVE when complete.
    RemoveRegionResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - ACTIVE
          - ADDING
          - REMOVING
          description: The status of the Region after the remove operation. The status is REMOVING when the asynchronous workflow is in progress. The Region record is deleted when the workflow completes.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_InvalidKeyUsageException
          - KMS_InvalidStateException
          - KMS_DisabledException
          description: The reason for the validation exception.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_AccessDeniedException
          description: The reason for the access denied exception.
    DescribeRegionRequest:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center instance.
        RegionName:
          type: string
          description: The name of the Amazon Web Services Region to retrieve information about. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1).
      required:
      - InstanceArn
      - RegionName
    RemoveRegionRequest:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center instance.
        RegionName:
          type: string
          description: The name of the Amazon Web Services Region to remove from the IAM Identity Center instance. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1). The primary Region cannot be removed.
      required:
      - InstanceArn
      - RegionName
    RegionMetadata:
      type: object
      properties:
        RegionName:
          type: string
          description: The Amazon Web Services Region name.
        Status:
          type: string
          enum:
          - ACTIVE
          - ADDING
          - REMOVING
          description: The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region extension workflow is in progress), or REMOVING (Region removal workflow is in progress).
        AddedDate:
          type: string
          format: date-time
          description: The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the instance creation time.
        IsPrimaryRegion:
          type: boolean
          description: Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.
    ListRegionsRequest:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center instance.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call. Default is 100.
        NextToken:
          type: string
          description: The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
      required:
      - InstanceArn
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    AddRegionRequest:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center instance to replicate to the target Region.
        RegionName:
          type: string
          description: The name of the Amazon Web Services Region to add to the IAM Identity Center instance. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1).
      required:
      - InstanceArn
      - RegionName
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - KMS_NotFoundException
          description: The reason for the resource not found exception.
    ListRegionsResponse:
      type: object
      properties:
        Regions:
          type: array
          items:
            $ref: '#/components/schemas/RegionMetadata'
          description: The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.
        NextToken:
          type: string
          description: The pagination token to be used in subsequent calls. If the value is null, then there are no more entries.
  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: sso
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)