QuickSight / Client / describe_data_set_refresh_properties

describe_data_set_refresh_properties#

QuickSight.Client.describe_data_set_refresh_properties(**kwargs)#

Describes the refresh properties of a dataset.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_set_refresh_properties(
    AwsAccountId='string',
    DataSetId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID.

  • DataSetId (string) –

    [REQUIRED]

    The ID of the dataset.

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123,
    'DataSetRefreshProperties': {
        'RefreshConfiguration': {
            'IncrementalRefresh': {
                'LookbackWindow': {
                    'ColumnName': 'string',
                    'Size': 123,
                    'SizeUnit': 'HOUR'|'DAY'|'WEEK'
                }
            }
        }
    }
}

Response Structure

  • (dict) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

    • DataSetRefreshProperties (dict) –

      The dataset refresh properties.

      • RefreshConfiguration (dict) –

        The refresh configuration for a dataset.

        • IncrementalRefresh (dict) –

          The incremental refresh for the dataset.

          • LookbackWindow (dict) –

            The lookback window setup for an incremental refresh configuration.

            • ColumnName (string) –

              The name of the lookback window column.

            • Size (integer) –

              The lookback window column size.

            • SizeUnit (string) –

              The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

Exceptions