Amazon Systems Manager Systems Manager Resource Policy API

openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Resource Policy 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: Resource Policy
paths:
  /#DeleteResourcePolicy:
    post:
      operationId: DeleteResourcePolicy
      summary: Delete Resource Policy
      description: Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems). Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide. Document – Shares the document using Resource Access Manager (RAM). For more information about sharing documents, see Sharing Systems Manager documents in the Amazon Web Services Systems Manager User Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteResourcePolicyResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: MalformedResourcePolicyDocumentException; ResourceNotFoundException; ResourcePolicyConflictException; ResourcePolicyInvalidParameterException; ResourcePolicyNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/MalformedResourcePolicyDocumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.DeleteResourcePolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteResourcePolicyRequest'
      tags:
      - Resource Policy
  /#GetResourcePolicies:
    post:
      operationId: GetResourcePolicies
      summary: Get Resource Policies
      description: Returns an array of the Policy object.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetResourcePoliciesResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: ResourceNotFoundException; ResourcePolicyInvalidParameterException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.GetResourcePolicies
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetResourcePoliciesRequest'
      tags:
      - Resource Policy
  /#PutResourcePolicy:
    post:
      operationId: PutResourcePolicy
      summary: Put Resource Policy
      description: Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems). Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter. To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutResourcePolicyResponse'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: MalformedResourcePolicyDocumentException; ResourceNotFoundException; ResourcePolicyConflictException; ResourcePolicyInvalidParameterException; ResourcePolicyLimitExceededException; ResourcePolicyNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/MalformedResourcePolicyDocumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.PutResourcePolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutResourcePolicyRequest'
      tags:
      - Resource Policy
components:
  schemas:
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    GetResourcePoliciesResponse:
      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.
        Policies:
          type: array
          items:
            $ref: '#/components/schemas/GetResourcePoliciesResponseEntry'
          description: An array of the Policy object.
    GetResourcePoliciesResponseEntry:
      type: object
      properties:
        PolicyId:
          type: string
          description: A policy ID.
        PolicyHash:
          type: string
          description: ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.
        Policy:
          type: string
          description: A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
    DeleteResourcePolicyResponse:
      type: object
      properties: {}
    PutResourcePolicyRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
        Policy:
          type: string
          description: A policy you want to associate with a resource.
        PolicyId:
          type: string
          description: The policy ID.
        PolicyHash:
          type: string
          description: ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.
      required:
      - ResourceArn
      - Policy
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    DeleteResourcePolicyRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource to which the policies are attached.
        PolicyId:
          type: string
          description: The policy ID.
        PolicyHash:
          type: string
          description: ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.
        DeletionMode:
          type: string
          enum:
          - RemoveSharing
          - RollbackMigration
          description: Specifies the intended outcome of the operation. Applies only to the Document resource type. The operation ignores this parameter for other resource types. Optional. Defaults to RemoveSharing. RemoveSharing – Deletes the resource policy and removes sharing of the document. RollbackMigration – Reverts the document to Custom sharing, preserving existing consumer access, instead of removing the policy.
      required:
      - ResourceArn
      - PolicyId
      - PolicyHash
    MalformedResourcePolicyDocumentException:
      type: object
      properties:
        Message:
          type: string
    GetResourcePoliciesRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource to which the policies are attached.
        NextToken:
          type: string
          description: A token to start the list. Use this token to get the next set 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.
      required:
      - ResourceArn
    PutResourcePolicyResponse:
      type: object
      properties:
        PolicyId:
          type: string
          description: The policy ID. To update a policy, you must specify PolicyId and PolicyHash.
        PolicyHash:
          type: string
          description: ID of the current policy version.
  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)