find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aws-glue:aws-glue-column-statistics-task-run-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Glue Column Statistics Task Run API
  version: '2017-03-31'
  description: Generated from AWS's published Smithy model for AWS Glue. 5 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: Column Statistics Task Run
paths:
  /#GetColumnStatisticsTaskRun:
    post:
      operationId: GetColumnStatisticsTaskRun
      summary: Get Column Statistics 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/GetColumnStatisticsTaskRunResponse'
        '400':
          description: EntityNotFoundException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetColumnStatisticsTaskRun
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetColumnStatisticsTaskRunRequest'
      tags:
      - Column Statistics Task Run
  /#GetColumnStatisticsTaskRuns:
    post:
      operationId: GetColumnStatisticsTaskRuns
      summary: Get Column Statistics Task Runs
      description: Retrieves information about all runs associated with the specified table.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetColumnStatisticsTaskRunsResponse'
        '400':
          description: OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetColumnStatisticsTaskRuns
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetColumnStatisticsTaskRunsRequest'
      tags:
      - Column Statistics Task Run
  /#ListColumnStatisticsTaskRuns:
    post:
      operationId: ListColumnStatisticsTaskRuns
      summary: List Column Statistics 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/ListColumnStatisticsTaskRunsResponse'
        '400':
          description: OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.ListColumnStatisticsTaskRuns
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListColumnStatisticsTaskRunsRequest'
      tags:
      - Column Statistics Task Run
  /#StartColumnStatisticsTaskRun:
    post:
      operationId: StartColumnStatisticsTaskRun
      summary: Start Column Statistics Task Run
      description: Starts a column statistics task run, for a specified table and columns.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartColumnStatisticsTaskRunResponse'
        '400':
          description: AccessDeniedException; ColumnStatisticsTaskRunningException; EntityNotFoundException; InvalidInputException; 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.StartColumnStatisticsTaskRun
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartColumnStatisticsTaskRunRequest'
      tags:
      - Column Statistics Task Run
  /#StopColumnStatisticsTaskRun:
    post:
      operationId: StopColumnStatisticsTaskRun
      summary: Stop Column Statistics Task Run
      description: Stops a task run for the specified table.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopColumnStatisticsTaskRunResponse'
        '400':
          description: ColumnStatisticsTaskNotRunningException; ColumnStatisticsTaskStoppingException; EntityNotFoundException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ColumnStatisticsTaskNotRunningException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.StopColumnStatisticsTaskRun
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopColumnStatisticsTaskRunRequest'
      tags:
      - Column Statistics Task Run
components:
  schemas:
    GetColumnStatisticsTaskRunRequest:
      type: object
      properties:
        ColumnStatisticsTaskRunId:
          type: string
          description: The identifier for the particular column statistics task run.
      required:
      - ColumnStatisticsTaskRunId
    GetColumnStatisticsTaskRunsRequest:
      type: object
      properties:
        DatabaseName:
          type: string
          description: The name of the database where the table resides.
        TableName:
          type: string
          description: The name of the table.
        MaxResults:
          type: integer
          description: The maximum size of the response.
        NextToken:
          type: string
          description: A continuation token, if this is a continuation call.
        CatalogID:
          type: string
          description: The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
      required:
      - DatabaseName
      - TableName
    ColumnStatisticsTaskRun:
      type: object
      properties:
        CustomerId:
          type: string
          description: The Amazon Web Services account ID.
        ColumnStatisticsTaskRunId:
          type: string
          description: The identifier for the particular column statistics task run.
        DatabaseName:
          type: string
          description: The database where the table resides.
        TableName:
          type: string
          description: The name of the table for which column statistics is generated.
        ColumnNameList:
          type: array
          items:
            type: string
          description: A list of the column names. If none is supplied, all column names for the table will be used by default.
        CatalogID:
          type: string
          description: The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
        Role:
          type: string
          description: The IAM role that the service assumes to generate statistics.
        SampleSize:
          type: number
          description: The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
        SecurityConfiguration:
          type: string
          description: Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
        NumberOfWorkers:
          type: integer
          description: The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
        WorkerType:
          type: string
          description: The type of workers being used for generating stats. The default is g.1x.
        ComputationType:
          type: string
          enum:
          - FULL
          - INCREMENTAL
          description: The type of column statistics computation.
        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.
    GetColumnStatisticsTaskRunsResponse:
      type: object
      properties:
        ColumnStatisticsTaskRuns:
          type: array
          items:
            $ref: '#/components/schemas/ColumnStatisticsTaskRun'
          description: A list of column statistics task runs.
        NextToken:
          type: string
          description: A continuation token, if not all task runs have yet been returned.
    StopColumnStatisticsTaskRunRequest:
      type: object
      properties:
        DatabaseName:
          type: string
          description: The name of the database where the table resides.
        TableName:
          type: string
          description: The name of the table.
        CatalogID:
          type: string
          description: The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
      required:
      - DatabaseName
      - TableName
    ListColumnStatisticsTaskRunsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum size of the response.
        NextToken:
          type: string
          description: A continuation token, if this is a continuation call.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    OperationTimeoutException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    StartColumnStatisticsTaskRunResponse:
      type: object
      properties:
        ColumnStatisticsTaskRunId:
          type: string
          description: The identifier for the column statistics task run.
    ListColumnStatisticsTaskRunsResponse:
      type: object
      properties:
        ColumnStatisticsTaskRunIds:
          type: array
          items:
            type: string
          description: A list of column statistics task run IDs.
        NextToken:
          type: string
          description: A continuation token, if not all task run IDs have yet been returned.
    GetColumnStatisticsTaskRunResponse:
      type: object
      properties:
        ColumnStatisticsTaskRun:
          $ref: '#/components/schemas/ColumnStatisticsTaskRun'
    StartColumnStatisticsTaskRunRequest:
      type: object
      properties:
        DatabaseName:
          type: string
          description: The name of the database where the table resides.
        TableName:
          type: string
          description: The name of the table to generate statistics.
        ColumnNameList:
          type: array
          items:
            type: string
          description: A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
        Role:
          type: string
          description: The IAM role that the service assumes to generate statistics.
        SampleSize:
          type: number
          description: The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
        CatalogID:
          type: string
          description: The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
        SecurityConfiguration:
          type: string
          description: Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
      required:
      - DatabaseName
      - TableName
      - Role
    ColumnStatisticsTaskNotRunningException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    EntityNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
        FromFederationSource:
          type: boolean
          description: Indicates whether or not the exception relates to a federated source.
    StopColumnStatisticsTaskRunResponse:
      type: object
      properties: {}
  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)