Amazon QuickSight Quicksight Profiles API

openapi: 3.1.0
info:
  title: Amazon QuickSight Profiles API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 5 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:
  /governance/limits/accounts/{accountId}/profiles:
    post:
      operationId: CreateLimitsProfile
      summary: Create Limits Profile
      description: Creates a limits profile that defines resource usage limits for Amazon Quick Sight users.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLimitsProfileResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLimitsProfileRequest'
      tags:
      - Profiles
    get:
      operationId: ListLimitsProfiles
      summary: List Limits Profiles
      description: Lists all limits profiles in an Amazon Quick Sight account. Results are paginated. Use the maxResults parameter
        to limit the number of results returned in a single call, and use the nextToken parameter to retrieve the next page
        of results.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLimitsProfilesResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLimitsProfilesRequest'
      tags:
      - Profiles
  /governance/limits/accounts/{accountId}/profiles/{profileId}:
    delete:
      operationId: DeleteLimitsProfile
      summary: Delete Limits Profile
      description: Deletes a limits profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLimitsProfileResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteLimitsProfileRequest'
      tags:
      - Profiles
    get:
      operationId: DescribeLimitsProfile
      summary: Describe Limits Profile
      description: Describes the properties of an existing limits profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeLimitsProfileResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeLimitsProfileRequest'
      tags:
      - Profiles
    put:
      operationId: UpdateLimitsProfile
      summary: Update Limits Profile
      description: Updates the properties of an existing limits profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLimitsProfileResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLimitsProfileRequest'
      tags:
      - Profiles
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.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    CreateLimitsProfileRequest:
      type: object
      properties:
        accountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the limits profile.
        profileName:
          type: string
          description: A display name for the limits profile.
        description:
          type: string
          description: A description for the limits profile.
        resourceLimits:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ProfileLimitValue'
          description: A map of resource types to their limit values for this profile.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If
            this token matches a previous request, the service ignores the request, but does not return an error.
      required:
      - accountId
      - profileName
      - resourceLimits
      - clientToken
    CreateLimitsProfileResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the created limits profile.
        profileId:
          type: string
          description: The unique identifier for the created limits profile.
      required:
      - arn
      - profileId
    DeleteLimitsProfileRequest:
      type: object
      properties:
        profileId:
          type: string
          description: The unique identifier for the limits profile to delete.
        accountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the limits profile.
      required:
      - profileId
      - accountId
    DeleteLimitsProfileResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the deleted limits profile.
      required:
      - arn
    DescribeLimitsProfileRequest:
      type: object
      properties:
        profileId:
          type: string
          description: The unique identifier for the limits profile.
        accountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the limits profile.
      required:
      - profileId
      - accountId
    DescribeLimitsProfileResponse:
      type: object
      properties:
        profile:
          $ref: '#/components/schemas/LimitsProfile'
      required:
      - profile
    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.
    LimitsProfile:
      type: object
      properties:
        profileId:
          type: string
          description: The unique identifier for the limits profile.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the limits profile.
        accountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the limits profile.
        profileName:
          type: string
          description: The display name of the limits profile.
        description:
          type: string
          description: The description of the limits profile.
        resourceLimits:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ProfileLimitValue'
          description: A map of resource types to their limit values.
        createdAt:
          type: string
          format: date-time
          description: The date and time that the limits profile was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time that the limits profile was last updated.
      required:
      - profileId
      - arn
      - accountId
      - profileName
      - resourceLimits
      - createdAt
      - updatedAt
    ListLimitsProfilesRequest:
      type: object
      properties:
        accountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the limits profiles.
        resourceType:
          type: string
          enum:
          - INDEX_STORAGE
          - AGENT_HOURS
          description: An optional filter that limits the results to profiles that contain the specified resource type. If
            you don't specify a value, the operation returns all profiles.
        maxResults:
          type: integer
          description: The maximum number of results to return in a single call. If you don't specify a value, the service
            uses the default maximum.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
      required:
      - accountId
    ListLimitsProfilesResponse:
      type: object
      properties:
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/LimitsProfile'
          description: A list of limits profiles.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
      required:
      - profiles
    ProfileLimitValue:
      type: object
      properties:
        maxValue:
          type: integer
          description: The maximum allowed value for the resource.
        unit:
          type: string
          enum:
          - MB
          - GB
          - HOURS
          - DAYS
          description: The unit of measurement for the limit value.
      required:
      - maxValue
      - unit
    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.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UpdateLimitsProfileRequest:
      type: object
      properties:
        profileId:
          type: string
          description: The unique identifier for the limits profile to update.
        accountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the limits profile.
        profileName:
          type: string
          description: A new display name for the limits profile.
        description:
          type: string
          description: A new description for the limits profile.
        resourceLimits:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ProfileLimitValue'
          description: A map of resource types to their updated limit values.
      required:
      - profileId
      - accountId
    UpdateLimitsProfileResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated limits profile.
      required:
      - arn
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)