

# API de vista materializada
<a name="aws-glue-api-catalog-materialized-views"></a>

La API de vista materializada describe los tipos de datos y las operaciones de AWS Glue para iniciar, detener y supervisar las ejecuciones de las tareas de actualización de vista materializada.

## Tipos de datos
<a name="aws-glue-api-catalog-materialized-views-objects"></a>
+ [Estructura de MaterializedViewRefreshTaskRun](#aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskRun)

## Estructura de MaterializedViewRefreshTaskRun
<a name="aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskRun"></a>

Objeto que muestra los detalles de la ejecución de la tarea de actualización de la vista materializada.

**Campos**
+ `CustomerId`: cadena UTF-8, no más de 12 bytes de largo.

  El ID de la cuenta de AWS.
+ `MaterializedViewRefreshTaskRunId` – cadena UTF-8 que coincide con el [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Identificador de la ejecución de la tarea de actualización de la vista materializada.
+ `DatabaseName`: cadena UTF-8.

  La base de datos en la que se encuentra la tabla.
+ `TableName`: cadena UTF-8.

  El nombre de la vista materializada.
+ `CatalogId` – cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El ID del Catálogo de datos donde reside la tabla. Si no se proporciona ninguno, el ID de cuenta de se usará de forma predeterminada.
+ `Role`: cadena UTF-8.

  Rol de IAM que asume el servicio para ejecutar la tarea de actualización de la vista materializada.
+ `Status` – cadena UTF-8 (valores válidos: `STARTING` \| `RUNNING` \| `SUCCEEDED` \| `FAILED` \| `STOPPED`).

  El estado de la ejecución de la tarea.
+ `CreationTime`: marca temporal.

  La hora en que se creó esta tarea.
+ `LastUpdated`: marca temporal.

  El último punto temporal en que se modificó esta tarea.
+ `StartTime`: marca temporal.

  La hora de inicio de la tarea.
+ `EndTime`: marca temporal.

  La hora de finalización de la tarea.
+ `ErrorMessage` – cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  El mensaje de error del trabajo.
+ `DPUSeconds`: número (doble).

  El uso de la DPU calculado en segundos para todos los trabajadores con escalado automático.
+ `RefreshType` – cadena UTF-8 (valores válidos: `FULL` \| `INCREMENTAL`).

  Tipo de ejecución de la tarea de actualización. Puede ser FULL o INCREMENTAL.
+ `ProcessedBytes`: número (largo).

  Cantidad de bytes que ha escaneado la ejecución de la tarea de actualización para actualizar la vista materializada.

## Operaciones
<a name="aws-glue-api-catalog-materialized-views-actions"></a>
+ [Acción StartMaterializedViewRefreshTaskRun (Python: start\_materialized\_view\_refresh\_task\_run)](#aws-glue-api-catalog-materialized-views-StartMaterializedViewRefreshTaskRun)
+ [Acción StopMaterializedViewRefreshTaskRun (Python: stop\_materialized\_view\_refresh\_task\_run)](#aws-glue-api-catalog-materialized-views-StopMaterializedViewRefreshTaskRun)
+ [Acción GetMaterializedViewRefreshTaskRun (Python: get\_materialized\_view\_refresh\_task\_run)](#aws-glue-api-catalog-materialized-views-GetMaterializedViewRefreshTaskRun)
+ [Acción ListMaterializedViewRefreshTaskRuns (Python: list\_materialized\_view\_refresh\_task\_runs)](#aws-glue-api-catalog-materialized-views-ListMaterializedViewRefreshTaskRuns)

## Acción StartMaterializedViewRefreshTaskRun (Python: start\_materialized\_view\_refresh\_task\_run)
<a name="aws-glue-api-catalog-materialized-views-StartMaterializedViewRefreshTaskRun"></a>

Inicia una ejecución de tarea de actualización de vista materializada para una vista materializada especificada.

**Solicitud**
+ `CatalogId`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El ID del catálogo de datos donde reside la tabla. Si no se proporciona ninguno, el ID de cuenta de se usará de forma predeterminada.
+ `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre de la base de datos donde reside la tabla.
+ `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nombre de la vista materializada para la que se ejecutará la tarea de actualización.
+ `FullRefresh`: booleano.

  Especifica si se trata de una actualización completa de la ejecución de la tarea.

**Respuesta**
+ `MaterializedViewRefreshTaskRunId` – cadena UTF-8 que coincide con el [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Identificador de la ejecución de la tarea de actualización de la vista materializada.

**Errores**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `MaterializedViewRefreshTaskRunningException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InvalidInputException`

## Acción StopMaterializedViewRefreshTaskRun (Python: stop\_materialized\_view\_refresh\_task\_run)
<a name="aws-glue-api-catalog-materialized-views-StopMaterializedViewRefreshTaskRun"></a>

Detiene una ejecución de tarea de actualización de vista materializada para una vista materializada especificada.

**Solicitud**
+ `CatalogId`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El ID del catálogo de datos donde reside la tabla. Si no se proporciona ninguno, el ID de cuenta de se usará de forma predeterminada.
+ `DatabaseName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre de la base de datos donde reside la tabla.
+ `TableName`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre de la vista materializada.

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ `AccessDeniedException`
+ `MaterializedViewRefreshTaskNotRunningException`
+ `MaterializedViewRefreshTaskStoppingException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Acción GetMaterializedViewRefreshTaskRun (Python: get\_materialized\_view\_refresh\_task\_run)
<a name="aws-glue-api-catalog-materialized-views-GetMaterializedViewRefreshTaskRun"></a>

Obtenga los metadatos o la información asociados a la ejecución de una tarea, con un identificador de ejecución de la tarea determinado.

**Solicitud**
+ `CatalogId`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El ID del Catálogo de datos donde reside la tabla. Si no se proporciona ninguno, el ID de cuenta de se usará de forma predeterminada.
+ `MaterializedViewRefreshTaskRunId`: *obligatorio:* cadena UTF-8 que coincide con el [Custom string pattern #48](aws-glue-api-common.md#regex_48).

  Identificador de la ejecución de la tarea de actualización de la vista materializada específica.

**Respuesta**
+ `MaterializedViewRefreshTaskRun`: un objeto [MaterializedViewRefreshTaskRun](#aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskRun).

  Objeto MaterializedViewRefreshTaskRun que representa los detalles de la ejecución de la tarea.

**Errores**
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`

## Acción ListMaterializedViewRefreshTaskRuns (Python: list\_materialized\_view\_refresh\_task\_runs)
<a name="aws-glue-api-catalog-materialized-views-ListMaterializedViewRefreshTaskRuns"></a>

Enumera todas las ejecuciones de tareas para una cuenta en particular.

**Solicitud**
+ `CatalogId`: *obligatorio:* cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El ID del Catálogo de datos donde reside la tabla. Si no se proporciona ninguno, el ID de cuenta de se usará de forma predeterminada.
+ `DatabaseName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  La base de datos en la que se encuentra la tabla.
+ `TableName` – cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre de la vista materializada.
+ `MaxResults`: número (entero) que no es inferior a 1 ni es superior a 1000.

  Tamaño máximo de la respuesta.
+ `NextToken`: cadena UTF-8.

  Token de continuación si se trata de una llamada de continuidad.

**Respuesta**
+ `MaterializedViewRefreshTaskRuns`: matriz de objetos [MaterializedViewRefreshTaskRun](#aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskRun).

  Resultados de la acción ListMaterializedViewRefreshTaskRuns. 
+ `NextToken`: cadena UTF-8.

  Un token de continuación, si todavía no se han devuelto todos los identificadores de ejecución de tareas.

**Errores**
+ `AccessDeniedException`
+ `InvalidInputException`
+ `OperationTimeoutException`

## Excepciones
<a name="aws-glue-api-catalog-materialized-views-exceptions"></a>
+ [Estructura de MaterializedViewRefreshTaskRunningException](#aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskRunningException)
+ [Estructura de MaterializedViewRefreshTaskNotRunningException](#aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskNotRunningException)
+ [Estructura de MaterializedViewRefreshTaskStoppingException](#aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskStoppingException)

## Estructura de MaterializedViewRefreshTaskRunningException
<a name="aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskRunningException"></a>

Excepción que se produce cuando una tarea ya se encuentra en estado de ejecución.

**Campos**
+ `Message`: cadena UTF-8.

  Mensaje que describe el problema.

## Estructura de MaterializedViewRefreshTaskNotRunningException
<a name="aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskNotRunningException"></a>

Excepción que se produce cuando se detiene una tarea que no se encuentra en estado de ejecución.

**Campos**
+ `Message`: cadena UTF-8.

  Mensaje que describe el problema.

## Estructura de MaterializedViewRefreshTaskStoppingException
<a name="aws-glue-api-catalog-materialized-views-MaterializedViewRefreshTaskStoppingException"></a>

Excepción que se produce cuando una tarea ya se encuentra en estado de detención.

**Campos**
+ `Message`: cadena UTF-8.

  Mensaje que describe el problema.