AWS Glue Glue Materialized View Refresh Task Run API

openapi: 3.2.0
info:
  title: AWS Glue Materialized View Refresh Task Run API
  version: '2017-03-31'
  description: Generated from AWS's published Smithy model for AWS Glue. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://glue.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Materialized View Refresh Task Run
paths:
  /#GetMaterializedViewRefreshTaskRun:
    post:
      operationId: GetMaterializedViewRefreshTaskRun
      summary: Get Materialized View Refresh Task Run
      description: Get the associated metadata/information for a task run, given a task run ID.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetMaterializedViewRefreshTaskRunResponse'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetMaterializedViewRefreshTaskRun
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetMaterializedViewRefreshTaskRunRequest'
      tags:
      - Materialized View Refresh Task Run
  /#ListMaterializedViewRefreshTaskRuns:
    post:
      operationId: ListMaterializedViewRefreshTaskRuns
      summary: List Materialized View Refresh Task Runs
      description: List all task runs for a particular account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListMaterializedViewRefreshTaskRunsResponse'
        '400':
          description: AccessDeniedException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.ListMaterializedViewRefreshTaskRuns
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListMaterializedViewRefreshTaskRunsRequest'
      tags:
      - Materialized View Refresh Task Run
  /#StartMaterializedViewRefreshTaskRun:
    post:
      operationId: StartMaterializedViewRefreshTaskRun
      summary: Start Materialized View Refresh Task Run
      description: Starts a materialized view refresh task run for a specified materialized view.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartMaterializedViewRefreshTaskRunResponse'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException; MaterializedViewRefreshTaskRunningException; OperationTimeoutException; ResourceNumberLimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.StartMaterializedViewRefreshTaskRun
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartMaterializedViewRefreshTaskRunRequest'
      tags:
      - Materialized View Refresh Task Run
  /#StopMaterializedViewRefreshTaskRun:
    post:
      operationId: StopMaterializedViewRefreshTaskRun
      summary: Stop Materialized View Refresh Task Run
      description: Stops a materialized view refresh task run for a specified materialized view.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopMaterializedViewRefreshTaskRunResponse'
        '400':
          description: AccessDeniedException; InvalidInputException; MaterializedViewRefreshTaskNotRunningException; MaterializedViewRefreshTaskStoppingException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.StopMaterializedViewRefreshTaskRun
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopMaterializedViewRefreshTaskRunRequest'
      tags:
      - Materialized View Refresh Task Run
components:
  schemas:
    GetMaterializedViewRefreshTaskRunRequest:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default.
        MaterializedViewRefreshTaskRunId:
          type: string
          description: The identifier for the particular materialized view refresh task run.
      required:
      - CatalogId
      - MaterializedViewRefreshTaskRunId
    StopMaterializedViewRefreshTaskRunRequest:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog where the table reside. If none is supplied, the account ID is used by default.
        DatabaseName:
          type: string
          description: The name of the database where the table resides.
        TableName:
          type: string
          description: The name of the materialized view.
      required:
      - CatalogId
      - DatabaseName
      - TableName
    StartMaterializedViewRefreshTaskRunResponse:
      type: object
      properties:
        MaterializedViewRefreshTaskRunId:
          type: string
          description: The identifier for the materialized view refresh task run.
    MaterializedViewRefreshTaskRun:
      type: object
      properties:
        CustomerId:
          type: string
          description: The Amazon Web Services account ID.
        MaterializedViewRefreshTaskRunId:
          type: string
          description: The identifier of the materialized view refresh task run.
        DatabaseName:
          type: string
          description: The database where the table resides.
        TableName:
          type: string
          description: The name of the materialized view.
        CatalogId:
          type: string
          description: The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default.
        Role:
          type: string
          description: The IAM role that the service assumes to run the materialized view refresh task.
        Status:
          type: string
          enum:
          - STARTING
          - RUNNING
          - SUCCEEDED
          - FAILED
          - STOPPED
          description: The status of the task run.
        CreationTime:
          type: string
          format: date-time
          description: The time that this task was created.
        LastUpdated:
          type: string
          format: date-time
          description: The last point in time when this task was modified.
        StartTime:
          type: string
          format: date-time
          description: The start time of the task.
        EndTime:
          type: string
          format: date-time
          description: The end time of the task.
        ErrorMessage:
          type: string
          description: The error message for the job.
        DPUSeconds:
          type: number
          description: The calculated DPU usage in seconds for all autoscaled workers.
        RefreshType:
          type: string
          enum:
          - FULL
          - INCREMENTAL
          description: The type of the refresh task run. Either FULL or INCREMENTAL.
        ProcessedBytes:
          type: integer
          description: The number of bytes the refresh task run has scanned to refresh the materialized view.
    ListMaterializedViewRefreshTaskRunsResponse:
      type: object
      properties:
        MaterializedViewRefreshTaskRuns:
          type: array
          items:
            $ref: '#/components/schemas/MaterializedViewRefreshTaskRun'
          description: The results of the ListMaterializedViewRefreshTaskRuns action.
        NextToken:
          type: string
          description: A continuation token, if not all task run IDs have yet been returned.
    StartMaterializedViewRefreshTaskRunRequest:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog where the table reside. If none is supplied, the account ID is used by default.
        DatabaseName:
          type: string
          description: The name of the database where the table resides.
        TableName:
          type: string
          description: The name of the materialized view to run the refresh task for.
        FullRefresh:
          type: boolean
          description: Specifies whether this is a full refresh of the task run.
      required:
      - CatalogId
      - DatabaseName
      - TableName
    StopMaterializedViewRefreshTaskRunResponse:
      type: object
      properties: {}
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    GetMaterializedViewRefreshTaskRunResponse:
      type: object
      properties:
        MaterializedViewRefreshTaskRun:
          $ref: '#/components/schemas/MaterializedViewRefreshTaskRun'
    ListMaterializedViewRefreshTaskRunsRequest:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default.
        DatabaseName:
          type: string
          description: The database where the table resides.
        TableName:
          type: string
          description: The name of the materialized view.
        MaxResults:
          type: integer
          description: The maximum size of the response.
        NextToken:
          type: string
          description: A continuation token, if this is a continuation call.
      required:
      - CatalogId
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: glue
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/glue/service/2017-03-31/glue-2017-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)