Amazon Systems Manager Systems Manager Activation API

openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Activation 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: Activation
paths:
  /#CreateActivation:
    post:
      operationId: CreateActivation
      summary: Create Activation
      description: Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide. Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateActivationResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidParameters
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameters'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.CreateActivation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateActivationRequest'
      tags:
      - Activation
  /#DeleteActivation:
    post:
      operationId: DeleteActivation
      summary: Delete Activation
      description: Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteActivationResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidActivation; InvalidActivationId; TooManyUpdates
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidActivation'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.DeleteActivation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteActivationRequest'
      tags:
      - Activation
  /#DescribeActivations:
    post:
      operationId: DescribeActivations
      summary: Describe Activations
      description: Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeActivationsResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidFilter; InvalidNextToken
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidFilter'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.DescribeActivations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeActivationsRequest'
      tags:
      - Activation
components:
  schemas:
    DescribeActivationsResult:
      type: object
      properties:
        ActivationList:
          type: array
          items:
            $ref: '#/components/schemas/Activation'
          description: A list of activations for your Amazon Web Services account.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    DescribeActivationsFilter:
      type: object
      properties:
        FilterKey:
          type: string
          enum:
          - ActivationIds
          - DefaultInstanceName
          - IamRole
          description: The name of the filter.
        FilterValues:
          type: array
          items:
            type: string
          description: The filter values.
    CreateActivationResult:
      type: object
      properties:
        ActivationId:
          type: string
          description: The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
        ActivationCode:
          type: string
          description: The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
    RegistrationMetadataItem:
      type: object
      properties:
        Key:
          type: string
          description: Reserved for internal use.
        Value:
          type: string
          description: Reserved for internal use.
      required:
      - Key
      - Value
    InvalidParameters:
      type: object
      properties:
        Message:
          type: string
    CreateActivationRequest:
      type: object
      properties:
        Description:
          type: string
          description: A user-defined description of the resource that you want to register with Systems Manager. Don't enter personally identifiable information in this field.
        DefaultInstanceName:
          type: string
          description: The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources. Don't enter personally identifiable information in this field.
        IamRole:
          type: string
          description: The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create the IAM service role required for Systems Manager in a hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide. You can't specify an IAM service-linked role for this parameter. You must create a unique role.
        RegistrationLimit:
          type: integer
          description: Specify the maximum number of managed nodes you want to register. The default value is 1.
        ExpirationDate:
          type: string
          format: date-time
          description: The date by which this activation request should expire, in timestamp format, such as "2024-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'Optional metadata that you assign to a resource. 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 activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs: Key=OS,Value=Windows Key=Environment,Value=Production When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activ'
        RegistrationMetadata:
          type: array
          items:
            $ref: '#/components/schemas/RegistrationMetadataItem'
          description: Reserved for internal use.
      required:
      - IamRole
    DescribeActivationsRequest:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/DescribeActivationsFilter'
          description: A filter to view information about your activations.
        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.
    InvalidActivation:
      type: object
      properties:
        Message:
          type: string
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    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
    InvalidFilter:
      type: object
      properties:
        Message:
          type: string
    DeleteActivationRequest:
      type: object
      properties:
        ActivationId:
          type: string
          description: The ID of the activation that you want to delete.
      required:
      - ActivationId
    DeleteActivationResult:
      type: object
      properties: {}
    Activation:
      type: object
      properties:
        ActivationId:
          type: string
          description: The ID created by Systems Manager when you submitted the activation.
        Description:
          type: string
          description: A user defined description of the activation.
        DefaultInstanceName:
          type: string
          description: A name for the managed node when it is created.
        IamRole:
          type: string
          description: The Identity and Access Management (IAM) role to assign to the managed node.
        RegistrationLimit:
          type: integer
          description: The maximum number of managed nodes that can be registered using this activation.
        RegistrationsCount:
          type: integer
          description: The number of managed nodes already registered with this activation.
        ExpirationDate:
          type: string
          format: date-time
          description: The date when this activation can no longer be used to register managed nodes.
        Expired:
          type: boolean
          description: Whether or not the activation is expired.
        CreatedDate:
          type: string
          format: date-time
          description: The date the activation was created.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags assigned to the activation.
  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)