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-personalize:amazon-personalize-dataset-group-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: Amazon Personalize Dataset Group API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 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://personalize.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Dataset Group
paths:
  /#CreateDatasetGroup:
    post:
      operationId: CreateDatasetGroup
      summary: Create Dataset Group
      description: 'Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDatasetGroupResponse'
        '400':
          description: InvalidInputException; TooManyTagsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '403':
          description: ResourceAlreadyExistsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.CreateDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetGroupRequest'
      tags:
      - Dataset Group
  /#DeleteDatasetGroup:
    post:
      operationId: DeleteDatasetGroup
      summary: Delete Dataset Group
      description: 'Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.DeleteDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDatasetGroupRequest'
      tags:
      - Dataset Group
  /#DescribeDatasetGroup:
    post:
      operationId: DescribeDatasetGroup
      summary: Describe Dataset Group
      description: Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDatasetGroupResponse'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.DescribeDatasetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDatasetGroupRequest'
      tags:
      - Dataset Group
  /#ListDatasetGroups:
    post:
      operationId: ListDatasetGroups
      summary: List Dataset Groups
      description: Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDatasetGroupsResponse'
        '400':
          description: InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.ListDatasetGroups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDatasetGroupsRequest'
      tags:
      - Dataset Group
components:
  schemas:
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    CreateDatasetGroupRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the new dataset group.
        roleArn:
          type: string
          description: The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the dataset group.
      required:
      - name
    ListDatasetGroupsResponse:
      type: object
      properties:
        datasetGroups:
          type: array
          items:
            $ref: '#/components/schemas/DatasetGroupSummary'
          description: The list of your dataset groups.
        nextToken:
          type: string
          description: A token for getting the next set of dataset groups (if they exist).
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ResourceInUseException:
      type: object
      properties:
        message:
          type: string
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    DeleteDatasetGroupRequest:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The ARN of the dataset group to delete.
      required:
      - datasetGroupArn
    CreateDatasetGroupResponse:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the new dataset group.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain for the new Domain dataset group.
    DescribeDatasetGroupResponse:
      type: object
      properties:
        datasetGroup:
          $ref: '#/components/schemas/DatasetGroup'
    Tag:
      type: object
      properties:
        tagKey:
          type: string
          description: One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
        tagValue:
          type: string
          description: The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
      required:
      - tagKey
      - tagValue
    InvalidNextTokenException:
      type: object
      properties:
        message:
          type: string
    DescribeDatasetGroupRequest:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group to describe.
      required:
      - datasetGroupArn
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    DatasetGroup:
      type: object
      properties:
        name:
          type: string
          description: The name of the dataset group.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group.
        status:
          type: string
          description: 'The current status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING'
        roleArn:
          type: string
          description: The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
        creationDateTime:
          type: string
          format: date-time
          description: The creation date and time (in Unix time) of the dataset group.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The last update date and time (in Unix time) of the dataset group.
        failureReason:
          type: string
          description: If creating a dataset group fails, provides the reason why.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of a Domain dataset group.
    ListDatasetGroupsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).
        maxResults:
          type: integer
          description: The maximum number of dataset groups to return.
    DatasetGroupSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the dataset group.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group.
        status:
          type: string
          description: 'The status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING'
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the dataset group was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the dataset group was last updated.
        failureReason:
          type: string
          description: If creating a dataset group fails, the reason behind the failure.
        domain:
          type: string
          enum:
          - ECOMMERCE
          - VIDEO_ON_DEMAND
          description: The domain of a Domain dataset group.
  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: personalize
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/personalize/service/2018-05-22/personalize-2018-05-22.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)