Amazon DataZone Datazone Actions API

The Datazone Actions API from Amazon DataZone — 2 operation(s) for datazone actions.

Operations 5

POST /v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions Create Environment Action #
GET /v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions List Environment Actions #
DELETE /v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier} Delete Environment Action #
GET /v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier} Get Environment Action #
PATCH /v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier} Update Environment Action #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-actions-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

amazon-datazone-actions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon DataZone Actions API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 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://datazone.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Actions
paths:
  /v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions:
    post:
      operationId: CreateEnvironmentAction
      summary: Create Environment Action
      description: Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentActionOutput'
        '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'
        '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/CreateEnvironmentActionInput'
      tags:
      - Actions
    get:
      operationId: ListEnvironmentActions
      summary: List Environment Actions
      description: Lists existing environment actions.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentActionsOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/ListEnvironmentActionsInput'
      tags:
      - Actions
  /v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier}:
    delete:
      operationId: DeleteEnvironmentAction
      summary: Delete Environment Action
      description: Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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'
        '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/DeleteEnvironmentActionInput'
      tags:
      - Actions
    get:
      operationId: GetEnvironmentAction
      summary: Get Environment Action
      description: Gets the specified environment action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentActionOutput'
        '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/GetEnvironmentActionInput'
      tags:
      - Actions
    patch:
      operationId: UpdateEnvironmentAction
      summary: Update Environment Action
      description: Updates an environment action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEnvironmentActionOutput'
        '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'
        '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/UpdateEnvironmentActionInput'
      tags:
      - Actions
components:
  schemas:
    CreateEnvironmentActionOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain in which the environment action is created.
        environmentId:
          type: string
          description: The ID of the environment in which the environment is created.
        id:
          type: string
          description: The ID of the environment action.
        name:
          type: string
          description: The name of the environment action.
        parameters:
          $ref: '#/components/schemas/ActionParameters'
        description:
          type: string
          description: The description of the environment action.
      required:
      - domainId
      - environmentId
      - id
      - name
      - parameters
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EnvironmentActionSummary:
      type: object
      properties:
        domainId:
          type: string
          description: The Amazon DataZone domain ID of the environment action.
        environmentId:
          type: string
          description: The environment ID of the environment action.
        id:
          type: string
          description: The ID of the environment action.
        name:
          type: string
          description: The name of the environment action.
        parameters:
          $ref: '#/components/schemas/ActionParameters'
        description:
          type: string
          description: The environment action description.
      required:
      - domainId
      - environmentId
      - id
      - name
      - parameters
    AwsConsoleLinkParameters:
      type: object
      properties:
        uri:
          type: string
          description: The URI of the console link specified as part of the environment action.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateEnvironmentActionInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the environment action is created.
        environmentIdentifier:
          type: string
          description: The ID of the environment in which the environment action is created.
        name:
          type: string
          description: The name of the environment action.
        parameters:
          $ref: '#/components/schemas/ActionParameters'
        description:
          type: string
          description: The description of the environment action that is being created in the environment.
      required:
      - domainIdentifier
      - environmentIdentifier
      - name
      - parameters
    UpdateEnvironmentActionOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The domain ID of the environment action.
        environmentId:
          type: string
          description: The environment ID of the environment action.
        id:
          type: string
          description: The ID of the environment action.
        name:
          type: string
          description: The name of the environment action.
        parameters:
          $ref: '#/components/schemas/ActionParameters'
        description:
          type: string
          description: The description of the environment action.
      required:
      - domainId
      - environmentId
      - id
      - name
      - parameters
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ActionParameters:
      type: object
      properties:
        awsConsoleLink:
          $ref: '#/components/schemas/AwsConsoleLinkParameters'
      description: Exactly one member is set.
    GetEnvironmentActionInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is invoked.
        environmentIdentifier:
          type: string
          description: The environment ID of the environment action.
        identifier:
          type: string
          description: The ID of the environment action
      required:
      - domainIdentifier
      - environmentIdentifier
      - identifier
    UpdateEnvironmentActionInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The domain ID of the environment action.
        environmentIdentifier:
          type: string
          description: The environment ID of the environment action.
        identifier:
          type: string
          description: The ID of the environment action.
        parameters:
          $ref: '#/components/schemas/ActionParameters'
        name:
          type: string
          description: The name of the environment action.
        description:
          type: string
          description: The description of the environment action.
      required:
      - domainIdentifier
      - environmentIdentifier
      - identifier
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListEnvironmentActionsOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentActionSummary'
          description: The results of ListEnvironmentActions.
        nextToken:
          type: string
          description: When the number of environment actions 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 environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListEnvironmentActionsInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the environment actions are listed.
        environmentIdentifier:
          type: string
          description: The ID of the envrironment whose environment actions are listed.
        nextToken:
          type: string
          description: When the number of environment actions 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 environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.
        maxResults:
          type: integer
          description: The maximum number of environment actions to return in a single call to ListEnvironmentActions. When the number of environment actions 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 ListEnvironmentActions to list the next set of environment actions.
      required:
      - domainIdentifier
      - environmentIdentifier
    GetEnvironmentActionOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which the environment action lives.
        environmentId:
          type: string
          description: The environment ID of the environment action.
        id:
          type: string
          description: The ID of the environment action.
        name:
          type: string
          description: The name of the environment action.
        parameters:
          $ref: '#/components/schemas/ActionParameters'
        description:
          type: string
          description: The description of the environment action.
      required:
      - domainId
      - environmentId
      - id
      - name
      - parameters
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteEnvironmentActionInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which an environment action is deleted.
        environmentIdentifier:
          type: string
          description: The ID of the environment where an environment action is deleted.
        identifier:
          type: string
          description: The ID of the environment action that is deleted.
      required:
      - domainIdentifier
      - environmentIdentifier
      - identifier
  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)