Amazon SageMaker Sagemaker Project API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Project 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:
  /#CreateProject:
    post:
      operationId: CreateProject
      summary: Create Project
      description: Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline
        from training to deploying an approved model.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateProjectOutput'
        '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.CreateProject
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateProjectInput'
      tags:
      - Project
  /#DeleteProject:
    post:
      operationId: DeleteProject
      summary: Delete Project
      description: Delete the specified project.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ConflictException
          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.DeleteProject
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteProjectInput'
      tags:
      - Project
  /#DescribeProject:
    post:
      operationId: DescribeProject
      summary: Describe Project
      description: Describes the details of a project.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeProjectOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeProject
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeProjectInput'
      tags:
      - Project
  /#ListProjects:
    post:
      operationId: ListProjects
      summary: List Projects
      description: Gets a list of the projects in an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListProjectsOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListProjects
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListProjectsInput'
      tags:
      - Project
  /#UpdateProject:
    post:
      operationId: UpdateProject
      summary: Update Project
      description: Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from
        training to deploying an approved model. You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails
        of a project that is active or being created, or updated, you may lose resources already created by the project.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateProjectOutput'
        '400':
          description: ConflictException
          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.UpdateProject
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateProjectInput'
      tags:
      - Project
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:
    CfnCreateTemplateProvider:
      type: object
      properties:
        TemplateName:
          type: string
          description: A unique identifier for the template within the project.
        TemplateURL:
          type: string
          description: The Amazon S3 URL of the CloudFormation template.
        RoleARN:
          type: string
          description: The IAM role that CloudFormation assumes when creating the stack.
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/CfnStackCreateParameter'
          description: An array of CloudFormation stack parameters.
      required:
      - TemplateName
      - TemplateURL
    CfnStackCreateParameter:
      type: object
      properties:
        Key:
          type: string
          description: The name of the CloudFormation parameter.
        Value:
          type: string
          description: The value of the CloudFormation parameter.
      required:
      - Key
    CfnStackDetail:
      type: object
      properties:
        Name:
          type: string
          description: The name of the CloudFormation stack.
        Id:
          type: string
          description: The unique identifier of the CloudFormation stack.
        StatusMessage:
          type: string
          description: A human-readable message about the stack's current status.
      required:
      - StatusMessage
    CfnStackParameter:
      type: object
      properties:
        Key:
          type: string
          description: The name of the CloudFormation parameter.
        Value:
          type: string
          description: The value of the CloudFormation parameter.
      required:
      - Key
    CfnStackUpdateParameter:
      type: object
      properties:
        Key:
          type: string
          description: The name of the CloudFormation parameter.
        Value:
          type: string
          description: The value of the CloudFormation parameter.
      required:
      - Key
    CfnTemplateProviderDetail:
      type: object
      properties:
        TemplateName:
          type: string
          description: The unique identifier of the template within the project.
        TemplateURL:
          type: string
          description: The Amazon S3 URL of the CloudFormation template.
        RoleARN:
          type: string
          description: The IAM role used by CloudFormation to create the stack.
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/CfnStackParameter'
          description: An array of CloudFormation stack parameters.
        StackDetail:
          $ref: '#/components/schemas/CfnStackDetail'
      required:
      - TemplateName
      - TemplateURL
    CfnUpdateTemplateProvider:
      type: object
      properties:
        TemplateName:
          type: string
          description: The unique identifier of the template to update within the project.
        TemplateURL:
          type: string
          description: The Amazon S3 URL of the CloudFormation template.
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/CfnStackUpdateParameter'
          description: An array of CloudFormation stack parameters.
      required:
      - TemplateName
      - TemplateURL
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateProjectInput:
      type: object
      properties:
        ProjectName:
          type: string
          description: The name of the project.
        ProjectDescription:
          type: string
          description: A description for the project.
        ServiceCatalogProvisioningDetails:
          $ref: '#/components/schemas/ServiceCatalogProvisioningDetails'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource
            costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference
            Guide.
        TemplateProviders:
          type: array
          items:
            $ref: '#/components/schemas/CreateTemplateProvider'
          description: An array of template provider configurations for creating infrastructure resources for the project.
      required:
      - ProjectName
    CreateProjectOutput:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project.
        ProjectId:
          type: string
          description: The ID of the new project.
      required:
      - ProjectArn
      - ProjectId
    CreateTemplateProvider:
      type: object
      properties:
        CfnTemplateProvider:
          $ref: '#/components/schemas/CfnCreateTemplateProvider'
    DeleteProjectInput:
      type: object
      properties:
        ProjectName:
          type: string
          description: The name of the project to delete.
      required:
      - ProjectName
    DescribeProjectInput:
      type: object
      properties:
        ProjectName:
          type: string
          description: The name of the project to describe.
      required:
      - ProjectName
    DescribeProjectOutput:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project.
        ProjectName:
          type: string
          description: The name of the project.
        ProjectId:
          type: string
          description: The ID of the project.
        ProjectDescription:
          type: string
          description: The description of the project.
        ServiceCatalogProvisioningDetails:
          $ref: '#/components/schemas/ServiceCatalogProvisioningDetails'
        ServiceCatalogProvisionedProductDetails:
          $ref: '#/components/schemas/ServiceCatalogProvisionedProductDetails'
        ProjectStatus:
          type: string
          enum:
          - Pending
          - CreateInProgress
          - CreateCompleted
          - CreateFailed
          - DeleteInProgress
          - DeleteFailed
          - DeleteCompleted
          - UpdateInProgress
          - UpdateCompleted
          - UpdateFailed
          description: The status of the project.
        TemplateProviderDetails:
          type: array
          items:
            $ref: '#/components/schemas/TemplateProviderDetail'
          description: An array of template providers associated with the project.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        CreationTime:
          type: string
          format: date-time
          description: The time when the project was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when project was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
      required:
      - ProjectArn
      - ProjectName
      - ProjectId
      - ProjectStatus
      - CreationTime
    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.
    ListProjectsInput:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns the projects that were created after a specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns the projects that were created before a specified time.
        MaxResults:
          type: integer
          description: The maximum number of projects to return in the response.
        NameContains:
          type: string
          description: A filter that returns the projects whose name contains a specified string.
        NextToken:
          type: string
          description: If the result of the previous ListProjects request was truncated, the response includes a NextToken.
            To retrieve the next set of projects, use the token in the next request.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          description: The field by which to sort results. The default is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results. The default is Ascending.
    ListProjectsOutput:
      type: object
      properties:
        ProjectSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/ProjectSummary'
          description: A list of summaries of projects.
        NextToken:
          type: string
          description: If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken.
            To retrieve the next set of model compilation jobs, use the token in the next request.
      required:
      - ProjectSummaryList
    ProjectSummary:
      type: object
      properties:
        ProjectName:
          type: string
          description: The name of the project.
        ProjectDescription:
          type: string
          description: The description of the project.
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project.
        ProjectId:
          type: string
          description: The ID of the project.
        CreationTime:
          type: string
          format: date-time
          description: The time that the project was created.
        ProjectStatus:
          type: string
          enum:
          - Pending
          - CreateInProgress
          - CreateCompleted
          - CreateFailed
          - DeleteInProgress
          - DeleteFailed
          - DeleteCompleted
          - UpdateInProgress
          - UpdateCompleted
          - UpdateFailed
          description: The status of the project.
      required:
      - ProjectName
      - ProjectArn
      - ProjectId
      - CreationTime
      - ProjectStatus
    ProvisioningParameter:
      type: object
      properties:
        Key:
          type: string
          description: The key that identifies a provisioning parameter.
        Value:
          type: string
          description: The value of the provisioning parameter.
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    ServiceCatalogProvisionedProductDetails:
      type: object
      properties:
        ProvisionedProductId:
          type: string
          description: The ID of the provisioned product.
        ProvisionedProductStatusMessage:
          type: string
          description: The current status of the product. AVAILABLE - Stable state, ready to perform any operation. The most
            recent operation succeeded and completed. UNDER_CHANGE - Transitive state. Operations performed might not have
            valid results. Wait for an AVAILABLE status before performing operations. TAINTED - Stable state, ready to perform
            any operation. The stack has completed the requested operation but is not exactly what was requested. For example,
            a request to update to a new version failed and the stack rolled back to the current version. ERROR - An unexpected
            error occurred. The provisioned product e
    ServiceCatalogProvisioningDetails:
      type: object
      properties:
        ProductId:
          type: string
          description: The ID of the product to provision.
        ProvisioningArtifactId:
          type: string
          description: The ID of the provisioning artifact.
        PathId:
          type: string
          description: The path identifier of the product. This value is optional if the product has a default path, and required
            if the product has more than one path.
        ProvisioningParameters:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningParameter'
          description: A list of key value pairs that you specify when you provision a product.
      required:
      - ProductId
    ServiceCatalogProvisioningUpdateDetails:
      type: object
      properties:
        ProvisioningArtifactId:
          type: string
          description: The ID of the provisioning artifact.
        ProvisioningParameters:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningParameter'
          description: A list of key value pairs that you specify when you provision a product.
    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
    TemplateProviderDetail:
      type: object
      properties:
        CfnTemplateProviderDetail:
          $ref: '#/components/schemas/CfnTemplateProviderDetail'
    UpdateProjectInput:
      type: object
      properties:
        ProjectName:
          type: string
          description: The name of the project.
        ProjectDescription:
          type: string
          description: The description for the project.
        ServiceCatalogProvisioningUpdateDetails:
          $ref: '#/components/schemas/ServiceCatalogProvisioningUpdateDetails'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different
            ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
            In addition, the project must have tag update constraints set in order to include this parameter in the request.
            For more information, see Amazon Web Services Service Catalog Tag Update Constraints.
        TemplateProvidersToUpdate:
          type: array
          items:
            $ref: '#/components/schemas/UpdateTemplateProvider'
          description: The template providers to update in the project.
      required:
      - ProjectName
    UpdateProjectOutput:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project.
      required:
      - ProjectArn
    UpdateTemplateProvider:
      type: object
      properties:
        CfnTemplateProvider:
          $ref: '#/components/schemas/CfnUpdateTemplateProvider'
    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)