Amazon SageMaker Sagemaker Tag API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Tag 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:
  /#AddTags:
    post:
      operationId: AddTags
      summary: Add Tags
      description: Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook
        instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint
        configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource.
        For more information about tags, see For more information, see Amazon Web Services Tagging Strategies. Tags that you
        add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter
        tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched
        before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added
        to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job
        by specifying them in the Tags parameter of CreateHyperParameterTuningJob Tags that you add to a SageMaker Domain
        or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you
        call this API, but not to Apps that the Domain or User
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AddTagsOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.AddTags
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AddTagsInput'
      tags:
      - Tag
  /#DeleteTags:
    post:
      operationId: DeleteTags
      summary: Delete Tags
      description: Deletes the specified tags from an SageMaker resource. To list a resource's tags, use the ListTags API.
        When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training
        jobs that the hyperparameter tuning job launched before you called this API. When you call this API to delete tags
        from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User
        Profile launched before you called this API.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteTagsOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteTags
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteTagsInput'
      tags:
      - Tag
  /#ListTags:
    post:
      operationId: ListTags
      summary: List Tags
      description: Returns the tags for the specified SageMaker resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListTags
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsInput'
      tags:
      - Tag
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:
    AddTagsInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource that you want to tag.
        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.
      required:
      - ResourceArn
      - Tags
    AddTagsOutput:
      type: object
      properties:
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags associated with the SageMaker resource.
    DeleteTagsInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
        TagKeys:
          type: array
          items:
            type: string
          description: An array or one or more tag keys to delete.
      required:
      - ResourceArn
      - TagKeys
    DeleteTagsOutput:
      type: object
      properties: {}
    ListTagsInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
        NextToken:
          type: string
          description: If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve
            the next set of tags, use it in the subsequent request.
        MaxResults:
          type: integer
          description: Maximum number of tags to return.
      required:
      - ResourceArn
    ListTagsOutput:
      type: object
      properties:
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of Tag objects, each with a tag key and a value.
        NextToken:
          type: string
          description: If response is truncated, SageMaker includes a token in the response. You can use this token in your
            subsequent request to fetch next set of tokens.
    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)