Amazon QuickSight Quicksight Iam Policy Assignments API

openapi: 3.1.0
info:
  title: Amazon QuickSight Iam Policy Assignments API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 6 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}/iam-policy-assignments:
    post:
      operationId: CreateIAMPolicyAssignment
      summary: Create IAMPolicy Assignment
      description: Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This
        policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique
        per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIAMPolicyAssignmentResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ConcurrentUpdatingException; InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentUpdatingException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExistsException'
        '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/CreateIAMPolicyAssignmentRequest'
      tags:
      - Iam Policy Assignments
  /accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}:
    delete:
      operationId: DeleteIAMPolicyAssignment
      summary: Delete IAMPolicy Assignment
      description: Deletes an existing IAM policy assignment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIAMPolicyAssignmentResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ConcurrentUpdatingException; InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentUpdatingException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExistsException'
        '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/DeleteIAMPolicyAssignmentRequest'
      tags:
      - Iam Policy Assignments
  /accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}:
    get:
      operationId: DescribeIAMPolicyAssignment
      summary: Describe IAMPolicy Assignment
      description: Describes an existing IAM policy assignment, as specified by the assignment name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeIAMPolicyAssignmentResponse'
        '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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '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/DescribeIAMPolicyAssignmentRequest'
      tags:
      - Iam Policy Assignments
    put:
      operationId: UpdateIAMPolicyAssignment
      summary: Update IAMPolicy Assignment
      description: Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters
        that are specified in the request. This overwrites all of the users included in Identities.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIAMPolicyAssignmentResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ConcurrentUpdatingException; InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentUpdatingException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExistsException'
        '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/UpdateIAMPolicyAssignmentRequest'
      tags:
      - Iam Policy Assignments
  /accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments:
    get:
      operationId: ListIAMPolicyAssignments
      summary: List IAMPolicy Assignments
      description: Lists the IAM policy assignments in the current Amazon Quick Sight account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIAMPolicyAssignmentsResponse'
        '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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '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/ListIAMPolicyAssignmentsRequest'
      tags:
      - Iam Policy Assignments
  /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments:
    get:
      operationId: ListIAMPolicyAssignmentsForUser
      summary: List IAMPolicy Assignments For User
      description: Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies
        assigned to the specified user and group, or groups that the user belongs to.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIAMPolicyAssignmentsForUserResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ConcurrentUpdatingException; InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentUpdatingException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExistsException'
        '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/ListIAMPolicyAssignmentsForUserRequest'
      tags:
      - Iam Policy Assignments
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.
    ActiveIAMPolicyAssignment:
      type: object
      properties:
        AssignmentName:
          type: string
          description: A name for the IAM policy assignment.
        PolicyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource.
    ConcurrentUpdatingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    CreateIAMPolicyAssignmentRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon Quick Sight
            users or groups.
        AssignmentName:
          type: string
          description: The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services
            account.
        AssignmentStatus:
          type: string
          enum:
          - ENABLED
          - DRAFT
          - DISABLED
          description: 'The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this
            assignment is used when creating the data source. DISABLED - This assignment isn''t used when creating the data
            source. DRAFT - This assignment is an unfinished draft and isn''t used when creating the data source.'
        PolicyArn:
          type: string
          description: The ARN for the IAM policy to apply to the Amazon Quick Sight users and groups specified in this assignment.
        Identities:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: The Amazon Quick Sight users, groups, or both that you want to assign the policy to.
        Namespace:
          type: string
          description: The namespace that contains the assignment.
      required:
      - AwsAccountId
      - AssignmentName
      - AssignmentStatus
      - Namespace
    CreateIAMPolicyAssignmentResponse:
      type: object
      properties:
        AssignmentName:
          type: string
          description: The name of the assignment. The name must be unique within the Amazon Web Services account.
        AssignmentId:
          type: string
          description: The ID for the assignment.
        AssignmentStatus:
          type: string
          enum:
          - ENABLED
          - DRAFT
          - DISABLED
          description: 'The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this
            assignment is used when creating the data source. DISABLED - This assignment isn''t used when creating the data
            source. DRAFT - This assignment is an unfinished draft and isn''t used when creating the data source.'
        PolicyArn:
          type: string
          description: The ARN for the IAM policy that is applied to the Amazon Quick Sight users and groups specified in
            this assignment.
        Identities:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: The Amazon Quick Sight users, groups, or both that the IAM policy is assigned to.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DeleteIAMPolicyAssignmentRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID where you want to delete the IAM policy assignment.
        AssignmentName:
          type: string
          description: The name of the assignment.
        Namespace:
          type: string
          description: The namespace that contains the assignment.
      required:
      - AwsAccountId
      - AssignmentName
      - Namespace
    DeleteIAMPolicyAssignmentResponse:
      type: object
      properties:
        AssignmentName:
          type: string
          description: The name of the assignment.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DescribeIAMPolicyAssignmentRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the assignment that you want to describe.
        AssignmentName:
          type: string
          description: The name of the assignment, also called a rule.
        Namespace:
          type: string
          description: The namespace that contains the assignment.
      required:
      - AwsAccountId
      - AssignmentName
      - Namespace
    DescribeIAMPolicyAssignmentResponse:
      type: object
      properties:
        IAMPolicyAssignment:
          $ref: '#/components/schemas/IAMPolicyAssignment'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    IAMPolicyAssignment:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        AssignmentId:
          type: string
          description: Assignment ID.
        AssignmentName:
          type: string
          description: Assignment name.
        PolicyArn:
          type: string
          description: The Amazon Resource Name (ARN) for the IAM policy.
        Identities:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Identities.
        AssignmentStatus:
          type: string
          enum:
          - ENABLED
          - DRAFT
          - DISABLED
          description: Assignment status.
    IAMPolicyAssignmentSummary:
      type: object
      properties:
        AssignmentName:
          type: string
          description: Assignment name.
        AssignmentStatus:
          type: string
          enum:
          - ENABLED
          - DRAFT
          - DISABLED
          description: Assignment status.
    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.
    ListIAMPolicyAssignmentsForUserRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the assignments.
        UserName:
          type: string
          description: The name of the user.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
        Namespace:
          type: string
          description: The namespace of the assignment.
      required:
      - AwsAccountId
      - UserName
      - Namespace
    ListIAMPolicyAssignmentsForUserResponse:
      type: object
      properties:
        ActiveAssignments:
          type: array
          items:
            $ref: '#/components/schemas/ActiveIAMPolicyAssignment'
          description: The active assignments for this user.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        Status:
          type: integer
          description: The HTTP status of the request.
    ListIAMPolicyAssignmentsRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains these IAM policy assignments.
        AssignmentStatus:
          type: string
          enum:
          - ENABLED
          - DRAFT
          - DISABLED
          description: The status of the assignments.
        Namespace:
          type: string
          description: The namespace for the assignments.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - AwsAccountId
      - Namespace
    ListIAMPolicyAssignmentsResponse:
      type: object
      properties:
        IAMPolicyAssignments:
          type: array
          items:
            $ref: '#/components/schemas/IAMPolicyAssignmentSummary'
          description: Information describing the IAM policy assignments.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    ResourceExistsException:
      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.
    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.
    UpdateIAMPolicyAssignmentRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the IAM policy assignment.
        AssignmentName:
          type: string
          description: The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services
            account.
        Namespace:
          type: string
          description: The namespace of the assignment.
        AssignmentStatus:
          type: string
          enum:
          - ENABLED
          - DRAFT
          - DISABLED
          description: 'The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this
            assignment is used when creating the data source. DISABLED - This assignment isn''t used when creating the data
            source. DRAFT - This assignment is an unfinished draft and isn''t used when creating the data source.'
        PolicyArn:
          type: string
          description: The ARN for the IAM policy to apply to the Amazon Quick Sight users and groups specified in this assignment.
        Identities:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: The Amazon Quick Sight users, groups, or both that you want to assign the policy to.
      required:
      - AwsAccountId
      - AssignmentName
      - Namespace
    UpdateIAMPolicyAssignmentResponse:
      type: object
      properties:
        AssignmentName:
          type: string
          description: The name of the assignment or rule.
        AssignmentId:
          type: string
          description: The ID of the assignment.
        PolicyArn:
          type: string
          description: The ARN for the IAM policy applied to the Amazon Quick Sight users and groups specified in this assignment.
        Identities:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: The Amazon Quick Sight users, groups, or both that the IAM policy is assigned to.
        AssignmentStatus:
          type: string
          enum:
          - ENABLED
          - DRAFT
          - DISABLED
          description: 'The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this
            assignment is used when creating the data source. DISABLED - This assignment isn''t used when creating the data
            source. DRAFT - This assignment is an unfinished draft and isn''t used when creating the data source.'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the 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)