"documentation":"<p>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.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>",
"documentation":"<p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-update.html\">Update an environment</a> in the <i>Proton Administrator guide</i>.</p> <p>The following list includes potential cancellation scenarios.</p> <ul> <li> <p>If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>.</p> </li> <li> <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p> </li> <li> <p>If the current <a>UpdateEnvironment</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p> </li> </ul>"
"documentation":"<p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see <i>Update a service instance</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html\">Proton Administrator guide</a> or the <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html\">Proton User guide</a>.</p> <p>The following list includes potential cancellation scenarios.</p> <ul> <li> <p>If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>.</p> </li> <li> <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p> </li> <li> <p>If the current <a>UpdateServiceInstance</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p> </li> </ul>"
"documentation":"<p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see <i>Update a service pipeline</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html\">Proton Administrator guide</a> or the <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html\">Proton User guide</a>.</p> <p>The following list includes potential cancellation scenarios.</p> <ul> <li> <p>If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>.</p> </li> <li> <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p> </li> <li> <p>If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p> </li> </ul>"
"documentation":"<p>Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.</p> <p class=\"title\"> <b>You can provision environments using the following methods:</b> </p> <ul> <li> <p>Standard provisioning: Proton makes direct calls to provision your resources.</p> </li> <li> <p>Pull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.</p> </li> </ul> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html\">Environments</a> in the <i>Proton Administrator Guide.</i> </p>",
"documentation":"<p>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.</p> <p>An environment account connection is a secure bi-directional connection between a <i>management account</i> and an <i>environment account</i> that maintains authorization and permissions. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>",
"documentation":"<p>Create an environment template for Proton. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-templates.html\">Environment Templates</a> in the <i>Proton Administrator Guide</i>.</p> <p>You can create an environment template in one of the two following ways:</p> <ul> <li> <p>Register and publish a <i>standard</i> environment template that instructs Proton to deploy and manage environment infrastructure.</p> </li> <li> <p>Register and publish a <i>customer managed</i> environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the <code>provisioning</code> parameter and set the value to <code>CUSTOMER_MANAGED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/template-create.html\">Register and publish an environment template</a> in the <i>Proton Administrator Guide</i>.</p> </li> </ul>",
"documentation":"<p>Create a new major or minor version of an environment template. A major version of an environment template is a version that <i>isn't</i> backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.</p>",
"documentation":"<p>Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html\">Template bundles</a> and <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html\">Template sync configurations</a> in the <i>Proton Administrator Guide</i>.</p>",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-services.html\">Services</a> in the <i>Proton Administrator Guide</i> and <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html\">Services</a> in the <i>Proton User Guide</i>.</p>",
"documentation":"<p>Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD 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 <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/managing-svc-templates.html\">Service Templates</a> in the <i>Proton Administrator Guide</i>.</p>",
"documentation":"<p>Create a new major or minor version of a service template. A major version of a service template is a version that <i>isn't</i> backward compatible. A minor version of a service template is a version that's backward compatible within its major version.</p>",
"documentation":"<p>Set up a template for automated template version creation. When a commit is pushed to your registered <a href=\"https://docs.aws.amazon.com/proton/latest/APIReference/API_Repository.html\">repository</a>, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html\">Template sync configurations</a> in the <i>Proton Administrator Guide</i>.</p>",
"documentation":"<p>In an environment account, delete an environment account connection.</p> <p>After you delete an environment account connection that’s in use by an Proton environment, Proton <i>can’t</i> 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.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>",
"documentation":"<p>If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the <code>Recommended</code> version. Delete the <code>Recommended</code> 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.</p> <p>Delete a minor version of an environment template if it <i>isn't</i> the <code>Recommended</code> version. Delete a <code>Recommended</code> 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.</p>",
"idempotent":true
},
"DeleteRepository":{
"name":"DeleteRepository",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRepositoryInput"},
"output":{"shape":"DeleteRepositoryOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>De-register and unlink your repository.</p>",
"documentation":"<p>If no other minor versions of a service template exist, delete a major version of the service template if it's not the <code>Recommended</code> version. Delete the <code>Recommended</code> 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 <i>isn't</i> backwards compatible.</p> <p>Delete a minor version of a service template if it's not the <code>Recommended</code> version. Delete a <code>Recommended</code> 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.</p>",
"documentation":"<p>In an environment account, view the detail data for an environment account connection.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>"
"documentation":"<p>Get detail data for a service.</p>"
},
"GetServiceInstance":{
"name":"GetServiceInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetServiceInstanceInput"},
"output":{"shape":"GetServiceInstanceOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.</p>"
},
"GetServiceTemplate":{
"name":"GetServiceTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetServiceTemplateInput"},
"output":{"shape":"GetServiceTemplateOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Get detail data for a service template.</p>"
"documentation":"<p>View a list of environment account connections.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>"
"documentation":"<p>List tags for a resource. For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>"
"documentation":"<p>Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html\">Template bundles</a>.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>In a management account, reject an environment account connection from another environment account.</p> <p>After you reject an environment account connection request, you <i>won’t</i> be able to accept or use the rejected environment account connection.</p> <p>You <i>can’t</i> reject an environment account connection that is connected to an environment.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>",
"documentation":"<p>Tag a resource. For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>",
"documentation":"<p>Remove a tag from a resource. For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>",
"documentation":"<p>Update an environment.</p> <p>If the environment is associated with an environment account connection, <i>don't</i> update or include the <code>protonServiceRoleArn</code> and <code>provisioningRepository</code> parameter to update or connect to an environment account connection.</p> <p>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.</p> <p>If the environment <i>isn't</i> associated with an environment account connection, <i>don't</i> update or include the <code>environmentAccountConnectionId</code> parameter to update or connect to an environment account connection.</p> <p>You can update either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value. You can’t update both.</p> <p>If the environment was provisioned with pull request provisioning, include the <code>provisioningRepository</code> parameter and omit the <code>protonServiceRoleArn</code> and <code>environmentAccountConnectionId</code> parameters.</p> <p>If the environment wasn't provisioned with pull request provisioning, omit the <code>provisioningRepository</code> parameter.</p> <p>There are four modes for updating an environment as described in the following. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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 (optional).</p> </dd> </dl>"
"documentation":"<p>In an environment account, update an environment account connection to use a new IAM role.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>",
"documentation":"<p>Update a major or minor version of an environment template.</p>"
},
"UpdateService":{
"name":"UpdateService",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateServiceInput"},
"output":{"shape":"UpdateServiceOutput"},
"errors":[
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Edit a service description or use a spec to add and delete service instances.</p> <note> <p>Existing service instances and the service pipeline <i>can't</i> be edited using this API. They can only be deleted.</p> </note> <p>Use the <code>description</code> parameter to modify the description.</p> <p>Edit the <code>spec</code> parameter to add or delete instances.</p>"
},
"UpdateServiceInstance":{
"name":"UpdateServiceInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateServiceInstanceInput"},
"output":{"shape":"UpdateServiceInstanceOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Update a service instance.</p> <p>There are four modes for updating a service instance as described in the following. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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 also specify a different major version that is higher than the major version in use and a minor version (optional).</p> </dd> </dl>"
},
"UpdateServicePipeline":{
"name":"UpdateServicePipeline",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateServicePipelineInput"},
"output":{"shape":"UpdateServicePipelineOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Update the service pipeline.</p> <p>There are four modes for updating a service pipeline as described in the following. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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 also specify a different minor version of the current major version in use.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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 also specify a different major version that is higher than the major version in use and a minor version (optional).</p> </dd> </dl>"
},
"UpdateServiceTemplate":{
"name":"UpdateServiceTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateServiceTemplateInput"},
"output":{"shape":"UpdateServiceTemplateOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Update a service template.</p>"
"documentation":"<p>The repository that you provide with pull request provisioning.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.</p>",
"documentation":"<p>The ID of the management account that accepts or rejects the environment account connection. You create an 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.</p>"
"documentation":"<p>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.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Tags for your environment account connection. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton resources and tagging</a> in the <i>Proton Administrator Guide</i>.</p>"
"documentation":"<p>The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value and omit the <code>provisioningRepository</code> parameter and values. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf. You must include either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value and omit the <code>provisioningRepository</code> parameter when you use standard provisioning.</p>"
},
"provisioningRepository":{
"shape":"RepositoryBranchInput",
"documentation":"<p>The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the <code>environmentAccountConnectionId</code> and <code>protonServiceRoleArn</code> parameters.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html\">Environments</a> in the <i>Proton Administrator Guide</i>.</p>"
"documentation":"<p>Create tags for your environment. For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>"
"documentation":"<p>The name of the environment template. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-templates.html\">Environment Templates</a> in the <i>Proton Administrator Guide</i>.</p>"
"documentation":"<p>Create tags for your environment template. For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>"
"documentation":"<p>When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first request created.</p>",
"documentation":"<p>To create a new minor version of the environment template, include a <code>major Version</code>.</p> <p>To create a new major and minor version of the environment template, <i>exclude</i> <code>major Version</code>.</p>"
"documentation":"<p>The environment template detail data that's returned by Proton.</p>"
}
}
},
"CreateRepositoryInput":{
"type":"structure",
"required":[
"connectionArn",
"name",
"provider"
],
"members":{
"connectionArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see <a href=\"https://docs.aws.amazon.com/setting-up-for-service\">Setting up for Proton</a> in the <i>Proton Administrator Guide</i>.</p>"
},
"encryptionKey":{
"shape":"Arn",
"documentation":"<p>The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.</p>"
},
"name":{
"shape":"RepositoryName",
"documentation":"<p>The repository name, for example <code>myrepos/myrepo</code>.</p>"
},
"provider":{
"shape":"RepositoryProvider",
"documentation":"<p>The repository provider.</p>"
}
}
},
"CreateRepositoryOutput":{
"type":"structure",
"required":["repository"],
"members":{
"repository":{
"shape":"Repository",
"documentation":"<p>The repository detail data that's returned by Proton.</p>"
"documentation":"<p>The name of the code repository branch that holds the code that's deployed in Proton. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#setting-up-vcontrol\">Set up repository connection</a> in the <i>Proton Administrator Guide</i> and <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/proton-setup.html#setup-repo-connection\">Setting up with Proton</a> in the <i>Proton User Guide</i>. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</p>"
"documentation":"<p>The ID of the code repository. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</p>"
"documentation":"<p>A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template <i>doesn’t</i> include a service pipeline. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-create-svc.html.html\">Create a service</a> in the <i>Proton Administrator Guide</i> and <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html\">Create a service</a> in the <i>Proton User Guide</i>.</p>"
"documentation":"<p>Create tags for your service. For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>"
"documentation":"<p>Proton includes a service pipeline for your service by default. When included, this parameter indicates that an Proton service pipeline <i>won't</i> be included for your service. Once specified, this parameter <i>can't</i> be changed. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html\">Service template bundles</a> in the <i>Proton Administrator Guide</i>.</p>"
"documentation":"<p>Create tags for your service template. For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>"
"documentation":"<p>When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.</p>",
"documentation":"<p>To create a new minor version of the service template, include a <code>major Version</code>.</p> <p>To create a new major and minor version of the service template, <i>exclude</i> <code>major Version</code>.</p>"
"documentation":"<p>The branch of the registered repository for your template.</p>"
},
"repositoryName":{
"shape":"RepositoryName",
"documentation":"<p>The name of your repository, for example <code>myrepos/myrepo</code>.</p>"
},
"repositoryProvider":{
"shape":"RepositoryProvider",
"documentation":"<p>The provider type for your repository.</p>"
},
"subdirectory":{
"shape":"Subdirectory",
"documentation":"<p>A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.</p>"
},
"templateName":{
"shape":"ResourceName",
"documentation":"<p>The name of your registered template.</p>"
},
"templateType":{
"shape":"TemplateType",
"documentation":"<p>The type of the registered template.</p>"
}
}
},
"CreateTemplateSyncConfigOutput":{
"type":"structure",
"members":{
"templateSyncConfig":{
"shape":"TemplateSyncConfig",
"documentation":"<p>The template sync configuration detail data that's returned by Proton.</p>"
"documentation":"<p>The repository that you provide with pull request provisioning.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>The request failed to register with the service.</p>",
"exception":true,
"fault":true,
"retryable":{"throttling":false}
},
"ListEnvironmentAccountConnectionsInput":{
"type":"structure",
"required":["requestedBy"],
"members":{
"environmentName":{
"shape":"ResourceName",
"documentation":"<p>The environment name that's associated with each listed environment account connection.</p>"
},
"maxResults":{
"shape":"MaxPageResults",
"documentation":"<p>The maximum number of environment account connections to list.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate 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.</p>"
"documentation":"<p>A token to indicate the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.</p>"
"documentation":"<p>A token to indicate the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.</p>"
}
}
},
"ListEnvironmentOutputsOutput":{
"type":"structure",
"required":["outputs"],
"members":{
"nextToken":{
"shape":"EmptyNextToken",
"documentation":"<p>A token to indicate the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.</p>"
},
"outputs":{
"shape":"OutputsList",
"documentation":"<p>An array of environment outputs with detail data.</p>"
}
}
},
"ListEnvironmentProvisionedResourcesInput":{
"type":"structure",
"required":["environmentName"],
"members":{
"environmentName":{
"shape":"ResourceName",
"documentation":"<p>The environment name.</p>"
},
"nextToken":{
"shape":"EmptyNextToken",
"documentation":"<p>A token to indicate the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.</p>"
}
}
},
"ListEnvironmentProvisionedResourcesOutput":{
"type":"structure",
"required":["provisionedResources"],
"members":{
"nextToken":{
"shape":"EmptyNextToken",
"documentation":"<p>A token to indicate the location of the next environment provisioned resource in the array of provisioned resources, after the current requested list of environment provisioned resources.</p>"
},
"provisionedResources":{
"shape":"ProvisionedResourceList",
"documentation":"<p>An array of environment provisioned resources.</p>"
"documentation":"<p>To view a list of minor of versions under a major version of an environment template, include <code>major Version</code>.</p> <p>To view a list of major versions of an environment template, <i>exclude</i> <code>major Version</code>.</p>"
"documentation":"<p>The maximum number of major or minor versions of an environment template to list.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate 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.</p>"
},
"templateName":{
"shape":"ResourceName",
"documentation":"<p>The name of the environment template.</p>"
}
}
},
"ListEnvironmentTemplateVersionsOutput":{
"type":"structure",
"required":["templateVersions"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate 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.</p>"
},
"templateVersions":{
"shape":"EnvironmentTemplateVersionSummaryList",
"documentation":"<p>An array of major or minor versions of an environment template detail data.</p>"
}
}
},
"ListEnvironmentTemplatesInput":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxPageResults",
"documentation":"<p>The maximum number of environment templates to list.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.</p>"
}
}
},
"ListEnvironmentTemplatesOutput":{
"type":"structure",
"required":["templates"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next environment template in the array of environment templates, after the current requested list of environment templates.</p>"
},
"templates":{
"shape":"EnvironmentTemplateSummaryList",
"documentation":"<p>An array of environment templates with detail data.</p>"
}
}
},
"ListEnvironmentsInput":{
"type":"structure",
"members":{
"environmentTemplates":{
"shape":"EnvironmentTemplateFilterList",
"documentation":"<p>An array of the versions of the environment template.</p>"
},
"maxResults":{
"shape":"MaxPageResults",
"documentation":"<p>The maximum number of environments to list.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.</p>"
}
}
},
"ListEnvironmentsOutput":{
"type":"structure",
"required":["environments"],
"members":{
"environments":{
"shape":"EnvironmentSummaryList",
"documentation":"<p>An array of environment detail data summaries.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next environment in the array of environments, after the current requested list of environments.</p>"
"documentation":"<p>A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously requested.</p>"
"documentation":"<p>A token to indicate the location of the next repository in the array of repositories, after the current requested list of repositories. </p>"
"documentation":"<p>A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.</p>"
"documentation":"<p>A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.</p>"
"documentation":"<p>A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.</p>"
},
"serviceInstanceName":{
"shape":"ResourceName",
"documentation":"<p>The service instance name.</p>"
"documentation":"<p>A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.</p>"
},
"serviceInstanceName":{
"shape":"ResourceName",
"documentation":"<p>The service instance name.</p>"
"documentation":"<p>A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.</p>"
"documentation":"<p>A token to indicate the location of the next service in the array of service instances, after the list of service instances that was previously requested.</p>"
},
"serviceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service that the service instance belongs to.</p>"
}
}
},
"ListServiceInstancesOutput":{
"type":"structure",
"required":["serviceInstances"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next service instance in the array of service instances, after the current requested list of service instances.</p>"
},
"serviceInstances":{
"shape":"ServiceInstanceSummaryList",
"documentation":"<p>An array of service instances with summaries of detail data.</p>"
}
}
},
"ListServicePipelineOutputsInput":{
"type":"structure",
"required":["serviceName"],
"members":{
"nextToken":{
"shape":"EmptyNextToken",
"documentation":"<p>A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.</p>"
},
"serviceName":{
"shape":"ResourceName",
"documentation":"<p>The service name.</p>"
}
}
},
"ListServicePipelineOutputsOutput":{
"type":"structure",
"required":["outputs"],
"members":{
"nextToken":{
"shape":"EmptyNextToken",
"documentation":"<p>A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.</p>"
},
"outputs":{
"shape":"OutputsList",
"documentation":"<p>An array of outputs.</p>"
}
}
},
"ListServicePipelineProvisionedResourcesInput":{
"type":"structure",
"required":["serviceName"],
"members":{
"nextToken":{
"shape":"EmptyNextToken",
"documentation":"<p>A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.</p>"
},
"serviceName":{
"shape":"ResourceName",
"documentation":"<p>The service name.</p>"
}
}
},
"ListServicePipelineProvisionedResourcesOutput":{
"type":"structure",
"required":["provisionedResources"],
"members":{
"nextToken":{
"shape":"EmptyNextToken",
"documentation":"<p>A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.</p>"
},
"provisionedResources":{
"shape":"ProvisionedResourceList",
"documentation":"<p>An array of provisioned resources for a service and pipeline.</p>"
}
}
},
"ListServiceTemplateVersionsInput":{
"type":"structure",
"required":["templateName"],
"members":{
"majorVersion":{
"shape":"TemplateVersionPart",
"documentation":"<p>To view a list of minor of versions under a major version of a service template, include <code>major Version</code>.</p> <p>To view a list of major versions of a service template, <i>exclude</i> <code>major Version</code>.</p>"
},
"maxResults":{
"shape":"MaxPageResults",
"documentation":"<p>The maximum number of major or minor versions of a service template to list.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.</p>"
},
"templateName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service template.</p>"
}
}
},
"ListServiceTemplateVersionsOutput":{
"type":"structure",
"required":["templateVersions"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate 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.</p>"
},
"templateVersions":{
"shape":"ServiceTemplateVersionSummaryList",
"documentation":"<p>An array of major or minor versions of a service template with detail data.</p>"
}
}
},
"ListServiceTemplatesInput":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxPageResults",
"documentation":"<p>The maximum number of service templates to list.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next service template in the array of service templates, after the list of service templates previously requested.</p>"
}
}
},
"ListServiceTemplatesOutput":{
"type":"structure",
"required":["templates"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next service template in the array of service templates, after the current requested list of service templates.</p>"
},
"templates":{
"shape":"ServiceTemplateSummaryList",
"documentation":"<p>An array of service templates with detail data.</p>"
}
}
},
"ListServicesInput":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxPageResults",
"documentation":"<p>The maximum number of services to list.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.</p>"
}
}
},
"ListServicesOutput":{
"type":"structure",
"required":["services"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to indicate the location of the next service in the array of services, after the current requested list of services.</p>"
},
"services":{
"shape":"ServiceSummaryList",
"documentation":"<p>An array of services with summaries of detail data.</p>"
}
}
},
"ListTagsForResourceInput":{
"type":"structure",
"required":["resourceArn"],
"members":{
"maxResults":{
"shape":"MaxPageResults",
"documentation":"<p>The maximum number of tags to list.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resource for the listed tags.</p>"
}
}
},
"ListTagsForResourceOutput":{
"type":"structure",
"required":["tags"],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>A token to indicate the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>An array of resource tags with detail data.</p>"
"documentation":"<p>The resource provisioning engine.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
}
},
"documentation":"<p>Detail data for a provisioned resource.</p>"
},
"ProvisionedResourceEngine":{
"type":"string",
"documentation":"<p>List of provisioning engines</p>",
"documentation":"<p>The repository Amazon Resource Name (ARN).</p>"
},
"connectionArn":{
"shape":"Arn",
"documentation":"<p>The repository Amazon Web Services CodeStar connection that connects Proton to your repository.</p>"
},
"encryptionKey":{
"shape":"Arn",
"documentation":"<p>Your customer Amazon Web Services KMS encryption key.</p>"
},
"name":{
"shape":"RepositoryName",
"documentation":"<p>The repository name.</p>"
},
"provider":{
"shape":"RepositoryProvider",
"documentation":"<p>The repository provider.</p>"
}
},
"documentation":"<p>Detail date for a repository that has been registered with Proton.</p>"
},
"RepositoryArn":{"type":"string"},
"RepositoryBranch":{
"type":"structure",
"required":[
"arn",
"branch",
"name",
"provider"
],
"members":{
"arn":{
"shape":"RepositoryArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the repository branch.</p>"
},
"branch":{
"shape":"GitBranchName",
"documentation":"<p>The repository branch.</p>"
},
"name":{
"shape":"RepositoryName",
"documentation":"<p>The repository name.</p>"
},
"provider":{
"shape":"RepositoryProvider",
"documentation":"<p>The repository provider.</p>"
}
},
"documentation":"<p>Detail data for a repository branch.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
},
"RepositoryBranchInput":{
"type":"structure",
"required":[
"branch",
"name",
"provider"
],
"members":{
"branch":{
"shape":"GitBranchName",
"documentation":"<p>The repository branch.</p>"
},
"name":{
"shape":"RepositoryName",
"documentation":"<p>The repository name.</p>"
},
"provider":{
"shape":"RepositoryProvider",
"documentation":"<p>The repository provider.</p>"
}
},
"documentation":"<p>Detail input data for a repository branch.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#setting-up-vcontrol\">Set up a repository connection</a> in the <i>Proton Administrator Guide</i> and <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/proton-setup.html#setup-repo-connection\">Setting up with Proton</a> in the <i>Proton User Guide</i>.</p>"
"documentation":"<p>A quota was exceeded. For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-limits.html\">Proton Quotas</a> in the <i>Proton Administrator Guide</i>.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the service.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The time when the service was created.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>A description of the service.</p>"
},
"lastModifiedAt":{
"shape":"Timestamp",
"documentation":"<p>The time when the service was last modified.</p>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the service.</p>"
},
"status":{
"shape":"ServiceStatus",
"documentation":"<p>The status of the service.</p>"
},
"statusMessage":{
"shape":"StatusMessage",
"documentation":"<p>A service status message.</p>"
},
"templateName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service template.</p>"
}
},
"documentation":"<p>A summary of the service detail data.</p>"
},
"ServiceSummaryList":{
"type":"list",
"member":{"shape":"ServiceSummary"}
},
"ServiceTemplate":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastModifiedAt",
"name"
],
"members":{
"arn":{
"shape":"ServiceTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the service template.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The time when the service template was created.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>A description of the service template.</p>"
},
"displayName":{
"shape":"DisplayName",
"documentation":"<p>The service template name as displayed in the developer interface.</p>"
},
"encryptionKey":{
"shape":"Arn",
"documentation":"<p>The customer provided service template encryption key that's used to encrypt data.</p>"
},
"lastModifiedAt":{
"shape":"Timestamp",
"documentation":"<p>The time when the service template was last modified.</p>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the service template.</p>"
},
"pipelineProvisioning":{
"shape":"Provisioning",
"documentation":"<p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included in the service template. Otherwise, a service pipeline <i>isn't</i> included in the service template.</p>"
"documentation":"<p>The service template detail data.</p>"
},
"ServiceTemplateArn":{"type":"string"},
"ServiceTemplateSummary":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastModifiedAt",
"name"
],
"members":{
"arn":{
"shape":"ServiceTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the service template.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The time when the service template was created.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>A description of the service template.</p>"
},
"displayName":{
"shape":"DisplayName",
"documentation":"<p>The service template name as displayed in the developer interface.</p>"
},
"lastModifiedAt":{
"shape":"Timestamp",
"documentation":"<p>The time when the service template was last modified.</p>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the service template.</p>"
},
"pipelineProvisioning":{
"shape":"Provisioning",
"documentation":"<p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included in the service template, otherwise a service pipeline <i>isn't</i> included in the service template.</p>"
"documentation":"<p>The repository that you provide with pull request provisioning.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Proton pipeline service role.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>There are four modes for updating an environment as described in the following. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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).</p> </dd> </dl>"
},
"description":{
"shape":"Description",
"documentation":"<p>A description of the environment update.</p>"
},
"environmentAccountConnectionId":{
"shape":"EnvironmentAccountConnectionId",
"documentation":"<p>The ID of the environment account connection.</p> <p>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.</p>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the environment to update.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.</p>"
},
"provisioningRepository":{
"shape":"RepositoryBranchInput",
"documentation":"<p>The repository that you provide with pull request provisioning.</p> <important> <p>Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about <a href=\"https://aws.amazon.com/service-terms\">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and Previews.</p> </important>"
"documentation":"<p>Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. <i>Don't</i> include edits to the existing service instances or pipeline. For more information, see <i>Edit a service</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-update.html\">Proton Administrator Guide</a> or the <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html\">Proton User Guide</a>.</p>"
"documentation":"<p>The deployment type.</p> <p>There are four modes for updating a service instance as described in the following. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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 also specify a different major version that is higher than the major version in use and a minor version (optional).</p> </dd> </dl>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the service instance to update.</p>"
},
"serviceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service that the service instance belongs to.</p>"
},
"spec":{
"shape":"SpecContents",
"documentation":"<p>The formatted specification that defines the service instance update.</p>"
},
"templateMajorVersion":{
"shape":"TemplateVersionPart",
"documentation":"<p>The major version of the service template to update.</p>"
},
"templateMinorVersion":{
"shape":"TemplateVersionPart",
"documentation":"<p>The minor version of the service template to update.</p>"
"documentation":"<p>The deployment type.</p> <p>There are four modes for updating a service pipeline as described in the following. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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 also specify a different minor version of the current major version in use.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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 also specify a different major version that is higher than the major version in use and a minor version (optional).</p> </dd> </dl>"
},
"serviceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service to that the pipeline is associated with.</p>"
},
"spec":{
"shape":"SpecContents",
"documentation":"<p>The spec for the service pipeline to update.</p>"
},
"templateMajorVersion":{
"shape":"TemplateVersionPart",
"documentation":"<p>The major version of the service template that was used to create the service that the pipeline is associated with.</p>"
},
"templateMinorVersion":{
"shape":"TemplateVersionPart",
"documentation":"<p>The minor version of the service template that was used to create the service that the pipeline is associated with.</p>"
"documentation":"<p>The service template version detail data that's returned by Proton.</p>"
}
}
},
"UpdateTemplateSyncConfigInput":{
"type":"structure",
"required":[
"branch",
"repositoryName",
"repositoryProvider",
"templateName",
"templateType"
],
"members":{
"branch":{
"shape":"GitBranchName",
"documentation":"<p>The repository branch.</p>"
},
"repositoryName":{
"shape":"RepositoryName",
"documentation":"<p>The name of the repository, for example <code>myrepos/myrepo</code>.</p>"
},
"repositoryProvider":{
"shape":"RepositoryProvider",
"documentation":"<p>The repository provider.</p>"
},
"subdirectory":{
"shape":"Subdirectory",
"documentation":"<p>A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.</p>"
"documentation":"<p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the <a href=\"https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html\">actions</a> and <a href=\"https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html\">data types</a> for the Proton service.</p> <p>The documentation for each action shows the Query API request parameters and the XML response.</p> <p>Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html\">Amazon Web Services Command Line Interface User Guide</a>.</p> <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.</p> <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the listed API operations.</p> <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are running on Proton, developers need permissions to the service <i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i> API operations and the service instance <i>list</i> and <i>update</i> API operations.</p> <p>To learn more about Proton administration, see the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html\">Proton Administrator Guide</a>.</p> <p>To learn more about deploying serverless and containerized applications on Proton, see the <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html\">ProtonUserGuide</a>.</p><p><b>EnsuringIdempotency</b></p><p>WhenyoumakeamutatingAPIrequest,therequesttypicallyreturnsaresultbeforetheasynchronousworkflowsoftheoperationarecomplete.Operationsmightalsotimeoutorencounterotherserverissuesbeforethey'recomplete,eveniftherequestalreadyreturnedaresult.Thismightmakeitdifficulttodeterminewhethertherequestsucceeded.Moreover,youmightneedtoretrytherequestmultipletimestoensurethattheoperationcompletessuccessfully.However,iftheoriginalrequestandthesubsequentretriesaresuccessful,theoperationoccursmultipletimes.Thismeansthatyoumightcreatemoreresourcesthanyouintended.</p><p><i>Idempotency</i>ensuresthatanAPIrequestactioncompletesnomorethanonetime.Withanidempotentrequest,iftheoriginalrequestactioncompletessuccessfully,anysubsequentretriescompletesuccessfullywithoutperforminganyfurtheractions.However,theresultmightcontainupdatedinformation,suchasthecurrentcreationstatus.</p><p>ThefollowinglistsofAPIsaregroupedaccordingtomethodsthatensureidempotency.</p><p><b>IdempotentcreateAPIswithaclienttoken</b></p><p>TheAPIactionsinthislistsupportidempotencywiththeuseofa<i>clienttoken</i>.ThecorrespondingAmazonWebServicesCLIcommandsalsosupportidempotencyusingaclienttoken.Aclienttokenisaunique,case-sensitivestringofupto64ASCIIcharacters.TomakeanidempotentAPIrequestusingoneoftheseactions,specifyaclienttokenintherequest.Werecommendthatyou<i>don't</i>reusethesameclienttokenforotherAPIrequests.Ifyoudon’tprovideaclienttokenfortheseAPIs,adefaultclienttokenisautomaticallyprovidedbySDKs.</p><p>Givenarequestactionthathassucceeded:</p><p>Ifyouretrytherequestusingthesameclienttokenandthesameparameters,theretrysucceedswithoutperforminganyfurtheractionsotherthanreturningtheoriginalresourcedetaildataintheresponse.</p><p>Ifyouretrytherequestusingthesameclienttoken,butoneormoreoftheparametersaredifferent,theretrythrowsa<c