Amazon Launch Wizard Deployments API

Launch Wizard deployment management

GitHub OpenAPI

Operations 5

POST /createDeployment Create Deployment #
POST /getDeployment Get Deployment #
POST /deleteDeployment Delete Deployment #
POST /listDeployments List Deployments #
POST /listWorkloads List Workloads #

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-launch-wizard:amazon-launch-wizard-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-launch-wizard-deployments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Launch Wizard Deployments API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS Launch Wizard. 5 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://launchwizard.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /createDeployment:
    post:
      operationId: CreateDeployment
      summary: Create Deployment
      description: Creates a deployment for the given workload. Deployments created by this operation are not available in
        the Launch Wizard console to use the Clone deployment action on.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDeploymentOutput'
              example:
                deploymentId: 4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ResourceLimitException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceLimitException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentInput'
            example:
              workloadName: SAP
              deploymentPatternName: SapHanaSingle
              name: TestDeployment1
              dryRun: false
              specifications:
                DisableDeploymentRollback: 'Yes'
                SaveDeploymentArtifacts: 'No'
                KeyPairName: keyName
                VpcId: vpc-1234566
                CreateSecurityGroup: 'No'
                ProxyServerAddress: http://xyz.abc.com:8080
                Timezone: Pacific/Wake
                EnableEbsVolumeEncryption: 'Yes'
                SapSysGroupId: '5003'
                SapVirtualIPOptIn: 'No'
                SnsTopicArn: arn:aws:sns:us-east-1:111111222222:snsNameUsEast1.fifo
      tags:
      - Deployments
  /getDeployment:
    post:
      operationId: GetDeployment
      summary: Get Deployment
      description: Returns information about the deployment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeploymentOutput'
              example:
                deployment:
                  name: SapHanaSingleForTest
                  id: 1111111-1111-1111-1111-111111111111
                  workloadName: SapHanaSingle
                  status: FAILED
                  createdAt: '2023-04-24T13:10:09.857Z'
                  specifications:
                    applicationName: SapHanaSingleForTest
                    deploymentScenario: SapHanaSingle
                    DisableDeploymentRollback: 'true'
                    saveDeploymentArtifacts: 'Yes'
                    saveArtifactsS3Uri: s3://testbucket
                    KeyName: testLinuxInstance
                    VPCID: vpc-1234567
                    environmentType: production
                    SAPTZ: America/Vancouver
                    Encryption: 'Yes'
                  deploymentArn: arn:aws:launchwizard:us-east-1:123456789012:deployment/1111111-1111-1111-1111-111111111111
                  tags:
                    key1: val1
                    key2: val2
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDeploymentInput'
            example:
              deploymentId: 1111111-1111-1111-1111-111111111111
      tags:
      - Deployments
  /deleteDeployment:
    post:
      operationId: DeleteDeployment
      summary: Delete Deployment
      description: Deletes a deployment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDeploymentOutput'
              example:
                status: DELETED
                statusReason: Finished processing DeleteApp request
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ResourceLimitException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceLimitException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDeploymentInput'
            example:
              deploymentId: 4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d
      tags:
      - Deployments
  /listDeployments:
    post:
      operationId: ListDeployments
      summary: List Deployments
      description: Lists the deployments that have been created.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDeploymentsOutput'
              example:
                deployments:
                - name: SapHanaSingleForTest
                  id: 4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d
                  workloadName: SAP
                  patternName: SapHanaSingle
                  status: IN_PROGRESS
                  createdAt: '2023-04-24T13:10:09.857Z'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDeploymentsInput'
            example:
              filters:
              - name: DEPLOYMENT_STATUS
                values:
                - IN_PROGRESS
      tags:
      - Deployments
  /listWorkloads:
    post:
      operationId: ListWorkloads
      summary: List Workloads
      description: Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover
        the available deployment patterns for a given workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkloadsOutput'
              example:
                workloads:
                - workloadName: SAP
                  displayName: SAP
                  status: ACTIVE
                - workloadName: SQL
                  displayName: MS SQL Server
                  status: ACTIVE
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListWorkloadsInput'
            example: {}
      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: launchwizard
  schemas:
    AccountConstraint:
      type: object
      properties:
        managementAccount:
          $ref: '#/components/schemas/ManagementAccountConstraint'
        delegatedAdmin:
          $ref: '#/components/schemas/DelegatedAdminConstraint'
      description: Exactly one member is set.
    CreateDeploymentInput:
      type: object
      properties:
        workloadName:
          type: string
          description: The name of the workload. You can use the ListWorkloads operation to discover supported values for
            this parameter.
        deploymentPatternName:
          type: string
          description: The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns
            operation to discover supported values for this parameter.
        name:
          type: string
          description: The name of the deployment.
        specifications:
          type: object
          additionalProperties:
            type: string
          description: The settings specified for the deployment. These settings define how to deploy and configure your resources
            created by the deployment. For more information about the specifications required for creating a deployment for
            a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment
            for other workloads, use the GetWorkloadDeploymentPattern operation.
        dryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request,
            and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise,
            it is UnauthorizedOperation.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to add to the deployment.
      required:
      - workloadName
      - deploymentPatternName
      - name
      - specifications
    CreateDeploymentOutput:
      type: object
      properties:
        deploymentId:
          type: string
          description: The ID of the deployment.
    DelegatedAdminConstraint:
      type: object
      properties:
        servicePrincipal:
          type: string
          description: The service principal for which the account must be a delegated administrator. For example, `stacksets.cloudformation.amazonaws.com`.
      required:
      - servicePrincipal
    DeleteDeploymentInput:
      type: object
      properties:
        deploymentId:
          type: string
          description: The ID of the deployment.
      required:
      - deploymentId
    DeleteDeploymentOutput:
      type: object
      properties:
        status:
          type: string
          enum:
          - COMPLETED
          - CREATING
          - DELETE_IN_PROGRESS
          - DELETE_INITIATING
          - DELETE_FAILED
          - DELETED
          - FAILED
          - IN_PROGRESS
          - VALIDATING
          - UPDATE_IN_PROGRESS
          - UPDATE_COMPLETED
          - UPDATE_FAILED
          - UPDATE_ROLLBACK_COMPLETED
          - UPDATE_ROLLBACK_FAILED
          description: The status of the deployment.
        statusReason:
          type: string
          description: The reason for the deployment status.
    DeploymentData:
      type: object
      properties:
        name:
          type: string
          description: The name of the deployment.
        id:
          type: string
          description: The ID of the deployment.
        workloadName:
          type: string
          description: The name of the workload.
        patternName:
          type: string
          description: The pattern name of the deployment.
        status:
          type: string
          enum:
          - COMPLETED
          - CREATING
          - DELETE_IN_PROGRESS
          - DELETE_INITIATING
          - DELETE_FAILED
          - DELETED
          - FAILED
          - IN_PROGRESS
          - VALIDATING
          - UPDATE_IN_PROGRESS
          - UPDATE_COMPLETED
          - UPDATE_FAILED
          - UPDATE_ROLLBACK_COMPLETED
          - UPDATE_ROLLBACK_FAILED
          description: The status of the deployment.
        createdAt:
          type: string
          description: The time the deployment was created.
        modifiedAt:
          type: string
          description: The time the deployment was last modified.
        specifications:
          type: object
          additionalProperties:
            type: string
          description: The settings specified for the deployment. These settings define how to deploy and configure your resources
            created by the deployment. For more information about the specifications required for creating a deployment for
            a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment
            for other workloads, use the GetWorkloadDeploymentPattern operation.
        resourceGroup:
          type: string
          description: The resource group of the deployment.
        deletedAt:
          type: string
          description: The time the deployment was deleted.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Information about the tags attached to a deployment.
        deploymentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the deployment.
    DeploymentDataSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the deployment
        id:
          type: string
          description: The ID of the deployment.
        workloadName:
          type: string
          description: The name of the workload.
        patternName:
          type: string
          description: The name of the workload deployment pattern.
        status:
          type: string
          enum:
          - COMPLETED
          - CREATING
          - DELETE_IN_PROGRESS
          - DELETE_INITIATING
          - DELETE_FAILED
          - DELETED
          - FAILED
          - IN_PROGRESS
          - VALIDATING
          - UPDATE_IN_PROGRESS
          - UPDATE_COMPLETED
          - UPDATE_FAILED
          - UPDATE_ROLLBACK_COMPLETED
          - UPDATE_ROLLBACK_FAILED
          description: The status of the deployment.
        createdAt:
          type: string
          description: The time the deployment was created.
        modifiedAt:
          type: string
          description: The time the deployment was last modified.
    DeploymentFilter:
      type: object
      properties:
        name:
          type: string
          enum:
          - WORKLOAD_NAME
          - DEPLOYMENT_STATUS
          description: The name of the filter. Filter names are case-sensitive.
        values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the
            values are joined with an OR, and the request returns all results that match any of the specified values.
    GetDeploymentInput:
      type: object
      properties:
        deploymentId:
          type: string
          description: The ID of the deployment.
      required:
      - deploymentId
    GetDeploymentOutput:
      type: object
      properties:
        deployment:
          $ref: '#/components/schemas/DeploymentData'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListDeploymentsInput:
      type: object
      properties:
        filters:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentFilter'
          description: 'Filters to scope the results. The following filters are supported: WORKLOAD_NAME - The name used in
            deployments. DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED
            | DELETED | FAILED | IN_PROGRESS | VALIDATING'
        maxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another
            request with the token returned in the output.
        nextToken:
          type: string
          description: The token returned from a previous paginated request. Pagination continues from the end of the items
            returned by the previous request.
    ListDeploymentsOutput:
      type: object
      properties:
        deployments:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentDataSummary'
          description: Lists the deployments.
        nextToken:
          type: string
          description: The token to include in another request to get the next page of items. This value is null when there
            are no more items to return.
    ListWorkloadsInput:
      type: object
      properties:
        maxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another
            request with the token returned in the output.
        nextToken:
          type: string
          description: The token returned from a previous paginated request. Pagination continues from the end of the items
            returned by the previous request.
    ListWorkloadsOutput:
      type: object
      properties:
        workloads:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadDataSummary'
          description: Information about the workloads.
        nextToken:
          type: string
          description: The token to include in another request to get the next page of items. This value is null when there
            are no more items to return.
    ManagementAccountConstraint:
      type: object
      properties: {}
    ResourceLimitException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
    WorkloadDataSummary:
      type: object
      properties:
        workloadName:
          type: string
          description: The name of the workload.
        displayName:
          type: string
          description: The display name of the workload data.
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - DISABLED
          - DELETED
          description: The status of the workload.
        accountConstraints:
          type: array
          items:
            $ref: '#/components/schemas/AccountConstraint'
          description: 'Optional list of constraints describing what kind of AWS account is allowed to deploy this workload
            or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies
            any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list
            at this level means no constraint at this level.'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/launch-wizard/service/2018-05-10/launch-wizard-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)