Amazon Proton #X Amz Target=AwsProton20200720.UpdateService API

openapi: 3.2.0
info:
  version: 2020-07-20
  x-release: v4
  title: 'AWS Proton #X Amz Target=AwsProton20200720.UpdateService API'
  description: This is the Proton Service API Reference.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: proton
  x-aws-signingName: proton
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/proton-2020-07-20.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://proton.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Proton multi-region endpoint
- url: https://proton.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Proton multi-region endpoint
- url: http://proton.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Proton endpoint for China (Beijing) and China (Ningxia)
- url: https://proton.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Proton endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AwsProton20200720.UpdateService'
paths:
  /#X-Amz-Target=AwsProton20200720.UpdateService:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: UpdateService
      description: 'Edit a service description or use a spec to add and delete service instances.


        Existing service instances and the service pipeline can''t be edited using this API. They can only be deleted.


        Use the description parameter to modify the description.


        Edit the spec parameter to add or delete instances.


        You can''t delete a service instance (remove it from the spec) if it has an attached component.


        For more information about components, see Proton components in the Proton User Guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateServiceOutput'
        '480':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '485':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '486':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServiceInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AwsProton20200720.UpdateService
      summary: Amazon Proton Update Service
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AwsProton20200720.UpdateService'
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
  schemas:
    ResourceName:
      type: string
      pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
      minLength: 1
      maxLength: 100
    ValidationException: {}
    SpecContents:
      type: string
      minLength: 1
      maxLength: 51200
      format: password
    ResourceNotFoundException: {}
    TemplateVersionPart:
      type: string
      pattern: ^(0|([1-9]{1}\d*))$
      minLength: 1
      maxLength: 20
    ServicePipeline:
      type: object
      required:
      - arn
      - createdAt
      - deploymentStatus
      - lastDeploymentAttemptedAt
      - lastDeploymentSucceededAt
      - templateMajorVersion
      - templateMinorVersion
      - templateName
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the service pipeline.
        createdAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the service pipeline was created.
        deploymentStatus:
          allOf:
          - $ref: '#/components/schemas/DeploymentStatus'
          - description: The deployment status of the service pipeline.
        deploymentStatusMessage:
          allOf:
          - $ref: '#/components/schemas/StatusMessage'
          - description: A service pipeline deployment status message.
        lastDeploymentAttemptedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when a deployment of the service pipeline was last attempted.
        lastDeploymentSucceededAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the service pipeline was last deployed successfully.
        spec:
          allOf:
          - $ref: '#/components/schemas/SpecContents'
          - description: The service spec that was used to create the service pipeline.
        templateMajorVersion:
          allOf:
          - $ref: '#/components/schemas/TemplateVersionPart'
          - description: The major version of the service template that was used to create the service pipeline.
        templateMinorVersion:
          allOf:
          - $ref: '#/components/schemas/TemplateVersionPart'
          - description: The minor version of the service template that was used to create the service pipeline.
        templateName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the service template that was used to create the service pipeline.
      description: Detailed data of an Proton service instance pipeline resource.
    UpdateServiceOutput:
      type: object
      required:
      - service
      properties:
        service:
          allOf:
          - $ref: '#/components/schemas/Service'
          - description: The service detail data that's returned by Proton.
    Service:
      type: object
      required:
      - arn
      - createdAt
      - lastModifiedAt
      - name
      - spec
      - status
      - templateName
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/ServiceArn'
          - description: The Amazon Resource Name (ARN) of the service.
        branchName:
          allOf:
          - $ref: '#/components/schemas/GitBranchName'
          - description: The name of the code repository branch that holds the code that's deployed in Proton.
        createdAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the service was created.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description of the service.
        lastModifiedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the service was last modified.
        name:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the service.
        pipeline:
          allOf:
          - $ref: '#/components/schemas/ServicePipeline'
          - description: The service pipeline detail data.
        repositoryConnectionArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol">Setting up an AWS CodeStar connection</a> in the <i>Proton User Guide</i>.
        repositoryId:
          allOf:
          - $ref: '#/components/schemas/RepositoryId'
          - description: The ID of the source code repository.
        spec:
          allOf:
          - $ref: '#/components/schemas/SpecContents'
          - description: The formatted specification that defines the service.
        status:
          allOf:
          - $ref: '#/components/schemas/ServiceStatus'
          - description: The status of the service.
        statusMessage:
          allOf:
          - $ref: '#/components/schemas/StatusMessage'
          - description: A service status message.
        templateName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the service template.
      description: Detailed data of an Proton service resource.
    Arn:
      type: string
      pattern: ^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$
      minLength: 1
      maxLength: 200
    RepositoryId:
      type: string
      minLength: 1
      maxLength: 200
    ConflictException: {}
    ThrottlingException: {}
    StatusMessage:
      type: string
      format: password
    Description:
      type: string
      minLength: 0
      maxLength: 500
      format: password
    ServiceStatus:
      type: string
      enum:
      - CREATE_IN_PROGRESS
      - CREATE_FAILED_CLEANUP_IN_PROGRESS
      - CREATE_FAILED_CLEANUP_COMPLETE
      - CREATE_FAILED_CLEANUP_FAILED
      - CREATE_FAILED
      - ACTIVE
      - DELETE_IN_PROGRESS
      - DELETE_FAILED
      - UPDATE_IN_PROGRESS
      - UPDATE_FAILED_CLEANUP_IN_PROGRESS
      - UPDATE_FAILED_CLEANUP_COMPLETE
      - UPDATE_FAILED_CLEANUP_FAILED
      - UPDATE_FAILED
      - UPDATE_COMPLETE_CLEANUP_FAILED
    Timestamp:
      type: string
      format: date-time
    DeploymentStatus:
      type: string
      enum:
      - IN_PROGRESS
      - FAILED
      - SUCCEEDED
      - DELETE_IN_PROGRESS
      - DELETE_FAILED
      - DELETE_COMPLETE
      - CANCELLING
      - CANCELLED
    ServiceQuotaExceededException: {}
    UpdateServiceInput:
      type: object
      required:
      - name
      title: UpdateServiceInput
      properties:
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The edited service description.
        name:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the service to edit.
        spec:
          allOf:
          - $ref: '#/components/schemas/SpecContents'
          - description: Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. <i>Don't</i> include edits to the existing service instances or pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html">Edit a service</a> in the <i>Proton User Guide</i>.
    InternalServerException: {}
    ServiceArn:
      type: string
    AccessDeniedException: {}
    GitBranchName:
      type: string
      minLength: 1
      maxLength: 200
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/proton/
x-hasEquivalentPaths: true