Amazon QuickSight Quicksight Data Loss Prevention API

openapi: 3.1.0
info:
  title: Amazon QuickSight Data Loss Prevention 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:
  /accounts/{AwsAccountId}/data-loss-prevention/settings/{DlpSettingId}:
    post:
      operationId: CreateDlpSetting
      summary: Create Dlp Setting
      description: Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account. A DLP setting
        defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDlpSettingResponse'
        '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: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDlpSettingRequest'
      tags:
      - Data Loss Prevention
    delete:
      operationId: DeleteDlpSetting
      summary: Delete Dlp Setting
      description: Deletes a DLP setting configuration from an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDlpSettingResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/DeleteDlpSettingRequest'
      tags:
      - Data Loss Prevention
    get:
      operationId: DescribeDlpSetting
      summary: Describe Dlp Setting
      description: Describes the full configuration of a DLP setting in an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDlpSettingResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/DescribeDlpSettingRequest'
      tags:
      - Data Loss Prevention
    put:
      operationId: UpdateDlpSetting
      summary: Update Dlp Setting
      description: Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted
        from the request retain their current values.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDlpSettingResponse'
        '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: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/UpdateDlpSettingRequest'
      tags:
      - Data Loss Prevention
  /accounts/{AwsAccountId}/data-loss-prevention/settings:
    get:
      operationId: ListDlpSettings
      summary: List Dlp Settings
      description: Lists all DLP settings in an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDlpSettingsResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDlpSettingsRequest'
      tags:
      - Data Loss Prevention
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.
    CreateDlpSettingRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account in which to create the DLP setting.
        DlpSettingId:
          type: string
          description: A unique identifier for the DLP setting.
        Name:
          type: string
          description: A human-readable display name for the DLP setting.
        ProviderType:
          type: string
          enum:
          - MICROSOFT_PURVIEW
          description: The type of external DLP provider to use for sensitivity label classification. Currently, the only
            supported value is MICROSOFT_PURVIEW.
        ProviderConfig:
          $ref: '#/components/schemas/ProviderConfig'
        ProviderOutageAction:
          type: string
          enum:
          - ALLOW
          - WARN
          - BLOCK
          description: The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.
        Enabled:
          type: boolean
          description: Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or
            false to disable it at time of setting creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of resource tags to apply to the DLP setting. You can use tags to manage access to your Amazon
            Web Services resources.
      required:
      - AwsAccountId
      - DlpSettingId
      - Name
      - ProviderType
      - ProviderConfig
      - ProviderOutageAction
      - Enabled
    CreateDlpSettingResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the created DLP setting.
        DlpSettingId:
          type: string
          description: The ID of the created DLP setting.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
      required:
      - Arn
      - DlpSettingId
    DeleteDlpSettingRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the DLP setting that you want to delete.
        DlpSettingId:
          type: string
          description: The ID of the DLP setting that you want to delete.
      required:
      - AwsAccountId
      - DlpSettingId
    DeleteDlpSettingResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the deleted DLP setting.
        DlpSettingId:
          type: string
          description: The ID of the deleted DLP setting.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
      required:
      - Arn
      - DlpSettingId
    DescribeDlpSettingRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the DLP setting that you want to describe.
        DlpSettingId:
          type: string
          description: The ID of the DLP setting that you want to describe.
      required:
      - AwsAccountId
      - DlpSettingId
    DescribeDlpSettingResponse:
      type: object
      properties:
        DlpSetting:
          $ref: '#/components/schemas/DlpSettingDetails'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
      required:
      - DlpSetting
    DlpSettingDetails:
      type: object
      properties:
        DlpSettingId:
          type: string
          description: The ID of the DLP setting.
        Name:
          type: string
          description: The display name of the DLP setting.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the DLP setting.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The status of the DLP setting. Valid values are ACTIVE and INACTIVE.
        ProviderType:
          type: string
          enum:
          - MICROSOFT_PURVIEW
          description: The type of external DLP provider used for sensitivity label classification.
        ProviderConfig:
          $ref: '#/components/schemas/ProviderConfig'
        ProviderOutageAction:
          type: string
          enum:
          - ALLOW
          - WARN
          - BLOCK
          description: The behavior applied when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that the DLP setting was created, in ISO 8601 format.
        UpdatedAt:
          type: string
          format: date-time
          description: The date and time that the DLP setting was most recently updated, in ISO 8601 format.
      required:
      - DlpSettingId
      - Name
      - Arn
      - Status
      - ProviderType
      - ProviderConfig
      - ProviderOutageAction
      - CreatedAt
      - UpdatedAt
    DlpSettingSummary:
      type: object
      properties:
        DlpSettingId:
          type: string
          description: The ID of the DLP setting.
        Name:
          type: string
          description: The display name of the DLP setting.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the DLP setting.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The status of the DLP setting. Valid values are ACTIVE and INACTIVE.
        ProviderType:
          type: string
          enum:
          - MICROSOFT_PURVIEW
          description: The type of external DLP provider used for sensitivity label classification.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that the DLP setting was created, in ISO 8601 format.
        UpdatedAt:
          type: string
          format: date-time
          description: The date and time that the DLP setting was most recently updated, in ISO 8601 format.
      required:
      - DlpSettingId
      - Name
      - Arn
      - Status
      - ProviderType
      - CreatedAt
      - UpdatedAt
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    LabelActionMapping:
      type: object
      properties:
        LabelId:
          type: string
          description: The identifier of the sensitivity label from the DLP provider.
        LabelName:
          type: string
          description: The display name of the sensitivity label from the DLP provider.
        Action:
          type: string
          enum:
          - ALLOW
          - WARN
          - BLOCK
          description: The enforcement action to apply when content with this sensitivity label is detected. Valid values
            are ALLOW, BLOCK, and WARN.
      required:
      - LabelId
      - LabelName
      - Action
    ListDlpSettingsRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the DLP settings that you want to list.
        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 return per request.
      required:
      - AwsAccountId
    ListDlpSettingsResponse:
      type: object
      properties:
        DlpSettingSummaries:
          type: array
          items:
            $ref: '#/components/schemas/DlpSettingSummary'
          description: A list of DlpSettingSummary objects for the DLP settings in the account. The list is empty if no DLP
            settings have been configured.
        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.
      required:
      - DlpSettingSummaries
    MicrosoftPurviewCredentials:
      type: object
      properties:
        SecretArn:
          type: string
          description: The ARN of the Amazon Web Services Secrets Manager secret that contains the Microsoft Purview OAuth
            credentials. The secret includes the Azure tenant ID, client ID, and client secret or certificate.
      required:
      - SecretArn
    MicrosoftPurviewProviderConfig:
      type: object
      properties:
        Credentials:
          $ref: '#/components/schemas/MicrosoftPurviewCredentials'
        LabelActionMappings:
          type: array
          items:
            $ref: '#/components/schemas/LabelActionMapping'
          description: The mappings from Microsoft Purview sensitivity labels to enforcement actions.
        UnmappedAction:
          type: string
          enum:
          - ALLOW
          - WARN
          - BLOCK
          description: The default action to apply to content that has no sensitivity label or whose label is not mapped.
            Valid values are ALLOW, BLOCK, and WARN.
      required:
      - Credentials
      - LabelActionMappings
      - UnmappedAction
    ProviderConfig:
      type: object
      properties:
        MicrosoftPurview:
          $ref: '#/components/schemas/MicrosoftPurviewProviderConfig'
      description: Exactly one member is set.
    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.
    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.
    UpdateDlpSettingRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the DLP setting that you want to update.
        DlpSettingId:
          type: string
          description: The ID of the DLP setting that you want to update.
        Name:
          type: string
          description: An updated display name for the DLP setting.
        ProviderType:
          type: string
          enum:
          - MICROSOFT_PURVIEW
          description: An updated DLP provider type. Currently, the only supported value is MICROSOFT_PURVIEW.
        ProviderConfig:
          $ref: '#/components/schemas/ProviderConfig'
        ProviderOutageAction:
          type: string
          enum:
          - ALLOW
          - WARN
          - BLOCK
          description: An updated behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and
            BLOCK.
        Enabled:
          type: boolean
          description: Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or
            false to disable it.
      required:
      - AwsAccountId
      - DlpSettingId
    UpdateDlpSettingResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated DLP setting.
        DlpSettingId:
          type: string
          description: The ID of the updated DLP setting.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
      required:
      - Arn
      - DlpSettingId
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)