Amazon Systems Manager

Amazon Systems Manager Systems Manager Ops Metadata API

The Systems Manager Ops Metadata API from Amazon Systems Manager — 5 operation(s) for systems manager ops metadata.

GitHub OpenAPI

Operations 5

POST /#CreateOpsMetadata Create Ops Metadata #
POST /#DeleteOpsMetadata Delete Ops Metadata #
POST /#GetOpsMetadata Get Ops Metadata #
POST /#ListOpsMetadata List Ops Metadata #
POST /#UpdateOpsMetadata Update Ops Metadata #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-systems-manager/openapi/amazon-systems-manager-ops-metadata-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-systems-manager:amazon-systems-manager-ops-metadata-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-systems-manager-ops-metadata-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Ops Metadata API
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 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://ssm.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Ops Metadata
paths:
  /#CreateOpsMetadata:
    post:
      operationId: CreateOpsMetadata
      summary: Create Ops Metadata
      description: If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateOpsMetadataResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsMetadataAlreadyExistsException; OpsMetadataInvalidArgumentException; OpsMetadataLimitExceededException; OpsMetadataTooManyUpdatesException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsMetadataAlreadyExistsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.CreateOpsMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateOpsMetadataRequest'
      tags:
      - Ops Metadata
  /#DeleteOpsMetadata:
    post:
      operationId: DeleteOpsMetadata
      summary: Delete Ops Metadata
      description: Delete OpsMetadata related to an application.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteOpsMetadataResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsMetadataInvalidArgumentException; OpsMetadataNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsMetadataInvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.DeleteOpsMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteOpsMetadataRequest'
      tags:
      - Ops Metadata
  /#GetOpsMetadata:
    post:
      operationId: GetOpsMetadata
      summary: Get Ops Metadata
      description: View operational metadata related to an application in Application Manager.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetOpsMetadataResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsMetadataInvalidArgumentException; OpsMetadataNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsMetadataInvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.GetOpsMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetOpsMetadataRequest'
      tags:
      - Ops Metadata
  /#ListOpsMetadata:
    post:
      operationId: ListOpsMetadata
      summary: List Ops Metadata
      description: Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListOpsMetadataResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsMetadataInvalidArgumentException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsMetadataInvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.ListOpsMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListOpsMetadataRequest'
      tags:
      - Ops Metadata
  /#UpdateOpsMetadata:
    post:
      operationId: UpdateOpsMetadata
      summary: Update Ops Metadata
      description: Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateOpsMetadataResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsMetadataInvalidArgumentException; OpsMetadataKeyLimitExceededException; OpsMetadataNotFoundException; OpsMetadataTooManyUpdatesException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsMetadataInvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.UpdateOpsMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateOpsMetadataRequest'
      tags:
      - Ops Metadata
components:
  schemas:
    ListOpsMetadataResult:
      type: object
      properties:
        OpsMetadataList:
          type: array
          items:
            $ref: '#/components/schemas/OpsMetadata'
          description: Returns a list of OpsMetadata objects.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    DeleteOpsMetadataResult:
      type: object
      properties: {}
    UpdateOpsMetadataRequest:
      type: object
      properties:
        OpsMetadataArn:
          type: string
          description: The Amazon Resource Name (ARN) of the OpsMetadata Object to update.
        MetadataToUpdate:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/MetadataValue'
          description: Metadata to add to an OpsMetadata object.
        KeysToDelete:
          type: array
          items:
            type: string
          description: The metadata keys to delete from the OpsMetadata object.
      required:
      - OpsMetadataArn
    GetOpsMetadataResult:
      type: object
      properties:
        ResourceId:
          type: string
          description: The resource ID of the Application Manager application.
        Metadata:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/MetadataValue'
          description: OpsMetadata for an Application Manager application.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    OpsMetadataFilter:
      type: object
      properties:
        Key:
          type: string
          description: A filter key.
        Values:
          type: array
          items:
            type: string
          description: A filter value.
      required:
      - Key
      - Values
    UpdateOpsMetadataResult:
      type: object
      properties:
        OpsMetadataArn:
          type: string
          description: The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.
    CreateOpsMetadataResult:
      type: object
      properties:
        OpsMetadataArn:
          type: string
          description: The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.
    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
    GetOpsMetadataRequest:
      type: object
      properties:
        OpsMetadataArn:
          type: string
          description: The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
        NextToken:
          type: string
          description: A token to start the list. Use this token to get the next set of results.
      required:
      - OpsMetadataArn
    OpsMetadataInvalidArgumentException:
      type: object
      properties:
        message:
          type: string
    OpsMetadataAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    ListOpsMetadataRequest:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/OpsMetadataFilter'
          description: One or more filters to limit the number of OpsMetadata objects returned by the call.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
        NextToken:
          type: string
          description: A token to start the list. Use this token to get the next set of results.
    DeleteOpsMetadataRequest:
      type: object
      properties:
        OpsMetadataArn:
          type: string
          description: The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.
      required:
      - OpsMetadataArn
    CreateOpsMetadataRequest:
      type: object
      properties:
        ResourceId:
          type: string
          description: A resource ID for a new Application Manager application.
        Metadata:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/MetadataValue'
          description: Metadata for a new Application Manager application.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs: Key=Environment,Value=Production Key=Region,Value=us-east-2'
      required:
      - ResourceId
    OpsMetadata:
      type: object
      properties:
        ResourceId:
          type: string
          description: The ID of the Application Manager application.
        OpsMetadataArn:
          type: string
          description: The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
        LastModifiedDate:
          type: string
          format: date-time
          description: The date the OpsMetadata object was last updated.
        LastModifiedUser:
          type: string
          description: The user name who last updated the OpsMetadata object.
        CreationDate:
          type: string
          format: date-time
          description: The date the OpsMetadata objects was created.
    MetadataValue:
      type: object
      properties:
        Value:
          type: string
          description: Metadata value to assign to an Application Manager application.
  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)