QuickSight / Client / put_data_set_refresh_properties

put_data_set_refresh_properties

QuickSight.Client.put_data_set_refresh_properties(**kwargs)

Creates or updates the dataset refresh properties for the dataset.

See also: AWS API Documentation

Request Syntax

response = client.put_data_set_refresh_properties(
    AwsAccountId='string',
    DataSetId='string',
    DataSetRefreshProperties={
        'RefreshConfiguration': {
            'IncrementalRefresh': {
                'LookbackWindow': {
                    'ColumnName': 'string',
                    'Size': 123,
                    'SizeUnit': 'HOUR'|'DAY'|'WEEK'
                }
            }
        }
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The Amazon Web Services account ID.

• DataSetId (string) –

  [REQUIRED]

  The ID of the dataset.

• DataSetRefreshProperties (dict) –

  [REQUIRED]

  The dataset refresh properties.

  • RefreshConfiguration (dict) – [REQUIRED]

    The refresh configuration for a dataset.

    • IncrementalRefresh (dict) – [REQUIRED]

      The incremental refresh for the dataset.

      • LookbackWindow (dict) – [REQUIRED]

        The lookback window setup for an incremental refresh configuration.

        • ColumnName (string) – [REQUIRED]

          The name of the lookback window column.

        • Size (integer) – [REQUIRED]

          The lookback window column size.

        • SizeUnit (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.LimitExceededException

• QuickSight.Client.exceptions.PreconditionNotMetException

• QuickSight.Client.exceptions.ConflictException

• QuickSight.Client.exceptions.InternalFailureException