Amazon Proton

Amazon Proton Proton Deployment API

The Proton Deployment API from Amazon Proton — 3 operation(s) for proton deployment.

GitHub OpenAPI
Business capability
Deployment Orchestration BC-4210.40

Operations 3

POST /#GetDeployment Get Deployment #
POST /#DeleteDeployment Delete Deployment #
POST /#ListDeployments List Deployments #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-proton/openapi/amazon-proton-deployment-api-openapi.yml

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-proton:amazon-proton-deployment-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.

GitHub Google LinkedIn

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

OpenAPI Specification

amazon-proton-deployment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Proton Deployment API
  version: '2020-07-20'
  description: Generated from AWS's published Smithy model for AWS Proton. 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://proton.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Deployment
paths:
  /#GetDeployment:
    post:
      operationId: GetDeployment
      summary: Get Deployment
      description: Get detailed data for a deployment.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetDeploymentOutput'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AwsProton20200720.GetDeployment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetDeploymentInput'
      tags:
      - Deployment
  /#DeleteDeployment:
    post:
      operationId: DeleteDeployment
      summary: Delete Deployment
      description: Delete the deployment.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteDeploymentOutput'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AwsProton20200720.DeleteDeployment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteDeploymentInput'
      tags:
      - Deployment
  /#ListDeployments:
    post:
      operationId: ListDeployments
      summary: List Deployments
      description: List deployments. You can filter the result list by environment, service, or a single service instance.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListDeploymentsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AwsProton20200720.ListDeployments
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListDeploymentsInput'
      tags:
      - Deployment
