Amazon QuickSight Quicksight Account API

openapi: 3.1.0
info:
  title: Amazon QuickSight Account API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 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://quicksight.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /account/{AwsAccountId}:
    post:
      operationId: CreateAccountSubscription
      summary: Create Account Subscription
      description: 'Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services
        Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure
        that you can connect to an existing Amazon Web Services account. If you don''t have an Amazon Web Services account,
        see Sign up for Amazon Web Services in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick
        Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy
        Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide. If your IAM policy includes both the Subscribe
        and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny,
        the Deny action prevails and your API call fails. You can''t pass an existing IAM role to access other Amazon Web
        Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM
        roles to Amazon Quick Sight in the Amazon Quick Sight User Guide. You can''t set default resource access on the new
        account from the Amazon Quick Sight API. Instead, add '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountSubscriptionResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/CreateAccountSubscriptionRequest'
      tags:
      - Account
    delete:
      operationId: DeleteAccountSubscription
      summary: Delete Account Subscription
      description: 'Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon
        Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight
        account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss
        – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.
        Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working
        and display errors to end users. Shared resources removed – All shared dashboards, folders, and resources will become
        inaccessible to other users and external recipients. User access terminated – All Quick Sight users in your account
        will lose access immediately, including authors, readers, and administrators. No recovery possible – Once deleted,
        your Quick Sight account and all associated data cannot be restored. Consider exporting critical dashboards and data
        before proceeding with account deletion. Use the DeleteAccountSubscription operation to delete an Quick Sight account.
        This operation will result in an error message '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAccountSubscriptionResponse'
        '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/DeleteAccountSubscriptionRequest'
      tags:
      - Account
    get:
      operationId: DescribeAccountSubscription
      summary: Describe Account Subscription
      description: Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription.
        A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication
        type, edition, and notification email address.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAccountSubscriptionResponse'
        '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/DescribeAccountSubscriptionRequest'
      tags:
      - Account
  /accounts/{AwsAccountId}:
    post:
      operationId: CreateNamespace
      summary: Create Namespace
      description: (Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows
        you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace
        can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces.
        You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must
        be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services
        account. To increase your limit, create a ticket with Amazon Web Services Support.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateNamespaceResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException; ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/CreateNamespaceRequest'
      tags:
      - Account
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.
    AccountInfo:
      type: object
      properties:
        AccountName:
          type: string
          description: The account name that you provided for the Amazon Quick Sight subscription in your Amazon Web Services
            account. You create this name when you sign up for Quick. It's unique over all of Amazon Web Services, and it
            appears only when users sign in.
        Edition:
          type: string
          enum:
          - STANDARD
          - ENTERPRISE
          - ENTERPRISE_AND_Q
          description: The edition of your Quick Sight account.
        NotificationEmail:
          type: string
          description: The email address that will be used for Quick Sight to send notifications regarding your Amazon Web
            Services account or Quick Sight subscription.
        AuthenticationType:
          type: string
          description: The way that your Amazon Quick Sight account is authenticated.
        AccountSubscriptionStatus:
          type: string
          description: The status of your account subscription.
        IAMIdentityCenterInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    CreateAccountSubscriptionRequest:
      type: object
      properties:
        Edition:
          type: string
          enum:
          - STANDARD
          - ENTERPRISE
          - ENTERPRISE_AND_Q
          description: 'The edition of Amazon Quick Sight that you want your account to have. Currently, you can choose from
            ENTERPRISE or ENTERPRISE_AND_Q. If you choose ENTERPRISE_AND_Q, the following parameters are required: FirstName
            LastName EmailAddress ContactNumber'
        AuthenticationMethod:
          type: string
          enum:
          - IAM_AND_QUICKSIGHT
          - IAM_ONLY
          - ACTIVE_DIRECTORY
          - IAM_IDENTITY_CENTER
          description: The method that you want to use to authenticate your Quick Sight account. If you choose ACTIVE_DIRECTORY,
            provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory. If you choose IAM_IDENTITY_CENTER,
            provide an AdminGroup associated with your IAM Identity Center account.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID of the account that you're using to create your Quick Sight account.
        AccountName:
          type: string
          description: The name of your Amazon Quick Sight account. This name is unique over all of Amazon Web Services, and
            it appears only when users sign in. You can't change AccountName value after the Amazon Quick Sight account is
            created.
        NotificationEmail:
          type: string
          description: The email address that you want Quick Sight to send notifications to regarding your Quick Sight account
            or Quick Sight subscription.
        ActiveDirectoryName:
          type: string
          description: The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication
            method of the new Quick Sight account.
        Realm:
          type: string
          description: The realm of the Active Directory that is associated with your Quick Sight account. This field is required
            if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.
        DirectoryId:
          type: string
          description: The ID of the Active Directory that is associated with your Quick Sight account.
        AdminGroup:
          type: array
          items:
            type: string
          description: 'The admin group associated with your Active Directory or IAM Identity Center account. Either this
            field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication
            method of the new Quick Sight account. For more information about using IAM Identity Center in Amazon Quick Sight,
            see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
            For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon
            Quick Sight Enterprise Edition in the Amazon '
        AuthorGroup:
          type: array
          items:
            type: string
          description: The author group associated with your Active Directory or IAM Identity Center account. For more information
            about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise
            Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick
            Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
        ReaderGroup:
          type: array
          items:
            type: string
          description: The reader group associated with your Active Directory or IAM Identity Center account. For more information
            about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise
            Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick
            Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
        AdminProGroup:
          type: array
          items:
            type: string
          description: The admin pro group associated with your Active Directory or IAM Identity Center account. Either this
            field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication
            method of the new Quick Sight account. For more information about using IAM Identity Center in Amazon Quick Sight,
            see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
            For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon
            Quick Sight Enterprise Edition in the Amazon
        AuthorProGroup:
          type: array
          items:
            type: string
          description: The author pro group associated with your Active Directory or IAM Identity Center account. For more
            information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick
            Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory
            in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick
            Sight User Guide.
        ReaderProGroup:
          type: array
          items:
            type: string
          description: The reader pro group associated with your Active Directory or IAM Identity Center account. For more
            information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick
            Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory
            in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick
            Sight User Guide.
        FirstName:
          type: string
          description: The first name of the author of the Amazon Quick Sight account to use for future communications. This
            field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
        LastName:
          type: string
          description: The last name of the author of the Amazon Quick Sight account to use for future communications. This
            field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
        EmailAddress:
          type: string
          description: The email address of the author of the Amazon Quick Sight account to use for future communications.
            This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
        ContactNumber:
          type: string
          description: A 10-digit phone number for the author of the Amazon Quick Sight account to use for future communications.
            This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
        IAMIdentityCenterInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) for the IAM Identity Center instance.
      required:
      - AuthenticationMethod
      - AwsAccountId
      - AccountName
      - NotificationEmail
    CreateAccountSubscriptionResponse:
      type: object
      properties:
        SignupResponse:
          $ref: '#/components/schemas/SignupResponse'
        Status:
          type: integer
          description: The HTTP status of the request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
    CreateNamespaceRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to create the Quick Sight namespace in.
        Namespace:
          type: string
          description: The name that you want to use to describe the new namespace.
        IdentityStore:
          type: string
          enum:
          - QUICKSIGHT
          description: Specifies the type of your user identity directory. Currently, this supports users with an identity
            type of QUICKSIGHT.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags that you want to associate with the namespace that you're creating.
      required:
      - AwsAccountId
      - Namespace
      - IdentityStore
    CreateNamespaceResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the Quick Sight namespace you created.
        Name:
          type: string
          description: The name of the new namespace that you created.
        CapacityRegion:
          type: string
          description: The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace.
            This is set to the region that you run CreateNamespace in.
        CreationStatus:
          type: string
          enum:
          - CREATED
          - CREATING
          - DELETING
          - RETRYABLE_FAILURE
          - NON_RETRYABLE_FAILURE
          description: The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means
            that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable.
            In the case of a non-retryable error, refer to the error message for follow-up tasks.
        IdentityStore:
          type: string
          enum:
          - QUICKSIGHT
          description: Specifies the type of your user identity directory. Currently, this supports users with an identity
            type of QUICKSIGHT.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DeleteAccountSubscriptionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID of the account that you want to delete.
      required:
      - AwsAccountId
    DeleteAccountSubscriptionResponse:
      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.
    DescribeAccountSubscriptionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID associated with your Quick Sight account.
      required:
      - AwsAccountId
    DescribeAccountSubscriptionResponse:
      type: object
      properties:
        AccountInfo:
          $ref: '#/components/schemas/AccountInfo'
        Status:
          type: integer
          description: The HTTP status of the request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
    InternalFailureException:
      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.
    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.
    SignupResponse:
      type: object
      properties:
        IAMUser:
          type: boolean
          description: A Boolean that is TRUE if the Amazon Quick Sight uses IAM as an authentication method.
        userLoginName:
          type: string
          description: The user login name for your Amazon Quick Sight account.
        accountName:
          type: string
          description: The name of your Quick Sight account.
        directoryType:
          type: string
          description: The type of Active Directory that is being used to authenticate the Amazon Quick Sight account. Valid
            values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: Tag key.
        Value:
          type: string
          description: Tag value.
      required:
      - Key
      - Value
    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)