Amazon DataZone Datazone Runs API
The Datazone Runs API from Amazon DataZone — 2 operation(s) for datazone runs.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-runs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon DataZone Runs API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for Amazon DataZone. 3 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://datazone.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Runs
paths:
/v2/domains/{domainIdentifier}/jobs/{jobIdentifier}/runs:
get:
operationId: ListJobRuns
summary: List Job Runs
description: Lists job runs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobRunsOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobRunsInput'
tags:
- Runs
/v2/domains/{domainIdentifier}/data-sources/{dataSourceIdentifier}/runs:
post:
operationId: StartDataSourceRun
summary: Start Data Source Run
description: Start the run of the specified data source in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartDataSourceRunOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartDataSourceRunInput'
tags:
- Runs
get:
operationId: ListDataSourceRuns
summary: List Data Source Runs
description: Lists data source runs in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDataSourceRunsOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListDataSourceRunsInput'
tags:
- Runs
components:
schemas:
ListDataSourceRunsOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DataSourceRunSummary'
description: The results of the ListDataSourceRuns action.
nextToken:
type: string
description: When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.
required:
- items
ValidationException:
type: object
properties:
message:
type: string
required:
- message
RunStatisticsForAssets:
type: object
properties:
added:
type: integer
description: The added statistic for the data source run.
updated:
type: integer
description: The updated statistic for the data source run.
unchanged:
type: integer
description: The unchanged statistic for the data source run.
skipped:
type: integer
description: The skipped statistic for the data source run.
failed:
type: integer
description: The failed statistic for the data source run.
StartDataSourceRunOutput:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which to start a data source run.
dataSourceId:
type: string
description: The identifier of the data source.
id:
type: string
description: The identifier of the data source run.
projectId:
type: string
description: The identifier of the project.
status:
type: string
enum:
- REQUESTED
- RUNNING
- FAILED
- PARTIALLY_SUCCEEDED
- SUCCESS
description: The status of the data source run.
type:
type: string
enum:
- PRIORITIZED
- SCHEDULED
description: The type of the data source run.
dataSourceConfigurationSnapshot:
type: string
description: The configuration snapshot of the data source that is being run.
runStatisticsForAssets:
$ref: '#/components/schemas/RunStatisticsForAssets'
errorMessage:
$ref: '#/components/schemas/DataSourceErrorMessage'
createdAt:
type: string
format: date-time
description: The timestamp of when data source run was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the data source run was updated.
startedAt:
type: string
format: date-time
description: The timestamp of when the data source run was started.
stoppedAt:
type: string
format: date-time
description: The timestamp of when the data source run was stopped.
required:
- domainId
- dataSourceId
- id
- projectId
- status
- type
- createdAt
- updatedAt
JobRunError:
type: object
properties:
message:
type: string
description: The job run error message.
required:
- message
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
ListJobRunsInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where you want to list job runs.
jobIdentifier:
type: string
description: The ID of the job run.
status:
type: string
enum:
- SCHEDULED
- IN_PROGRESS
- SUCCESS
- PARTIALLY_SUCCEEDED
- FAILED
- ABORTED
- TIMED_OUT
- CANCELED
description: The status of a job run.
sortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
description: Specifies the order in which job runs are to be sorted.
nextToken:
type: string
description: When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.
maxResults:
type: integer
description: The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs.
required:
- domainIdentifier
- jobIdentifier
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
DataSourceErrorMessage:
type: object
properties:
errorType:
type: string
enum:
- ACCESS_DENIED_EXCEPTION
- CONFLICT_EXCEPTION
- INTERNAL_SERVER_EXCEPTION
- RESOURCE_NOT_FOUND_EXCEPTION
- SERVICE_QUOTA_EXCEEDED_EXCEPTION
- THROTTLING_EXCEPTION
- VALIDATION_EXCEPTION
description: The type of the error message that is returned if the operation cannot be successfully completed.
errorDetail:
type: string
description: The details of the error message that is returned if the operation cannot be successfully completed.
required:
- errorType
DataSourceRunSummary:
type: object
properties:
id:
type: string
description: The identifier of the data source run.
dataSourceId:
type: string
description: The identifier of the data source of the data source run.
type:
type: string
enum:
- PRIORITIZED
- SCHEDULED
description: The type of the data source run.
status:
type: string
enum:
- REQUESTED
- RUNNING
- FAILED
- PARTIALLY_SUCCEEDED
- SUCCESS
description: The status of the data source run.
projectId:
type: string
description: The project ID of the data source run.
runStatisticsForAssets:
$ref: '#/components/schemas/RunStatisticsForAssets'
errorMessage:
$ref: '#/components/schemas/DataSourceErrorMessage'
createdAt:
type: string
format: date-time
description: The timestamp of when a data source run was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when a data source run was updated.
startedAt:
type: string
format: date-time
description: The timestamp of when a data source run was started.
stoppedAt:
type: string
format: date-time
description: The timestamp of when a data source run was stopped.
lineageSummary:
$ref: '#/components/schemas/DataSourceRunLineageSummary'
required:
- id
- dataSourceId
- type
- status
- projectId
- createdAt
- updatedAt
StartDataSourceRunInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which to start a data source run.
dataSourceIdentifier:
type: string
description: The identifier of the data source.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- domainIdentifier
- dataSourceIdentifier
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
ListJobRunsOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/JobRunSummary'
description: The results of the ListJobRuns action.
nextToken:
type: string
description: When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.
JobRunSummary:
type: object
properties:
domainId:
type: string
description: The domain ID of the job run.
jobId:
type: string
description: The job ID of a job run.
jobType:
type: string
enum:
- LINEAGE
description: The job type of a job run.
runId:
type: string
description: The run ID of a job run.
runMode:
type: string
enum:
- SCHEDULED
- ON_DEMAND
description: The run mode of a job run.
status:
type: string
enum:
- SCHEDULED
- IN_PROGRESS
- SUCCESS
- PARTIALLY_SUCCEEDED
- FAILED
- ABORTED
- TIMED_OUT
- CANCELED
description: The status of a job run.
error:
$ref: '#/components/schemas/JobRunError'
createdBy:
type: string
description: The user who created the job run.
createdAt:
type: string
description: The timestamp at which job run was created.
startTime:
type: string
description: The start time of a job run.
endTime:
type: string
description: The end time of a job run.
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
ListDataSourceRunsInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.
dataSourceIdentifier:
type: string
description: The identifier of the data source.
status:
type: string
enum:
- REQUESTED
- RUNNING
- FAILED
- PARTIALLY_SUCCEEDED
- SUCCESS
description: The status of the data source.
nextToken:
type: string
description: When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.
maxResults:
type: integer
description: The maximum number of runs to return in a single call to ListDataSourceRuns. When the number of runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSourceRuns to list the next set of runs.
required:
- domainIdentifier
- dataSourceIdentifier
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
required:
- message
DataSourceRunLineageSummary:
type: object
properties:
importStatus:
type: string
enum:
- IN_PROGRESS
- SUCCESS
- FAILED
- PARTIALLY_SUCCEEDED
description: The import status that's part of the run lineage summary of a data source.
ConflictException:
type: object
properties:
message:
type: string
required:
- message
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: datazone
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)