Amazon DataZone Datazone Account Pools API

The Datazone Account Pools API from Amazon DataZone — 2 operation(s) for datazone account pools.

Operations 5

POST /v2/domains/{domainIdentifier}/account-pools Create Account Pool #
GET /v2/domains/{domainIdentifier}/account-pools List Account Pools #
DELETE /v2/domains/{domainIdentifier}/account-pools/{identifier} Delete Account Pool #
GET /v2/domains/{domainIdentifier}/account-pools/{identifier} Get Account Pool #
PATCH /v2/domains/{domainIdentifier}/account-pools/{identifier} Update Account Pool #

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-account-pools-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-account-pools-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon DataZone Account Pools 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: Account Pools
paths:
  /v2/domains/{domainIdentifier}/account-pools:
    post:
      operationId: CreateAccountPool
      summary: Create Account Pool
      description: Creates an account pool.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountPoolOutput'
        '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/CreateAccountPoolInput'
      tags:
      - Account Pools
    get:
      operationId: ListAccountPools
      summary: List Account Pools
      description: Lists existing account pools.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAccountPoolsOutput'
        '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/ListAccountPoolsInput'
      tags:
      - Account Pools
  /v2/domains/{domainIdentifier}/account-pools/{identifier}:
    delete:
      operationId: DeleteAccountPool
      summary: Delete Account Pool
      description: Deletes an account pool.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAccountPoolOutput'
        '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/DeleteAccountPoolInput'
      tags:
      - Account Pools
    get:
      operationId: GetAccountPool
      summary: Get Account Pool
      description: Gets the details of the account pool.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountPoolOutput'
        '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/GetAccountPoolInput'
      tags:
      - Account Pools
    patch:
      operationId: UpdateAccountPool
      summary: Update Account Pool
      description: Updates the account pool.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAccountPoolOutput'
        '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/UpdateAccountPoolInput'
      tags:
      - Account Pools
