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-item-related-item-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

openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Ops Item Related Item…
  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: Ops Item Related Item
paths:
  /#AssociateOpsItemRelatedItem:
    post:
      operationId: AssociateOpsItemRelatedItem
      summary: Associate Ops Item Related Item
      description: Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in Amazon Web Services Systems Manager.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AssociateOpsItemRelatedItemResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsItemConflictException; OpsItemInvalidParameterException; OpsItemLimitExceededException; OpsItemNotFoundException; OpsItemRelatedItemAlreadyExistsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsItemConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.AssociateOpsItemRelatedItem
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AssociateOpsItemRelatedItemRequest'
      tags:
      - Ops Item Related Item
  /#DisassociateOpsItemRelatedItem:
    post:
      operationId: DisassociateOpsItemRelatedItem
      summary: Disassociate Ops Item Related Item
      description: Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisassociateOpsItemRelatedItemResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsItemConflictException; OpsItemInvalidParameterException; OpsItemNotFoundException; OpsItemRelatedItemAssociationNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsItemConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.DisassociateOpsItemRelatedItem
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisassociateOpsItemRelatedItemRequest'
      tags:
      - Ops Item Related Item
  /#ListOpsItemRelatedItems:
    post:
      operationId: ListOpsItemRelatedItems
      summary: List Ops Item Related Items
      description: Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListOpsItemRelatedItemsResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: OpsItemInvalidParameterException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OpsItemInvalidParameterException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.ListOpsItemRelatedItems
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListOpsItemRelatedItemsRequest'
      tags:
      - Ops Item Related Item
components:
  schemas:
    AssociateOpsItemRelatedItemResponse:
      type: object
      properties:
        AssociationId:
          type: string
          description: The association ID.
    OpsItemIdentity:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
    OpsItemRelatedItemsFilter:
      type: object
      properties:
        Key:
          type: string
          enum:
          - ResourceType
          - AssociationId
          - ResourceUri
          description: The name of the filter key. Supported values include ResourceUri, ResourceType, or AssociationId.
        Values:
          type: array
          items:
            type: string
          description: The values for the filter.
        Operator:
          type: string
          enum:
          - Equal
          description: The operator used by the filter call. The only supported operator is EQUAL.
      required:
      - Key
      - Values
      - Operator
    OpsItemRelatedItemSummary:
      type: object
      properties:
        OpsItemId:
          type: string
          description: The OpsItem ID.
        AssociationId:
          type: string
          description: The association ID.
        ResourceType:
          type: string
          description: The resource type.
        AssociationType:
          type: string
          description: The association type.
        ResourceUri:
          type: string
          description: The Amazon Resource Name (ARN) of the related-item resource.
        CreatedBy:
          $ref: '#/components/schemas/OpsItemIdentity'
        CreatedTime:
          type: string
          format: date-time
          description: The time the related-item association was created.
        LastModifiedBy:
          $ref: '#/components/schemas/OpsItemIdentity'
        LastModifiedTime:
          type: string
          format: date-time
          description: The time the related-item association was last updated.
    AssociateOpsItemRelatedItemRequest:
      type: object
      properties:
        OpsItemId:
          type: string
          description: The ID of the OpsItem to which you want to associate a resource as a related item.
        AssociationType:
          type: string
          description: The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.
        ResourceType:
          type: string
          description: 'The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types: AWS::SSMIncidents::IncidentRecord: an Incident Manager incident. AWS::SSM::Document: a Systems Manager (SSM) document.'
        ResourceUri:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.
      required:
      - OpsItemId
      - AssociationType
      - ResourceType
      - ResourceUri
    OpsItemInvalidParameterException:
      type: object
      properties:
        ParameterNames:
          type: array
          items:
            type: string
        Message:
          type: string
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    DisassociateOpsItemRelatedItemRequest:
      type: object
      properties:
        OpsItemId:
          type: string
          description: The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.
        AssociationId:
          type: string
          description: The ID of the association for which you want to delete an association between the OpsItem and a related item.
      required:
      - OpsItemId
      - AssociationId
    ListOpsItemRelatedItemsRequest:
      type: object
      properties:
        OpsItemId:
          type: string
          description: The ID of the OpsItem for which you want to list all related-item resources.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/OpsItemRelatedItemsFilter'
          description: One or more OpsItem filters. Use a filter to return a more specific list of results.
        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: The token for the next set of items to return. (You received this token from a previous call.)
    ListOpsItemRelatedItemsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
        Summaries:
          type: array
          items:
            $ref: '#/components/schemas/OpsItemRelatedItemSummary'
          description: A list of related-item resources for the specified OpsItem.
    OpsItemConflictException:
      type: object
      properties:
        Message:
          type: string
    DisassociateOpsItemRelatedItemResponse:
      type: object
      properties: {}
  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)