components:
  schemas:
    EnvironmentState:
      type: object
      properties:
        spec:
          type: string
          description: The environment spec that was used to create the environment.
        templateName:
          type: string
          description: The name of the environment template that was used to create the environment.
        templateMajorVersion:
          type: string
          description: The major version of the environment template that was used to create the environment.
        templateMinorVersion:
          type: string
          description: The minor version of the environment template that was used to create the environment.
      required:
      - templateName
      - templateMajorVersion
      - templateMinorVersion
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteDeploymentInput:
      type: object
      properties:
        id:
          type: string
          description: The ID of the deployment to delete.
      required:
      - id
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    Deployment:
      type: object
      properties:
        id:
          type: string
          description: The ID of the deployment.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the deployment.
        targetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target of the deployment.
        targetResourceCreatedAt:
          type: string
          description: The date and time the depoyment target was created.
        targetResourceType:
          type: string
          description: The resource type of the deployment target. It can be an environment, service, service instance, or component.
        environmentName:
          type: string
          description: The name of the environment associated with this deployment.
        serviceName:
          type: string
          description: The name of the service in this deployment.
        serviceInstanceName:
          type: string
          description: The name of the deployment's service instance.
        componentName:
          type: string
          description: The name of the component associated with this deployment.
        deploymentStatus:
          type: string
          description: The status of the deployment.
        deploymentStatusMessage:
          type: string
          description: The deployment status message.
        createdAt:
          type: string
          description: The date and time the deployment was created.
        lastModifiedAt:
          type: string
          description: The date and time the deployment was last modified.
        completedAt:
          type: string
          description: The date and time the deployment was completed.
        lastAttemptedDeploymentId:
          type: string
          description: The ID of the last attempted deployment.
        lastSucceededDeploymentId:
          type: string
          description: The ID of the last successful deployment.
        initialState:
          $ref: '#/components/schemas/DeploymentState'
        targetState:
          $ref: '#/components/schemas/DeploymentState'
      required:
      - id
      - arn
      - targetArn
      - targetResourceCreatedAt
      - targetResourceType
      - environmentName
      - deploymentStatus
      - createdAt
      - lastModifiedAt
    DeploymentState:
      type: object
      properties:
        serviceInstance:
          $ref: '#/components/schemas/ServiceInstanceState'
        environment:
          $ref: '#/components/schemas/EnvironmentState'
        servicePipeline:
          $ref: '#/components/schemas/ServicePipelineState'
        component:
          $ref: '#/components/schemas/ComponentState'
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteDeploymentOutput:
      type: object
      properties:
        deployment:
          $ref: '#/components/schemas/Deployment'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeploymentSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the deployment.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the deployment.
        targetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target of the deployment.
        targetResourceCreatedAt:
          type: string
          description: The date and time the target resource was created.
        targetResourceType:
          type: string
          description: The resource type of the deployment target. It can be an environment, service, service instance, or component.
        createdAt:
          type: string
          description: The date and time the deployment was created.
        lastModifiedAt:
          type: string
          description: The date and time the deployment was last modified.
        completedAt:
          type: string
          description: The date and time the deployment was completed.
        environmentName:
          type: string
          description: The name of the environment associated with the deployment.
        serviceName:
          type: string
          description: The name of the service associated with the deployment.
        serviceInstanceName:
          type: string
          description: The name of the service instance associated with the deployment.
        componentName:
          type: string
          description: The name of the component associated with the deployment.
        lastAttemptedDeploymentId:
          type: string
          description: The ID of the last attempted deployment.
        lastSucceededDeploymentId:
          type: string
          description: The ID of the last successful deployment.
        deploymentStatus:
          type: string
          description: The current status of the deployment.
      required:
      - id
      - arn
      - targetArn
      - targetResourceCreatedAt
      - targetResourceType
      - createdAt
      - lastModifiedAt
      - environmentName
      - deploymentStatus
    ServiceInstanceState:
      type: object
      properties:
        spec:
          type: string
          description: The service spec that was used to create the service instance.
        templateName:
          type: string
          description: The name of the service template that was used to create the service instance.
        templateMajorVersion:
          type: string
          description: The major version of the service template that was used to create the service pipeline.
        templateMinorVersion:
          type: string
          description: The minor version of the service template that was used to create the service pipeline.
        lastSuccessfulComponentDeploymentIds:
          type: array
          items:
            type: string
          description: The IDs for the last successful components deployed for this service instance.
        lastSuccessfulEnvironmentDeploymentId:
          type: string
          description: The ID for the last successful environment deployed for this service instance.
        lastSuccessfulServicePipelineDeploymentId:
          type: string
          description: The ID for the last successful service pipeline deployed for this service instance.
      required:
      - spec
      - templateName
      - templateMajorVersion
      - templateMinorVersion
    ListDeploymentsInput:
      type: object
      properties:
        nextToken:
          type: string
          description: A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously requested.
        environmentName:
          type: string
          description: The name of an environment for result list filtering. Proton returns deployments associated with the environment.
        serviceName:
          type: string
          description: The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.
        serviceInstanceName:
          type: string
          description: The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.
        componentName:
          type: string
          description: The name of a component for result list filtering. Proton returns deployments associated with that component.
        maxResults:
          type: integer
          description: The maximum number of deployments to list.
    ListDeploymentsOutput:
      type: object
      properties:
        nextToken:
          type: string
          description: A token that indicates the location of the next deployment in the array of deployment, after the current requested list of deployment.
        deployments:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentSummary'
          description: An array of deployment with summary data.
      required:
      - deployments
    ComponentState:
      type: object
      properties:
        serviceName:
          type: string
          description: The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
        serviceInstanceName:
          type: string
          description: The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
        serviceSpec:
          type: string
          description: The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
        templateFile:
          type: string
          description: The template file used.
    GetDeploymentOutput:
      type: object
      properties:
        deployment:
          $ref: '#/components/schemas/Deployment'
    GetDeploymentInput:
      type: object
      properties:
        id:
          type: string
          description: The ID of the deployment that you want to get the detailed data for.
        environmentName:
          type: string
          description: The name of a environment that you want to get the detailed data for.
        serviceName:
          type: string
          description: The name of the service associated with the given deployment ID.
        serviceInstanceName:
          type: string
          description: The name of the service instance associated with the given deployment ID. serviceName must be specified to identify the service instance.
        componentName:
          type: string
          description: The name of a component that you want to get the detailed data for.
      required:
      - id
    ServicePipelineState:
      type: object
      properties:
        spec:
          type: string
          description: The service spec that was used to create the service pipeline.
        templateName:
          type: string
          description: The name of the service template that was used to create the service pipeline.
        templateMajorVersion:
          type: string
          description: The major version of the service template that was used to create the service pipeline.
        templateMinorVersion:
          type: string
          description: The minor version of the service template that was used to create the service pipeline.
      required:
      - templateName
      - templateMajorVersion
      - templateMinorVersion
  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: proton
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/proton/service/2020-07-20/proton-2020-07-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)