components:
  schemas:
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateAccountPoolInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain where the account pool is created.
        name:
          type: string
          description: The name of the account pool.
        description:
          type: string
          description: The description of the account pool.
        resolutionStrategy:
          type: string
          enum:
          - MANUAL
          description: The mechanism used to resolve the account selection from the account pool.
        accountSource:
          $ref: '#/components/schemas/AccountSource'
      required:
      - domainIdentifier
      - name
      - resolutionStrategy
      - accountSource
    GetAccountPoolInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain in which the account pool lives whose details are to be displayed.
        identifier:
          type: string
          description: The ID of the account pool whose details are to be displayed.
      required:
      - domainIdentifier
      - identifier
    AccountInfo:
      type: object
      properties:
        awsAccountId:
          type: string
          description: The account ID.
        supportedRegions:
          type: array
          items:
            type: string
          description: The regions supported for an account within an account pool.
        awsAccountName:
          type: string
          description: The account name.
      required:
      - awsAccountId
      - supportedRegions
    DeleteAccountPoolInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain where the account pool is deleted.
        identifier:
          type: string
          description: The ID of the account pool to be deleted.
      required:
      - domainIdentifier
      - identifier
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListAccountPoolsInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain where exsting account pools are to be listed.
        name:
          type: string
          description: The name of the account pool to be listed.
        sortBy:
          type: string
          enum:
          - NAME
          description: The sort by mechanism in which the existing account pools are to be listed.
        sortOrder:
          type: string
          enum:
          - ASCENDING
          - DESCENDING
          description: The sort order in which the existing account pools are to be listed.
        nextToken:
          type: string
          description: When the number of account pools 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 account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.
        maxResults:
          type: integer
          description: The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools 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 ListAccountPools to list the next set of account pools.
      required:
      - domainIdentifier
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteAccountPoolOutput:
      type: object
      properties: {}
    CustomAccountPoolHandler:
      type: object
      properties:
        lambdaFunctionArn:
          type: string
          description: The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.
        lambdaExecutionRoleArn:
          type: string
          description: The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.
      required:
      - lambdaFunctionArn
    ListAccountPoolsOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AccountPoolSummary'
          description: The results of the ListAccountPools operation.
        nextToken:
          type: string
          description: When the number of account pools 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 account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.
    CreateAccountPoolOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain where the account pool is created.
        name:
          type: string
          description: The name of the account pool.
        id:
          type: string
          description: The ID of the account pool.
        description:
          type: string
          description: The description of the account pool.
        resolutionStrategy:
          type: string
          enum:
          - MANUAL
          description: The mechanism used to resolve the account selection from the account pool.
        accountSource:
          $ref: '#/components/schemas/AccountSource'
        createdBy:
          type: string
          description: The user who created the account pool.
        createdAt:
          type: string
          description: The timestamp at which the account pool was created.
        lastUpdatedAt:
          type: string
          description: The timestamp at which the account pool was last updated.
        updatedBy:
          type: string
          description: The user who last updated the account pool.
        domainUnitId:
          type: string
          description: The ID of the domain where the account pool is created.
      required:
      - accountSource
      - createdBy
    UpdateAccountPoolOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The domain ID where the account pool that is to be updated lives.
        name:
          type: string
          description: The name of the account pool that is to be updated.
        id:
          type: string
          description: The ID of the account pool that is to be updated.
        description:
          type: string
          description: The description of the account pool that is to be udpated.
        resolutionStrategy:
          type: string
          enum:
          - MANUAL
          description: The mechanism used to resolve the account selection from the account pool.
        accountSource:
          $ref: '#/components/schemas/AccountSource'
        createdBy:
          type: string
          description: The user who created the account pool.
        createdAt:
          type: string
          description: The timestamp at which the account pool was created.
        lastUpdatedAt:
          type: string
          description: The timestamp at which the account pool was last updated.
        updatedBy:
          type: string
          description: The user who last updated the account pool.
        domainUnitId:
          type: string
          description: The domain ID in which the account pool that is to be updated lives.
      required:
      - accountSource
      - createdBy
    GetAccountPoolOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain in which the account pool lives whose details are to be displayed.
        name:
          type: string
          description: The name of the account pool.
        id:
          type: string
          description: The ID of the account pool.
        description:
          type: string
          description: The description of the account pool.
        resolutionStrategy:
          type: string
          enum:
          - MANUAL
          description: The mechanism used to resolve the account selection from the account pool.
        accountSource:
          $ref: '#/components/schemas/AccountSource'
        createdBy:
          type: string
          description: The user who created the account pool.
        createdAt:
          type: string
          description: The timestamp at which the account pool was created.
        lastUpdatedAt:
          type: string
          description: The timestamp at which the account pool was last updated.
        updatedBy:
          type: string
          description: The user who last updated the account pool.
        domainUnitId:
          type: string
          description: The domain unit ID of the account pool.
      required:
      - accountSource
      - createdBy
    AccountPoolSummary:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain.
        id:
          type: string
          description: The ID of the account pool.
        name:
          type: string
          description: The name of the account pool.
        resolutionStrategy:
          type: string
          enum:
          - MANUAL
          description: The mechanism used to resolve the account selection from the account pool.
        domainUnitId:
          type: string
          description: The ID of the domain unit.
        createdBy:
          type: string
          description: The user who created the account pool.
        updatedBy:
          type: string
          description: The user who updated the account pool.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AccountSource:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountInfo'
          description: The static list of accounts within an account pool.
        customAccountPoolHandler:
          $ref: '#/components/schemas/CustomAccountPoolHandler'
      description: Exactly one member is set.
    UpdateAccountPoolInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The domain ID where the account pool that is to be updated lives.
        identifier:
          type: string
          description: The ID of the account pool that is to be updated.
        name:
          type: string
          description: The name of the account pool that is to be updated.
        description:
          type: string
          description: The description of the account pool that is to be udpated.
        resolutionStrategy:
          type: string
          enum:
          - MANUAL
          description: The mechanism used to resolve the account selection from the account pool.
        accountSource:
          $ref: '#/components/schemas/AccountSource'
      required:
      - domainIdentifier
      - 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)