AWS Glue

Stops a materialized view refresh task run, for a specified table and columns.

See also: AWS API Documentation

Request Syntax

client.stop_materialized_view_refresh_task_run(
    CatalogId='string',
    DatabaseName='string',
    TableName='string'
)

type CatalogId:

string

param CatalogId:

[REQUIRED]

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

type DatabaseName:

string

param DatabaseName:

[REQUIRED]

The name of the database where the table resides.

type TableName:

string

param TableName:

[REQUIRED]

The name of the table to generate statistics.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

List all task runs for a particular account.

See also: AWS API Documentation

Request Syntax

client.list_materialized_view_refresh_task_runs(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    MaxResults=123,
    NextToken='string'
)

type CatalogId:

string

param CatalogId:

[REQUIRED]

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

type DatabaseName:

string

param DatabaseName:

The database where the table resides.

type TableName:

string

param TableName:

The name of the table for which statistics is generated.

type MaxResults:

integer

param MaxResults:

The maximum size of the response.

type NextToken:

string

param NextToken:

A continuation token, if this is a continuation call.

rtype:

dict

returns:

Response Syntax

{
    'MaterializedViewRefreshTaskRuns': [
        {
            'CustomerId': 'string',
            'MaterializedViewRefreshTaskRunId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'CatalogId': 'string',
            'Role': 'string',
            'Status': 'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPED',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'ErrorMessage': 'string',
            'DPUSeconds': 123.0,
            'RefreshType': 'FULL'|'INCREMENTAL',
            'ProcessedBytes': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • MaterializedViewRefreshTaskRuns (list) --

    The results of the ListMaterializedViewRefreshTaskRuns action.

    • (dict) --

      The object that shows the details of the materialized view refresh task run.

      • CustomerId (string) --

        The Amazon Web Services account ID.

      • MaterializedViewRefreshTaskRunId (string) --

        The identifier of the materialized view refresh task run.

      • DatabaseName (string) --

        The database where the table resides.

      • TableName (string) --

        The name of the table for which statistics is generated.

      • CatalogId (string) --

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

      • Role (string) --

        The IAM role that the service assumes to generate statistics.

      • Status (string) --

        The status of the task run.

      • CreationTime (datetime) --

        The time that this task was created.

      • LastUpdated (datetime) --

        The last point in time when this task was modified.

      • StartTime (datetime) --

        The start time of the task.

      • EndTime (datetime) --

        The end time of the task.

      • ErrorMessage (string) --

        The error message for the job.

      • DPUSeconds (float) --

        The calculated DPU usage in seconds for all autoscaled workers.

      • RefreshType (string) --

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

      • ProcessedBytes (integer) --

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

  • NextToken (string) --

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

Get the associated metadata/information for a task run, given a task run ID.

See also: AWS API Documentation

Request Syntax

client.get_materialized_view_refresh_task_run(
    CatalogId='string',
    MaterializedViewRefreshTaskRunId='string'
)

type CatalogId:

string

param CatalogId:

[REQUIRED]

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

type MaterializedViewRefreshTaskRunId:

string

param MaterializedViewRefreshTaskRunId:

[REQUIRED]

The identifier for the particular materialized view refresh task run.

rtype:

dict

returns:

Response Syntax

{
    'MaterializedViewRefreshTaskRun': {
        'CustomerId': 'string',
        'MaterializedViewRefreshTaskRunId': 'string',
        'DatabaseName': 'string',
        'TableName': 'string',
        'CatalogId': 'string',
        'Role': 'string',
        'Status': 'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPED',
        'CreationTime': datetime(2015, 1, 1),
        'LastUpdated': datetime(2015, 1, 1),
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'ErrorMessage': 'string',
        'DPUSeconds': 123.0,
        'RefreshType': 'FULL'|'INCREMENTAL',
        'ProcessedBytes': 123
    }
}

Response Structure

• (dict) --

  • MaterializedViewRefreshTaskRun (dict) --

    A MaterializedViewRefreshTaskRun object representing the details of the task run.

    • CustomerId (string) --

      The Amazon Web Services account ID.

    • MaterializedViewRefreshTaskRunId (string) --

      The identifier of the materialized view refresh task run.

    • DatabaseName (string) --

      The database where the table resides.

    • TableName (string) --

      The name of the table for which statistics is generated.

    • CatalogId (string) --

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

    • Role (string) --

      The IAM role that the service assumes to generate statistics.

    • Status (string) --

      The status of the task run.

    • CreationTime (datetime) --

      The time that this task was created.

    • LastUpdated (datetime) --

      The last point in time when this task was modified.

    • StartTime (datetime) --

      The start time of the task.

    • EndTime (datetime) --

      The end time of the task.

    • ErrorMessage (string) --

      The error message for the job.

    • DPUSeconds (float) --

      The calculated DPU usage in seconds for all autoscaled workers.

    • RefreshType (string) --

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

    • ProcessedBytes (integer) --

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

Starts a materialized view refresh task run, for a specified table and columns.

See also: AWS API Documentation

Request Syntax

client.start_materialized_view_refresh_task_run(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    FullRefresh=True|False
)

type CatalogId:

string

param CatalogId:

[REQUIRED]

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

type DatabaseName:

string

param DatabaseName:

[REQUIRED]

The name of the database where the table resides.

type TableName:

string

param TableName:

[REQUIRED]

The name of the table to generate run the materialized view refresh task.

type FullRefresh:

boolean

param FullRefresh:

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

rtype:

dict

returns:

Response Syntax

{
    'MaterializedViewRefreshTaskRunId': 'string'
}

Response Structure

• (dict) --

  • MaterializedViewRefreshTaskRunId (string) --

    The identifier for the materialized view refresh task run.