QuickSight / Client / create_dlp_setting

create_dlp_setting

QuickSight.Client.create_dlp_setting(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_dlp_setting(
    AwsAccountId='string',
    DlpSettingId='string',
    Name='string',
    ProviderType='MICROSOFT_PURVIEW',
    ProviderConfig={
        'MicrosoftPurview': {
            'Credentials': {
                'SecretArn': 'string'
            },
            'LabelActionMappings': [
                {
                    'LabelId': 'string',
                    'LabelName': 'string',
                    'Action': 'ALLOW'|'WARN'|'BLOCK'
                },
            ],
            'UnmappedAction': 'ALLOW'|'WARN'|'BLOCK'
        }
    },
    ProviderOutageAction='ALLOW'|'WARN'|'BLOCK',
    Enabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account in which to create the DLP setting.

• DlpSettingId (string) –

  [REQUIRED]

  A unique identifier for the DLP setting.

• Name (string) –

  [REQUIRED]

  A human-readable display name for the DLP setting.

• ProviderType (string) –

  [REQUIRED]

  The type of external DLP provider to use for sensitivity label classification. Currently, the only supported value is MICROSOFT_PURVIEW.

• ProviderConfig (dict) –

  [REQUIRED]

  The provider-specific configuration for the DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: MicrosoftPurview.

  • MicrosoftPurview (dict) –

    The configuration for a Microsoft Purview DLP integration.

    • Credentials (dict) – [REQUIRED]

      The credentials used to authenticate with Microsoft Purview.

      • SecretArn (string) – [REQUIRED]

        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.

    • LabelActionMappings (list) – [REQUIRED]

      The mappings from Microsoft Purview sensitivity labels to enforcement actions.

      • (dict) –

        Maps a sensitivity label from Microsoft Purview to an enforcement action.

        • LabelId (string) – [REQUIRED]

          The identifier of the sensitivity label from the DLP provider.

        • LabelName (string) – [REQUIRED]

          The display name of the sensitivity label from the DLP provider.

        • Action (string) – [REQUIRED]

          The enforcement action to apply when content with this sensitivity label is detected. Valid values are ALLOW, BLOCK, and WARN.

    • UnmappedAction (string) – [REQUIRED]

      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.

• ProviderOutageAction (string) –

  [REQUIRED]

  The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.

• Enabled (boolean) –

  [REQUIRED]

  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 (list) –

  A list of resource tags to apply to the DLP setting. You can use tags to manage access to your Amazon Web Services resources.

  • (dict) –

    The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

    • Key (string) – [REQUIRED]

      Tag key.

    • Value (string) – [REQUIRED]

      Tag value.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'DlpSettingId': 'string',
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the created DLP setting.

  • DlpSettingId (string) –

    The ID of the created DLP setting.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.ResourceExistsException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidRequestException

• QuickSight.Client.exceptions.InternalFailureException

• QuickSight.Client.exceptions.LimitExceededException

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.ConflictException