Amazon SageMaker Sagemaker Ai Recommendation Job API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Ai Recommendation Job API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 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://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateAIRecommendationJob:
    post:
      operationId: CreateAIRecommendationJob
      summary: Create AIRecommendation Job
      description: Creates a recommendation job that generates intelligent optimization recommendations for generative AI
        inference deployments. The job analyzes your model, workload configuration, and performance targets to recommend optimal
        instance types, model optimization techniques (such as quantization and speculative decoding), and deployment configurations.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAIRecommendationJobResponse'
        '400':
          description: ResourceInUse; ResourceLimitExceeded; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateAIRecommendationJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAIRecommendationJobRequest'
      tags:
      - Ai Recommendation Job
  /#DeleteAIRecommendationJob:
    post:
      operationId: DeleteAIRecommendationJob
      summary: Delete AIRecommendation Job
      description: Deletes the specified AI recommendation job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAIRecommendationJobResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteAIRecommendationJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAIRecommendationJobRequest'
      tags:
      - Ai Recommendation Job
  /#DescribeAIRecommendationJob:
    post:
      operationId: DescribeAIRecommendationJob
      summary: Describe AIRecommendation Job
      description: Returns details of an AI recommendation job, including its status, model source, performance targets, optimization
        recommendations, and deployment configurations.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAIRecommendationJobResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeAIRecommendationJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAIRecommendationJobRequest'
      tags:
      - Ai Recommendation Job
  /#ListAIRecommendationJobs:
    post:
      operationId: ListAIRecommendationJobs
      summary: List AIRecommendation Jobs
      description: Returns a list of AI recommendation jobs in your account. You can filter the results by name, status, and
        creation time, and sort the results. The response is paginated.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAIRecommendationJobsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListAIRecommendationJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAIRecommendationJobsRequest'
      tags:
      - Ai Recommendation Job
  /#StopAIRecommendationJob:
    post:
      operationId: StopAIRecommendationJob
      summary: Stop AIRecommendation Job
      description: Stops a running AI recommendation job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopAIRecommendationJobResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.StopAIRecommendationJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopAIRecommendationJobRequest'
      tags:
      - Ai Recommendation Job
components:
  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: sagemaker
  schemas:
    AIAdapterModelPackageEntry:
      type: object
      properties:
        AdapterId:
          type: string
          description: A unique identifier for the adapter. This ID is used as the inference component name when the adapter
            is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric
            characters, and can be up to 63 characters long.
        ModelPackageArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model package that contains the LoRA adapter artifacts.
      required:
      - AdapterId
      - ModelPackageArn
    AIAdapterS3Entry:
      type: object
      properties:
        AdapterId:
          type: string
          description: A unique identifier for the adapter. This ID is used as the inference component name when the adapter
            is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric
            characters, and can be up to 63 characters long.
        S3Uri:
          type: string
          description: The Amazon S3 URI of the directory that contains the LoRA adapter artifacts in PEFT format.
      required:
      - AdapterId
      - S3Uri
    AIAdapterSource:
      type: object
      properties:
        ModelPackageArns:
          type: array
          items:
            $ref: '#/components/schemas/AIAdapterModelPackageEntry'
          description: A list of LoRA adapters identified by their model package ARNs. Use this when your adapters were produced
            by a SageMaker AI fine-tuning workflow that registers model packages.
        S3Uris:
          type: array
          items:
            $ref: '#/components/schemas/AIAdapterS3Entry'
          description: A list of LoRA adapters identified by their Amazon S3 URIs. Use this when your adapters are stored
            as raw artifacts in Amazon S3.
      description: Exactly one member is set.
    AICapacityReservationConfig:
      type: object
      properties:
        CapacityReservationPreference:
          type: string
          enum:
          - capacity-reservations-only
          description: The capacity reservation preference. The only valid value is capacity-reservations-only.
        MlReservationArns:
          type: array
          items:
            type: string
          description: The list of ML reservation ARNs to use.
    AIMlflowConfig:
      type: object
      properties:
        MlflowResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the SageMaker managed MLflow resource.
        MlflowExperimentName:
          type: string
          description: The MLflow experiment name used for tracking.
        MlflowRunName:
          type: string
          description: The MLflow run name used for tracking.
      required:
      - MlflowResourceArn
    AIModelSource:
      type: object
      properties:
        S3:
          $ref: '#/components/schemas/AIModelSourceS3'
      description: Exactly one member is set.
    AIModelSourceS3:
      type: object
      properties:
        S3Uri:
          type: string
          description: The Amazon S3 URI of the model artifacts.
    AIRecommendation:
      type: object
      properties:
        RecommendationDescription:
          type: string
          description: A description of the recommendation.
        OptimizationDetails:
          type: array
          items:
            $ref: '#/components/schemas/AIRecommendationOptimizationDetail'
          description: The optimization techniques applied in this recommendation.
        ModelDetails:
          $ref: '#/components/schemas/AIRecommendationModelDetails'
        DeploymentConfiguration:
          $ref: '#/components/schemas/AIRecommendationDeploymentConfiguration'
        AIBenchmarkJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the benchmark job associated with this recommendation.
        ExpectedPerformance:
          type: array
          items:
            $ref: '#/components/schemas/AIRecommendationPerformanceMetric'
          description: The expected performance metrics for this recommendation.
        AdapterDetails:
          $ref: '#/components/schemas/AIRecommendationAdapterDetails'
    AIRecommendationAdapterDetails:
      type: object
      properties:
        ModelPackageArns:
          type: array
          items:
            $ref: '#/components/schemas/AIAdapterModelPackageEntry'
          description: The list of LoRA adapters with their model package ARNs.
        S3Uris:
          type: array
          items:
            $ref: '#/components/schemas/AIAdapterS3Entry'
          description: The list of LoRA adapters with their Amazon S3 URIs.
      required:
      - ModelPackageArns
      - S3Uris
    AIRecommendationComputeSpec:
      type: object
      properties:
        InstanceTypes:
          type: array
          items:
            type: string
            enum:
            - ml.g5.xlarge
            - ml.g5.2xlarge
            - ml.g5.4xlarge
            - ml.g5.8xlarge
            - ml.g5.12xlarge
            - ml.g5.16xlarge
            - ml.g5.24xlarge
            - ml.g5.48xlarge
            - ml.g6.xlarge
            - ml.g6.2xlarge
            - ml.g6.4xlarge
            - ml.g6.8xlarge
            - ml.g6.12xlarge
            - ml.g6.16xlarge
            - ml.g6.24xlarge
            - ml.g6.48xlarge
            - ml.g6e.xlarge
            - ml.g6e.2xlarge
            - ml.g6e.4xlarge
            - ml.g6e.8xlarge
            - ml.g6e.12xlarge
            - ml.g6e.16xlarge
            - ml.g6e.24xlarge
            - ml.g6e.48xlarge
            - ml.g7.2xlarge
            - ml.g7.4xlarge
            - ml.g7.8xlarge
            - ml.g7.12xlarge
            - ml.g7.24xlarge
            - ml.g7.48xlarge
            - ml.g7e.2xlarge
            - ml.g7e.4xlarge
            - ml.g7e.8xlarge
            - ml.g7e.12xlarge
            - ml.g7e.24xlarge
            - ml.g7e.48xlarge
            - ml.p3.2xlarge
            - ml.p3.8xlarge
            - ml.p3.16xlarge
            - ml.p4d.24xlarge
            - ml.p4de.24xlarge
            - ml.p5.4xlarge
            - ml.p5.48xlarge
            - ml.p5e.48xlarge
            - ml.p5en.48xlarge
            - ml.p6-b200.48xlarge
          description: The list of instance types to consider for recommendations. You can specify up to 3 instance types.
        CapacityReservationConfig:
          $ref: '#/components/schemas/AICapacityReservationConfig'
    AIRecommendationConstraint:
      type: object
      properties:
        Metric:
          type: string
          enum:
          - ttft-ms
          - throughput
          - cost
          description: The performance metric. Valid values are ttft-ms (time to first token in milliseconds), throughput,
            and cost.
      required:
      - Metric
    AIRecommendationDeploymentConfiguration:
      type: object
      properties:
        S3:
          type: array
          items:
            $ref: '#/components/schemas/AIRecommendationDeploymentS3Channel'
          description: The Amazon S3 data channels for the deployment.
        ImageUri:
          type: string
          description: The URI of the container image for the deployment.
        InstanceType:
          type: string
          enum:
          - ml.g5.xlarge
          - ml.g5.2xlarge
          - ml.g5.4xlarge
          - ml.g5.8xlarge
          - ml.g5.12xlarge
          - ml.g5.16xlarge
          - ml.g5.24xlarge
          - ml.g5.48xlarge
          - ml.g6.xlarge
          - ml.g6.2xlarge
          - ml.g6.4xlarge
          - ml.g6.8xlarge
          - ml.g6.12xlarge
          - ml.g6.16xlarge
          - ml.g6.24xlarge
          - ml.g6.48xlarge
          - ml.g6e.xlarge
          - ml.g6e.2xlarge
          - ml.g6e.4xlarge
          - ml.g6e.8xlarge
          - ml.g6e.12xlarge
          - ml.g6e.16xlarge
          - ml.g6e.24xlarge
          - ml.g6e.48xlarge
          - ml.g7.2xlarge
          - ml.g7.4xlarge
          - ml.g7.8xlarge
          - ml.g7.12xlarge
          - ml.g7.24xlarge
          - ml.g7.48xlarge
          - ml.g7e.2xlarge
          - ml.g7e.4xlarge
          - ml.g7e.8xlarge
          - ml.g7e.12xlarge
          - ml.g7e.24xlarge
          - ml.g7e.48xlarge
          - ml.p3.2xlarge
          - ml.p3.8xlarge
          - ml.p3.16xlarge
          - ml.p4d.24xlarge
          - ml.p4de.24xlarge
          - ml.p5.4xlarge
          - ml.p5.48xlarge
          - ml.p5e.48xlarge
          - ml.p5en.48xlarge
          - ml.p6-b200.48xlarge
          description: The recommended instance type for the deployment.
        InstanceCount:
          type: integer
          description: The recommended number of instances for the deployment.
        CopyCountPerInstance:
          type: integer
          description: The number of model copies per instance.
        EnvironmentVariables:
          type: object
          additionalProperties:
            type: string
          description: The environment variables for the deployment.
        MinCpuMemoryRequiredInMb:
          type: integer
          description: The minimum host (CPU) memory, in MiB, to reserve for each model copy when deploying the recommendation
            as an Inference Component. This value maps to the Inference Component's ComputeResourceRequirements$MinMemoryRequiredInMb
            field.
    AIRecommendationDeploymentS3Channel:
      type: object
      properties:
        ChannelName:
          type: string
          description: A custom name for this Amazon S3 data channel.
        Uri:
          type: string
          description: The Amazon S3 URI of the data for this channel.
    AIRecommendationInferenceSpecification:
      type: object
      properties:
        Framework:
          type: string
          enum:
          - LMI
          - VLLM
          description: The inference framework. Valid values are LMI and VLLM.
    AIRecommendationInstanceDetail:
      type: object
      properties:
        InstanceType:
          type: string
          enum:
          - ml.g5.xlarge
          - ml.g5.2xlarge
          - ml.g5.4xlarge
          - ml.g5.8xlarge
          - ml.g5.12xlarge
          - ml.g5.16xlarge
          - ml.g5.24xlarge
          - ml.g5.48xlarge
          - ml.g6.xlarge
          - ml.g6.2xlarge
          - ml.g6.4xlarge
          - ml.g6.8xlarge
          - ml.g6.12xlarge
          - ml.g6.16xlarge
          - ml.g6.24xlarge
          - ml.g6.48xlarge
          - ml.g6e.xlarge
          - ml.g6e.2xlarge
          - ml.g6e.4xlarge
          - ml.g6e.8xlarge
          - ml.g6e.12xlarge
          - ml.g6e.16xlarge
          - ml.g6e.24xlarge
          - ml.g6e.48xlarge
          - ml.g7.2xlarge
          - ml.g7.4xlarge
          - ml.g7.8xlarge
          - ml.g7.12xlarge
          - ml.g7.24xlarge
          - ml.g7.48xlarge
          - ml.g7e.2xlarge
          - ml.g7e.4xlarge
          - ml.g7e.8xlarge
          - ml.g7e.12xlarge
          - ml.g7e.24xlarge
          - ml.g7e.48xlarge
          - ml.p3.2xlarge
          - ml.p3.8xlarge
          - ml.p3.16xlarge
          - ml.p4d.24xlarge
          - ml.p4de.24xlarge
          - ml.p5.4xlarge
          - ml.p5.48xlarge
          - ml.p5e.48xlarge
          - ml.p5en.48xlarge
          - ml.p6-b200.48xlarge
          description: The recommended instance type.
        InstanceCount:
          type: integer
          description: The recommended number of instances.
        CopyCountPerInstance:
          type: integer
          description: The number of model copies per instance.
    AIRecommendationJobSummary:
      type: object
      properties:
        AIRecommendationJobName:
          type: string
          description: The name of the recommendation job.
        AIRecommendationJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recommendation job.
        AIRecommendationJobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the recommendation job.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the recommendation job was created.
        EndTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the recommendation job completed.
      required:
      - AIRecommendationJobName
      - AIRecommendationJobArn
      - AIRecommendationJobStatus
      - CreationTime
    AIRecommendationModelDetails:
      type: object
      properties:
        ModelPackageArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model package.
        InferenceSpecificationName:
          type: string
          description: The name of the inference specification within the model package.
        InstanceDetails:
          type: array
          items:
            $ref: '#/components/schemas/AIRecommendationInstanceDetail'
          description: The instance details for this recommendation, including instance type, count, and model copies per
            instance.
    AIRecommendationOptimizationDetail:
      type: object
      properties:
        OptimizationType:
          type: string
          enum:
          - SpeculativeDecoding
          - KernelTuning
          description: The type of optimization. Valid values are SpeculativeDecoding and KernelTuning.
        OptimizationConfig:
          type: object
          additionalProperties:
            type: string
          description: A map of configuration parameters for the optimization technique.
      required:
      - OptimizationType
    AIRecommendationOutputConfig:
      type: object
      properties:
        S3OutputLocation:
          type: string
          description: The Amazon S3 URI where recommendation results are stored.
        ModelPackageGroupIdentifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the model package group where the optimized model is registered
            as a new model package version.
        MlflowConfig:
          $ref: '#/components/schemas/AIMlflowConfig'
    AIRecommendationOutputResult:
      type: object
      properties:
        S3OutputLocation:
          type: string
          description: The Amazon S3 URI where the recommendation job writes its output results.
        ModelPackageGroupIdentifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the model package group where deployment-ready model packages
            are registered.
        MlflowConfig:
          $ref: '#/components/schemas/AIMlflowConfig'
      required:
      - S3OutputLocation
    AIRecommendationPerformanceMetric:
      type: object
      properties:
        Metric:
          type: string
          description: The name of the performance metric.
        Stat:
          type: string
          description: The statistical measure for the metric.
        Value:
          type: string
          description: The value of the metric.
        Unit:
          type: string
          description: The unit of the metric value.
      required:
      - Metric
      - Value
    AIRecommendationPerformanceTarget:
      type: object
      properties:
        Constraints:
          type: array
          items:
            $ref: '#/components/schemas/AIRecommendationConstraint'
          description: An array of performance constraints that define the optimization objectives.
      required:
      - Constraints
    CreateAIRecommendationJobRequest:
      type: object
      properties:
        AIRecommendationJobName:
          type: string
          description: The name of the AI recommendation job. The name must be unique within your Amazon Web Services account
            in the current Amazon Web Services Region.
        ModelSource:
          $ref: '#/components/schemas/AIModelSource'
        OutputConfig:
          $ref: '#/components/schemas/AIRecommendationOutputConfig'
        AIWorkloadConfigIdentifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation
            job.
        PerformanceTarget:
          $ref: '#/components/schemas/AIRecommendationPerformanceTarget'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on
            your behalf.
        InferenceSpecification:
          $ref: '#/components/schemas/AIRecommendationInferenceSpecification'
        OptimizeModel:
          type: boolean
          description: Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel
            tuning. The default is true.
        ComputeSpec:
          $ref: '#/components/schemas/AIRecommendationComputeSpec'
        AdapterSource:
          $ref: '#/components/schemas/AIAdapterSource'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
      required:
      - AIRecommendationJobName
      - ModelSource
      - OutputConfig
      - AIWorkloadConfigIdentifier
      - PerformanceTarget
      - RoleArn
    CreateAIRecommendationJobResponse:
      type: object
      properties:
        AIRecommendationJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created recommendation job.
      required:
      - AIRecommendationJobArn
    DeleteAIRecommendationJobRequest:
      type: object
      properties:
        AIRecommendationJobName:
          type: string
          description: The name of the AI recommendation job to delete.
      required:
      - AIRecommendationJobName
    DeleteAIRecommendationJobResponse:
      type: object
      properties:
        AIRecommendationJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the deleted recommendation job.
    DescribeAIRecommendationJobRequest:
      type: object
      properties:
        AIRecommendationJobName:
          type: string
          description: The name of the AI recommendation job to describe.
      required:
      - AIRecommendationJobName
    DescribeAIRecommendationJobResponse:
      type: object
      properties:
        AIRecommendationJobName:
          type: string
          description: The name of the AI recommendation job.
        AIRecommendationJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AI recommendation job.
        AIRecommendationJobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the AI recommendation job.
        FailureReason:
          type: string
          description: If the recommendation job failed, the reason it failed.
        ModelSource:
          $ref: '#/components/schemas/AIModelSource'
        OutputConfig:
          $ref: '#/components/schemas/AIRecommendationOutputResult'
        InferenceSpecification:
          $ref: '#/components/schemas/AIRecommendationInferenceSpecification'
        AIWorkloadConfigIdentifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation
            job.
        OptimizeModel:
          type: boolean
          description: Whether model optimization techniques were allowed.
        PerformanceTarget:
          $ref: '#/components/schemas/AIRecommendationPerformanceTarget'
        Recommendations:
          type: array
          items:
            $ref: '#/components/schemas/AIRecommendation'
          description: The list of optimization recommendations generated by the job. Each recommendation includes optimization
            details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.
        ComputeSpec:
          $ref: '#/components/schemas/AIRecommendationComputeSpec'
        AdapterSource:
          $ref: '#/components/schemas/AIAdapterSource'
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the recommendation job was created.
        StartTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the recommendation job started running.
        EndTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the recommendation job completed.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the recommendation job.
      required:
      - AIRecommendationJobName
      - AIRecommendationJobArn
      - AIRecommendationJobStatus
      - ModelSource
      - OutputConfig
      - AIWorkloadConfigIdentifier
      - RoleArn
      - CreationTime
    ListAIRecommendationJobsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of recommendation jobs to return in the response.
        NextToken:
          type: string
          description: If the previous call to ListAIRecommendationJobs didn't return the full set of jobs, the call returns
            a token for getting the next set.
        NameContains:
          type: string
          description: A string in the job name. This filter returns only jobs whose name contains the specified string.
        StatusEquals:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: A filter that returns only recommendation jobs with the specified status.
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only jobs created after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only jobs created before the specified time.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - Status
          description: The field to sort results by. The default is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results. The default is Descending.
    ListAIRecommendationJobsResponse:
      type: object
      properties:
        AIRecommendationJobs:
          type: array
          items:
            $ref: '#/components/schemas/AIRecommendationJobSummary'
          description: An array of AIRecommendationJobSummary objects, one for each recommendation job that matches the specified
            filters.
        NextToken:
          type: string
          description: If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs,
            use it in the subsequent request.
      required:
      - AIRecommendationJobs
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    StopAIRecommendationJobRequest:
      type: object
      properties:
        AIRecommendationJobName:
          type: string
          description: The name of the AI recommendation job to stop.
      required:
      - AIRecommendationJobName
    StopAIRecommendationJobResponse:
      type: object
      properties:
        AIRecommendationJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the stopped recommendation job.
      required:
      - AIRecommendationJobArn
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key. Tag keys must be unique per resource.
        Value:
          type: string
          description: The tag value.
      required:
      - Key
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)