Amazon Systems Manager Systems Manager Tag API

openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Tag API
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 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://ssm.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Tag
paths:
  /#AddTagsToResource:
    post:
      operationId: AddTagsToResource
      summary: Add Tags To Resource
      description: 'Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account''s managed nodes that helps you track each node''s owner and stack level. For example: Key=Owner,Value=DbAdmin Key=Owner,Value=SysAdmin Key=Owner,Value=Dev Key=Stack,Value=Production Key=Stack,Value=Pre-Production Key=Stack,Value=Test Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don''t have any semantic meaning to and are interpreted strictly as a string of characters. For more information about using tags with Amazon Elastic Compute Clou'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AddTagsToResourceResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidResourceId; InvalidResourceType; TooManyTagsError; TooManyUpdates
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidResourceId'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.AddTagsToResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AddTagsToResourceRequest'
      tags:
      - Tag
  /#ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Returns a list of the tags assigned to the specified resource. For information about the ID format for each supported resource type, see AddTagsToResource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidResourceId; InvalidResourceType
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidResourceId'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.ListTagsForResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsForResourceRequest'
      tags:
      - Tag
  /#RemoveTagsFromResource:
    post:
      operationId: RemoveTagsFromResource
      summary: Remove Tags From Resource
      description: Removes tag keys from the specified resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RemoveTagsFromResourceResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidResourceId; InvalidResourceType; TooManyUpdates
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidResourceId'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.RemoveTagsFromResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/RemoveTagsFromResourceRequest'
      tags:
      - Tag
components:
  schemas:
    InvalidResourceId:
      type: object
      properties: {}
    RemoveTagsFromResourceResult:
      type: object
      properties: {}
    ListTagsForResourceRequest:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - Document
          - ManagedInstance
          - MaintenanceWindow
          - Parameter
          - PatchBaseline
          - OpsItem
          - OpsMetadata
          - Automation
          - Association
          - CloudConnector
          description: Returns a list of tags for a specific resource type.
        ResourceId:
          type: string
          description: The resource ID for which you want to see a list of tags.
      required:
      - ResourceType
      - ResourceId
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The name of the tag.
        Value:
          type: string
          description: The value of the tag.
      required:
      - Key
      - Value
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    AddTagsToResourceResult:
      type: object
      properties: {}
    ListTagsForResourceResult:
      type: object
      properties:
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags.
    RemoveTagsFromResourceRequest:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - Document
          - ManagedInstance
          - MaintenanceWindow
          - Parameter
          - PatchBaseline
          - OpsItem
          - OpsMetadata
          - Automation
          - Association
          - CloudConnector
          description: 'The type of resource from which you want to remove a tag. The ManagedInstance type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.'
        ResourceId:
          type: string
          description: 'The ID of the resource from which you want to remove tags. For example: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde Automation: example-c160-4567-8519-012345abcde PatchBaseline: pb-012345abcde OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager o'
        TagKeys:
          type: array
          items:
            type: string
          description: Tag keys that you want to remove from the specified resource.
      required:
      - ResourceType
      - ResourceId
      - TagKeys
    AddTagsToResourceRequest:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - Document
          - ManagedInstance
          - MaintenanceWindow
          - Parameter
          - PatchBaseline
          - OpsItem
          - OpsMetadata
          - Automation
          - Association
          - CloudConnector
          description: 'Specifies the type of resource you are tagging. The ManagedInstance type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.'
        ResourceId:
          type: string
          description: 'The resource ID you want to tag. Use the ID of the resource. Here are some examples: MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde Automation: example-c160-4567-8519-012345abcde OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more tags. The value parameter is required. Don't enter personally identifiable information in this field.
      required:
      - ResourceType
      - ResourceId
      - Tags
  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: ssm
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ssm/service/2014-11-06/ssm-2014-11-06.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)