CoreStack Aws Ssm API

openapi: 3.2.0
info:
  title: CoreStack External Aws Ssm API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Manage AWS SSM
servers:
- url: /
tags:
- name: AwsSsm
  description: Manage AWS SSM
paths:
  /v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/batch:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    - name: document_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsSsmDocumentVersionBatchResponse'
      summary: Batch Document versions
      description: List document version batches
      operationId: DocumentVersionsBatch
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordIdentityBatchRequest'
        required: true
  /v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/history:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    - name: document_id
      in: path
      required: true
      schema:
        type: string
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AwsSsmListDocumentVersion'
      summary: List Document versions
      description: List all document versions
      operationId: DocumentVersionsList
      security:
      - auth_token: []
      tags:
      - AwsSsm
  /v1/runbook/{tenant_id}/AWS/document/{document_type}/filters:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    - name: document_type
      in: path
      required: true
      schema:
        type: string
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsSsmDocumentFilter'
      summary: List document filters
      description: List Document Filters
      operationId: ListDocumentFilters
      security:
      - auth_token: []
      tags:
      - AwsSsm
  /v1/runbook/{tenant_id}/AWS/documents/batch:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsSsmDocumentsBatchResponse'
      summary: Batch SSM Documents
      description: List all SSM document batches
      operationId: DocumentBatch
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordIdentityBatchRequest'
        required: true
  /v1/runbook/{tenant_id}/AWS/documents/execution/batch:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsSsmDocumentExecutionBatchResponse'
      summary: Batch executions
      description: List all document execution batches
      operationId: ExecutionBatch
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordIdentityBatchRequest'
        required: true
  /v1/runbook/{tenant_id}/AWS/documents/execution/list:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse'
      summary: List executions
      description: List all document executions
      operationId: ExecutionList
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsSsmListDocumentExecutionRequest'
        required: true
  /v1/runbook/{tenant_id}/AWS/documents/list:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse'
      summary: List Documents
      description: List all SSM Documents
      operationId: DocumentList
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsSsmListDocumentsRequest'
        required: true
  /v1/runbook/{tenant_id}/AWS/documents/sync:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsSsmDocumentSyncResponse'
      summary: Manual document sync
      description: Sync SSM Documents for mentioned cloud accounts
      operationId: DocumentSync
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsSsmDocumentSyncRequest'
        required: true
  /v1/runbook/{tenant_id}/AWS/execution/filters/{document_type}:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    - name: document_type
      in: path
      required: true
      schema:
        type: string
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsSsmExecutionFilter'
      summary: List execution filters
      description: List Execution Filters
      operationId: listExecutionFilters
      security:
      - auth_token: []
      tags:
      - AwsSsm
  /v1/runbook/{tenant_id}/AWS/execution/group/batch:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsSsmExecutionGroupBatchResponse'
      summary: Batch execution job groups
      description: List all document execution group batches
      operationId: ExecutionGroupsBatch
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordIdentityBatchRequest'
        required: true
  /v1/runbook/{tenant_id}/AWS/execution/group/list:
    parameters:
    - name: tenant_id
      in: path
      required: true
      schema:
        type: string
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse'
      summary: List execution job groups
      description: List all document execution groups
      operationId: ExecutionGroupsList
      security:
      - auth_token: []
      tags:
      - AwsSsm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsSsmListExecutionGroupRequest'
        required: true
