Amazon Systems Manager Systems Manager Deployments API

The Systems Manager Deployments API from Amazon Systems Manager — 2 operation(s) for systems manager deployments.

GitHub OpenAPI

Operations 4

GET /applications/{ApplicationId}/environments/{EnvironmentId}/deployments/{DeploymentNumber} Get Deployment #
DELETE /applications/{ApplicationId}/environments/{EnvironmentId}/deployments/{DeploymentNumber} Stop Deployment #
GET /applications/{ApplicationId}/environments/{EnvironmentId}/deployments List Deployments #
POST /applications/{ApplicationId}/environments/{EnvironmentId}/deployments Start Deployment #

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-deployments-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.

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

OpenAPI Specification

amazon-systems-manager-deployments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Simple Systems Manager (SSM) Deployments API
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 4 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://appconfig.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /applications/{ApplicationId}/environments/{EnvironmentId}/deployments/{DeploymentNumber}:
    get:
      operationId: GetDeployment
      summary: Get Deployment
      description: Retrieves information about a configuration deployment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDeploymentRequest'
      tags:
      - Deployments
    delete:
      operationId: StopDeployment
      summary: Stop Deployment
      description: Stops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an
        AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment
        will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AppConfig only allows a revert within
        72 hours of deployment completion.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
              example:
                DeploymentNumber: 2
                DeploymentDurationInMinutes: 15
                GrowthFactor: 25.0
                FinalBakeTimeInMinutes: 0
                PercentageComplete: 1.0
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopDeploymentRequest'
            example:
              ApplicationId: 339ohji
              EnvironmentId: 54j1r29
              DeploymentNumber: 2
      tags:
      - Deployments
  /applications/{ApplicationId}/environments/{EnvironmentId}/deployments:
    get:
      operationId: ListDeployments
      summary: List Deployments
      description: Lists the deployments for an environment in descending deployment number order.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployments'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDeploymentsRequest'
      tags:
      - Deployments
    post:
      operationId: StartDeployment
      summary: Start Deployment
      description: Starts a deployment. AppConfig Agent supports deploying feature flag or free-form configuration data to
        specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once
        a user or segment receives a configuration version, they continue to receive that same version throughout the deployment
        period, regardless of which compute resource serves their requests. For more information, see Using AppConfig Agent
        for user-based or entity-based gradual deployments
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDeploymentRequest'
      tags:
      - Deployments
