Amazon SageMaker Sagemaker Hub Content Reference API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Hub Content Reference API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateHubContentReference:
    post:
      operationId: CreateHubContentReference
      summary: Create Hub Content Reference
      description: Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateHubContentReferenceResponse'
        '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.CreateHubContentReference
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateHubContentReferenceRequest'
      tags:
      - Hub Content Reference
  /#DeleteHubContentReference:
    post:
      operationId: DeleteHubContentReference
      summary: Delete Hub Content Reference
      description: Delete a hub content reference in order to remove a model from a private hub.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '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.DeleteHubContentReference
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteHubContentReferenceRequest'
      tags:
      - Hub Content Reference
  /#UpdateHubContentReference:
    post:
      operationId: UpdateHubContentReference
      summary: Update Hub Content Reference
      description: Updates the contents of a SageMaker hub for a ModelReference resource. A ModelReference allows you to access
        public SageMaker JumpStart models from within your private hub. When using this API, you can update the MinVersion
        field for additional flexibility in the model version. You shouldn't update any additional fields when using this
        API, because the metadata in your private hub should match the public JumpStart model's metadata. If you want to update
        a Model or Notebook resource in your hub, use the UpdateHubContent API instead. For more information about adding
        model references to your hub, see Add models to a private hub.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateHubContentReferenceResponse'
        '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.UpdateHubContentReference
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateHubContentReferenceRequest'
      tags:
      - Hub Content Reference
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:
    CreateHubContentReferenceRequest:
      type: object
      properties:
        HubName:
          type: string
          description: The name of the hub to add the hub content reference to.
        SageMakerPublicHubContentArn:
          type: string
          description: The ARN of the public hub content to reference.
        HubContentName:
          type: string
          description: The name of the hub content to reference.
        MinVersion:
          type: string
          description: The minimum version of the hub content to reference.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags associated with the hub content to reference.
      required:
      - HubName
      - SageMakerPublicHubContentArn
    CreateHubContentReferenceResponse:
      type: object
      properties:
        HubArn:
          type: string
          description: The ARN of the hub that the hub content reference was added to.
        HubContentArn:
          type: string
          description: The ARN of the hub content.
      required:
      - HubArn
      - HubContentArn
    DeleteHubContentReferenceRequest:
      type: object
      properties:
        HubName:
          type: string
          description: The name of the hub to delete the hub content reference from.
        HubContentType:
          type: string
          enum:
          - Model
          - Notebook
          - ModelReference
          - DataSet
          - JsonDoc
          description: The type of hub content reference to delete. The only supported type of hub content reference to delete
            is ModelReference.
        HubContentName:
          type: string
          description: The name of the hub content to delete.
      required:
      - HubName
      - HubContentType
      - HubContentName
    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
    UpdateHubContentReferenceRequest:
      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 ModelReference resource for
            this API. To update a Model or Notebook resource, use the UpdateHubContent API instead.
        MinVersion:
          type: string
          description: The minimum hub content version of the referenced model that you want to use. The minimum version must
            be older than the latest available version of the referenced model. To support all versions of a model, set the
            value to 1.0.0.
      required:
      - HubName
      - HubContentName
      - HubContentType
    UpdateHubContentReferenceResponse:
      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)