QuickSight / Client / list_dlp_settings

list_dlp_settings

QuickSight.Client.list_dlp_settings(**kwargs)

Lists all DLP settings in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_dlp_settings(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the DLP settings that you want to list.

  • NextToken (string) – The token for the next set of results, or null if there are no more results.

  • MaxResults (integer) – The maximum number of results to return per request.

Return type:

dict

Returns:

Response Syntax

{
    'DlpSettingSummaries': [
        {
            'DlpSettingId': 'string',
            'Name': 'string',
            'Arn': 'string',
            'Status': 'ACTIVE'|'INACTIVE',
            'ProviderType': 'MICROSOFT_PURVIEW',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • DlpSettingSummaries (list) –

      A list of DlpSettingSummary objects for the DLP settings in the account. The list is empty if no DLP settings have been configured.

      • (dict) –

        A summary of a DLP setting returned by list operations.

        • 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.

        • 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.

    • NextToken (string) –

      The token for the next set of results, or null if there are no more results.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidRequestException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.AccessDeniedException