components:
  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: appconfig
  schemas:
    ActionInvocation:
      type: object
      properties:
        ExtensionIdentifier:
          type: string
          description: The name, the ID, or the Amazon Resource Name (ARN) of the extension.
        ActionName:
          type: string
          description: The name of the action.
        Uri:
          type: string
          description: 'The extension URI associated to the action point in the extension definition. The URI can be an Amazon
            Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon
            Simple Notification Service topic, or the Amazon EventBridge default event bus.'
        RoleArn:
          type: string
          description: An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
        ErrorMessage:
          type: string
          description: The error message when an extension invocation fails.
        ErrorCode:
          type: string
          description: The error code when an extension invocation fails.
        InvocationId:
          type: string
          description: A system-generated ID for this invocation.
    AppconfigInternalServerException:
      type: object
      properties:
        Message:
          type: string
    AppconfigResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceName:
          type: string
    AppliedExtension:
      type: object
      properties:
        ExtensionId:
          type: string
          description: The system-generated ID of the extension.
        ExtensionAssociationId:
          type: string
          description: The system-generated ID for the association.
        VersionNumber:
          type: integer
          description: The extension version number.
        Parameters:
          type: object
          additionalProperties:
            type: string
          description: One or more parameters for the actions called by the extension.
    BadRequestDetails:
      type: object
      properties:
        InvalidConfiguration:
          type: array
          items:
            $ref: '#/components/schemas/InvalidConfigurationDetail'
          description: Detailed information about the bad request exception error when creating a hosted configuration version.
      description: Exactly one member is set.
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - InvalidConfiguration
        Details:
          $ref: '#/components/schemas/BadRequestDetails'
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    Deployment:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The ID of the application that was deployed.
        EnvironmentId:
          type: string
          description: The ID of the environment that was deployed.
        DeploymentStrategyId:
          type: string
          description: The ID of the deployment strategy that was deployed.
        ConfigurationProfileId:
          type: string
          description: The ID of the configuration profile that was deployed.
        DeploymentNumber:
          type: integer
          description: The sequence number of the deployment.
        ConfigurationName:
          type: string
          description: The name of the configuration.
        ConfigurationLocationUri:
          type: string
          description: Information about the source location of the configuration.
        ConfigurationVersion:
          type: string
          description: The configuration version that was deployed.
        Description:
          type: string
          description: The description of the deployment.
        DeploymentDurationInMinutes:
          type: integer
          description: Total amount of time the deployment lasted.
        GrowthType:
          type: string
          enum:
          - LINEAR
          - EXPONENTIAL
          description: The algorithm used to define how percentage grew over time.
        GrowthFactor:
          type: number
          description: The percentage of targets to receive a deployed configuration during each interval.
        FinalBakeTimeInMinutes:
          type: integer
          description: The amount of time that AppConfig monitored for alarms before considering the deployment to be complete
            and no longer eligible for automatic rollback.
        State:
          type: string
          enum:
          - BAKING
          - VALIDATING
          - DEPLOYING
          - COMPLETE
          - ROLLING_BACK
          - ROLLED_BACK
          - REVERTED
          description: The state of the deployment.
        EventLog:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentEvent'
          description: A list containing all events related to a deployment. The most recent events are displayed first.
        PercentageComplete:
          type: number
          description: The percentage of targets for which the deployment is available.
        StartedAt:
          type: string
          format: date-time
          description: The time the deployment started.
        CompletedAt:
          type: string
          format: date-time
          description: The time the deployment completed.
        AppliedExtensions:
          type: array
          items:
            $ref: '#/components/schemas/AppliedExtension'
          description: A list of extensions that were processed as part of the deployment. The extensions that were previously
            associated to the configuration profile, environment, or the application when StartDeployment was called.
        KmsKeyArn:
          type: string
          description: The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You
            can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with
            SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
        KmsKeyIdentifier:
          type: string
          description: The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource
            was created or updated.
        VersionLabel:
          type: string
          description: A user-defined label for an AppConfig hosted configuration version.
    DeploymentEvent:
      type: object
      properties:
        EventType:
          type: string
          enum:
          - PERCENTAGE_UPDATED
          - ROLLBACK_STARTED
          - ROLLBACK_COMPLETED
          - BAKE_TIME_STARTED
          - DEPLOYMENT_STARTED
          - DEPLOYMENT_COMPLETED
          - REVERT_COMPLETED
          description: The type of deployment event. Deployment event types include the start, stop, or completion of a deployment;
            a percentage update; the start or stop of a bake period; and the start or completion of a rollback.
        TriggeredBy:
          type: string
          enum:
          - USER
          - APPCONFIG
          - CLOUDWATCH_ALARM
          - INTERNAL_ERROR
          description: The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon
            CloudWatch alarm, or an internal error.
        Description:
          type: string
          description: 'A description of the deployment event. Descriptions include, but are not limited to, the following:
            The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback. The percentage of
            hosts that received the deployment. A recommendation to attempt a new deployment (in the case of an internal error).'
        ActionInvocations:
          type: array
          items:
            $ref: '#/components/schemas/ActionInvocation'
          description: The list of extensions that were invoked as part of the deployment.
        OccurredAt:
          type: string
          format: date-time
          description: The date and time the event occurred.
    DeploymentSummary:
      type: object
      properties:
        DeploymentNumber:
          type: integer
          description: The sequence number of the deployment.
        ConfigurationProfileId:
          type: string
          description: The ID of the configuration profile that was deployed.
        ConfigurationName:
          type: string
          description: The name of the configuration.
        ConfigurationVersion:
          type: string
          description: The version of the configuration.
        DeploymentDurationInMinutes:
          type: integer
          description: Total amount of time the deployment lasted.
        GrowthType:
          type: string
          enum:
          - LINEAR
          - EXPONENTIAL
          description: The algorithm used to define how percentage grows over time.
        GrowthFactor:
          type: number
          description: The percentage of targets to receive a deployed configuration during each interval.
        FinalBakeTimeInMinutes:
          type: integer
          description: The amount of time that AppConfig monitors for alarms before considering the deployment to be complete
            and no longer eligible for automatic rollback.
        State:
          type: string
          enum:
          - BAKING
          - VALIDATING
          - DEPLOYING
          - COMPLETE
          - ROLLING_BACK
          - ROLLED_BACK
          - REVERTED
          description: The state of the deployment.
        PercentageComplete:
          type: number
          description: The percentage of targets for which the deployment is available.
        StartedAt:
          type: string
          format: date-time
          description: Time the deployment started.
        CompletedAt:
          type: string
          format: date-time
          description: Time the deployment completed.
        VersionLabel:
          type: string
          description: A user-defined label for an AppConfig hosted configuration version.
        Type:
          type: string
          enum:
          - USER
          - MANAGED
          description: The type of deployment.
    Deployments:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentSummary'
          description: The elements from this collection.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    GetDeploymentRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The ID of the application that includes the deployment you want to get.
        EnvironmentId:
          type: string
          description: The ID of the environment that includes the deployment you want to get.
        DeploymentNumber:
          type: integer
          description: The sequence number of the deployment.
      required:
      - ApplicationId
      - EnvironmentId
      - DeploymentNumber
    InvalidConfigurationDetail:
      type: object
      properties:
        Constraint:
          type: string
          description: The invalid or out-of-range validation constraint in your JSON schema that failed validation.
        Location:
          type: string
          description: Location of the validation constraint in the configuration JSON schema that failed validation.
        Reason:
          type: string
          description: The reason for an invalid configuration error.
        Type:
          type: string
          description: The type of error for an invalid configuration.
        Value:
          type: string
          description: Details about an error with Lambda when a synchronous extension experiences an error during an invocation.
    ListDeploymentsRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The application ID.
        EnvironmentId:
          type: string
          description: The environment ID.
        MaxResults:
          type: integer
          description: The maximum number of items that may be returned for this call. If there are items that have not yet
            been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get
            the next set of results.
        NextToken:
          type: string
          description: The token returned by a prior call to this operation indicating the next set of results to be returned.
            If not specified, the operation will return the first set of results.
      required:
      - ApplicationId
      - EnvironmentId
    StartDeploymentRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The application ID.
        EnvironmentId:
          type: string
          description: The environment ID.
        DeploymentStrategyId:
          type: string
          description: The deployment strategy ID.
        ConfigurationProfileId:
          type: string
          description: The configuration profile ID.
        ConfigurationVersion:
          type: string
          description: The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can
            specify either the version number or version label. For all other configurations, you must specify the version
            number.
        Description:
          type: string
          description: A description of the deployment.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each
            tag consists of a key and an optional value, both of which you define.
        KmsKeyIdentifier:
          type: string
          description: The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration
            data using a customer managed key.
        DynamicExtensionParameters:
          type: object
          additionalProperties:
            type: string
          description: A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT
            actions.
        LatestDeploymentNumber:
          type: integer
          description: The number of the latest deployment. Use this value to ensure that the deployment starts from the expected
            state and to prevent conflicting updates.
      required:
      - ApplicationId
      - EnvironmentId
      - DeploymentStrategyId
      - ConfigurationProfileId
      - ConfigurationVersion
    StopDeploymentRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The application ID.
        EnvironmentId:
          type: string
          description: The environment ID.
        DeploymentNumber:
          type: integer
          description: The sequence number of the deployment.
        AllowRevert:
          type: boolean
          description: A Boolean that enables AppConfig to rollback a COMPLETED deployment to the previous configuration version.
            This action moves the deployment to a status of REVERTED.
      required:
      - ApplicationId
      - EnvironmentId
      - DeploymentNumber
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/appconfig/service/2019-10-09/appconfig-2019-10-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)