QuickSight / Client / describe_dlp_setting

describe_dlp_setting

QuickSight.Client.describe_dlp_setting(**kwargs)

Describes the full configuration of a DLP setting in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.describe_dlp_setting(
    AwsAccountId='string',
    DlpSettingId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • DlpSettingId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DlpSetting': {
        'DlpSettingId': 'string',
        'Name': 'string',
        'Arn': 'string',
        'Status': 'ACTIVE'|'INACTIVE',
        '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',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • DlpSetting (dict) –

      The full configuration of the requested DLP setting, returned as a DlpSettingDetails object.

      • DlpSettingId (string) –

        The ID of the DLP setting.

      • Name (string) –

        The display name of the DLP setting.

      • Arn (string) –

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

      • Status (string) –

        The status of the DLP setting. Valid values are ACTIVE and INACTIVE.

      • ProviderType (string) –

        The type of external DLP provider used for sensitivity label classification.

      • ProviderConfig (dict) –

        The provider-specific configuration for the DLP integration.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: MicrosoftPurview. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • MicrosoftPurview (dict) –

          The configuration for a Microsoft Purview DLP integration.

          • Credentials (dict) –

            The credentials used to authenticate with Microsoft Purview.

            • SecretArn (string) –

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

            The mappings from Microsoft Purview sensitivity labels to enforcement actions.

            • (dict) –

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

              • LabelId (string) –

                The identifier of the sensitivity label from the DLP provider.

              • LabelName (string) –

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

              • Action (string) –

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

          • UnmappedAction (string) –

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

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

      • CreatedAt (datetime) –

        The date and time that the DLP setting was created, in ISO 8601 format.

      • UpdatedAt (datetime) –

        The date and time that the DLP setting was most recently updated, in ISO 8601 format.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions