openapi: 3.2.0
info:
version: 2020-07-20
x-release: v4
title: AWS Proton 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: AWS Proton
paths:
/#X-Amz-Target=AwsProton20200720.AcceptEnvironmentAccountConnection:
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: AcceptEnvironmentAccountConnection
description: 'In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
For more information, see Environment account connections in the Proton User guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptEnvironmentAccountConnectionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptEnvironmentAccountConnectionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.AcceptEnvironmentAccountConnection
summary: Amazon Proton Accept Environment Account Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CancelComponentDeployment:
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: CancelComponentDeployment
description: 'Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelComponentDeploymentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelComponentDeploymentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CancelComponentDeployment
summary: Amazon Proton Cancel Component Deployment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CancelEnvironmentDeployment:
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: CancelEnvironmentDeployment
description: 'Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelEnvironmentDeploymentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelEnvironmentDeploymentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CancelEnvironmentDeployment
summary: Amazon Proton Cancel Environment Deployment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CancelServiceInstanceDeployment:
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: CancelServiceInstanceDeployment
description: 'Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelServiceInstanceDeploymentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelServiceInstanceDeploymentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CancelServiceInstanceDeployment
summary: Amazon Proton Cancel Service Instance Deployment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CancelServicePipelineDeployment:
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: CancelServicePipelineDeployment
description: 'Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelServicePipelineDeploymentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelServicePipelineDeploymentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CancelServicePipelineDeployment
summary: Amazon Proton Cancel Service Pipeline Deployment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateComponent:
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: CreateComponent
description: 'Create an Proton component. A component is an infrastructure extension for a service instance.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComponentOutput'
'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/CreateComponentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateComponent
summary: Amazon Proton Create Component
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateEnvironment:
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: CreateEnvironment
description: 'Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.
You can provision environments using the following methods:
Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.
For more information, see Environments and Provisioning methods in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentOutput'
'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/CreateEnvironmentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateEnvironment
summary: Amazon Proton Create Environment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateEnvironmentAccountConnection:
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: CreateEnvironmentAccountConnection
description: 'Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton User guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentAccountConnectionOutput'
'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: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentAccountConnectionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateEnvironmentAccountConnection
summary: Amazon Proton Create Environment Account Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateEnvironmentTemplate:
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: CreateEnvironmentTemplate
description: 'Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide.
You can create an environment template in one of the two following ways:
Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure.
Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn''t manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentTemplateOutput'
'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: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateEnvironmentTemplate
summary: Amazon Proton Create Environment Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateEnvironmentTemplateVersion:
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: CreateEnvironmentTemplateVersion
description: Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentTemplateVersionOutput'
'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/CreateEnvironmentTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateEnvironmentTemplateVersion
summary: Amazon Proton Create Environment Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateRepository:
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: CreateRepository
description: 'Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you.
For more information, see Self-managed provisioning, Template bundles, and Template sync configurations in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRepositoryOutput'
'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: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRepositoryInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateRepository
summary: Amazon Proton Create Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateService:
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: CreateService
description: Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton User Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceOutput'
'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/CreateServiceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateService
summary: Amazon Proton Create Service
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateServiceInstance:
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: CreateServiceInstance
description: Create a service instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceInstanceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceInstanceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateServiceInstance
summary: Amazon Proton Create Service Instance
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateServiceSyncConfig:
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: CreateServiceSyncConfig
description: Create the Proton Ops configuration file.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceSyncConfigOutput'
'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: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateServiceSyncConfig
summary: Amazon Proton Create Service Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateServiceTemplate:
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: CreateServiceTemplate
description: Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Proton templates in the Proton User Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceTemplateOutput'
'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: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateServiceTemplate
summary: Amazon Proton Create Service Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateServiceTemplateVersion:
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: CreateServiceTemplateVersion
description: Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateServiceTemplateVersionOutput'
'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/CreateServiceTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateServiceTemplateVersion
summary: Amazon Proton Create Service Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.CreateTemplateSyncConfig:
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: CreateTemplateSyncConfig
description: 'Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTemplateSyncConfigOutput'
'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: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTemplateSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.CreateTemplateSyncConfig
summary: Amazon Proton Create Template Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteComponent:
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: DeleteComponent
description: 'Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteComponentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteComponentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteComponent
summary: Amazon Proton Delete Component
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteEnvironment:
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: DeleteEnvironment
description: Delete an environment.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteEnvironment
summary: Amazon Proton Delete Environment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentAccountConnection:
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: DeleteEnvironmentAccountConnection
description: 'In an environment account, delete an environment account connection.
After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You''re responsible for cleaning up provisioned resources that remain without an environment connection.
For more information, see Environment account connections in the Proton User guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentAccountConnectionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentAccountConnectionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteEnvironmentAccountConnection
summary: Amazon Proton Delete Environment Account Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentTemplate:
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: DeleteEnvironmentTemplate
description: If no other major or minor versions of an environment template exist, delete the environment template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentTemplateOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteEnvironmentTemplate
summary: Amazon Proton Delete Environment Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentTemplateVersion:
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: DeleteEnvironmentTemplateVersion
description: 'If no other minor versions of an environment template exist, delete a major version of the environment template if it''s not the Recommended version. Delete the Recommended version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that''s not backward compatible.
Delete a minor version of an environment template if it isn''t the Recommended version. Delete a Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that''s backward compatible.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentTemplateVersionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEnvironmentTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteEnvironmentTemplateVersion
summary: Amazon Proton Delete Environment Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteRepository:
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: DeleteRepository
description: De-register and unlink your repository.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRepositoryOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRepositoryInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteRepository
summary: Amazon Proton Delete Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteService:
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: DeleteService
description: 'Delete a service, with its instances and pipeline.
You can''t delete a service if it has any service instances that have components attached to them.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteService
summary: Amazon Proton Delete Service
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteServiceSyncConfig:
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: DeleteServiceSyncConfig
description: Delete the Proton Ops file.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceSyncConfigOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteServiceSyncConfig
summary: Amazon Proton Delete Service Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteServiceTemplate:
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: DeleteServiceTemplate
description: If no other major or minor versions of the service template exist, delete the service template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceTemplateOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteServiceTemplate
summary: Amazon Proton Delete Service Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteServiceTemplateVersion:
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: DeleteServiceTemplateVersion
description: 'If no other minor versions of a service template exist, delete a major version of the service template if it''s not the Recommended version. Delete the Recommended version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that isn''t backwards compatible.
Delete a minor version of a service template if it''s not the Recommended version. Delete a Recommended minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that''s backwards compatible.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceTemplateVersionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteServiceTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteServiceTemplateVersion
summary: Amazon Proton Delete Service Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.DeleteTemplateSyncConfig:
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: DeleteTemplateSyncConfig
description: Delete a template sync configuration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTemplateSyncConfigOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTemplateSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.DeleteTemplateSyncConfig
summary: Amazon Proton Delete Template Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetAccountSettings:
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: GetAccountSettings
description: Get detail data for Proton account-wide settings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAccountSettingsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetAccountSettingsInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetAccountSettings
summary: Amazon Proton Get Account Settings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetComponent:
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: GetComponent
description: 'Get detailed data for a 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/GetComponentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetComponentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetComponent
summary: Amazon Proton Get Component
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetEnvironment:
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: GetEnvironment
description: Get detailed data for an environment.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetEnvironment
summary: Amazon Proton Get Environment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetEnvironmentAccountConnection:
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: GetEnvironmentAccountConnection
description: 'In an environment account, get the detailed data for an environment account connection.
For more information, see Environment account connections in the Proton User guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentAccountConnectionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentAccountConnectionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetEnvironmentAccountConnection
summary: Amazon Proton Get Environment Account Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetEnvironmentTemplate:
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: GetEnvironmentTemplate
description: Get detailed data for an environment template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentTemplateOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetEnvironmentTemplate
summary: Amazon Proton Get Environment Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetEnvironmentTemplateVersion:
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: GetEnvironmentTemplateVersion
description: Get detailed data for a major or minor version of an environment template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentTemplateVersionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetEnvironmentTemplateVersion
summary: Amazon Proton Get Environment Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetRepository:
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: GetRepository
description: Get detail data for a linked repository.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRepositoryOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetRepositoryInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetRepository
summary: Amazon Proton Get Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetRepositorySyncStatus:
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: GetRepositorySyncStatus
description: 'Get the sync status of a repository used for Proton template sync. For more information about template sync, see .
A repository sync status isn''t tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can''t use these tags to control access to this action using Attribute-based access control (ABAC).
For more information about ABAC, see ABAC in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRepositorySyncStatusOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetRepositorySyncStatusInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetRepositorySyncStatus
summary: Amazon Proton Get Repository Sync Status
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetResourcesSummary:
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: GetResourcesSummary
description: 'Get counts of Proton resources.
For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it''s behind the recommended version of the Proton template that it uses and it needs an update to become current.
The action returns staleness counts (counts of resources that are up-to-date, behind a template major version, or behind a template minor version), the total number of resources, and the number of resources that are in a failed state, grouped by resource type. Components, environments, and service templates return less information - see the components, environments, and serviceTemplates field descriptions.
For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account.
For more information, see Proton dashboard in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourcesSummaryOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourcesSummaryInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetResourcesSummary
summary: Amazon Proton Get Resources Summary
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetService:
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: GetService
description: Get detailed data for a service.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetService
summary: Amazon Proton Get Service
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetServiceInstance:
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: GetServiceInstance
description: Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceInstanceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceInstanceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetServiceInstance
summary: Amazon Proton Get Service Instance
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetServiceInstanceSyncStatus:
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: GetServiceInstanceSyncStatus
description: Get the status of the synced service instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceInstanceSyncStatusOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceInstanceSyncStatusInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetServiceInstanceSyncStatus
summary: Amazon Proton Get Service Instance Sync Status
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetServiceSyncBlockerSummary:
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: GetServiceSyncBlockerSummary
description: Get detailed data for the service sync blocker summary.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceSyncBlockerSummaryOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceSyncBlockerSummaryInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetServiceSyncBlockerSummary
summary: Amazon Proton Get Service Sync Blocker Summary
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetServiceSyncConfig:
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: GetServiceSyncConfig
description: Get detailed information for the service sync configuration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceSyncConfigOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetServiceSyncConfig
summary: Amazon Proton Get Service Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetServiceTemplate:
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: GetServiceTemplate
description: Get detailed data for a service template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceTemplateOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetServiceTemplate
summary: Amazon Proton Get Service Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetServiceTemplateVersion:
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: GetServiceTemplateVersion
description: Get detailed data for a major or minor version of a service template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceTemplateVersionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetServiceTemplateVersion
summary: Amazon Proton Get Service Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetTemplateSyncConfig:
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: GetTemplateSyncConfig
description: Get detail data for a template sync configuration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTemplateSyncConfigOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTemplateSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetTemplateSyncConfig
summary: Amazon Proton Get Template Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.GetTemplateSyncStatus:
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: GetTemplateSyncStatus
description: Get the status of a template sync.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTemplateSyncStatusOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTemplateSyncStatusInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.GetTemplateSyncStatus
summary: Amazon Proton Get Template Sync Status
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListComponentOutputs:
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: ListComponentOutputs
description: 'Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListComponentOutputsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListComponentOutputsInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListComponentOutputs
summary: Amazon Proton List Component Outputs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListComponentProvisionedResources:
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: ListComponentProvisionedResources
description: 'List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListComponentProvisionedResourcesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListComponentProvisionedResourcesInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListComponentProvisionedResources
summary: Amazon Proton List Component Provisioned Resources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListComponents:
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: ListComponents
description: 'List components with summary data. You can filter the result list by environment, service, or a single service instance.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListComponentsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListComponentsInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListComponents
summary: Amazon Proton List Components
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListEnvironmentAccountConnections:
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: ListEnvironmentAccountConnections
description: 'View a list of environment account connections.
For more information, see Environment account connections in the Proton User guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentAccountConnectionsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentAccountConnectionsInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListEnvironmentAccountConnections
summary: Amazon Proton List Environment Account Connections
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListEnvironmentOutputs:
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: ListEnvironmentOutputs
description: List the infrastructure as code outputs for your environment.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentOutputsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentOutputsInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListEnvironmentOutputs
summary: Amazon Proton List Environment Outputs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListEnvironmentProvisionedResources:
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: ListEnvironmentProvisionedResources
description: List the provisioned resources for your environment.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentProvisionedResourcesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentProvisionedResourcesInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListEnvironmentProvisionedResources
summary: Amazon Proton List Environment Provisioned Resources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListEnvironmentTemplateVersions:
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: ListEnvironmentTemplateVersions
description: List major or minor versions of an environment template with detail data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentTemplateVersionsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentTemplateVersionsInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListEnvironmentTemplateVersions
summary: Amazon Proton List Environment Template Versions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListEnvironmentTemplates:
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: ListEnvironmentTemplates
description: List environment templates.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentTemplatesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentTemplatesInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListEnvironmentTemplates
summary: Amazon Proton List Environment Templates
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListEnvironments:
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: ListEnvironments
description: List environments with detail data summaries.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentsInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListEnvironments
summary: Amazon Proton List Environments
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListRepositories:
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: ListRepositories
description: List linked repositories with detail data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositoriesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositoriesInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListRepositories
summary: Amazon Proton List Repositories
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListRepositorySyncDefinitions:
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: ListRepositorySyncDefinitions
description: List repository sync definitions with detail data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositorySyncDefinitionsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositorySyncDefinitionsInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListRepositorySyncDefinitions
summary: Amazon Proton List Repository Sync Definitions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServiceInstanceOutputs:
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: ListServiceInstanceOutputs
description: Get a list service of instance Infrastructure as Code (IaC) outputs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceInstanceOutputsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceInstanceOutputsInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServiceInstanceOutputs
summary: Amazon Proton List Service Instance Outputs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServiceInstanceProvisionedResources:
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: ListServiceInstanceProvisionedResources
description: List provisioned resources for a service instance with details.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceInstanceProvisionedResourcesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceInstanceProvisionedResourcesInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServiceInstanceProvisionedResources
summary: Amazon Proton List Service Instance Provisioned Resources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServiceInstances:
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: ListServiceInstances
description: List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceInstancesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceInstancesInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServiceInstances
summary: Amazon Proton List Service Instances
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServicePipelineOutputs:
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: ListServicePipelineOutputs
description: Get a list of service pipeline Infrastructure as Code (IaC) outputs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServicePipelineOutputsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServicePipelineOutputsInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServicePipelineOutputs
summary: Amazon Proton List Service Pipeline Outputs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServicePipelineProvisionedResources:
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: ListServicePipelineProvisionedResources
description: List provisioned resources for a service and pipeline with details.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServicePipelineProvisionedResourcesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServicePipelineProvisionedResourcesInput'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServicePipelineProvisionedResources
summary: Amazon Proton List Service Pipeline Provisioned Resources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServiceTemplateVersions:
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: ListServiceTemplateVersions
description: List major or minor versions of a service template with detail data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceTemplateVersionsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceTemplateVersionsInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServiceTemplateVersions
summary: Amazon Proton List Service Template Versions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServiceTemplates:
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: ListServiceTemplates
description: List service templates with detail data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceTemplatesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceTemplatesInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServiceTemplates
summary: Amazon Proton List Service Templates
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListServices:
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: ListServices
description: List services with summaries of detail data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListServicesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListServicesInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListServices
summary: Amazon Proton List Services
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.ListTagsForResource:
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: ListTagsForResource
description: List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceInput'
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.ListTagsForResource
summary: Amazon Proton List Tags For Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.NotifyResourceDeploymentStatusChange:
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: NotifyResourceDeploymentStatusChange
description: 'Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotifyResourceDeploymentStatusChangeOutput'
'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/NotifyResourceDeploymentStatusChangeInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.NotifyResourceDeploymentStatusChange
summary: Amazon Proton Notify Resource Deployment Status Change
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.RejectEnvironmentAccountConnection:
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: RejectEnvironmentAccountConnection
description: 'In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you can''t accept or use the rejected environment account connection.
You can’t reject an environment account connection that''s connected to an environment.
For more information, see Environment account connections in the Proton User guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RejectEnvironmentAccountConnectionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RejectEnvironmentAccountConnectionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.RejectEnvironmentAccountConnection
summary: Amazon Proton Reject Environment Account Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.TagResource:
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: TagResource
description: 'Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.TagResource
summary: Amazon Proton Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UntagResource:
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: UntagResource
description: 'Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UntagResource
summary: Amazon Proton Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateAccountSettings:
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: UpdateAccountSettings
description: Update Proton settings that are used for multiple services in the Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAccountSettingsOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAccountSettingsInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateAccountSettings
summary: Amazon Proton Update Account Settings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateComponent:
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: UpdateComponent
description: 'Update a component.
There are a few modes for updating a component. The deploymentType field defines the mode.
You can''t update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComponentOutput'
'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/UpdateComponentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateComponent
summary: Amazon Proton Update Component
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateEnvironment:
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: UpdateEnvironment
description: 'Update an environment.
If the environment is associated with an environment account connection, don''t update or include the protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn''t associated with an environment account connection, don''t update or include the environmentAccountConnectionId parameter. You can''t update or connect the environment to an environment account connection if it isn''t already associated with an environment connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.
If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.
If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.
For more information, see Environments and Provisioning methods in the Proton User Guide.
There are four modes for updating an environment. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn''t occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that''s higher than the major version in use and a minor version.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateEnvironment
summary: Amazon Proton Update Environment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentAccountConnection:
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: UpdateEnvironmentAccountConnection
description: 'In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton User guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentAccountConnectionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentAccountConnectionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateEnvironmentAccountConnection
summary: Amazon Proton Update Environment Account Connection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentTemplate:
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: UpdateEnvironmentTemplate
description: Update an environment template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentTemplateOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateEnvironmentTemplate
summary: Amazon Proton Update Environment Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentTemplateVersion:
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: UpdateEnvironmentTemplateVersion
description: Update a major or minor version of an environment template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentTemplateVersionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateEnvironmentTemplateVersion
summary: Amazon Proton Update Environment Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#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:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateServiceInstance:
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: UpdateServiceInstance
description: 'Update a service instance.
There are a few modes for updating a service instance. The deploymentType field defines the mode.
You can''t update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS.
For more information about components, see Proton components in the Proton User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceInstanceOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceInstanceInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateServiceInstance
summary: Amazon Proton Update Service Instance
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateServicePipeline:
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: UpdateServicePipeline
description: 'Update the service pipeline.
There are four modes for updating a service pipeline. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn''t occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that''s higher than the major version in use and a minor version.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServicePipelineOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServicePipelineInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateServicePipeline
summary: Amazon Proton Update Service Pipeline
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateServiceSyncBlocker:
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: UpdateServiceSyncBlocker
description: Update the service sync blocker by resolving it.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceSyncBlockerOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceSyncBlockerInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateServiceSyncBlocker
summary: Amazon Proton Update Service Sync Blocker
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateServiceSyncConfig:
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: UpdateServiceSyncConfig
description: Update the Proton Ops config file.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceSyncConfigOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateServiceSyncConfig
summary: Amazon Proton Update Service Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateServiceTemplate:
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: UpdateServiceTemplate
description: Update a service template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceTemplateOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceTemplateInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateServiceTemplate
summary: Amazon Proton Update Service Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateServiceTemplateVersion:
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: UpdateServiceTemplateVersion
description: Update a major or minor version of a service template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceTemplateVersionOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateServiceTemplateVersionInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateServiceTemplateVersion
summary: Amazon Proton Update Service Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
/#X-Amz-Target=AwsProton20200720.UpdateTemplateSyncConfig:
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: UpdateTemplateSyncConfig
description: Update template sync configuration parameters, except for the templateName and templateType. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTemplateSyncConfigOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTemplateSyncConfigInput'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AwsProton20200720.UpdateTemplateSyncConfig
summary: Amazon Proton Update Template Sync Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- AWS Proton
components:
schemas:
GetAccountSettingsInput:
type: object
title: GetAccountSettingsInput
properties: {}
CompatibleEnvironmentTemplateInput:
type: object
required:
- majorVersion
- templateName
properties:
majorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: The major version of the compatible environment template.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The compatible environment template name.
description: Compatible environment template data.
AccountSettings:
type: object
properties:
pipelineCodebuildRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArnOrEmptyString'
- description: The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.
pipelineProvisioningRepository:
allOf:
- $ref: '#/components/schemas/RepositoryBranch'
- description: The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
pipelineServiceRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArnOrEmptyString'
- description: The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.
description: Proton settings that are used for multiple services in the Amazon Web Services account.
ListServicePipelineProvisionedResourcesOutput:
type: object
required:
- provisionedResources
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
provisionedResources:
allOf:
- $ref: '#/components/schemas/ProvisionedResourceList'
- description: An array of provisioned resources for a service and pipeline.
ListServiceInstancesFilterValue:
type: string
UpdateAccountSettingsOutput:
type: object
required:
- accountSettings
properties:
accountSettings:
allOf:
- $ref: '#/components/schemas/AccountSettings'
- description: The Proton pipeline service role and repository data shared across the Amazon Web Services account.
CancelServicePipelineDeploymentOutput:
type: object
required:
- pipeline
properties:
pipeline:
allOf:
- $ref: '#/components/schemas/ServicePipeline'
- description: The service pipeline detail data that's returned by Proton.
ListEnvironmentOutputsInput:
type: object
required:
- environmentName
title: ListEnvironmentOutputsInput
properties:
environmentName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The environment name.
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.
ResourceNotFoundException: {}
UpdateServiceInstanceOutput:
type: object
required:
- serviceInstance
properties:
serviceInstance:
allOf:
- $ref: '#/components/schemas/ServiceInstance'
- description: The service instance summary data that's returned by Proton.
EnvironmentAccountConnectionArn:
type: string
DeleteComponentOutput:
type: object
properties:
component:
allOf:
- $ref: '#/components/schemas/Component'
- description: The detailed data of the component being deleted.
UpdateServiceSyncConfigOutput:
type: object
properties:
serviceSyncConfig:
allOf:
- $ref: '#/components/schemas/ServiceSyncConfig'
- description: The detailed data of the Proton Ops file.
ListServiceInstancesOutput:
type: object
required:
- serviceInstances
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.
serviceInstances:
allOf:
- $ref: '#/components/schemas/ServiceInstanceSummaryList'
- description: An array of service instances with summary data.
ServiceTemplateVersionArn:
type: string
BlockerType:
type: string
enum:
- AUTOMATED
TagResourceOutput:
type: object
properties: {}
UntagResourceInput:
type: object
required:
- resourceArn
- tagKeys
title: UntagResourceInput
properties:
resourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the resource to remove customer tags from.
tagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: A list of customer tag keys that indicate the customer tags to be removed from the resource.
SyncType:
type: string
enum:
- TEMPLATE_SYNC
- SERVICE_SYNC
DeleteServiceSyncConfigOutput:
type: object
properties:
serviceSyncConfig:
allOf:
- $ref: '#/components/schemas/ServiceSyncConfig'
- description: The detailed data for the service sync config.
DeleteServiceSyncConfigInput:
type: object
required:
- serviceName
title: DeleteServiceSyncConfigInput
properties:
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service that you want to delete the service sync configuration for.
GetEnvironmentOutput:
type: object
required:
- environment
properties:
environment:
allOf:
- $ref: '#/components/schemas/Environment'
- description: The detailed data of the requested environment.
RepositorySyncDefinitionList:
type: array
items:
$ref: '#/components/schemas/RepositorySyncDefinition'
UpdateAccountSettingsInput:
type: object
title: UpdateAccountSettingsInput
properties:
deletePipelineProvisioningRepository:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Set to true to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the configured pipeline repository.
pipelineCodebuildRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArnOrEmptyString'
- description: The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.
pipelineProvisioningRepository:
allOf:
- $ref: '#/components/schemas/RepositoryBranchInput'
- description:
A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
To remove a previously configured repository, set deletePipelineProvisioningRepository to true, and don't set pipelineProvisioningRepository.
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.
To remove a previously configured ARN, specify an empty string.
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 CreateRepositoryInput: type: object required: - connectionArn - name - provider title: CreateRepositoryInput properties: connectionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account. For more information, see Setting up for Proton in the Proton User Guide. encryptionKey: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key. name: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name (for example,myrepos/myrepo).
provider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The repository provider.
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
LatestSyncBlockers: type: array items: $ref: '#/components/schemas/SyncBlocker' EnvironmentTemplateVersion: type: object required: - arn - createdAt - lastModifiedAt - majorVersion - minorVersion - status - templateName properties: arn: allOf: - $ref: '#/components/schemas/EnvironmentTemplateVersionArn' - description: The Amazon Resource Name (ARN) of the version of an environment template. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the version of an environment template was created. description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the minor version of an environment template. lastModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the version of an environment template was last modified. majorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The latest major version that's associated with the version of an environment template. minorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The minor version of an environment template. recommendedMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The recommended minor version of the environment template. schema: allOf: - $ref: '#/components/schemas/TemplateSchema' - description: The schema of the version of an environment template. status: allOf: - $ref: '#/components/schemas/TemplateVersionStatus' - description: The status of the version of an environment template. statusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: The status message of the version of an environment template. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the version of an environment template. description: The environment template version data. ServiceTemplateSummary: type: object required: - arn - createdAt - lastModifiedAt - name properties: arn: allOf: - $ref: '#/components/schemas/ServiceTemplateArn' - description: The Amazon Resource Name (ARN) of the service template. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the service template was created. description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the service template. displayName: allOf: - $ref: '#/components/schemas/DisplayName' - description: The service template name as displayed in the developer interface. lastModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the service template was last modified. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template. pipelineProvisioning: allOf: - $ref: '#/components/schemas/Provisioning' - description: IfpipelineProvisioning is true, a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template.
recommendedVersion:
allOf:
- $ref: '#/components/schemas/FullTemplateVersionNumber'
- description: The recommended version of the service template.
description: Summary data of an Proton service template resource.
ListComponentProvisionedResourcesInput:
type: object
required:
- componentName
title: ListComponentProvisionedResourcesInput
properties:
componentName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the component whose provisioned resources you want.
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
RepositorySyncDefinition:
type: object
required:
- branch
- directory
- parent
- target
properties:
branch:
allOf:
- $ref: '#/components/schemas/GitBranchName'
- description: The repository branch.
directory:
allOf:
- $ref: '#/components/schemas/String'
- description: The directory in the repository.
parent:
allOf:
- $ref: '#/components/schemas/String'
- description: The resource that is synced from.
target:
allOf:
- $ref: '#/components/schemas/String'
- description: The resource that is synced to.
description: A repository sync definition.
ListComponentOutputsOutput:
type: object
required:
- outputs
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
outputs:
allOf:
- $ref: '#/components/schemas/OutputsList'
- description: An array of component Infrastructure as Code (IaC) outputs.
DeleteEnvironmentAccountConnectionInput:
type: object
required:
- id
title: DeleteEnvironmentAccountConnectionInput
properties:
id:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnectionId'
- description: The ID of the environment account connection to delete.
ServiceTemplateSupportedComponentSourceInputList:
type: array
items:
$ref: '#/components/schemas/ServiceTemplateSupportedComponentSourceType'
ServiceInstance:
type: object
required:
- arn
- createdAt
- deploymentStatus
- environmentName
- lastDeploymentAttemptedAt
- lastDeploymentSucceededAt
- name
- serviceName
- templateMajorVersion
- templateMinorVersion
- templateName
properties:
arn:
allOf:
- $ref: '#/components/schemas/ServiceInstanceArn'
- description: The Amazon Resource Name (ARN) of the service instance.
createdAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the service instance was created.
deploymentStatus:
allOf:
- $ref: '#/components/schemas/DeploymentStatus'
- description: The service instance deployment status.
deploymentStatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: The message associated with the service instance deployment status.
environmentName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the environment that the service instance was deployed into.
lastClientRequestToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The last client request token received.
lastDeploymentAttemptedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when a deployment of the service instance was last attempted.
lastDeploymentSucceededAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the service instance was last deployed successfully.
name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service instance.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service that the service instance belongs to.
spec:
allOf:
- $ref: '#/components/schemas/SpecContents'
- description: The service spec that was used to create the service instance.
templateMajorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: The major version of the service template that was used to create the service instance.
templateMinorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: The minor version of the service template that was used to create the service instance.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service template that was used to create the service instance.
description: Detailed data of an Proton service instance resource.
AccessDeniedException: {}
ServiceTemplateVersion:
type: object
required:
- arn
- compatibleEnvironmentTemplates
- createdAt
- lastModifiedAt
- majorVersion
- minorVersion
- status
- templateName
properties:
arn:
allOf:
- $ref: '#/components/schemas/ServiceTemplateVersionArn'
- description: The Amazon Resource Name (ARN) of the version of a service template.
compatibleEnvironmentTemplates:
allOf:
- $ref: '#/components/schemas/CompatibleEnvironmentTemplateList'
- description: An array of compatible environment template names for the major version of a service template.
createdAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the version of a service template was created.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description of the version of a service template.
lastModifiedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the version of a service template was last modified.
majorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: The latest major version that's associated with the version of a service template.
minorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: The minor version of a service template.
recommendedMinorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: The recommended minor version of the service template.
schema:
allOf:
- $ref: '#/components/schemas/TemplateSchema'
- description: The schema of the version of a service template.
status:
allOf:
- $ref: '#/components/schemas/TemplateVersionStatus'
- description: The service template version status.
statusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A service template version status message.
supportedComponentSources:
allOf:
- $ref: '#/components/schemas/ServiceTemplateSupportedComponentSourceInputList'
- description: An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
For more information about components, see Proton components in the Proton User Guide.
templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the version of a service template. description: Detailed data of an Proton service template version resource. ListComponentOutputsInput: type: object required: - componentName title: ListComponentOutputsInput properties: componentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the component whose outputs you want. nextToken: allOf: - $ref: '#/components/schemas/EmptyNextToken' - description: A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested. FullTemplateVersionNumber: type: string pattern: ^(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))$ minLength: 1 maxLength: 10 UpdateServiceTemplateInput: type: object required: - name title: UpdateServiceTemplateInput properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the service template update. displayName: allOf: - $ref: '#/components/schemas/DisplayName' - description: The name of the service template to update that's displayed in the developer interface. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template to update. GetServiceSyncConfigOutput: type: object properties: serviceSyncConfig: allOf: - $ref: '#/components/schemas/ServiceSyncConfig' - description: The detailed data of the requested service sync configuration. CreateServiceTemplateOutput: type: object required: - serviceTemplate properties: serviceTemplate: allOf: - $ref: '#/components/schemas/ServiceTemplate' - description: The service template detail data that's returned by Proton. ServiceSyncConfig: type: object required: - branch - filePath - repositoryName - repositoryProvider - serviceName properties: branch: allOf: - $ref: '#/components/schemas/GitBranchName' - description: The name of the code repository branch that holds the service code Proton will sync with. filePath: allOf: - $ref: '#/components/schemas/OpsFilePath' - description: The file path to the service sync configuration file. repositoryName: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The name of the code repository that holds the service code Proton will sync with. repositoryProvider: allOf: - $ref: '#/components/schemas/RepositoryProvider' - description: The name of the repository provider that holds the repository Proton will sync with. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service that the service instance is added to. description: Detailed data of the service sync configuration. GetServiceSyncConfigInput: type: object required: - serviceName title: GetServiceSyncConfigInput properties: serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service that you want to get the service sync configuration for. RoleArnOrEmptyString: type: string pattern: (^$)|(^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$) minLength: 0 maxLength: 2048 DeploymentUpdateType: type: string enum: - NONE - CURRENT_VERSION - MINOR_VERSION - MAJOR_VERSION GetServiceInstanceOutput: type: object required: - serviceInstance properties: serviceInstance: allOf: - $ref: '#/components/schemas/ServiceInstance' - description: The detailed data of the requested service instance. CompatibleEnvironmentTemplate: type: object required: - majorVersion - templateName properties: majorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The major version of the compatible environment template. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The compatible environment template name. description: Compatible environment template data. CancelComponentDeploymentInput: type: object required: - componentName title: CancelComponentDeploymentInput properties: componentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the component with the deployment to cancel. DeleteServiceInput: type: object required: - name title: DeleteServiceInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service to delete. DeleteEnvironmentInput: type: object required: - name title: DeleteEnvironmentInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment to delete. CreateComponentInput: type: object required: - manifest - name - templateFile title: CreateComponentInput properties: clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: The client token for the created component. description: allOf: - $ref: '#/components/schemas/Description' - description: An optional customer-provided description of the component. environmentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the Proton environment that you want to associate this component with. You must specify this when you don't specifyserviceInstanceName and serviceName.
manifest:
allOf:
- $ref: '#/components/schemas/TemplateManifestContents'
- description: A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The customer-provided name of the component.
serviceInstanceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
serviceSpec:
allOf:
- $ref: '#/components/schemas/SpecContents'
- description: The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
templateFile: allOf: - $ref: '#/components/schemas/TemplateFileContents' - description:A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Components support a single IaC file, even if you use Terraform as your template language.
To view a list of minor of versions under a major version of a service template, include major Version.
To view a list of major versions of a service template, exclude major Version.
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
You must specify componentRoleArn to allow directly defined components to be associated with this environment.
For more information about components, see Proton components in the Proton User Guide.
description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the environment that's being created and deployed. environmentAccountConnectionId: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionId' - description:The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
templateMajorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The major version of the environment template. templateMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The minor version of the environment template. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template. For more information, see Environment Templates in the Proton User Guide. DeleteComponentInput: type: object required: - name title: DeleteComponentInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the component to delete. ListServiceInstancesSortBy: type: string enum: - name - deploymentStatus - templateName - serviceName - environmentName - lastDeploymentAttemptedAt - createdAt ProvisionedResourceEngine: type: string enum: - CLOUDFORMATION - TERRAFORM description: List of provisioning engines Tag: type: object required: - key - value properties: key: allOf: - $ref: '#/components/schemas/TagKey' - description: The key of the resource tag. value: allOf: - $ref: '#/components/schemas/TagValue' - description: The value of the resource tag. description: A description of a resource tag. CreateEnvironmentTemplateOutput: type: object required: - environmentTemplate properties: environmentTemplate: allOf: - $ref: '#/components/schemas/EnvironmentTemplate' - description: The environment template detail data that's returned by Proton. CancelServicePipelineDeploymentInput: type: object required: - serviceName title: CancelServicePipelineDeploymentInput properties: serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service with the service pipeline deployment to cancel. GetServiceInstanceSyncStatusOutput: type: object properties: desiredState: allOf: - $ref: '#/components/schemas/Revision' - description: The service instance sync desired state that's returned by Proton latestSuccessfulSync: allOf: - $ref: '#/components/schemas/ResourceSyncAttempt' - description: The detailed data of the latest successful sync with the service instance. latestSync: allOf: - $ref: '#/components/schemas/ResourceSyncAttempt' - description: The detailed data of the latest sync with the service instance. EmptyNextToken: type: string minLength: 0 maxLength: 0 TemplateSyncConfig: type: object required: - branch - repositoryName - repositoryProvider - templateName - templateType properties: branch: allOf: - $ref: '#/components/schemas/GitBranchName' - description: The repository branch. repositoryName: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name (for example,myrepos/myrepo).
repositoryProvider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The repository provider.
subdirectory:
allOf:
- $ref: '#/components/schemas/Subdirectory'
- description: A subdirectory path to your template bundle version.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The template name.
templateType:
allOf:
- $ref: '#/components/schemas/TemplateType'
- description: The template type.
description: The detail data for a template sync configuration.
GetTemplateSyncConfigInput:
type: object
required:
- templateName
- templateType
title: GetTemplateSyncConfigInput
properties:
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The template name.
templateType:
allOf:
- $ref: '#/components/schemas/TemplateType'
- description: The template type.
CountsSummary:
type: object
properties:
components:
allOf:
- $ref: '#/components/schemas/ResourceCountsSummary'
- description: The total number of components in the Amazon Web Services account.
The semantics of the components field are different from the semantics of results for other infrastructure-provisioning resources. That's because at this time components don't have associated templates, therefore they don't have the concept of staleness. The components object will only contain total and failed members.
environmentTemplates object will only contain total members.
environments:
allOf:
- $ref: '#/components/schemas/ResourceCountsSummary'
- description: The staleness counts for Proton environments in the Amazon Web Services account. The environments object will only contain total members.
pipelines:
allOf:
- $ref: '#/components/schemas/ResourceCountsSummary'
- description: The staleness counts for Proton pipelines in the Amazon Web Services account.
serviceInstances:
allOf:
- $ref: '#/components/schemas/ResourceCountsSummary'
- description: The staleness counts for Proton service instances in the Amazon Web Services account.
serviceTemplates:
allOf:
- $ref: '#/components/schemas/ResourceCountsSummary'
- description: The total number of service templates in the Amazon Web Services account. The serviceTemplates object will only contain total members.
services:
allOf:
- $ref: '#/components/schemas/ResourceCountsSummary'
- description: The staleness counts for Proton services in the Amazon Web Services account.
description: Summary counts of each Proton resource type.
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 Setting up an AWS CodeStar connection in the Proton User Guide.
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.
UpdateEnvironmentOutput:
type: object
required:
- environment
properties:
environment:
allOf:
- $ref: '#/components/schemas/Environment'
- description: The environment detail data that's returned by Proton.
ServiceTemplateVersionSummaryList:
type: array
items:
$ref: '#/components/schemas/ServiceTemplateVersionSummary'
Integer:
type: integer
DeleteTemplateSyncConfigOutput:
type: object
properties:
templateSyncConfig:
allOf:
- $ref: '#/components/schemas/TemplateSyncConfig'
- description: The template sync configuration detail data that's returned by Proton.
EnvironmentSummary:
type: object
required:
- arn
- createdAt
- deploymentStatus
- lastDeploymentAttemptedAt
- lastDeploymentSucceededAt
- name
- templateMajorVersion
- templateMinorVersion
- templateName
properties:
arn:
allOf:
- $ref: '#/components/schemas/EnvironmentArn'
- description: The Amazon Resource Name (ARN) of the environment.
componentRoleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide.
createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment was created. deploymentStatus: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The environment deployment status. deploymentStatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: An environment deployment status message. description: allOf: - $ref: '#/components/schemas/Description' - description: The description of the environment. environmentAccountConnectionId: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionId' - description: The ID of the environment account connection that the environment is associated with. environmentAccountId: allOf: - $ref: '#/components/schemas/AwsAccountId' - description: The ID of the environment account that the environment infrastructure resources are provisioned in. lastDeploymentAttemptedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when a deployment of the environment was last attempted. lastDeploymentSucceededAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment was last deployed successfully. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment. protonServiceRoleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf. provisioning: allOf: - $ref: '#/components/schemas/Provisioning' - description: When included, indicates that the environment template is for customer provisioned and managed infrastructure. templateMajorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The major version of the environment template. templateMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The minor version of the environment template. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template. description: Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services. TemplateSchema: type: string minLength: 1 maxLength: 51200 format: password ListServiceInstancesFilterList: type: array items: $ref: '#/components/schemas/ListServiceInstancesFilter' ServiceInstanceArn: type: string UpdateEnvironmentTemplateVersionInput: type: object required: - majorVersion - minorVersion - templateName title: UpdateEnvironmentTemplateVersionInput properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of environment template version to update. majorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: To update a major version of an environment template, includemajor Version.
minorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To update a minor version of an environment template, include minorVersion.
status:
allOf:
- $ref: '#/components/schemas/TemplateVersionStatus'
- description: The status of the environment template minor version to update.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the environment template.
RepositoryName:
type: string
pattern: '[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*'
minLength: 1
maxLength: 100
NotifyResourceDeploymentStatusChangeInputOutputsList:
type: array
items:
$ref: '#/components/schemas/Output'
minItems: 0
maxItems: 50
RejectEnvironmentAccountConnectionOutput:
type: object
required:
- environmentAccountConnection
properties:
environmentAccountConnection:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnection'
- description: The environment connection account detail data that's returned by Proton.
CreateServiceTemplateVersionInput:
type: object
required:
- compatibleEnvironmentTemplates
- source
- templateName
title: CreateServiceTemplateVersionInput
properties:
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.
compatibleEnvironmentTemplates:
allOf:
- $ref: '#/components/schemas/CompatibleEnvironmentTemplateInputList'
- description: An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description of the new version of a service template.
majorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To create a new minor version of the service template, include a major Version.
To create a new major and minor version of the service template, exclude major Version.
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
For more information about components, see Proton components in the Proton User Guide.
tags: allOf: - $ref: '#/components/schemas/TagList' - description:An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template. ComponentSummaryList: type: array items: $ref: '#/components/schemas/ComponentSummary' ProvisionedResourceList: type: array items: $ref: '#/components/schemas/ProvisionedResource' ListServiceInstanceOutputsOutput: type: object required: - outputs properties: nextToken: allOf: - $ref: '#/components/schemas/EmptyNextToken' - description: A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs. outputs: allOf: - $ref: '#/components/schemas/OutputsList' - description: An array of service instance Infrastructure as Code (IaC) outputs. ResourceNameOrEmpty: type: string pattern: (^$)|^[0-9A-Za-z]+[0-9A-Za-z_\-]*$ minLength: 0 maxLength: 100 EnvironmentAccountConnectionSummaryList: type: array items: $ref: '#/components/schemas/EnvironmentAccountConnectionSummary' TemplateVersionSourceInput: type: object properties: s3: allOf: - $ref: '#/components/schemas/S3ObjectSource' - description: An S3 source object that includes the template bundle S3 path and name for a template minor version. description: Template version source data. ResourceCountsSummary: type: object required: - total properties: behindMajor: allOf: - $ref: '#/components/schemas/Integer' - description: The number of resources of this type in the Amazon Web Services account that need a major template version update. behindMinor: allOf: - $ref: '#/components/schemas/Integer' - description: The number of resources of this type in the Amazon Web Services account that need a minor template version update. failed: allOf: - $ref: '#/components/schemas/Integer' - description: The number of resources of this type in the Amazon Web Services account that failed to deploy. total: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of resources of this type in the Amazon Web Services account. upToDate: allOf: - $ref: '#/components/schemas/Integer' - description: The number of resources of this type in the Amazon Web Services account that are up-to-date with their template. description: Summary counts of each Proton resource types. CreateServiceInstanceInput: type: object required: - name - serviceName - spec title: CreateServiceInstanceInput properties: clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: The client token of the service instance to create. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service instance to create. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service the service instance is added to. spec: allOf: - $ref: '#/components/schemas/SpecContents' - description: The spec for the service instance you want to create. tags: allOf: - $ref: '#/components/schemas/TagList' - description:An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
templateMajorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: To create a new major and minor version of the service template, excludemajor Version.
templateMinorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To create a new minor version of the service template, include a major Version.
AwsAccountId:
type: string
pattern: ^\d{12}$
SpecContents:
type: string
minLength: 1
maxLength: 51200
format: password
CancelEnvironmentDeploymentInput:
type: object
required:
- environmentName
title: CancelEnvironmentDeploymentInput
properties:
environmentName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the environment with the deployment to cancel.
DisplayName:
type: string
minLength: 1
maxLength: 100
format: password
ResourceSyncEvents:
type: array
items:
$ref: '#/components/schemas/ResourceSyncEvent'
UpdateServicePipelineInput:
type: object
required:
- deploymentType
- serviceName
- spec
title: UpdateServicePipelineInput
properties:
deploymentType:
allOf:
- $ref: '#/components/schemas/DeploymentUpdateType'
- description: The deployment type.
There are four modes for updating a service pipeline. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
templateMajorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The major version of the service template that was used to create the service. templateMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The minor version of the service template that was used to create the service. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template that's used to create the service. RepositorySummary: type: object required: - arn - connectionArn - name - provider properties: arn: allOf: - $ref: '#/components/schemas/RepositoryArn' - description: The Amazon Resource Name (ARN) of the linked repository. connectionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the of your connection that connects Proton to your repository. name: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name. provider: allOf: - $ref: '#/components/schemas/RepositoryProvider' - description: The repository provider. description: Summary data of a linked repository—a repository that has been registered with Proton. DeleteEnvironmentTemplateInput: type: object required: - name title: DeleteEnvironmentTemplateInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template to delete. RejectEnvironmentAccountConnectionInput: type: object required: - id title: RejectEnvironmentAccountConnectionInput properties: id: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionId' - description: The ID of the environment account connection to reject. MaxPageResults: type: integer minimum: 1 maximum: 100 DeleteEnvironmentTemplateOutput: type: object properties: environmentTemplate: allOf: - $ref: '#/components/schemas/EnvironmentTemplate' - description: The detailed data of the environment template being deleted. GitBranchName: type: string minLength: 1 maxLength: 200 CompatibleEnvironmentTemplateList: type: array items: $ref: '#/components/schemas/CompatibleEnvironmentTemplate' ClientToken: type: string pattern: ^[!-~]*$ minLength: 0 maxLength: 64 TemplateFileContents: type: string minLength: 1 maxLength: 51200 format: password UpdateServiceSyncBlockerInput: type: object required: - id - resolvedReason title: UpdateServiceSyncBlockerInput properties: id: allOf: - $ref: '#/components/schemas/String' - description: The ID of the service sync blocker. resolvedReason: allOf: - $ref: '#/components/schemas/String' - description: The reason the service sync blocker was resolved. ServiceQuotaExceededException: {} InternalServerException: {} GetServiceOutput: type: object properties: service: allOf: - $ref: '#/components/schemas/Service' - description: The detailed data of the requested service. ListEnvironmentsInput: type: object title: ListEnvironmentsInput properties: environmentTemplates: allOf: - $ref: '#/components/schemas/EnvironmentTemplateFilterList' - description: An array of the versions of the environment template. maxResults: allOf: - $ref: '#/components/schemas/MaxPageResults' - description: The maximum number of environments to list. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested. CreateServiceTemplateInput: type: object required: - name title: CreateServiceTemplateInput properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the service template. displayName: allOf: - $ref: '#/components/schemas/DisplayName' - description: The name of the service template as displayed in the developer interface. encryptionKey: allOf: - $ref: '#/components/schemas/Arn' - description: A customer provided encryption key that's used to encrypt data. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template. pipelineProvisioning: allOf: - $ref: '#/components/schemas/Provisioning' - description: By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide. tags: allOf: - $ref: '#/components/schemas/TagList' - description:An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
DeleteServiceOutput: type: object properties: service: allOf: - $ref: '#/components/schemas/Service' - description: The detailed data of the service being deleted. EnvironmentTemplateVersionSummary: type: object required: - arn - createdAt - lastModifiedAt - majorVersion - minorVersion - status - templateName properties: arn: allOf: - $ref: '#/components/schemas/EnvironmentTemplateVersionArn' - description: The Amazon Resource Name (ARN) of the version of an environment template. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the version of an environment template was created. description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the version of an environment template. lastModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the version of an environment template was last modified. majorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The latest major version that's associated with the version of an environment template. minorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The version of an environment template. recommendedMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The recommended minor version of the environment template. status: allOf: - $ref: '#/components/schemas/TemplateVersionStatus' - description: The status of the version of an environment template. statusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: The status message of the version of an environment template. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template. description: A summary of the version of an environment template detail data. ComponentArn: type: string GetTemplateSyncStatusOutput: type: object properties: desiredState: allOf: - $ref: '#/components/schemas/Revision' - description: The template sync desired state that's returned by Proton. latestSuccessfulSync: allOf: - $ref: '#/components/schemas/ResourceSyncAttempt' - description: The details of the last successful sync that's returned by Proton. latestSync: allOf: - $ref: '#/components/schemas/ResourceSyncAttempt' - description: The details of the last sync that's returned by Proton. ListComponentProvisionedResourcesOutput: type: object required: - provisionedResources properties: nextToken: allOf: - $ref: '#/components/schemas/EmptyNextToken' - description: A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources. provisionedResources: allOf: - $ref: '#/components/schemas/ProvisionedResourceList' - description: An array of provisioned resources for a component. TagList: type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 50 UpdateServiceTemplateVersionInput: type: object required: - majorVersion - minorVersion - templateName title: UpdateServiceTemplateVersionInput properties: compatibleEnvironmentTemplates: allOf: - $ref: '#/components/schemas/CompatibleEnvironmentTemplateInputList' - description: An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates. description: allOf: - $ref: '#/components/schemas/Description' - description: A description of a service template version to update. majorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: To update a major version of a service template, includemajor Version.
minorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To update a minor version of a service template, include minorVersion.
status:
allOf:
- $ref: '#/components/schemas/TemplateVersionStatus'
- description: The status of the service template minor version to update.
supportedComponentSources:
allOf:
- $ref: '#/components/schemas/ServiceTemplateSupportedComponentSourceInputList'
- description: An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.
For more information about components, see Proton components in the Proton User Guide.
templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template. DeploymentId: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ GetRepositoryInput: type: object required: - name - provider title: GetRepositoryInput properties: name: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name, for examplemyrepos/myrepo.
provider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The repository provider.
RoleArn:
type: string
pattern: ^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$
minLength: 1
maxLength: 2048
Repository:
type: object
required:
- arn
- connectionArn
- name
- provider
properties:
arn:
allOf:
- $ref: '#/components/schemas/RepositoryArn'
- description: The Amazon Resource Name (ARN) of the linked repository.
connectionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.
encryptionKey:
allOf:
- $ref: '#/components/schemas/Arn'
- description: Your customer Amazon Web Services KMS encryption key.
name:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: The repository name.
provider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The repository provider.
description: Detailed data of a linked repository—a repository that has been registered with Proton.
ResourceName:
type: string
pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
minLength: 1
maxLength: 100
Output:
type: object
properties:
key:
allOf:
- $ref: '#/components/schemas/OutputKey'
- description: The output key.
valueString:
allOf:
- $ref: '#/components/schemas/OutputValueString'
- description: The output value.
description: An infrastructure as code defined resource output.
GetAccountSettingsOutput:
type: object
properties:
accountSettings:
allOf:
- $ref: '#/components/schemas/AccountSettings'
- description: The Proton pipeline service role detail data that's returned by Proton.
AcceptEnvironmentAccountConnectionOutput:
type: object
required:
- environmentAccountConnection
properties:
environmentAccountConnection:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnection'
- description: The environment account connection data that's returned by Proton.
NotifyResourceDeploymentStatusChangeInputStatusMessageString:
type: string
minLength: 0
maxLength: 5000
format: password
CreateEnvironmentTemplateVersionInput:
type: object
required:
- source
- templateName
title: CreateEnvironmentTemplateVersionInput
properties:
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first request created.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description of the new version of an environment template.
majorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To create a new minor version of the environment template, include major Version.
To create a new major and minor version of the environment template, exclude major Version.
An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template. ComponentSummary: type: object required: - arn - createdAt - deploymentStatus - environmentName - lastModifiedAt - name properties: arn: allOf: - $ref: '#/components/schemas/ComponentArn' - description: The Amazon Resource Name (ARN) of the component. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the component was created. deploymentStatus: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The component deployment status. deploymentStatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: The message associated with the component deployment status. environmentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the Proton environment that this component is associated with. lastDeploymentAttemptedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when a deployment of the component was last attempted. lastDeploymentSucceededAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the component was last deployed successfully. lastModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the component was last modified. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the component. serviceInstanceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service instance that this component is attached to. Provided when a component is attached to a service instance. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service thatserviceInstanceName is associated with. Provided when a component is attached to a service instance.
description: Summary data of an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.
UpdateTemplateSyncConfigInput: type: object required: - branch - repositoryName - repositoryProvider - templateName - templateType title: UpdateTemplateSyncConfigInput properties: branch: allOf: - $ref: '#/components/schemas/GitBranchName' - description: The repository branch for your template. repositoryName: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name (for example,myrepos/myrepo).
repositoryProvider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The repository provider.
subdirectory:
allOf:
- $ref: '#/components/schemas/Subdirectory'
- description: A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The synced template name.
templateType:
allOf:
- $ref: '#/components/schemas/TemplateType'
- description: The synced template type.
UpdateServiceSyncConfigInput:
type: object
required:
- branch
- filePath
- repositoryName
- repositoryProvider
- serviceName
title: UpdateServiceSyncConfigInput
properties:
branch:
allOf:
- $ref: '#/components/schemas/GitBranchName'
- description: The name of the code repository branch where the Proton Ops file is found.
filePath:
allOf:
- $ref: '#/components/schemas/OpsFilePath'
- description: The path to the Proton Ops file.
repositoryName:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: The name of the repository where the Proton Ops file is found.
repositoryProvider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The name of the repository provider where the Proton Ops file is found.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service the Proton Ops file is for.
GetEnvironmentAccountConnectionOutput:
type: object
required:
- environmentAccountConnection
properties:
environmentAccountConnection:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnection'
- description: The detailed data of the requested environment account connection.
CancelEnvironmentDeploymentOutput:
type: object
required:
- environment
properties:
environment:
allOf:
- $ref: '#/components/schemas/Environment'
- description: The environment summary data that's returned by Proton.
EnvironmentArn:
type: string
GetEnvironmentAccountConnectionInput:
type: object
required:
- id
title: GetEnvironmentAccountConnectionInput
properties:
id:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnectionId'
- description: The ID of the environment account connection that you want to get the detailed data for.
CancelServiceInstanceDeploymentInput:
type: object
required:
- serviceInstanceName
- serviceName
title: CancelServiceInstanceDeploymentInput
properties:
serviceInstanceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service instance with the deployment to cancel.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service with the service instance deployment to cancel.
GetEnvironmentTemplateVersionOutput:
type: object
required:
- environmentTemplateVersion
properties:
environmentTemplateVersion:
allOf:
- $ref: '#/components/schemas/EnvironmentTemplateVersion'
- description: The detailed data of the requested environment template version.
EnvironmentTemplate:
type: object
required:
- arn
- createdAt
- lastModifiedAt
- name
properties:
arn:
allOf:
- $ref: '#/components/schemas/EnvironmentTemplateArn'
- description: The Amazon Resource Name (ARN) of the environment template.
createdAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the environment template was created.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description of the environment template.
displayName:
allOf:
- $ref: '#/components/schemas/DisplayName'
- description: The name of the environment template as displayed in the developer interface.
encryptionKey:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The customer provided encryption key for the environment template.
lastModifiedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the environment template was last modified.
name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the environment template.
provisioning:
allOf:
- $ref: '#/components/schemas/Provisioning'
- description: When included, indicates that the environment template is for customer provisioned and managed infrastructure.
recommendedVersion:
allOf:
- $ref: '#/components/schemas/FullTemplateVersionNumber'
- description: The ID of the recommended version of the environment template.
description: The environment template data.
ListServicePipelineOutputsOutput:
type: object
required:
- outputs
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
outputs:
allOf:
- $ref: '#/components/schemas/OutputsList'
- description: An array of service pipeline Infrastructure as Code (IaC) outputs.
ServiceSyncBlockerSummary:
type: object
required:
- serviceName
properties:
latestBlockers:
allOf:
- $ref: '#/components/schemas/LatestSyncBlockers'
- description: The latest active blockers for the synced service.
serviceInstanceName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the service instance that you want sync your service configuration with.
serviceName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the service that you want to get the sync blocker summary for. If given a service instance name and a service name, it will return the blockers only applying to the instance that is blocked.
If given only a service name, it will return the blockers that apply to all of the instances. In order to get the blockers for a single instance, you will need to make two distinct calls, one to get the sync blocker summary for the service and the other to get the sync blocker for the service instance.
description:If a service instance is manually updated, Proton wants to prevent accidentally overriding a manual change.
A blocker is created because of the manual update or deletion of a service instance. The summary describes the blocker as being active or resolved.
S3Bucket: type: string pattern: ^[a-z0-9]+[a-z0-9-\.]+[a-z0-9]+$ minLength: 3 maxLength: 63 ServiceInstanceSummary: type: object required: - arn - createdAt - deploymentStatus - environmentName - lastDeploymentAttemptedAt - lastDeploymentSucceededAt - name - serviceName - templateMajorVersion - templateMinorVersion - templateName properties: arn: allOf: - $ref: '#/components/schemas/ServiceInstanceArn' - description: The Amazon Resource Name (ARN) of the service instance. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the service instance was created. deploymentStatus: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The service instance deployment status. deploymentStatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: A service instance deployment status message. environmentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment that the service instance was deployed into. lastDeploymentAttemptedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when a deployment of the service was last attempted. lastDeploymentSucceededAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the service was last deployed successfully. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service instance. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service that the service instance belongs to. templateMajorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The service instance template major version. templateMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The service instance template minor version. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template. description: Summary data of an Proton service instance resource. S3Key: type: string minLength: 1 maxLength: 1024 Environment: type: object required: - arn - createdAt - deploymentStatus - lastDeploymentAttemptedAt - lastDeploymentSucceededAt - name - templateMajorVersion - templateMinorVersion - templateName properties: arn: allOf: - $ref: '#/components/schemas/EnvironmentArn' - description: The Amazon Resource Name (ARN) of the environment. codebuildRoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf. componentRoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description:The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide.
createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment was created. deploymentStatus: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The environment deployment status. deploymentStatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: An environment deployment status message. description: allOf: - $ref: '#/components/schemas/Description' - description: The description of the environment. environmentAccountConnectionId: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionId' - description: The ID of the environment account connection that's used to provision infrastructure resources in an environment account. environmentAccountId: allOf: - $ref: '#/components/schemas/AwsAccountId' - description: The ID of the environment account that the environment infrastructure resources are provisioned in. lastDeploymentAttemptedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when a deployment of the environment was last attempted. lastDeploymentSucceededAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment was last deployed successfully. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment. protonServiceRoleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf. provisioning: allOf: - $ref: '#/components/schemas/Provisioning' - description: When included, indicates that the environment template is for customer provisioned and managed infrastructure. provisioningRepository: allOf: - $ref: '#/components/schemas/RepositoryBranch' - description: The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository. spec: allOf: - $ref: '#/components/schemas/SpecContents' - description: The environment spec. templateMajorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The major version of the environment template. templateMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The minor version of the environment template. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The Amazon Resource Name (ARN) of the environment template. description: Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services. RepositorySummaryList: type: array items: $ref: '#/components/schemas/RepositorySummary' EnvironmentSummaryList: type: array items: $ref: '#/components/schemas/EnvironmentSummary' ListTagsForResourceInput: type: object required: - resourceArn title: ListTagsForResourceInput properties: maxResults: allOf: - $ref: '#/components/schemas/MaxPageResults' - description: The maximum number of tags to list. nextToken: allOf: - $ref: '#/components/schemas/String' - description: A token that indicates the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested. resourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the resource for the listed tags. DeleteEnvironmentTemplateVersionInput: type: object required: - majorVersion - minorVersion - templateName title: DeleteEnvironmentTemplateVersionInput properties: majorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The environment template major version to delete. minorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The environment template minor version to delete. templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template. RepositoryId: type: string minLength: 1 maxLength: 200 GetEnvironmentTemplateOutput: type: object required: - environmentTemplate properties: environmentTemplate: allOf: - $ref: '#/components/schemas/EnvironmentTemplate' - description: The detailed data of the requested environment template. GetServiceSyncBlockerSummaryOutput: type: object properties: serviceSyncBlockerSummary: allOf: - $ref: '#/components/schemas/ServiceSyncBlockerSummary' - description: The detailed data of the requested service sync blocker summary. ListTagsForResourceOutput: type: object required: - tags properties: nextToken: allOf: - $ref: '#/components/schemas/String' - description: A token that indicates the location of the next resource tag in the array of resource tags, after the current requested list of resource tags. tags: allOf: - $ref: '#/components/schemas/TagList' - description: A list of resource tags with detail data. ListEnvironmentsOutput: type: object required: - environments properties: environments: allOf: - $ref: '#/components/schemas/EnvironmentSummaryList' - description: An array of environment detail data summaries. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates the location of the next environment in the array of environments, after the current requested list of environments. GetServiceTemplateVersionInput: type: object required: - majorVersion - minorVersion - templateName title: GetServiceTemplateVersionInput properties: majorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: To get service template major version detail data, includemajor Version.
minorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To get service template minor version detail data, include minorVersion.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service template a version of which you want to get detailed data for.
OutputValueString:
type: string
minLength: 1
maxLength: 1024
Boolean:
type: boolean
UntagResourceOutput:
type: object
properties: {}
DeleteTemplateSyncConfigInput:
type: object
required:
- templateName
- templateType
title: DeleteTemplateSyncConfigInput
properties:
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The template name.
templateType:
allOf:
- $ref: '#/components/schemas/TemplateType'
- description: The template type.
UpdateServiceInstanceInput:
type: object
required:
- deploymentType
- name
- serviceName
title: UpdateServiceInstanceInput
properties:
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: The client token of the service instance to update.
deploymentType:
allOf:
- $ref: '#/components/schemas/DeploymentUpdateType'
- description: The deployment type. It defines the mode for updating a service instance, as follows:
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.
MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
A value to filter by.
With the date/time keys (*At{Before,After}), the value is a valid RFC 3339 string with no UTC offset and with an optional fractional precision (for example, 1985-04-12T23:20:50.52Z).
serviceInstanceName is associated to.
ServiceSummary:
type: object
required:
- arn
- createdAt
- lastModifiedAt
- name
- status
- templateName
properties:
arn:
allOf:
- $ref: '#/components/schemas/ServiceArn'
- description: The Amazon Resource Name (ARN) of the service.
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.
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: Summary data of an Proton service resource.
EnvironmentAccountConnectionId:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
ListEnvironmentTemplateVersionsInput:
type: object
required:
- templateName
title: ListEnvironmentTemplateVersionsInput
properties:
majorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To view a list of minor of versions under a major version of an environment template, include major Version.
To view a list of major versions of an environment template, exclude major Version.
The field that the result list is sorted by.
When you choose to sort by serviceName, service instances within each service are sorted by service instance name.
Default: serviceName
Result list sort order.
Default: ASCENDING
pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
recommendedVersion:
allOf:
- $ref: '#/components/schemas/FullTemplateVersionNumber'
- description: The recommended version of the service template.
description: Detailed data of an Proton service template resource.
ListEnvironmentTemplateVersionsOutput:
type: object
required:
- templateVersions
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
templateVersions:
allOf:
- $ref: '#/components/schemas/EnvironmentTemplateVersionSummaryList'
- description: An array of major or minor versions of an environment template detail data.
ListComponentsInput:
type: object
title: ListComponentsInput
properties:
environmentName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
maxResults:
allOf:
- $ref: '#/components/schemas/MaxPageResults'
- description: The maximum number of components to list.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
serviceInstanceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of a service for result list filtering. Proton returns components attached to service instances of the service.
ServiceInstanceSummaryList:
type: array
items:
$ref: '#/components/schemas/ServiceInstanceSummary'
RepositorySyncEvents:
type: array
items:
$ref: '#/components/schemas/RepositorySyncEvent'
ListEnvironmentTemplatesInput:
type: object
title: ListEnvironmentTemplatesInput
properties:
maxResults:
allOf:
- $ref: '#/components/schemas/MaxPageResults'
- description: The maximum number of environment templates to list.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A token that indicates the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.
DeleteServiceTemplateVersionOutput:
type: object
properties:
serviceTemplateVersion:
allOf:
- $ref: '#/components/schemas/ServiceTemplateVersion'
- description: The detailed data of the service template version being deleted.
ListRepositorySyncDefinitionsOutput:
type: object
required:
- syncDefinitions
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.
syncDefinitions:
allOf:
- $ref: '#/components/schemas/RepositorySyncDefinitionList'
- description: An array of repository sync definitions.
SHA:
type: string
minLength: 1
maxLength: 255
ProvisionedResource:
type: object
properties:
identifier:
allOf:
- $ref: '#/components/schemas/ProvisionedResourceIdentifier'
- description: The provisioned resource identifier.
name:
allOf:
- $ref: '#/components/schemas/ProvisionedResourceName'
- description: The provisioned resource name.
provisioningEngine:
allOf:
- $ref: '#/components/schemas/ProvisionedResourceEngine'
- description: The resource provisioning engine. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide.
description: Detail data for a provisioned resource. UpdateEnvironmentInput: type: object required: - deploymentType - name title: UpdateEnvironmentInput properties: codebuildRoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf. componentRoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description:The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide.
deploymentType: allOf: - $ref: '#/components/schemas/DeploymentUpdateType' - description:There are four modes for updating an environment. The deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
The ID of the environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment to update. protonServiceRoleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf. provisioningRepository: allOf: - $ref: '#/components/schemas/RepositoryBranchInput' - description: The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository. spec: allOf: - $ref: '#/components/schemas/SpecContents' - description: The formatted specification that defines the update. templateMajorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The major version of the environment to update. templateMinorVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The minor version of the environment to update. GetResourcesSummaryOutput: type: object required: - counts properties: counts: allOf: - $ref: '#/components/schemas/CountsSummary' - description: Summary counts of each Proton resource type. UpdateEnvironmentAccountConnectionOutput: type: object required: - environmentAccountConnection properties: environmentAccountConnection: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnection' - description: The environment account connection detail data that's returned by Proton. ResourceSyncAttempt: type: object required: - events - initialRevision - startedAt - status - target - targetRevision properties: events: allOf: - $ref: '#/components/schemas/ResourceSyncEvents' - description: An array of events with detail data. initialRevision: allOf: - $ref: '#/components/schemas/Revision' - description: Detail data for the initial repository commit, path and push. startedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the sync attempt started. status: allOf: - $ref: '#/components/schemas/ResourceSyncStatus' - description: The status of the sync attempt. target: allOf: - $ref: '#/components/schemas/String' - description: The resource that is synced to. targetRevision: allOf: - $ref: '#/components/schemas/Revision' - description: Detail data for the target revision. description: Detail data for a resource sync attempt activated by a push to a repository. UpdateComponentInput: type: object required: - deploymentType - name title: UpdateComponentInput properties: clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: The client token for the updated component. deploymentType: allOf: - $ref: '#/components/schemas/ComponentDeploymentUpdateType' - description:The deployment type. It defines the mode for updating a component, as follows:
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.
CURRENT_VERSION
In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.
serviceInstanceName and serviceName or for neither of them.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceNameOrEmpty'
- description: The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.
serviceSpec:
allOf:
- $ref: '#/components/schemas/SpecContents'
- description: The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.
templateFile:
allOf:
- $ref: '#/components/schemas/TemplateFileContents'
- description: A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Components support a single IaC file, even if you use Terraform as your template language.
TEMPLATE_SYNC.
GetEnvironmentTemplateVersionInput:
type: object
required:
- majorVersion
- minorVersion
- templateName
title: GetEnvironmentTemplateVersionInput
properties:
majorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To get environment template major version detail data, include major Version.
minorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: To get environment template minor version detail data, include minorVersion.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the environment template a version of which you want to get detailed data for.
Timestamp:
type: string
format: date-time
RepositorySyncStatus:
type: string
enum:
- INITIATED
- IN_PROGRESS
- SUCCEEDED
- FAILED
- QUEUED
ListServicePipelineOutputsInput:
type: object
required:
- serviceName
title: ListServicePipelineOutputsInput
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service whose pipeline's outputs you want.
GetResourcesSummaryInput:
type: object
title: GetResourcesSummaryInput
properties: {}
GetComponentOutput:
type: object
properties:
component:
allOf:
- $ref: '#/components/schemas/Component'
- description: The detailed data of the requested component.
TagResourceInput:
type: object
required:
- resourceArn
- tags
title: TagResourceInput
properties:
resourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of customer tags to apply to the Proton resource.
Revision:
type: object
required:
- branch
- directory
- repositoryName
- repositoryProvider
- sha
properties:
branch:
allOf:
- $ref: '#/components/schemas/GitBranchName'
- description: The repository branch.
directory:
allOf:
- $ref: '#/components/schemas/String'
- description: The repository directory changed by a commit and push that activated the sync attempt.
repositoryName:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: The repository name.
repositoryProvider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The repository provider.
sha:
allOf:
- $ref: '#/components/schemas/SHA'
- description: The secure hash algorithm (SHA) hash for the revision.
description: Revision detail data for a commit and push that activates a sync attempt
ListServiceInstanceProvisionedResourcesOutput:
type: object
required:
- provisionedResources
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
provisionedResources:
allOf:
- $ref: '#/components/schemas/ProvisionedResourceList'
- description: An array of provisioned resources for a service instance.
ConflictException: {}
ListServiceTemplatesOutput:
type: object
required:
- templates
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A token that indicates the location of the next service template in the array of service templates, after the current requested list of service templates.
templates:
allOf:
- $ref: '#/components/schemas/ServiceTemplateSummaryList'
- description: An array of service templates with detail data.
EnvironmentTemplateVersionSummaryList:
type: array
items:
$ref: '#/components/schemas/EnvironmentTemplateVersionSummary'
UpdateEnvironmentTemplateInput:
type: object
required:
- name
title: UpdateEnvironmentTemplateInput
properties:
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description of the environment template update.
displayName:
allOf:
- $ref: '#/components/schemas/DisplayName'
- description: The name of the environment template to update as displayed in the developer interface.
name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the environment template to update.
EnvironmentTemplateFilter:
type: object
required:
- majorVersion
- templateName
properties:
majorVersion:
allOf:
- $ref: '#/components/schemas/TemplateVersionPart'
- description: Include majorVersion to filter search for a major version.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: Include templateName to filter search for a template name.
description: A search filter for environment templates.
NotifyResourceDeploymentStatusChangeInput:
type: object
required:
- resourceArn
title: NotifyResourceDeploymentStatusChangeInput
properties:
deploymentId:
allOf:
- $ref: '#/components/schemas/DeploymentId'
- description: The deployment ID for your provisioned resource.
outputs:
allOf:
- $ref: '#/components/schemas/NotifyResourceDeploymentStatusChangeInputOutputsList'
- description: The provisioned resource state change detail data that's returned by Proton.
resourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The provisioned resource Amazon Resource Name (ARN).
status:
allOf:
- $ref: '#/components/schemas/ResourceDeploymentStatus'
- description: The status of your provisioned resource.
statusMessage:
allOf:
- $ref: '#/components/schemas/NotifyResourceDeploymentStatusChangeInputStatusMessageString'
- description: The deployment status message for your provisioned resource.
TemplateVersionStatus:
type: string
enum:
- REGISTRATION_IN_PROGRESS
- REGISTRATION_FAILED
- DRAFT
- PUBLISHED
Provisioning:
type: string
enum:
- CUSTOMER_MANAGED
DeploymentStatus:
type: string
enum:
- IN_PROGRESS
- FAILED
- SUCCEEDED
- DELETE_IN_PROGRESS
- DELETE_FAILED
- DELETE_COMPLETE
- CANCELLING
- CANCELLED
AcceptEnvironmentAccountConnectionInput:
type: object
required:
- id
title: AcceptEnvironmentAccountConnectionInput
properties:
id:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnectionId'
- description: The ID of the environment account connection.
ListServicePipelineProvisionedResourcesInput:
type: object
required:
- serviceName
title: ListServicePipelineProvisionedResourcesInput
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/EmptyNextToken'
- description: A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
serviceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the service whose pipeline's provisioned resources you want.
ComponentDeploymentUpdateType:
type: string
enum:
- NONE
- CURRENT_VERSION
EnvironmentAccountConnectionRequesterAccountType:
type: string
enum:
- MANAGEMENT_ACCOUNT
- ENVIRONMENT_ACCOUNT
TemplateManifestContents:
type: string
minLength: 1
maxLength: 1024
format: password
CreateServiceOutput:
type: object
required:
- service
properties:
service:
allOf:
- $ref: '#/components/schemas/Service'
- description: The service detail data that's returned by Proton.
ThrottlingException: {}
NotifyResourceDeploymentStatusChangeOutput:
type: object
properties: {}
UpdateEnvironmentAccountConnectionInput:
type: object
required:
- id
title: UpdateEnvironmentAccountConnectionInput
properties:
codebuildRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
componentRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide.
id: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionId' - description: The ID of the environment account connection to update. roleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update. GetTemplateSyncStatusInput: type: object required: - templateName - templateType - templateVersion title: GetTemplateSyncStatusInput properties: templateName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The template name. templateType: allOf: - $ref: '#/components/schemas/TemplateType' - description: The template type. templateVersion: allOf: - $ref: '#/components/schemas/TemplateVersionPart' - description: The template major version. GetEnvironmentInput: type: object required: - name title: GetEnvironmentInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment that you want to get the detailed data for. GetServiceInput: type: object required: - name title: GetServiceInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service that you want to get the detailed data for. ListServiceInstanceOutputsInput: type: object required: - serviceInstanceName - serviceName title: ListServiceInstanceOutputsInput properties: nextToken: allOf: - $ref: '#/components/schemas/EmptyNextToken' - description: A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested. serviceInstanceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service instance whose outputs you want. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service thatserviceInstanceName is associated to.
ResourceDeploymentStatus:
type: string
enum:
- IN_PROGRESS
- FAILED
- SUCCEEDED
description: The state that a PR-based deployment can be updated to.
ListEnvironmentAccountConnectionsInput:
type: object
required:
- requestedBy
title: ListEnvironmentAccountConnectionsInput
properties:
environmentName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The environment name that's associated with each listed environment account connection.
maxResults:
allOf:
- $ref: '#/components/schemas/MaxPageResults'
- description: The maximum number of environment account connections to list.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
requestedBy:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnectionRequesterAccountType'
- description: The type of account making the ListEnvironmentAccountConnections request.
statuses:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnectionStatusList'
- description: The status details for each listed environment account connection.
CreateEnvironmentAccountConnectionInput:
type: object
required:
- environmentName
- managementAccountId
title: CreateEnvironmentAccountConnectionInput
properties:
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
codebuildRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
componentRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.
For more information about components, see Proton components in the Proton User Guide.
environmentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the Proton environment that's created in the associated management account. managementAccountId: allOf: - $ref: '#/components/schemas/AwsAccountId' - description: The ID of the management account that accepts or rejects the environment account connection. You create and manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account. roleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account. tags: allOf: - $ref: '#/components/schemas/TagList' - description:An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
OutputsList: type: array items: $ref: '#/components/schemas/Output' ProvisionedResourceName: type: string minLength: 1 maxLength: 200 RepositorySyncEvent: type: object required: - event - time - type properties: event: allOf: - $ref: '#/components/schemas/String' - description: Event detail for a repository sync attempt. externalId: allOf: - $ref: '#/components/schemas/String' - description: The external ID of the sync event. time: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time that the sync event occurred. type: allOf: - $ref: '#/components/schemas/String' - description: The type of event. description: Repository sync event detail data for a sync attempt. EnvironmentAccountConnectionStatus: type: string enum: - PENDING - CONNECTED - REJECTED RepositorySyncAttempt: type: object required: - events - startedAt - status properties: events: allOf: - $ref: '#/components/schemas/RepositorySyncEvents' - description: Detail data for sync attempt events. startedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the sync attempt started. status: allOf: - $ref: '#/components/schemas/RepositorySyncStatus' - description: The sync attempt status. description: Detail data for a repository sync attempt activated by a push to a repository. Description: type: string minLength: 0 maxLength: 500 format: password ListServiceTemplateVersionsOutput: type: object required: - templateVersions properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions. templateVersions: allOf: - $ref: '#/components/schemas/ServiceTemplateVersionSummaryList' - description: An array of major or minor versions of a service template with detail data. RepositoryBranchInput: type: object required: - branch - name - provider properties: branch: allOf: - $ref: '#/components/schemas/GitBranchName' - description: The repository branch. name: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name. provider: allOf: - $ref: '#/components/schemas/RepositoryProvider' - description: The repository provider. description: Detail input data for a linked repository branch. UpdateServiceOutput: type: object required: - service properties: service: allOf: - $ref: '#/components/schemas/Service' - description: The service detail data that's returned by Proton. SyncBlocker: type: object required: - createdAt - createdReason - id - status - type properties: contexts: allOf: - $ref: '#/components/schemas/SyncBlockerContexts' - description: The contexts for the sync blocker. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the sync blocker was created. createdReason: allOf: - $ref: '#/components/schemas/String' - description: The reason why the sync blocker was created. id: allOf: - $ref: '#/components/schemas/String' - description: The ID of the sync blocker. resolvedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the sync blocker was resolved. resolvedReason: allOf: - $ref: '#/components/schemas/String' - description: The reason the sync blocker was resolved. status: allOf: - $ref: '#/components/schemas/BlockerStatus' - description: The status of the sync blocker. type: allOf: - $ref: '#/components/schemas/BlockerType' - description: The type of the sync blocker. description: Detailed data of the sync blocker. GetRepositorySyncStatusInput: type: object required: - branch - repositoryName - repositoryProvider - syncType title: GetRepositorySyncStatusInput properties: branch: allOf: - $ref: '#/components/schemas/GitBranchName' - description: The repository branch. repositoryName: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name. repositoryProvider: allOf: - $ref: '#/components/schemas/RepositoryProvider' - description: The repository provider. syncType: allOf: - $ref: '#/components/schemas/SyncType' - description: The repository sync type. CreateServiceInstanceOutput: type: object required: - serviceInstance properties: serviceInstance: allOf: - $ref: '#/components/schemas/ServiceInstance' - description: The detailed data of the service instance being created. GetEnvironmentTemplateInput: type: object required: - name title: GetEnvironmentTemplateInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template that you want to get the detailed data for. GetTemplateSyncConfigOutput: type: object properties: templateSyncConfig: allOf: - $ref: '#/components/schemas/TemplateSyncConfig' - description: The template sync configuration detail data that's returned by Proton. ListRepositoriesInput: type: object title: ListRepositoriesInput properties: maxResults: allOf: - $ref: '#/components/schemas/MaxPageResults' - description: The maximum number of repositories to list. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested. NextToken: type: string pattern: ^[A-Za-z0-9+=/]+$ SyncBlockerContext: type: object required: - key - value properties: key: allOf: - $ref: '#/components/schemas/String' - description: The key for the sync blocker context. value: allOf: - $ref: '#/components/schemas/String' - description: The value of the sync blocker context. description: Detailed data of the context of the sync blocker. ListEnvironmentOutputsOutput: type: object required: - outputs properties: nextToken: allOf: - $ref: '#/components/schemas/EmptyNextToken' - description: A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs. outputs: allOf: - $ref: '#/components/schemas/OutputsList' - description: An array of environment outputs with detail data. EnvironmentTemplateSummaryList: type: array items: $ref: '#/components/schemas/EnvironmentTemplateSummary' DeleteEnvironmentOutput: type: object properties: environment: allOf: - $ref: '#/components/schemas/Environment' - description: The detailed data of the environment being deleted. ListRepositoriesOutput: type: object required: - repositories properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories. ' repositories: allOf: - $ref: '#/components/schemas/RepositorySummaryList' - description: An array of repository links. TemplateType: type: string enum: - ENVIRONMENT - SERVICE GetServiceTemplateOutput: type: object required: - serviceTemplate properties: serviceTemplate: allOf: - $ref: '#/components/schemas/ServiceTemplate' - description: The detailed data of the requested service template. UpdateServiceTemplateOutput: type: object required: - serviceTemplate properties: serviceTemplate: allOf: - $ref: '#/components/schemas/ServiceTemplate' - description: The service template detail data that's returned by Proton. CreateComponentOutput: type: object required: - component properties: component: allOf: - $ref: '#/components/schemas/Component' - description: The detailed data of the created component. ServiceArn: type: string RepositoryArn: type: string CreateTemplateSyncConfigOutput: type: object properties: templateSyncConfig: allOf: - $ref: '#/components/schemas/TemplateSyncConfig' - description: The template sync configuration detail data that's returned by Proton. GetServiceTemplateInput: type: object required: - name title: GetServiceTemplateInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service template that you want to get detailed data for. DeleteServiceTemplateOutput: type: object properties: serviceTemplate: allOf: - $ref: '#/components/schemas/ServiceTemplate' - description: The detailed data of the service template being deleted. CreateRepositoryOutput: type: object required: - repository properties: repository: allOf: - $ref: '#/components/schemas/Repository' - description: The repository link's detail data that's returned by Proton. GetServiceInstanceInput: type: object required: - name - serviceName title: GetServiceInstanceInput properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of a service instance that you want to get the detailed data for. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service that you want the service instance input for. ListEnvironmentTemplatesOutput: type: object required: - templates properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates the location of the next environment template in the array of environment templates, after the current requested list of environment templates. templates: allOf: - $ref: '#/components/schemas/EnvironmentTemplateSummaryList' - description: An array of environment templates with detail data. CancelServiceInstanceDeploymentOutput: type: object required: - serviceInstance properties: serviceInstance: allOf: - $ref: '#/components/schemas/ServiceInstance' - description: The service instance summary data that's returned by Proton. CreateEnvironmentTemplateInput: type: object required: - name title: CreateEnvironmentTemplateInput properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the environment template. displayName: allOf: - $ref: '#/components/schemas/DisplayName' - description: The environment template name as displayed in the developer interface. encryptionKey: allOf: - $ref: '#/components/schemas/Arn' - description: A customer provided encryption key that Proton uses to encrypt data. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment template. provisioning: allOf: - $ref: '#/components/schemas/Provisioning' - description: When included, indicates that the environment template is for customer provisioned and managed infrastructure. tags: allOf: - $ref: '#/components/schemas/TagList' - description:An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
GetRepositoryOutput: type: object required: - repository properties: repository: allOf: - $ref: '#/components/schemas/Repository' - description: The repository link's detail data that's returned by Proton. CreateEnvironmentOutput: type: object required: - environment properties: environment: allOf: - $ref: '#/components/schemas/Environment' - description: The environment detail data that's returned by Proton. EnvironmentAccountConnection: type: object required: - arn - environmentAccountId - environmentName - id - lastModifiedAt - managementAccountId - requestedAt - roleArn - status properties: arn: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionArn' - description: The Amazon Resource Name (ARN) of the environment account connection. codebuildRoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account. componentRoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description:The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide.
environmentAccountId: allOf: - $ref: '#/components/schemas/AwsAccountId' - description: The environment account that's connected to the environment account connection. environmentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment that's associated with the environment account connection. id: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionId' - description: The ID of the environment account connection. lastModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment account connection was last modified. managementAccountId: allOf: - $ref: '#/components/schemas/AwsAccountId' - description: The ID of the management account that's connected to the environment account connection. requestedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment account connection request was made. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The IAM service role that's associated with the environment account connection. status: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionStatus' - description: The status of the environment account connection. description: Detailed data of an Proton environment account connection resource. TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 50 StatusMessage: type: string format: password ListServicesOutput: type: object required: - services properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates the location of the next service in the array of services, after the current requested list of services. services: allOf: - $ref: '#/components/schemas/ServiceSummaryList' - description: An array of services with summaries of detail data. CreateServiceSyncConfigInput: type: object required: - branch - filePath - repositoryName - repositoryProvider - serviceName title: CreateServiceSyncConfigInput properties: branch: allOf: - $ref: '#/components/schemas/GitBranchName' - description: The repository branch for your Proton Ops file. filePath: allOf: - $ref: '#/components/schemas/OpsFilePath' - description: The path to the Proton Ops file. repositoryName: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name. repositoryProvider: allOf: - $ref: '#/components/schemas/RepositoryProvider' - description: The provider type for your repository. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service the Proton Ops file is for. BlockerStatus: type: string enum: - ACTIVE - RESOLVED TagKey: type: string minLength: 1 maxLength: 128 CreateServiceSyncConfigOutput: type: object properties: serviceSyncConfig: allOf: - $ref: '#/components/schemas/ServiceSyncConfig' - description: The detailed data of the Proton Ops file. CancelComponentDeploymentOutput: type: object required: - component properties: component: allOf: - $ref: '#/components/schemas/Component' - description: The detailed data of the component with the deployment that is being canceled. Component: type: object required: - arn - createdAt - deploymentStatus - environmentName - lastModifiedAt - name properties: arn: allOf: - $ref: '#/components/schemas/ComponentArn' - description: The Amazon Resource Name (ARN) of the component. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the component was created. deploymentStatus: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The component deployment status. deploymentStatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: The message associated with the component deployment status. description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the component. environmentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the Proton environment that this component is associated with. lastClientRequestToken: allOf: - $ref: '#/components/schemas/String' - description: The last token the client requested. lastDeploymentAttemptedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when a deployment of the component was last attempted. lastDeploymentSucceededAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the component was last deployed successfully. lastModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the component was last modified. name: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the component. serviceInstanceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service instance that this component is attached to. Provided when a component is attached to a service instance. serviceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service thatserviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec:
allOf:
- $ref: '#/components/schemas/SpecContents'
- description: The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
description: Detailed data of an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.
Subdirectory: type: string minLength: 1 maxLength: 4096 TemplateVersionPart: type: string pattern: ^(0|([1-9]{1}\d*))$ minLength: 1 maxLength: 20 OutputKey: type: string minLength: 1 maxLength: 1024 CreateTemplateSyncConfigInput: type: object required: - branch - repositoryName - repositoryProvider - templateName - templateType title: CreateTemplateSyncConfigInput properties: branch: allOf: - $ref: '#/components/schemas/GitBranchName' - description: The repository branch for your template. repositoryName: allOf: - $ref: '#/components/schemas/RepositoryName' - description: The repository name (for example,myrepos/myrepo).
repositoryProvider:
allOf:
- $ref: '#/components/schemas/RepositoryProvider'
- description: The provider type for your repository.
subdirectory:
allOf:
- $ref: '#/components/schemas/Subdirectory'
- description: A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.
templateName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of your registered template.
templateType:
allOf:
- $ref: '#/components/schemas/TemplateType'
- description: The type of the registered template.
SyncBlockerContexts:
type: array
items:
$ref: '#/components/schemas/SyncBlockerContext'
EnvironmentTemplateFilterList:
type: array
items:
$ref: '#/components/schemas/EnvironmentTemplateFilter'
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
EnvironmentAccountConnectionSummary:
type: object
required:
- arn
- environmentAccountId
- environmentName
- id
- lastModifiedAt
- managementAccountId
- requestedAt
- roleArn
- status
properties:
arn:
allOf:
- $ref: '#/components/schemas/EnvironmentAccountConnectionArn'
- description: The Amazon Resource Name (ARN) of the environment account connection.
componentRoleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide.
environmentAccountId: allOf: - $ref: '#/components/schemas/AwsAccountId' - description: The ID of the environment account that's connected to the environment account connection. environmentName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the environment that's associated with the environment account connection. id: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionId' - description: The ID of the environment account connection. lastModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment account connection was last modified. managementAccountId: allOf: - $ref: '#/components/schemas/AwsAccountId' - description: The ID of the management account that's connected to the environment account connection. requestedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the environment account connection request was made. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The IAM service role that's associated with the environment account connection. status: allOf: - $ref: '#/components/schemas/EnvironmentAccountConnectionStatus' - description: The status of the environment account connection. description: Summary data of an Proton environment account connection resource. UpdateEnvironmentTemplateVersionOutput: type: object required: - environmentTemplateVersion properties: environmentTemplateVersion: allOf: - $ref: '#/components/schemas/EnvironmentTemplateVersion' - description: The environment template version detail data that's returned by Proton. parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 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 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