QuickSight / Client / update_dlp_setting

update_dlp_setting

QuickSight.Client.update_dlp_setting(**kwargs)

Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted from the request retain their current values.

See also: AWS API Documentation

Request Syntax

response = client.update_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
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the DLP setting that you want to update.

  • DlpSettingId (string) –

    [REQUIRED]

    The ID of the DLP setting that you want to update.

  • Name (string) – An updated display name for the DLP setting.

  • ProviderType (string) – An updated DLP provider type. Currently, the only supported value is MICROSOFT_PURVIEW.

  • ProviderConfig (dict) –

    An updated 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) – An updated behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.

  • Enabled (boolean) – Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or false to disable it.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Arn (string) –

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

    • DlpSettingId (string) –

      The ID of the updated DLP setting.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions