Amazon SageMaker Sagemaker Trial Component API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Trial Component API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 7 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:
  /#AssociateTrialComponent:
    post:
      operationId: AssociateTrialComponent
      summary: Associate Trial Component
      description: Associates a trial component with a trial. A trial component can be associated with multiple trials. To
        disassociate a trial component from a trial, call the DisassociateTrialComponent API.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AssociateTrialComponentResponse'
        '400':
          description: ResourceLimitExceeded; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceeded'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.AssociateTrialComponent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AssociateTrialComponentRequest'
      tags:
      - Trial Component
  /#CreateTrialComponent:
    post:
      operationId: CreateTrialComponent
      summary: Create Trial Component
      description: Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or
        more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs,
        training jobs, and batch transform jobs. When you use SageMaker Studio or the SageMaker Python SDK, all experiments,
        trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services
        SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial component and
        then use the Search API to search for the tags.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateTrialComponentResponse'
        '400':
          description: ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceeded'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateTrialComponent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateTrialComponentRequest'
      tags:
      - Trial Component
  /#DeleteTrialComponent:
    post:
      operationId: DeleteTrialComponent
      summary: Delete Trial Component
      description: Deletes the specified trial component. A trial component must be disassociated from all trials before the
        trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent
        API.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteTrialComponentResponse'
        '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.DeleteTrialComponent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteTrialComponentRequest'
      tags:
      - Trial Component
  /#DescribeTrialComponent:
    post:
      operationId: DescribeTrialComponent
      summary: Describe Trial Component
      description: Provides a list of a trials component's properties.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeTrialComponentResponse'
        '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.DescribeTrialComponent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeTrialComponentRequest'
      tags:
      - Trial Component
  /#DisassociateTrialComponent:
    post:
      operationId: DisassociateTrialComponent
      summary: Disassociate Trial Component
      description: Disassociates a trial component from a trial. This doesn't effect other trials the component is associated
        with. Before you can delete a component, you must disassociate the component from all trials it is associated with.
        To associate a trial component with a trial, call the AssociateTrialComponent API. To get a list of the trials a component
        is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears
        in the response under Results.TrialComponent.Parents.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisassociateTrialComponentResponse'
        '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.DisassociateTrialComponent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisassociateTrialComponentRequest'
      tags:
      - Trial Component
  /#ListTrialComponents:
    post:
      operationId: ListTrialComponents
      summary: List Trial Components
      description: 'Lists the trial components in your account. You can sort the list by trial component name or creation
        time. You can filter the list to show only components that were created in a specific time range. You can also filter
        on one of the following: ExperimentName SourceArn TrialName'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTrialComponentsResponse'
        '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.ListTrialComponents
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTrialComponentsRequest'
      tags:
      - Trial Component
  /#UpdateTrialComponent:
    post:
      operationId: UpdateTrialComponent
      summary: Update Trial Component
      description: Updates one or more properties of a trial component.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateTrialComponentResponse'
        '400':
          description: ConflictException; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateTrialComponent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateTrialComponentRequest'
      tags:
      - Trial Component
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:
    AssociateTrialComponentRequest:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the component to associated with the trial.
        TrialName:
          type: string
          description: The name of the trial to associate with.
      required:
      - TrialComponentName
      - TrialName
    AssociateTrialComponentResponse:
      type: object
      properties:
        TrialComponentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial component.
        TrialArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateTrialComponentRequest:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
        DisplayName:
          type: string
          description: The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified,
            TrialComponentName is displayed.
        Status:
          $ref: '#/components/schemas/TrialComponentStatus'
        StartTime:
          type: string
          format: date-time
          description: When the component started.
        EndTime:
          type: string
          format: date-time
          description: When the component ended.
        Parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentParameterValue'
          description: The hyperparameters for the component.
        InputArtifacts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentArtifact'
          description: The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters,
            source code, and instance types.
        OutputArtifacts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentArtifact'
          description: The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs,
            and images.
        MetadataProperties:
          $ref: '#/components/schemas/MetadataProperties'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to associate with the component. You can use Search API to search on the tags.
      required:
      - TrialComponentName
    CreateTrialComponentResponse:
      type: object
      properties:
        TrialComponentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial component.
    DeleteTrialComponentRequest:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the component to delete.
      required:
      - TrialComponentName
    DeleteTrialComponentResponse:
      type: object
      properties:
        TrialComponentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the component is being deleted.
    DescribeTrialComponentRequest:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the trial component to describe.
      required:
      - TrialComponentName
    DescribeTrialComponentResponse:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the trial component.
        TrialComponentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial component.
        DisplayName:
          type: string
          description: The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
        Source:
          $ref: '#/components/schemas/TrialComponentSource'
        Status:
          $ref: '#/components/schemas/TrialComponentStatus'
        StartTime:
          type: string
          format: date-time
          description: When the component started.
        EndTime:
          type: string
          format: date-time
          description: When the component ended.
        CreationTime:
          type: string
          format: date-time
          description: When the component was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: When the component was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        Parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentParameterValue'
          description: The hyperparameters of the component.
        InputArtifacts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentArtifact'
          description: The input artifacts of the component.
        OutputArtifacts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentArtifact'
          description: The output artifacts of the component.
        MetadataProperties:
          $ref: '#/components/schemas/MetadataProperties'
        Metrics:
          type: array
          items:
            $ref: '#/components/schemas/TrialComponentMetricSummary'
          description: The metrics for the component.
        LineageGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the lineage group.
        Sources:
          type: array
          items:
            $ref: '#/components/schemas/TrialComponentSource'
          description: A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
    DisassociateTrialComponentRequest:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the component to disassociate from the trial.
        TrialName:
          type: string
          description: The name of the trial to disassociate from.
      required:
      - TrialComponentName
      - TrialName
    DisassociateTrialComponentResponse:
      type: object
      properties:
        TrialComponentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial component.
        TrialArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial.
    IamIdentity:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM identity.
        PrincipalId:
          type: string
          description: The ID of the principal that assumes the IAM identity.
        SourceIdentity:
          type: string
          description: The person or application which assumes the IAM identity.
    ListTrialComponentsRequest:
      type: object
      properties:
        ExperimentName:
          type: string
          description: A filter that returns only components that are part of the specified experiment. If you specify ExperimentName,
            you can't filter by SourceArn or TrialName.
        TrialName:
          type: string
          description: A filter that returns only components that are part of the specified trial. If you specify TrialName,
            you can't filter by ExperimentName or SourceArn.
        SourceArn:
          type: string
          description: A filter that returns only components that have the specified source Amazon Resource Name (ARN). If
            you specify SourceArn, you can't filter by ExperimentName or TrialName.
        CreatedAfter:
          type: string
          format: date-time
          description: A filter that returns only components created after the specified time.
        CreatedBefore:
          type: string
          format: date-time
          description: A filter that returns only components created before the specified time.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          description: The property used to sort results. The default value is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order. The default value is Descending.
        MaxResults:
          type: integer
          description: The maximum number of components to return in the response. The default value is 10.
        NextToken:
          type: string
          description: If the previous call to ListTrialComponents didn't return the full set of components, the call returns
            a token for getting the next set of components.
    ListTrialComponentsResponse:
      type: object
      properties:
        TrialComponentSummaries:
          type: array
          items:
            $ref: '#/components/schemas/TrialComponentSummary'
          description: A list of the summaries of your trial components.
        NextToken:
          type: string
          description: A token for getting the next set of components, if there are any.
    MetadataProperties:
      type: object
      properties:
        CommitId:
          type: string
          description: The commit ID.
        Repository:
          type: string
          description: The repository.
        GeneratedBy:
          type: string
          description: The entity this entity was generated by.
        ProjectId:
          type: string
          description: The project ID.
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    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
    TrialComponentArtifact:
      type: object
      properties:
        MediaType:
          type: string
          description: The media type of the artifact, which indicates the type of data in the artifact file. The media type
            consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and
            s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.
        Value:
          type: string
          description: The location of the artifact.
      required:
      - Value
    TrialComponentMetricSummary:
      type: object
      properties:
        MetricName:
          type: string
          description: The name of the metric.
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source.
        TimeStamp:
          type: string
          format: date-time
          description: When the metric was last updated.
        Max:
          type: number
          description: The maximum value of the metric.
        Min:
          type: number
          description: The minimum value of the metric.
        Last:
          type: number
          description: The most recent value of the metric.
        Count:
          type: integer
          description: The number of samples used to generate the metric.
        Avg:
          type: number
          description: The average value of the metric.
        StdDev:
          type: number
          description: The standard deviation of the metric.
    TrialComponentParameterValue:
      type: object
      properties:
        StringValue:
          type: string
          description: The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't
            specify the NumberValue parameter.
        NumberValue:
          type: number
          description: The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't
            specify the StringValue parameter.
      description: Exactly one member is set.
    TrialComponentSource:
      type: object
      properties:
        SourceArn:
          type: string
          description: The source Amazon Resource Name (ARN).
        SourceType:
          type: string
          description: The source job type.
      required:
      - SourceArn
    TrialComponentStatus:
      type: object
      properties:
        PrimaryStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the trial component.
        Message:
          type: string
          description: If the component failed, a message describing why.
    TrialComponentSummary:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the trial component.
        TrialComponentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial component.
        DisplayName:
          type: string
          description: The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
        TrialComponentSource:
          $ref: '#/components/schemas/TrialComponentSource'
        Status:
          $ref: '#/components/schemas/TrialComponentStatus'
        StartTime:
          type: string
          format: date-time
          description: When the component started.
        EndTime:
          type: string
          format: date-time
          description: When the component ended.
        CreationTime:
          type: string
          format: date-time
          description: When the component was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: When the component was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
    UpdateTrialComponentRequest:
      type: object
      properties:
        TrialComponentName:
          type: string
          description: The name of the component to update.
        DisplayName:
          type: string
          description: The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified,
            TrialComponentName is displayed.
        Status:
          $ref: '#/components/schemas/TrialComponentStatus'
        StartTime:
          type: string
          format: date-time
          description: When the component started.
        EndTime:
          type: string
          format: date-time
          description: When the component ended.
        Parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentParameterValue'
          description: Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters.
            Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
        ParametersToRemove:
          type: array
          items:
            type: string
          description: The hyperparameters to remove from the component.
        InputArtifacts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentArtifact'
          description: Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts.
            Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
        InputArtifactsToRemove:
          type: array
          items:
            type: string
          description: The input artifacts to remove from the component.
        OutputArtifacts:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TrialComponentArtifact'
          description: Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts.
            Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
        OutputArtifactsToRemove:
          type: array
          items:
            type: string
          description: The output artifacts to remove from the component.
      required:
      - TrialComponentName
    UpdateTrialComponentResponse:
      type: object
      properties:
        TrialComponentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the trial component.
    UserContext:
      type: object
      properties:
        UserProfileArn:
          type: string
          description: The Amazon Resource Name (ARN) of the user's profile.
        UserProfileName:
          type: string
          description: The name of the user's profile.
        DomainId:
          type: string
          description: The domain associated with the user.
        IamIdentity:
          $ref: '#/components/schemas/IamIdentity'
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)