Materialized view API

• MaterializedViewRefreshTaskRun structure

Fields

• CustomerId – UTF-8 string, not more than 12 bytes long.

  The AWS account ID.

• MaterializedViewRefreshTaskRunId – UTF-8 string, matching the Custom string pattern #48.

  The identifier of the materialized view refresh task run.

• DatabaseName – UTF-8 string.

  The database where the table resides.

• TableName – UTF-8 string.

  The name of the materialized view.

• CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default.

• Role – UTF-8 string.

  The IAM role that the service assumes to run the materialized view refresh task.

• Status – UTF-8 string (valid values: STARTING | RUNNING | SUCCEEDED | FAILED | STOPPED).

  The status of the task run.

• CreationTime – Timestamp.

  The time that this task was created.

• LastUpdated – Timestamp.

  The last point in time when this task was modified.

• StartTime – Timestamp.

  The start time of the task.

• EndTime – Timestamp.

  The end time of the task.

• ErrorMessage – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

  The error message for the job.

• DPUSeconds – Number (double).

  The calculated DPU usage in seconds for all autoscaled workers.

• RefreshType – UTF-8 string (valid values: FULL | INCREMENTAL).

  The type of the refresh task run. Either FULL or INCREMENTAL.

• ProcessedBytes – Number (long).

  The number of bytes the refresh task run has scanned to refresh the materialized view.

• StartMaterializedViewRefreshTaskRun action (Python: start_materialized_view_refresh_task_run)

• StopMaterializedViewRefreshTaskRun action (Python: stop_materialized_view_refresh_task_run)

• GetMaterializedViewRefreshTaskRun action (Python: get_materialized_view_refresh_task_run)

• ListMaterializedViewRefreshTaskRuns action (Python: list_materialized_view_refresh_task_runs)

Request

• CatalogId – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The ID of the Data Catalog where the table reside. If none is supplied, the account ID is used by default.

• DatabaseName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the database where the table resides.

• TableName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the materialized view to run the refresh task for.

• FullRefresh – Boolean.

  Specifies whether this is a full refresh of the task run.

Response

• MaterializedViewRefreshTaskRunId – UTF-8 string, matching the Custom string pattern #48.

  The identifier for the materialized view refresh task run.

Errors

• AccessDeniedException

• EntityNotFoundException

• MaterializedViewRefreshTaskRunningException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InvalidInputException

Request

• CatalogId – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The ID of the Data Catalog where the table reside. If none is supplied, the account ID is used by default.

• DatabaseName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the database where the table resides.

• TableName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the materialized view.

Response

• No Response parameters.

Errors

• AccessDeniedException

• MaterializedViewRefreshTaskNotRunningException

• MaterializedViewRefreshTaskStoppingException

• InvalidInputException

• OperationTimeoutException

Request

• CatalogId – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default.

• MaterializedViewRefreshTaskRunId – Required: UTF-8 string, matching the Custom string pattern #48.

  The identifier for the particular materialized view refresh task run.

Response

• MaterializedViewRefreshTaskRun – A MaterializedViewRefreshTaskRun object.

  A MaterializedViewRefreshTaskRun object representing the details of the task run.

Errors

• AccessDeniedException

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

Request

• CatalogId – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default.

• DatabaseName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The database where the table resides.

• TableName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the materialized view.

• MaxResults – Number (integer), not less than 1 or more than 1000.

  The maximum size of the response.

• NextToken – UTF-8 string.

  A continuation token, if this is a continuation call.

Response

• MaterializedViewRefreshTaskRuns – An array of MaterializedViewRefreshTaskRun objects.

  The results of the ListMaterializedViewRefreshTaskRuns action.

• NextToken – UTF-8 string.

  A continuation token, if not all task run IDs have yet been returned.

Errors

• AccessDeniedException

• InvalidInputException

• OperationTimeoutException

• MaterializedViewRefreshTaskRunningException structure

• MaterializedViewRefreshTaskNotRunningException structure

• MaterializedViewRefreshTaskStoppingException structure

Fields

• Message – UTF-8 string.

  A message describing the problem.

Fields

• Message – UTF-8 string.

  A message describing the problem.

Fields

• Message – UTF-8 string.

  A message describing the problem.