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-quicksight:amazon-quicksight-namespaces-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.1.0
info:
  title: Amazon QuickSight Namespaces API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 3 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://quicksight.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /accounts/{AwsAccountId}/namespaces/{Namespace}:
    delete:
      operationId: DeleteNamespace
      summary: Delete Namespace
      description: Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous
        process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets,
        you use the API operations for the relevant asset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteNamespaceResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteNamespaceRequest'
      tags:
      - Namespaces
    get:
      operationId: DescribeNamespace
      summary: Describe Namespace
      description: Describes the current namespace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeNamespaceResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeNamespaceRequest'
      tags:
      - Namespaces
  /accounts/{AwsAccountId}/namespaces:
    get:
      operationId: ListNamespaces
      summary: List Namespaces
      description: Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted
        namespaces.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNamespacesResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidNextTokenException; InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListNamespacesRequest'
      tags:
      - Namespaces
components:
  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: quicksight
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    DeleteNamespaceRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to delete the Quick Sight namespace from.
        Namespace:
          type: string
          description: The namespace that you want to delete.
      required:
      - AwsAccountId
      - Namespace
    DeleteNamespaceResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DescribeNamespaceRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that contains the Quick Sight namespace that you want to
            describe.
        Namespace:
          type: string
          description: The namespace that you want to describe.
      required:
      - AwsAccountId
      - Namespace
    DescribeNamespaceResponse:
      type: object
      properties:
        Namespace:
          $ref: '#/components/schemas/NamespaceInfoV2'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidNextTokenException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidParameterValueException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ListNamespacesRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that contains the Quick Sight namespaces that you want to
            list.
        NextToken:
          type: string
          description: A unique pagination token that can be used in a subsequent request. You will receive a pagination token
            in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive
            the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each
            token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive
            a HTTP 400 InvalidNextTokenException error.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
      required:
      - AwsAccountId
    ListNamespacesResponse:
      type: object
      properties:
        Namespaces:
          type: array
          items:
            $ref: '#/components/schemas/NamespaceInfoV2'
          description: The information about the namespaces in this Amazon Web Services account. The response includes the
            namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.
        NextToken:
          type: string
          description: A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response
            inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call
            with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make
            a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    NamespaceError:
      type: object
      properties:
        Type:
          type: string
          enum:
          - PERMISSION_DENIED
          - INTERNAL_SERVICE_ERROR
          description: The error type.
        Message:
          type: string
          description: The message for the error.
    NamespaceInfoV2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the error.
        Arn:
          type: string
          description: The namespace ARN.
        CapacityRegion:
          type: string
          description: The namespace Amazon Web Services Region.
        CreationStatus:
          type: string
          enum:
          - CREATED
          - CREATING
          - DELETING
          - RETRYABLE_FAILURE
          - NON_RETRYABLE_FAILURE
          description: The creation status of a namespace that is not yet completely created.
        IdentityStore:
          type: string
          enum:
          - QUICKSIGHT
          description: The identity store used for the namespace.
        NamespaceError:
          $ref: '#/components/schemas/NamespaceError'
        IamIdentityCenterApplicationArn:
          type: string
          description: The Amazon Resource Name (ARN) for the IAM Identity Center application.
        IamIdentityCenterInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - USER
          - GROUP
          - NAMESPACE
          - ACCOUNT_SETTINGS
          - IAMPOLICY_ASSIGNMENT
          - DATA_SOURCE
          - DATA_SET
          - VPC_CONNECTION
          - INGESTION
          description: The resource type for this request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ResourceUnavailableException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - USER
          - GROUP
          - NAMESPACE
          - ACCOUNT_SETTINGS
          - IAMPOLICY_ASSIGNMENT
          - DATA_SOURCE
          - DATA_SET
          - VPC_CONNECTION
          - INGESTION
          description: The resource type for this request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/quicksight/service/2018-04-01/quicksight-2018-04-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)