Amazon SageMaker Sagemaker Hub Content API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Hub Content 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:
  /#DeleteHubContent:
    post:
      operationId: DeleteHubContent
      summary: Delete Hub Content
      description: Delete the contents of a hub.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ResourceInUse; 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.DeleteHubContent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteHubContentRequest'
      tags:
      - Hub Content
  /#DescribeHubContent:
    post:
      operationId: DescribeHubContent
      summary: Describe Hub Content
      description: Describe the content of a hub.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeHubContentResponse'
        '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.DescribeHubContent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeHubContentRequest'
      tags:
      - Hub Content
  /#ImportHubContent:
    post:
      operationId: ImportHubContent
      summary: Import Hub Content
      description: Import hub content.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ImportHubContentResponse'
        '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.ImportHubContent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ImportHubContentRequest'
      tags:
      - Hub Content
  /#ListHubContents:
    post:
      operationId: ListHubContents
      summary: List Hub Contents
      description: List the contents of a hub.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListHubContentsResponse'
        '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.ListHubContents
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListHubContentsRequest'
      tags:
      - Hub Content
  /#UpdateHubContent:
    post:
      operationId: UpdateHubContent
      summary: Update Hub Content
      description: 'Updates SageMaker hub content (either a Model or Notebook resource). You can update the metadata that
        describes the resource. In addition to the required request fields, specify at least one of the following fields to
        update: HubContentDescription HubContentDisplayName HubContentMarkdown HubContentSearchKeywords SupportStatus For
        more information about hubs, see Private curated hubs for foundation model access control in JumpStart. If you want
        to update a ModelReference resource in your hub, use the UpdateHubContentResource API instead.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateHubContentResponse'
        '400':
          description: ResourceInUse; 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.UpdateHubContent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateHubContentRequest'
      tags:
      - Hub Content
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:
    DeleteHubContentRequest:
      type: object
      properties:
        HubName:
          type: string
          description: The name of the hub that you want to delete content in.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The type of content that you want to delete from a hub.
        HubContentName:
          type: string
          description: The name of the content that you want to delete from a hub.
        HubContentVersion:
          type: string
          description: The version of the content that you want to delete from a hub.
      required:
      - HubName
      - HubContentType
      - HubContentName
      - HubContentVersion
    DescribeHubContentRequest:
      type: object
      properties:
        HubName:
          type: string
          description: The name of the hub that contains the content to describe.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The type of content in the hub.
        HubContentName:
          type: string
          description: The name of the content to describe.
        HubContentVersion:
          type: string
          description: The version of the content to describe.
      required:
      - HubName
      - HubContentType
      - HubContentName
    DescribeHubContentResponse:
      type: object
      properties:
        HubContentName:
          type: string
          description: The name of the hub content.
        HubContentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the hub content.
        HubContentVersion:
          type: string
          description: The version of the hub content.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The type of hub content.
        DocumentSchemaVersion:
          type: string
          description: The document schema version for the hub content.
        HubName:
          type: string
          description: The name of the hub that contains the content.
        HubArn:
          type: string
          description: The Amazon Resource Name (ARN) of the hub that contains the content.
        HubContentDisplayName:
          type: string
          description: The display name of the hub content.
        HubContentDescription:
          type: string
          description: A description of the hub content.
        HubContentMarkdown:
          type: string
          description: A string that provides a description of the hub content. This string can include links, tables, and
            standard markdown formating.
        HubContentDocument:
          type: string
          description: The hub content document that describes information about the hub content such as type, associated
            containers, scripts, and more.
        SageMakerPublicHubContentArn:
          type: string
          description: The ARN of the public hub content.
        ReferenceMinVersion:
          type: string
          description: The minimum version of the hub content.
        SupportStatus:
          type: string
          enum:
          - Supported
          - Deprecated
          - Restricted
          description: The support status of the hub content.
        HubContentSearchKeywords:
          type: array
          items:
            type: string
          description: The searchable keywords for the hub content.
        HubContentDependencies:
          type: array
          items:
            $ref: '#/components/schemas/HubContentDependency'
          description: The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets,
            or notebooks.
        HubContentStatus:
          type: string
          enum:
          - Available
          - Importing
          - Deleting
          - ImportFailed
          - DeleteFailed
          - PendingImport
          - PendingDelete
          description: The status of the hub content.
        FailureReason:
          type: string
          description: The failure reason if importing hub content failed.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that hub content was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last modified time of the hub content.
      required:
      - HubContentName
      - HubContentArn
      - HubContentVersion
      - HubContentType
      - DocumentSchemaVersion
      - HubName
      - HubArn
      - HubContentDocument
      - HubContentStatus
      - CreationTime
    HubContentDependency:
      type: object
      properties:
        DependencyOriginPath:
          type: string
          description: The hub content dependency origin path.
        DependencyCopyPath:
          type: string
          description: The hub content dependency copy path.
    HubContentInfo:
      type: object
      properties:
        HubContentName:
          type: string
          description: The name of the hub content.
        HubContentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the hub content.
        SageMakerPublicHubContentArn:
          type: string
          description: The ARN of the public hub content.
        HubContentVersion:
          type: string
          description: The version of the hub content.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The type of hub content.
        DocumentSchemaVersion:
          type: string
          description: The version of the hub content document schema.
        HubContentDisplayName:
          type: string
          description: The display name of the hub content.
        HubContentDescription:
          type: string
          description: A description of the hub content.
        SupportStatus:
          type: string
          enum:
          - Supported
          - Deprecated
          - Restricted
          description: The support status of the hub content.
        HubContentSearchKeywords:
          type: array
          items:
            type: string
          description: The searchable keywords for the hub content.
        HubContentStatus:
          type: string
          enum:
          - Available
          - Importing
          - Deleting
          - ImportFailed
          - DeleteFailed
          - PendingImport
          - PendingDelete
          description: The status of the hub content.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the hub content was created.
        OriginalCreationTime:
          type: string
          format: date-time
          description: The date and time when the hub content was originally created, before any updates or revisions.
      required:
      - HubContentName
      - HubContentArn
      - HubContentVersion
      - HubContentType
      - DocumentSchemaVersion
      - HubContentStatus
      - CreationTime
    ImportHubContentRequest:
      type: object
      properties:
        HubContentName:
          type: string
          description: The name of the hub content to import.
        HubContentVersion:
          type: string
          description: The version of the hub content to import.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The type of hub content to import.
        DocumentSchemaVersion:
          type: string
          description: The version of the hub content schema to import.
        HubName:
          type: string
          description: The name of the hub to import content into.
        HubContentDisplayName:
          type: string
          description: The display name of the hub content to import.
        HubContentDescription:
          type: string
          description: A description of the hub content to import.
        HubContentMarkdown:
          type: string
          description: A string that provides a description of the hub content. This string can include links, tables, and
            standard markdown formating.
        HubContentDocument:
          type: string
          description: The hub content document that describes information about the hub content such as type, associated
            containers, scripts, and more.
        SupportStatus:
          type: string
          enum:
          - Supported
          - Deprecated
          - Restricted
          description: The status of the hub content resource.
        HubContentSearchKeywords:
          type: array
          items:
            type: string
          description: The searchable keywords of the hub content.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags associated with the hub content.
      required:
      - HubContentName
      - HubContentType
      - DocumentSchemaVersion
      - HubName
      - HubContentDocument
    ImportHubContentResponse:
      type: object
      properties:
        HubArn:
          type: string
          description: The ARN of the hub that the content was imported into.
        HubContentArn:
          type: string
          description: The ARN of the hub content that was imported.
      required:
      - HubArn
      - HubContentArn
    ListHubContentsRequest:
      type: object
      properties:
        HubName:
          type: string
          description: The name of the hub to list the contents of.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The type of hub content to list.
        NameContains:
          type: string
          description: Only list hub content if the name contains the specified string.
        MaxSchemaVersion:
          type: string
          description: The upper bound of the hub content schema verion.
        CreationTimeBefore:
          type: string
          format: date-time
          description: Only list hub content that was created before the time specified.
        CreationTimeAfter:
          type: string
          format: date-time
          description: Only list hub content that was created after the time specified.
        SortBy:
          type: string
          enum:
          - HubContentName
          - CreationTime
          - HubContentStatus
          description: Sort hub content versions by either name or creation time.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: Sort hubs by ascending or descending order.
        MaxResults:
          type: integer
          description: The maximum amount of hub content to list.
        NextToken:
          type: string
          description: If the response to a previous ListHubContents request was truncated, the response includes a NextToken.
            To retrieve the next set of hub content, use the token in the next request.
      required:
      - HubName
      - HubContentType
    ListHubContentsResponse:
      type: object
      properties:
        HubContentSummaries:
          type: array
          items:
            $ref: '#/components/schemas/HubContentInfo'
          description: The summaries of the listed hub content.
        NextToken:
          type: string
          description: If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content,
            use it in the subsequent request.
      required:
      - HubContentSummaries
    ResourceInUse:
      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
    UpdateHubContentRequest:
      type: object
      properties:
        HubName:
          type: string
          description: The name of the SageMaker hub that contains the hub content you want to update. You can optionally
            use the hub ARN instead.
        HubContentName:
          type: string
          description: The name of the hub content resource that you want to update.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The content type of the resource that you want to update. Only specify a Model or Notebook resource
            for this API. To update a ModelReference, use the UpdateHubContentReference API instead.
        HubContentVersion:
          type: string
          description: The hub content version that you want to update. For example, if you have two versions of a resource
            in your hub, you can update the second version.
        HubContentDisplayName:
          type: string
          description: The display name of the hub content.
        HubContentDescription:
          type: string
          description: The description of the hub content.
        HubContentMarkdown:
          type: string
          description: A string that provides a description of the hub content. This string can include links, tables, and
            standard markdown formatting.
        HubContentSearchKeywords:
          type: array
          items:
            type: string
          description: The searchable keywords of the hub content.
        SupportStatus:
          type: string
          enum:
          - Supported
          - Deprecated
          - Restricted
          description: Indicates the current status of the hub content resource.
      required:
      - HubName
      - HubContentName
      - HubContentType
      - HubContentVersion
    UpdateHubContentResponse:
      type: object
      properties:
        HubArn:
          type: string
          description: The ARN of the private model hub that contains the updated hub content.
        HubContentArn:
          type: string
          description: The ARN of the hub content resource that was updated.
      required:
      - HubArn
      - HubContentArn
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)