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-batch-segment-job-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 Batch Segment Job API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 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://personalize.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Batch Segment Job
paths:
  /#CreateBatchSegmentJob:
    post:
      operationId: CreateBatchSegmentJob
      summary: Create Batch Segment Job
      description: Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateBatchSegmentJobResponse'
        '400':
          description: InvalidInputException; TooManyTagsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: LimitExceededException; ResourceInUseException
          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'
        '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.CreateBatchSegmentJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateBatchSegmentJobRequest'
      tags:
      - Batch Segment Job
  /#DescribeBatchSegmentJob:
    post:
      operationId: DescribeBatchSegmentJob
      summary: Describe Batch Segment Job
      description: Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeBatchSegmentJobResponse'
        '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.DescribeBatchSegmentJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeBatchSegmentJobRequest'
      tags:
      - Batch Segment Job
  /#ListBatchSegmentJobs:
    post:
      operationId: ListBatchSegmentJobs
      summary: List Batch Segment Jobs
      description: Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListBatchSegmentJobsResponse'
        '400':
          description: InvalidInputException; InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.ListBatchSegmentJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListBatchSegmentJobsRequest'
      tags:
      - Batch Segment Job
components:
  schemas:
    DescribeBatchSegmentJobResponse:
      type: object
      properties:
        batchSegmentJob:
          $ref: '#/components/schemas/BatchSegmentJob'
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ListBatchSegmentJobsResponse:
      type: object
      properties:
        batchSegmentJobs:
          type: array
          items:
            $ref: '#/components/schemas/BatchSegmentJobSummary'
          description: A list containing information on each job that is returned.
        nextToken:
          type: string
          description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
    S3DataConfig:
      type: object
      properties:
        path:
          type: string
          description: The file path of the Amazon S3 bucket.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
      required:
      - path
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    BatchSegmentJobSummary:
      type: object
      properties:
        batchSegmentJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the batch segment job.
        jobName:
          type: string
          description: The name of the batch segment job.
        status:
          type: string
          description: 'The status of the batch segment job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED'
        creationDateTime:
          type: string
          format: date-time
          description: The time at which the batch segment job was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The time at which the batch segment job was last updated.
        failureReason:
          type: string
          description: If the batch segment job failed, the reason for the failure.
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
    DescribeBatchSegmentJobRequest:
      type: object
      properties:
        batchSegmentJobArn:
          type: string
          description: The ARN of the batch segment job to describe.
      required:
      - batchSegmentJobArn
    CreateBatchSegmentJobRequest:
      type: object
      properties:
        jobName:
          type: string
          description: The name of the batch segment job to create.
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
        filterArn:
          type: string
          description: The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
        numResults:
          type: integer
          description: The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
        jobInput:
          $ref: '#/components/schemas/BatchSegmentJobInput'
        jobOutput:
          $ref: '#/components/schemas/BatchSegmentJobOutput'
        roleArn:
          type: string
          description: The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the batch segment job.
      required:
      - jobName
      - solutionVersionArn
      - jobInput
      - jobOutput
      - roleArn
    ListBatchSegmentJobsRequest:
      type: object
      properties:
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
        nextToken:
          type: string
          description: The token to request the next page of results.
        maxResults:
          type: integer
          description: The maximum number of batch segment job results to return in each page. The default value is 100.
    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
    BatchSegmentJobOutput:
      type: object
      properties:
        s3DataDestination:
          $ref: '#/components/schemas/S3DataConfig'
      required:
      - s3DataDestination
    BatchSegmentJobInput:
      type: object
      properties:
        s3DataSource:
          $ref: '#/components/schemas/S3DataConfig'
      required:
      - s3DataSource
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    BatchSegmentJob:
      type: object
      properties:
        jobName:
          type: string
          description: The name of the batch segment job.
        batchSegmentJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the batch segment job.
        filterArn:
          type: string
          description: The ARN of the filter used on the batch segment job.
        failureReason:
          type: string
          description: If the batch segment job failed, the reason for the failure.
        solutionVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
        numResults:
          type: integer
          description: The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
        jobInput:
          $ref: '#/components/schemas/BatchSegmentJobInput'
        jobOutput:
          $ref: '#/components/schemas/BatchSegmentJobOutput'
        roleArn:
          type: string
          description: The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
        status:
          type: string
          description: 'The status of the batch segment job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED'
        creationDateTime:
          type: string
          format: date-time
          description: The time at which the batch segment job was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The time at which the batch segment job last updated.
    CreateBatchSegmentJobResponse:
      type: object
      properties:
        batchSegmentJobArn:
          type: string
          description: The ARN of the batch segment job.
  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)