components:
  schemas:
    AwsSsmDocumentFilter:
      allOf:
      - $ref: '#/components/schemas/AwsSsmBaseDocumentFilter'
      - properties:
          owners:
            type: array
            description: The AWS user that created the document.
            items:
              type: string
          categories:
            type: array
            description: The classification of a document to help you identify and categorize its use.
            items:
              type: string
          platform_types:
            type: array
            description: The list of operating system (OS) platforms compatible with available SSM documents.
            items:
              type: string
          filters:
            description: Account filters for the tags
            $ref: '#/components/schemas/AwsSsmDocumentQueryFilters'
        type: object
      x-cs-type-name: AwsSsmDocumentFilter
    AwsSsmJobGroup:
      properties:
        sysId:
          type: string
          description: Id of the Group Executions
        status:
          type: string
          description: Status of the Job Group
          example: in_progress
          enum:
          - in_progress
          - completed
          x-cs-enum-type: AwsSsmJobGroupStatus
        document_id:
          type: string
          description: Document id from the ssm_docs collection
        document_version:
          type: string
          description: Document version id from the ssm_docs_version collection
        document_type:
          type: string
          description: Type of the document
          example: Command
          enum:
          - Command
          - Automation
          x-cs-enum-type: AwsSsmJobGroupDocumentType
        created_at:
          type: string
          format: date-time
          description: The date when the job was fetched
        created_by:
          type: string
          description: Name of the user who executed the document
        updated_at:
          type: string
          format: date-time
          description: Date when the document was last updated
        updated_by:
          type: string
          description: Name of the user who updated the execution
        change_id:
          type: string
          description: Service Now tracking id
      type: object
    AwsSsmBaseExecution:
      required:
      - flavor
      properties:
        inputs:
          type: object
          additionalProperties:
            type: string
        targets:
          type: array
          description: Details of the target.
          items:
            $ref: '#/components/schemas/AwsSsmTarget'
        max_concurrency:
          type: string
        max_errors:
          type: string
          description: The maximum number of errors allowed without the command failing.
      discriminator:
        propertyName: flavor
      type: object
      x-cs-subtypes:
      - subtype_model: AwsSsmCommandExecution
        subtype_name: AwsSsmCommandExecution
      - subtype_model: AwsSsmAutomationExecution
        subtype_name: AwsSsmAutomationExecution
    AwsSsmTarget:
      properties:
        key:
          type: string
          description: Type of the target resource for execution of command document
        values:
          type: array
          description: Target resource details
          items:
            type: string
      type: object
    AwsSsmDocumentPermissionDetail:
      properties:
        account_ids:
          type: array
          description: 'AWS account ids '
          items:
            type: string
        account_sharing_info:
          type: array
          description: AWS account details
          items:
            $ref: '#/components/schemas/AwsSsmDocumentAccountShared'
      type: object
    AwsSsmDocumentQueryFilters:
      properties:
        regions:
          type: array
          description: Regions based on the available documents (all if missing)
          items:
            type: string
        owners:
          type: array
          description: The AWS user that created the document (all if missing)
          items:
            type: string
        categories:
          type: array
          description: The classification of a document to help you identify and categorize its use (all if missing)
          items:
            type: string
      type: object
    AwsSsmExecutionFilters:
      properties:
        group_job_ids:
          type: array
          description: List of group job ids.
          items:
            type: string
        parent_job_ids:
          type: array
          description: List of parent job ids.
          items:
            type: string
        cloud_account_ids:
          type: array
          description: List of ids of the cloud account.
          items:
            type: string
        regions:
          type: array
          description: region of the document to be executed.
          items:
            type: string
        document_ids:
          type: array
          description: Name of the document.
          items:
            type: string
        document_types:
          type: array
          description: Type of the executed document
          items:
            type: string
        executed_by:
          type: array
          description: IAM ARN of the user who executed the document
          items:
            type: string
        status:
          type: string
          description: Status of the Automation Execution
          example: Pending
          enum:
          - Pending
          - InProgress
          - Waiting
          - Success
          - TimedOut
          - Cancelling
          - Cancelled
          - Failed
          - PendingApproval
          - Approved
          - Rejected
          - Scheduled
          - RunbookInProgress
          - PendingChangeCalendarOverride
          - ChangeCalendarOverrideApproved
          - ChangeCalendarOverrideRejected
          - CompletedWithSuccess
          - CompletedWithFailure
          x-cs-enum-type: AwsSsmAutomationExecutionStatus
        text_query:
          type: string
          description: Text query for Document Executions list. Search by Execution Id and Document Name
        query_filter:
          $ref: '#/components/schemas/QueryOperator'
      type: object
    AwsSsmCloudAccount:
      properties:
        id:
          type: string
          description: Id of the cloud account.
        name:
          type: string
          description: Name of the cloud account.
        sync_status:
          $ref: '#/components/schemas/AwsSsmCloudAccountSyncDetails'
      type: object
    AwsSsmListDocumentsRequestContext:
      required:
      - document_types
      properties:
        cloud_account_ids:
          type: array
          description: id of the cloud accounts.
          items:
            type: string
        regions:
          type: array
          description: region of the document to be executed.
          items:
            type: string
        document_names:
          type: array
          description: Name of the document.
          items:
            type: string
        owners:
          type: array
          description: Owner of the SSM document.
          items:
            type: string
        platform_types:
          type: array
          description: Platform types supported for the document.
          items:
            type: string
        document_types:
          type: array
          description: Type of the document.
          items:
            type: string
        text_query:
          type: string
          description: Text query for SSM Documents List. Search by Document Name, Category and Owner
        query_filter:
          $ref: '#/components/schemas/QueryOperator'
      type: object
    AwsSsmParameter:
      properties:
        name:
          type: string
          description: The name of the parameter
        type:
          type: string
          description: Type of the parameter of automation documents
          example: StringMap
          enum:
          - StringMap
          - MapList
          - Integer
          - Boolean
          - String
          - StringList
          - AWS_EC2_Instance_Id
          - AWS_IAM_Role_Arn
          - AWS_S3_Bucket_Name
          x-cs-enum-type: AwsSsmDocumentParameterType
        description:
          type: string
          description: The description of the parameters
        default_value:
          type: string
          description: The default values for the parameters
        min_items:
          type: integer
          description: Minimum number items in parameter
        max_items:
          type: integer
          description: Maximum number items in parameter
        allowed_values:
          type: array
          description: List of allowed values
          items:
            type: string
        display_type:
          type: string
          description: Type of display items
        allowed_pattern:
          type: string
          description: Regex patterns of the parameter
        min_chars:
          type: integer
          description: Minimum number of characters in the parameters
        max_chars:
          type: integer
          description: Maximum number of characters in the parameters
      type: object
    AwsSsmListDocumentsSortCriteria:
      required:
      - column
      properties:
        column:
          type: string
          example: name
          enum:
          - name
          x-cs-enum-type: AwsSsmListDocumentsSortColumn
        ascending:
          type: boolean
      type: object
    AwsSsmDocumentsBatchResponse:
      properties:
        results:
          type: object
          description: Map from identifier to response model
          additionalProperties:
            $ref: '#/components/schemas/AwsSsmDocument'
      type: object
    AwsSsmDocumentExecutionBatchResponse:
      properties:
        results:
          type: object
          description: Map from identifier to response model
          additionalProperties:
            $ref: '#/components/schemas/AwsSsmJob'
      type: object
    ModelError:
      required:
      - message
      properties:
        message:
          type: string
          description: Error response message.
      type: object
    AwsSsmListDocumentsRequest:
      properties:
        list_context:
          description: Optional list context
          $ref: '#/components/schemas/ListContext'
        sort:
          type: array
          description: Sort criteria
          items:
            $ref: '#/components/schemas/AwsSsmListDocumentsSortCriteria'
        filters:
          description: Filters for the request
          $ref: '#/components/schemas/AwsSsmListDocumentsRequestContext'
      type: object
    AwsSsmBaseDocumentFilter:
      required:
      - flavor
      properties:
        cloud_account_details:
          type: array
          description: Id and name of the cloud accounts.
          items:
            $ref: '#/components/schemas/AwsSsmCloudAccount'
        regions:
          type: array
          description: Regions based on the available documents.
          items:
            type: string
      discriminator:
        propertyName: flavor
      type: object
      x-cs-subtypes:
      - subtype_model: AwsSsmExecutionFilter
        subtype_name: AwsSsmExecutionFilter
      - subtype_model: AwsSsmAutomationFilter
        subtype_name: AwsSsmAutomationFilter
      - subtype_model: AwsSsmCommandFilter
        subtype_name: AwsSsmCommandFilter
      - subtype_model: AwsSsmDocumentFilter
        subtype_name: AwsSsmDocumentFilter
    AwsSsmExecutionGroupBatchResponse:
      properties:
        results:
          type: object
          description: Map from identifier to response model
          additionalProperties:
            $ref: '#/components/schemas/AwsSsmJobGroup'
      type: object
    AwsSsmDocument:
      properties:
        sysId:
          type: string
          description: Id of the document.
        name:
          type: string
          description: Name of the document.
        categories:
          type: array
          description: Category of the document.
          items:
            type: string
        document_type:
          type: string
          description: Type of the document.
        owner:
          type: string
          description: Owner of the document.
        os_types:
          type: array
          description: Platform of the document can be executed.
          items:
            type: string
        scope:
          type: string
          description: Scope of the SSM document.
        cloud_account_id:
          type: string
          description: For private, self type of documents the cloud account id will be mapped
        region:
          type: string
          description: For non global document region based mapping will be there
        document_creation_time:
          type: string
          format: date-time
          description: Time of document creation
        latest_version:
          type: string
          description: Latest version of the document
        default_version:
          type: string
          description: The default version
        document_version:
          type: string
          description: Current document version that is viewing
        status:
          type: string
          description: Status of the document
          example: Creating
          enum:
          - Creating
          - Active
          - Updating
          - Deleting
          - Failed
          - Deleted
          x-cs-enum-type: AwsSsmAutomationDocumentStatus
        tags:
          type: array
          description: Tag key and Value pair available for the document
          items:
            $ref: '#/components/schemas/AwsSsmDocumentTag'
        permission_details:
          description: Permission details of the Document.
          $ref: '#/components/schemas/AwsSsmDocumentPermissionDetail'
        created_at:
          type: string
          format: date-time
          description: Time of the document synced with system.
        updated_at:
          type: string
          format: date-time
          description: last synced time of the document.
      type: object
    RecordIdentityBatchRequest:
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/RecordIdentity'
      type: object
    RecordIdentity:
      properties:
        sysId:
          type: string
          description: Unique Identifier of the tracked item
        lastUpdate:
          type: string
          format: date-time
          description: Last update of the tracked item
        table:
          type: string
          description: Context of the tracked item
      type: object
    AwsSsmListDocumentExecutionRequest:
      properties:
        list_context:
          description: Optional list context
          $ref: '#/components/schemas/ListContext'
        sort:
          type: array
          description: Sort criteria
          items:
            $ref: '#/components/schemas/AwsSsmListDocumentExecutionsSortCriteria'
        filters:
          description: Filters for the request
          $ref: '#/components/schemas/AwsSsmExecutionFilters'
      type: object
    AwsSsmDocumentVersion:
      properties:
        content:
          type: string
          description: A structure that includes attributes that describe a document attachment
        document_version:
          type: string
          description: The document version
        document_format:
          type: string
          description: The document format, either JSON or YAML
        description:
          type: string
          description: A description of the document
        document_id:
          type: string
          description: Document ID of SSM docs
        document_creation_time:
          type: string
          format: date-time
          description: The date the SSM document was created
        hash:
          type: string
          description: The cryptographic hash value of the document content.
        hash_type:
          type: string
          description: The hash algorithm used to calculate the hash value
          example: Sha256
          enum:
          - Sha256
          - Sha1
          x-cs-enum-type: AwsSsmHashType
        schema_version:
          type: string
          description: The schema version
        target_type:
          type: string
          description: The target type defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance
        parameters:
          type: array
          description: Parameters specified in a Systems Manager document that run on the server
          items:
            $ref: '#/components/schemas/AwsSsmParameter'
        os_types:
          type: array
          description: The list of operating system (OS) platforms
          items:
            type: string
        attachment_contents:
          type: array
          description: A description of the document attachments, including names, locations, sizes
          items:
            $ref: '#/components/schemas/AwsSsmContentAttachmentDetail'
      type: object
    AwsSsmDocumentVersionDetails:
      allOf:
      - $ref: '#/components/schemas/AwsSsmDocumentVersion'
      - properties:
          sysId:
            type: string
          document_creation_time:
            type: string
            format: date-time
        type: object
    ListContext:
      properties:
        batch_size:
          type: integer
          description: Max number of ids in the response
        batch_offset:
          type: integer
          description: Offset of batches into the results. First batch is 0
        total:
          type: integer
          description: Total number of results
      type: object
    AwsSsmDocumentTag:
      properties:
        key:
          type: string
          description: Name for the tag key
        value:
          type: string
          description: Value for the respective tag key
      type: object
    AwsSsmListExecutionGroupRequest:
      properties:
        list_context:
          description: Optional list context
          $ref: '#/components/schemas/ListContext'


# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/corestack/refs/heads/main/openapi/corestack-awsssm-api-openapi.yml