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-data-exchange:amazon-data-exchange-data-grants-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.

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 Data Exchange Data Grants API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Data Exchange. 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://dataexchange.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Data Grants
paths:
  /v1/data-grants:
    post:
      operationId: CreateDataGrant
      summary: Create Data Grant
      description: This operation creates a data grant.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataGrantResponse'
        '403':
          description: 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'
        '402':
          description: ServiceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceLimitExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataGrantRequest'
      tags:
      - Data Grants
    get:
      operationId: ListDataGrants
      summary: List Data Grants
      description: This operation returns information about all data grants.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataGrantsResponse'
        '403':
          description: 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDataGrantsRequest'
      tags:
      - Data Grants
  /v1/data-grants/{DataGrantId}:
    delete:
      operationId: DeleteDataGrant
      summary: Delete Data Grant
      description: This operation deletes a data grant.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDataGrantRequest'
      tags:
      - Data Grants
    get:
      operationId: GetDataGrant
      summary: Get Data Grant
      description: This operation returns information about a data grant.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataGrantResponse'
        '403':
          description: 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDataGrantRequest'
      tags:
      - Data Grants
components:
  schemas:
    CreateDataGrantResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the data grant.
        SenderPrincipal:
          type: string
          description: The Amazon Web Services account ID of the data grant sender.
        ReceiverPrincipal:
          type: string
          description: The Amazon Web Services account ID of the data grant receiver.
        Description:
          type: string
          description: The description of the data grant.
        AcceptanceState:
          type: string
          description: The acceptance state of the data grant.
        AcceptedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was accepted.
        EndsAt:
          type: string
          format: date-time
          description: The timestamp of when access to the associated data set ends.
        GrantDistributionScope:
          type: string
          description: The distribution scope for the data grant.
        DataSetId:
          type: string
          description: The ID of the data set associated to the data grant.
        SourceDataSetId:
          type: string
          description: The ID of the data set used to create the data grant.
        Id:
          type: string
          description: The ID of the data grant.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the data grant.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was last updated.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated to the data grant. A tag is a key-value pair.
      required:
      - Name
      - SenderPrincipal
      - ReceiverPrincipal
      - AcceptanceState
      - GrantDistributionScope
      - DataSetId
      - SourceDataSetId
      - Id
      - Arn
      - CreatedAt
      - UpdatedAt
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The resource couldn't be found.
        ResourceId:
          type: string
          description: The unique identifier for the resource that couldn't be found.
        ResourceType:
          type: string
          description: The type of resource that couldn't be found.
      required:
      - Message
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
          description: The limit on the number of requests per second was exceeded.
      required:
      - Message
    ListDataGrantsResponse:
      type: object
      properties:
        DataGrantSummaries:
          type: array
          items:
            $ref: '#/components/schemas/DataGrantSummaryEntry'
          description: An object that contains a list of data grant information.
        NextToken:
          type: string
          description: The pagination token used to retrieve the next page of results for this operation.
    DataGrantSummaryEntry:
      type: object
      properties:
        Name:
          type: string
          description: The name of the data grant.
        SenderPrincipal:
          type: string
          description: The Amazon Web Services account ID of the data grant sender.
        ReceiverPrincipal:
          type: string
          description: The Amazon Web Services account ID of the data grant receiver.
        AcceptanceState:
          type: string
          description: The acceptance state of the data grant.
        AcceptedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was accepted.
        EndsAt:
          type: string
          format: date-time
          description: The timestamp of when access to the associated data set ends.
        DataSetId:
          type: string
          description: The ID of the data set associated to the data grant.
        SourceDataSetId:
          type: string
          description: The ID of the data set used to create the data grant.
        Id:
          type: string
          description: The ID of the data grant.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the data grant.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was last updated.
      required:
      - Name
      - SenderPrincipal
      - ReceiverPrincipal
      - AcceptanceState
      - DataSetId
      - SourceDataSetId
      - Id
      - Arn
      - CreatedAt
      - UpdatedAt
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
          description: The message identifying the service exception that occurred.
      required:
      - Message
    GetDataGrantResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the data grant.
        SenderPrincipal:
          type: string
          description: The Amazon Web Services account ID of the data grant sender.
        ReceiverPrincipal:
          type: string
          description: The Amazon Web Services account ID of the data grant receiver.
        Description:
          type: string
          description: The description of the data grant.
        AcceptanceState:
          type: string
          description: The acceptance state of the data grant.
        AcceptedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was accepted.
        EndsAt:
          type: string
          format: date-time
          description: The timestamp of when access to the associated data set ends.
        GrantDistributionScope:
          type: string
          description: The distribution scope for the data grant.
        DataSetId:
          type: string
          description: The ID of the data set associated to the data grant.
        SourceDataSetId:
          type: string
          description: The ID of the data set used to create the data grant.
        Id:
          type: string
          description: The ID of the data grant.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the data grant.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the data grant was last updated.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated to the data grant. A tag is a key-value pair.
      required:
      - Name
      - SenderPrincipal
      - ReceiverPrincipal
      - AcceptanceState
      - GrantDistributionScope
      - DataSetId
      - SourceDataSetId
      - Id
      - Arn
      - CreatedAt
      - UpdatedAt
    DeleteDataGrantRequest:
      type: object
      properties:
        DataGrantId:
          type: string
          description: The ID of the data grant to delete.
      required:
      - DataGrantId
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
          description: Access to the resource is denied.
      required:
      - Message
    ListDataGrantsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of results to be included in the next page.
        NextToken:
          type: string
          description: The pagination token used to retrieve the next page of results for this operation.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
          description: The message that informs you about what was invalid about the request.
        ExceptionCause:
          type: string
          description: The unique identifier for the resource that couldn't be found.
      required:
      - Message
    GetDataGrantRequest:
      type: object
      properties:
        DataGrantId:
          type: string
          description: The ID of the data grant.
      required:
      - DataGrantId
    ServiceLimitExceededException:
      type: object
      properties:
        LimitName:
          type: string
          description: The name of the limit that was reached.
        LimitValue:
          type: number
          description: The value of the exceeded limit.
        Message:
          type: string
          description: The request has exceeded the quotas imposed by the service.
      required:
      - Message
    CreateDataGrantRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the data grant.
        GrantDistributionScope:
          type: string
          description: The distribution scope of the data grant.
        ReceiverPrincipal:
          type: string
          description: The Amazon Web Services account ID of the data grant receiver.
        SourceDataSetId:
          type: string
          description: The ID of the data set used to create the data grant.
        EndsAt:
          type: string
          format: date-time
          description: The timestamp of when access to the associated data set ends.
        Description:
          type: string
          description: The description of the data grant.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to add to the data grant. A tag is a key-value pair.
      required:
      - Name
      - GrantDistributionScope
      - ReceiverPrincipal
      - SourceDataSetId
  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: dataexchange
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/dataexchange/service/2017-07-25/dataexchange-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)