This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the Proton service.
The documentation for each action shows the Query API request parameters and the XML response.
Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User Guide.
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.
Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the listed API operations.
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 create, list, update and delete API operations and the service instance list and update API operations.
To learn more about Proton administration, see the Proton Administrator Guide.
To learn more about deploying serverless and containerized applications on Proton, see the Proton User Guide.
Ensuring Idempotency
When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.
The following lists of APIs are grouped according to methods that ensure idempotency.
Idempotent create APIs with a client token
The API actions in this list support idempotency with the use of a client token. The corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.
Given a request action that has succeeded:
If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a ValidationException with an IdempotentParameterMismatch error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.
If the original resource is deleted and you retry the request, a new resource is created.
Idempotent create APIs with a client token:
CreateEnvironmentTemplateVersion
CreateServiceTemplateVersion
CreateEnvironmentAccountConnection
Idempotent create APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If the original resource has been modified, the retry throws a ConflictException.
If you retry with different input parameters, the retry throws a ValidationException with an IdempotentParameterMismatch error.
Idempotent create APIs:
CreateEnvironmentTemplate
CreateServiceTemplate
CreateEnvironment
CreateService
Idempotent delete APIs
Given a request action that has succeeded:
When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.
If you retry and the resource doesn't exist, the response is empty.
In both cases, the retry succeeds.
Idempotent delete APIs:
DeleteEnvironmentTemplate
DeleteEnvironmentTemplateVersion
DeleteServiceTemplate
DeleteServiceTemplateVersion
DeleteEnvironmentAccountConnection
Asynchronous idempotent delete APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, if the original request delete operation status is DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any further actions.
If the original request delete operation is complete, a retry returns an empty response.
Asynchronous idempotent delete APIs:
DeleteEnvironment
DeleteService
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 Administrator guide.
", "CancelEnvironmentDeployment": "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 Administrator 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.
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 Administrator guide or 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.
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 Administrator guide or 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.
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:
Standard provisioning: Proton makes direct calls to provision your resources.
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.
For more information, see the Environments in the Proton Administrator Guide.
", "CreateEnvironmentAccountConnection": "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 Administrator guide.
", "CreateEnvironmentTemplate": "Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator 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 Administrator Guide.
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.
", "CreateRepository": "Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see Template bundles and Template sync configurations in the Proton Administrator Guide.
", "CreateService": "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 Administrator Guide and Services in the Proton User Guide.
", "CreateServiceTemplate": "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 Service Templates in the Proton Administrator Guide.
", "CreateServiceTemplateVersion": "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.
", "CreateTemplateSyncConfig": "Set up a template for automated template version creation. When a commit is pushed to your registered repository, 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 Template sync configurations in the Proton Administrator Guide.
", "DeleteEnvironment": "Delete an environment.
", "DeleteEnvironmentAccountConnection": "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 Administrator guide.
", "DeleteEnvironmentTemplate": "If no other major or minor versions of an environment template exist, delete the environment template.
", "DeleteEnvironmentTemplateVersion": "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.
De-register and unlink your repository.
", "DeleteService": "Delete a service.
", "DeleteServiceTemplate": "If no other major or minor versions of the service template exist, delete the service template.
", "DeleteServiceTemplateVersion": "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.
Delete a template sync configuration.
", "GetAccountSettings": "Get detail data for the Proton pipeline service role.
", "GetEnvironment": "Get detail data for an environment.
", "GetEnvironmentAccountConnection": "In an environment account, view the detail data for an environment account connection.
For more information, see Environment account connections in the Proton Administrator guide.
", "GetEnvironmentTemplate": "Get detail data for an environment template.
", "GetEnvironmentTemplateVersion": "View detail data for a major or minor version of an environment template.
", "GetRepository": "Get detail data for a repository.
", "GetRepositorySyncStatus": "Get the repository sync status.
", "GetService": "Get detail data for a service.
", "GetServiceInstance": "Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
", "GetServiceTemplate": "Get detail data for a service template.
", "GetServiceTemplateVersion": "View detail data for a major or minor version of a service template.
", "GetTemplateSyncConfig": "Get detail data for a template sync configuration.
", "GetTemplateSyncStatus": "Get the status of a template sync.
", "ListEnvironmentAccountConnections": "View a list of environment account connections.
For more information, see Environment account connections in the Proton Administrator guide.
", "ListEnvironmentOutputs": "List the infrastructure as code outputs for your environment.
", "ListEnvironmentProvisionedResources": "List the provisioned resources for your environment.
", "ListEnvironmentTemplateVersions": "List major or minor versions of an environment template with detail data.
", "ListEnvironmentTemplates": "List environment templates.
", "ListEnvironments": "List environments with detail data summaries.
", "ListRepositories": "List repositories with detail data.
", "ListRepositorySyncDefinitions": "List repository sync definitions with detail data.
", "ListServiceInstanceOutputs": "View a list service instance infrastructure as code outputs with detail data.
", "ListServiceInstanceProvisionedResources": "List provisioned resources for a service instance with details.
", "ListServiceInstances": "List service instances with summaries of detail data.
", "ListServicePipelineOutputs": "View a list service pipeline infrastructure as code outputs with detail.
", "ListServicePipelineProvisionedResources": "List provisioned resources for a service and pipeline with details.
", "ListServiceTemplateVersions": "List major or minor versions of a service template with detail data.
", "ListServiceTemplates": "List service templates with detail data.
", "ListServices": "List services with summaries of detail data.
", "ListTagsForResource": "List tags for a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "NotifyResourceDeploymentStatusChange": "Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you won’t be able to accept or use the rejected environment account connection.
You can’t reject an environment account connection that is connected to an environment.
For more information, see Environment account connections in the Proton Administrator guide.
", "TagResource": "Tag a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "UntagResource": "Remove a tag from a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "UpdateAccountSettings": "Update the Proton service pipeline role or repository settings.
", "UpdateEnvironment": "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 it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter to update or connect to an environment account connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.
If the environment was provisioned with pull request provisioning, include the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.
If the environment wasn't provisioned with pull request provisioning, omit the provisioningRepository parameter.
There are four modes for updating an environment as described in the following. 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 (optional).
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 Administrator guide.
", "UpdateEnvironmentTemplate": "Update an environment template.
", "UpdateEnvironmentTemplateVersion": "Update a major or minor version of an environment template.
", "UpdateService": "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.
Update a service instance.
There are four modes for updating a service instance as described in the following. 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 instance 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 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 also specify a different major version that is higher than the major version in use and a minor version (optional).
Update the service pipeline.
There are four modes for updating a service pipeline as described in the following. 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 minor or major 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 also 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 also specify a different major version that is higher than the major version in use and a minor version (optional).
Update a service template.
", "UpdateServiceTemplateVersion": "Update a major or minor version of a service template.
", "UpdateTemplateSyncConfig": "Update template sync configuration parameters, except for the templateName and templateType.
There isn't sufficient access for performing this action.
", "refs": { } }, "AccountSettings": { "base": "The Proton pipeline service role and repository data.
", "refs": { "GetAccountSettingsOutput$accountSettings": "The Proton pipeline service role detail data that's returned by Proton.
", "UpdateAccountSettingsOutput$accountSettings": "The Proton pipeline service role repository detail data that's returned by Proton.
" } }, "Arn": { "base": null, "refs": { "CreateEnvironmentAccountConnectionInput$roleArn": "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.
", "CreateEnvironmentInput$protonServiceRoleArn": "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 environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter when you use standard provisioning.
A customer provided encryption key that Proton uses to encrypt data.
", "CreateRepositoryInput$connectionArn": "The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide.
", "CreateRepositoryInput$encryptionKey": "The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.
", "CreateServiceInput$repositoryConnectionArn": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.
", "CreateServiceTemplateInput$encryptionKey": "A customer provided encryption key that's used to encrypt data.
", "Environment$protonServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
", "EnvironmentAccountConnection$roleArn": "The IAM service role that's associated with the environment account connection.
", "EnvironmentAccountConnectionSummary$roleArn": "The IAM service role that's associated with the environment account connection.
", "EnvironmentSummary$protonServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
", "EnvironmentTemplate$encryptionKey": "The customer provided encryption key for the environment template.
", "ListTagsForResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource for the listed tags.
", "NotifyResourceDeploymentStatusChangeInput$resourceArn": "The provisioned resource Amazon Resource Name (ARN).
", "Repository$connectionArn": "The repository Amazon Web Services CodeStar connection that connects Proton to your repository.
", "Repository$encryptionKey": "Your customer Amazon Web Services KMS encryption key.
", "Service$repositoryConnectionArn": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide.
", "ServicePipeline$arn": "The Amazon Resource Name (ARN) of the service pipeline.
", "ServiceTemplate$encryptionKey": "The customer provided service template encryption key that's used to encrypt data.
", "TagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource that the resource tag is applied to.
", "UntagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource that the tag is to be removed from.
", "UpdateEnvironmentAccountConnectionInput$roleArn": "The Amazon Resource Name (ARN) of the IAM service role that is associated with the environment account connection to update.
", "UpdateEnvironmentInput$protonServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
" } }, "AwsAccountId": { "base": null, "refs": { "CreateEnvironmentAccountConnectionInput$managementAccountId": "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.
", "Environment$environmentAccountId": "The ID of the environment account that the environment infrastructure resources are provisioned in.
", "EnvironmentAccountConnection$environmentAccountId": "The environment account that's connected to the environment account connection.
", "EnvironmentAccountConnection$managementAccountId": "The ID of the management account that's connected to the environment account connection.
", "EnvironmentAccountConnectionSummary$environmentAccountId": "The ID of the environment account that's connected to the environment account connection.
", "EnvironmentAccountConnectionSummary$managementAccountId": "The ID of the management account that's connected to the environment account connection.
", "EnvironmentSummary$environmentAccountId": "The ID of the environment account that the environment infrastructure resources are provisioned in.
" } }, "CancelEnvironmentDeploymentInput": { "base": null, "refs": { } }, "CancelEnvironmentDeploymentOutput": { "base": null, "refs": { } }, "CancelServiceInstanceDeploymentInput": { "base": null, "refs": { } }, "CancelServiceInstanceDeploymentOutput": { "base": null, "refs": { } }, "CancelServicePipelineDeploymentInput": { "base": null, "refs": { } }, "CancelServicePipelineDeploymentOutput": { "base": null, "refs": { } }, "ClientToken": { "base": null, "refs": { "CreateEnvironmentAccountConnectionInput$clientToken": "When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
", "CreateEnvironmentTemplateVersionInput$clientToken": "When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first request created.
", "CreateServiceTemplateVersionInput$clientToken": "When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.
" } }, "CompatibleEnvironmentTemplate": { "base": "Compatible environment template data.
", "refs": { "CompatibleEnvironmentTemplateList$member": null } }, "CompatibleEnvironmentTemplateInput": { "base": "Compatible environment template data.
", "refs": { "CompatibleEnvironmentTemplateInputList$member": null } }, "CompatibleEnvironmentTemplateInputList": { "base": null, "refs": { "CreateServiceTemplateVersionInput$compatibleEnvironmentTemplates": "An array of compatible environment template objects for the new version of a service template.
", "UpdateServiceTemplateVersionInput$compatibleEnvironmentTemplates": "An array of compatible environment names for a service template major or minor version to update.
" } }, "CompatibleEnvironmentTemplateList": { "base": null, "refs": { "ServiceTemplateVersion$compatibleEnvironmentTemplates": "An array of compatible environment template names for the major version of a service template.
" } }, "ConflictException": { "base": "The request couldn't be made due to a conflicting operation or resource.
", "refs": { } }, "CreateEnvironmentAccountConnectionInput": { "base": null, "refs": { } }, "CreateEnvironmentAccountConnectionOutput": { "base": null, "refs": { } }, "CreateEnvironmentInput": { "base": null, "refs": { } }, "CreateEnvironmentOutput": { "base": null, "refs": { } }, "CreateEnvironmentTemplateInput": { "base": null, "refs": { } }, "CreateEnvironmentTemplateOutput": { "base": null, "refs": { } }, "CreateEnvironmentTemplateVersionInput": { "base": null, "refs": { } }, "CreateEnvironmentTemplateVersionOutput": { "base": null, "refs": { } }, "CreateRepositoryInput": { "base": null, "refs": { } }, "CreateRepositoryOutput": { "base": null, "refs": { } }, "CreateServiceInput": { "base": null, "refs": { } }, "CreateServiceOutput": { "base": null, "refs": { } }, "CreateServiceTemplateInput": { "base": null, "refs": { } }, "CreateServiceTemplateOutput": { "base": null, "refs": { } }, "CreateServiceTemplateVersionInput": { "base": null, "refs": { } }, "CreateServiceTemplateVersionOutput": { "base": null, "refs": { } }, "CreateTemplateSyncConfigInput": { "base": null, "refs": { } }, "CreateTemplateSyncConfigOutput": { "base": null, "refs": { } }, "DeleteEnvironmentAccountConnectionInput": { "base": null, "refs": { } }, "DeleteEnvironmentAccountConnectionOutput": { "base": null, "refs": { } }, "DeleteEnvironmentInput": { "base": null, "refs": { } }, "DeleteEnvironmentOutput": { "base": null, "refs": { } }, "DeleteEnvironmentTemplateInput": { "base": null, "refs": { } }, "DeleteEnvironmentTemplateOutput": { "base": null, "refs": { } }, "DeleteEnvironmentTemplateVersionInput": { "base": null, "refs": { } }, "DeleteEnvironmentTemplateVersionOutput": { "base": null, "refs": { } }, "DeleteRepositoryInput": { "base": null, "refs": { } }, "DeleteRepositoryOutput": { "base": null, "refs": { } }, "DeleteServiceInput": { "base": null, "refs": { } }, "DeleteServiceOutput": { "base": null, "refs": { } }, "DeleteServiceTemplateInput": { "base": null, "refs": { } }, "DeleteServiceTemplateOutput": { "base": null, "refs": { } }, "DeleteServiceTemplateVersionInput": { "base": null, "refs": { } }, "DeleteServiceTemplateVersionOutput": { "base": null, "refs": { } }, "DeleteTemplateSyncConfigInput": { "base": null, "refs": { } }, "DeleteTemplateSyncConfigOutput": { "base": null, "refs": { } }, "DeploymentId": { "base": null, "refs": { "NotifyResourceDeploymentStatusChangeInput$deploymentId": "The deployment ID for your provisioned resource.
" } }, "DeploymentStatus": { "base": null, "refs": { "Environment$deploymentStatus": "The environment deployment status.
", "EnvironmentSummary$deploymentStatus": "The environment deployment status.
", "ServiceInstance$deploymentStatus": "The service instance deployment status.
", "ServiceInstanceSummary$deploymentStatus": "The service instance deployment status.
", "ServicePipeline$deploymentStatus": "The deployment status of the service pipeline.
" } }, "DeploymentUpdateType": { "base": null, "refs": { "UpdateEnvironmentInput$deploymentType": "There are four modes for updating an environment as described in the following. 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 is higher than the major version in use and a minor version (optional).
The deployment type.
There are four modes for updating a service instance as described in the following. 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 instance 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 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 also specify a different major version that is higher than the major version in use and a minor version (optional).
The deployment type.
There are four modes for updating a service pipeline as described in the following. 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 minor or major 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 also 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 also specify a different major version that is higher than the major version in use and a minor version (optional).
A description of the environment that's being created and deployed.
", "CreateEnvironmentTemplateInput$description": "A description of the environment template.
", "CreateEnvironmentTemplateVersionInput$description": "A description of the new version of an environment template.
", "CreateServiceInput$description": "A description of the Proton service.
", "CreateServiceTemplateInput$description": "A description of the service template.
", "CreateServiceTemplateVersionInput$description": "A description of the new version of a service template.
", "Environment$description": "The description of the environment.
", "EnvironmentSummary$description": "The description of the environment.
", "EnvironmentTemplate$description": "A description of the environment template.
", "EnvironmentTemplateSummary$description": "A description of the environment template.
", "EnvironmentTemplateVersion$description": "A description of the minor version of an environment template.
", "EnvironmentTemplateVersionSummary$description": "A description of the version of an environment template.
", "Service$description": "A description of a service.
", "ServiceSummary$description": "A description of the service.
", "ServiceTemplate$description": "A description of the service template.
", "ServiceTemplateSummary$description": "A description of the service template.
", "ServiceTemplateVersion$description": "A description of the version of a service template.
", "ServiceTemplateVersionSummary$description": "A description of the version of a service template.
", "UpdateEnvironmentInput$description": "A description of the environment update.
", "UpdateEnvironmentTemplateInput$description": "A description of the environment template update.
", "UpdateEnvironmentTemplateVersionInput$description": "A description of environment template version to update.
", "UpdateServiceInput$description": "The edited service description.
", "UpdateServiceTemplateInput$description": "A description of the service template update.
", "UpdateServiceTemplateVersionInput$description": "A description of a service template version to update.
" } }, "DisplayName": { "base": null, "refs": { "CreateEnvironmentTemplateInput$displayName": "The environment template name as displayed in the developer interface.
", "CreateServiceTemplateInput$displayName": "The name of the service template as displayed in the developer interface.
", "EnvironmentTemplate$displayName": "The name of the environment template as displayed in the developer interface.
", "EnvironmentTemplateSummary$displayName": "The name of the environment template as displayed in the developer interface.
", "ServiceTemplate$displayName": "The service template name as displayed in the developer interface.
", "ServiceTemplateSummary$displayName": "The service template name as displayed in the developer interface.
", "UpdateEnvironmentTemplateInput$displayName": "The name of the environment template to update as displayed in the developer interface.
", "UpdateServiceTemplateInput$displayName": "The name of the service template to update as displayed in the developer interface.
" } }, "EmptyNextToken": { "base": null, "refs": { "ListEnvironmentOutputsInput$nextToken": "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.
", "ListEnvironmentOutputsOutput$nextToken": "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.
", "ListEnvironmentProvisionedResourcesInput$nextToken": "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.
", "ListEnvironmentProvisionedResourcesOutput$nextToken": "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.
", "ListRepositorySyncDefinitionsInput$nextToken": "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.
", "ListRepositorySyncDefinitionsOutput$nextToken": "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.
", "ListServiceInstanceOutputsInput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
", "ListServiceInstanceOutputsOutput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
", "ListServiceInstanceProvisionedResourcesInput$nextToken": "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.
", "ListServiceInstanceProvisionedResourcesOutput$nextToken": "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.
", "ListServicePipelineOutputsInput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
", "ListServicePipelineOutputsOutput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
", "ListServicePipelineProvisionedResourcesInput$nextToken": "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.
", "ListServicePipelineProvisionedResourcesOutput$nextToken": "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.
" } }, "Environment": { "base": "The environment detail data. An Proton environment is a set resources shared across an Proton service.
", "refs": { "CancelEnvironmentDeploymentOutput$environment": "The environment summary data that's returned by Proton.
", "CreateEnvironmentOutput$environment": "The environment detail data that's returned by Proton.
", "DeleteEnvironmentOutput$environment": "The environment detail data that's returned by Proton.
", "GetEnvironmentOutput$environment": "The environment detail data that's returned by Proton.
", "UpdateEnvironmentOutput$environment": "The environment detail data that's returned by Proton.
" } }, "EnvironmentAccountConnection": { "base": "The environment account connection detail data.
", "refs": { "AcceptEnvironmentAccountConnectionOutput$environmentAccountConnection": "The environment account connection data that's returned by Proton.
", "CreateEnvironmentAccountConnectionOutput$environmentAccountConnection": "The environment account connection detail data that's returned by Proton.
", "DeleteEnvironmentAccountConnectionOutput$environmentAccountConnection": "The environment account connection detail data that's returned by Proton.
", "GetEnvironmentAccountConnectionOutput$environmentAccountConnection": "The environment account connection detail data that's returned by Proton.
", "RejectEnvironmentAccountConnectionOutput$environmentAccountConnection": "The environment connection account detail data that's returned by Proton.
", "UpdateEnvironmentAccountConnectionOutput$environmentAccountConnection": "The environment account connection detail data that's returned by Proton.
" } }, "EnvironmentAccountConnectionArn": { "base": null, "refs": { "EnvironmentAccountConnection$arn": "The Amazon Resource Name (ARN) of the environment account connection.
", "EnvironmentAccountConnectionSummary$arn": "The Amazon Resource Name (ARN) of the environment account connection.
" } }, "EnvironmentAccountConnectionId": { "base": null, "refs": { "AcceptEnvironmentAccountConnectionInput$id": "The ID of the environment account connection.
", "CreateEnvironmentInput$environmentAccountConnectionId": "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 environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter and values. For more information, see Environment account connections in the Proton Administrator guide.
The ID of the environment account connection to delete.
", "Environment$environmentAccountConnectionId": "The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
", "EnvironmentAccountConnection$id": "The ID of the environment account connection.
", "EnvironmentAccountConnectionSummary$id": "The ID of the environment account connection.
", "EnvironmentSummary$environmentAccountConnectionId": "The ID of the environment account connection that the environment is associated with.
", "GetEnvironmentAccountConnectionInput$id": "The ID of the environment account connection.
", "RejectEnvironmentAccountConnectionInput$id": "The ID of the environment account connection to reject.
", "UpdateEnvironmentAccountConnectionInput$id": "The ID of the environment account connection to update.
", "UpdateEnvironmentInput$environmentAccountConnectionId": "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.
" } }, "EnvironmentAccountConnectionRequesterAccountType": { "base": null, "refs": { "ListEnvironmentAccountConnectionsInput$requestedBy": "The type of account making the ListEnvironmentAccountConnections request.
The status of the environment account connection.
", "EnvironmentAccountConnectionStatusList$member": null, "EnvironmentAccountConnectionSummary$status": "The status of the environment account connection.
" } }, "EnvironmentAccountConnectionStatusList": { "base": null, "refs": { "ListEnvironmentAccountConnectionsInput$statuses": "The status details for each listed environment account connection.
" } }, "EnvironmentAccountConnectionSummary": { "base": "A summary of the environment account connection detail data.
", "refs": { "EnvironmentAccountConnectionSummaryList$member": null } }, "EnvironmentAccountConnectionSummaryList": { "base": null, "refs": { "ListEnvironmentAccountConnectionsOutput$environmentAccountConnections": "An array of environment account connections with details that's returned by Proton.
" } }, "EnvironmentArn": { "base": null, "refs": { "Environment$arn": "The Amazon Resource Name (ARN) of the environment.
", "EnvironmentSummary$arn": "The Amazon Resource Name (ARN) of the environment.
" } }, "EnvironmentSummary": { "base": "A summary of the environment detail data.
", "refs": { "EnvironmentSummaryList$member": null } }, "EnvironmentSummaryList": { "base": null, "refs": { "ListEnvironmentsOutput$environments": "An array of environment detail data summaries.
" } }, "EnvironmentTemplate": { "base": "The environment template data.
", "refs": { "CreateEnvironmentTemplateOutput$environmentTemplate": "The environment template detail data that's returned by Proton.
", "DeleteEnvironmentTemplateOutput$environmentTemplate": "The environment template detail data that's returned by Proton.
", "GetEnvironmentTemplateOutput$environmentTemplate": "The environment template detail data that's returned by Proton.
", "UpdateEnvironmentTemplateOutput$environmentTemplate": "The environment template detail data that's returned by Proton.
" } }, "EnvironmentTemplateArn": { "base": null, "refs": { "EnvironmentTemplate$arn": "The Amazon Resource Name (ARN) of the environment template.
", "EnvironmentTemplateSummary$arn": "The Amazon Resource Name (ARN) of the environment template.
" } }, "EnvironmentTemplateFilter": { "base": "A search filter for environment templates.
", "refs": { "EnvironmentTemplateFilterList$member": null } }, "EnvironmentTemplateFilterList": { "base": null, "refs": { "ListEnvironmentsInput$environmentTemplates": "An array of the versions of the environment template.
" } }, "EnvironmentTemplateSummary": { "base": "The environment template data.
", "refs": { "EnvironmentTemplateSummaryList$member": null } }, "EnvironmentTemplateSummaryList": { "base": null, "refs": { "ListEnvironmentTemplatesOutput$templates": "An array of environment templates with detail data.
" } }, "EnvironmentTemplateVersion": { "base": "The environment template version data.
", "refs": { "CreateEnvironmentTemplateVersionOutput$environmentTemplateVersion": "The environment template detail data that's returned by Proton.
", "DeleteEnvironmentTemplateVersionOutput$environmentTemplateVersion": "The environment template version detail data that's returned by Proton.
", "GetEnvironmentTemplateVersionOutput$environmentTemplateVersion": "The environment template version detail data that's returned by Proton.
", "UpdateEnvironmentTemplateVersionOutput$environmentTemplateVersion": "The environment template version detail data that's returned by Proton.
" } }, "EnvironmentTemplateVersionArn": { "base": null, "refs": { "EnvironmentTemplateVersion$arn": "The Amazon Resource Name (ARN) of the version of an environment template.
", "EnvironmentTemplateVersionSummary$arn": "The Amazon Resource Name (ARN) of the version of an environment template.
" } }, "EnvironmentTemplateVersionSummary": { "base": "A summary of the version of an environment template detail data.
", "refs": { "EnvironmentTemplateVersionSummaryList$member": null } }, "EnvironmentTemplateVersionSummaryList": { "base": null, "refs": { "ListEnvironmentTemplateVersionsOutput$templateVersions": "An array of major or minor versions of an environment template detail data.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "FullTemplateVersionNumber": { "base": null, "refs": { "EnvironmentTemplate$recommendedVersion": "The ID of the recommended version of the environment template.
", "EnvironmentTemplateSummary$recommendedVersion": "The recommended version of the environment template.
", "ServiceTemplate$recommendedVersion": "The recommended version of the service template.
", "ServiceTemplateSummary$recommendedVersion": "The recommended version of the service template.
" } }, "GetAccountSettingsInput": { "base": null, "refs": { } }, "GetAccountSettingsOutput": { "base": null, "refs": { } }, "GetEnvironmentAccountConnectionInput": { "base": null, "refs": { } }, "GetEnvironmentAccountConnectionOutput": { "base": null, "refs": { } }, "GetEnvironmentInput": { "base": null, "refs": { } }, "GetEnvironmentOutput": { "base": null, "refs": { } }, "GetEnvironmentTemplateInput": { "base": null, "refs": { } }, "GetEnvironmentTemplateOutput": { "base": null, "refs": { } }, "GetEnvironmentTemplateVersionInput": { "base": null, "refs": { } }, "GetEnvironmentTemplateVersionOutput": { "base": null, "refs": { } }, "GetRepositoryInput": { "base": null, "refs": { } }, "GetRepositoryOutput": { "base": null, "refs": { } }, "GetRepositorySyncStatusInput": { "base": null, "refs": { } }, "GetRepositorySyncStatusOutput": { "base": null, "refs": { } }, "GetServiceInput": { "base": null, "refs": { } }, "GetServiceInstanceInput": { "base": null, "refs": { } }, "GetServiceInstanceOutput": { "base": null, "refs": { } }, "GetServiceOutput": { "base": null, "refs": { } }, "GetServiceTemplateInput": { "base": null, "refs": { } }, "GetServiceTemplateOutput": { "base": null, "refs": { } }, "GetServiceTemplateVersionInput": { "base": null, "refs": { } }, "GetServiceTemplateVersionOutput": { "base": null, "refs": { } }, "GetTemplateSyncConfigInput": { "base": null, "refs": { } }, "GetTemplateSyncConfigOutput": { "base": null, "refs": { } }, "GetTemplateSyncStatusInput": { "base": null, "refs": { } }, "GetTemplateSyncStatusOutput": { "base": null, "refs": { } }, "GitBranchName": { "base": null, "refs": { "CreateServiceInput$branchName": "The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.
", "CreateTemplateSyncConfigInput$branch": "The branch of the registered repository for your template.
", "GetRepositorySyncStatusInput$branch": "The repository branch.
", "RepositoryBranch$branch": "The repository branch.
", "RepositoryBranchInput$branch": "The repository branch.
", "RepositorySyncDefinition$branch": "The repository branch.
", "Revision$branch": "The repository branch.
", "Service$branchName": "The name of the code repository branch that holds the code that's deployed in Proton.
", "TemplateSyncConfig$branch": "The repository branch.
", "UpdateTemplateSyncConfigInput$branch": "The repository branch.
" } }, "InternalServerException": { "base": "The request failed to register with the service.
", "refs": { } }, "ListEnvironmentAccountConnectionsInput": { "base": null, "refs": { } }, "ListEnvironmentAccountConnectionsOutput": { "base": null, "refs": { } }, "ListEnvironmentOutputsInput": { "base": null, "refs": { } }, "ListEnvironmentOutputsOutput": { "base": null, "refs": { } }, "ListEnvironmentProvisionedResourcesInput": { "base": null, "refs": { } }, "ListEnvironmentProvisionedResourcesOutput": { "base": null, "refs": { } }, "ListEnvironmentTemplateVersionsInput": { "base": null, "refs": { } }, "ListEnvironmentTemplateVersionsOutput": { "base": null, "refs": { } }, "ListEnvironmentTemplatesInput": { "base": null, "refs": { } }, "ListEnvironmentTemplatesOutput": { "base": null, "refs": { } }, "ListEnvironmentsInput": { "base": null, "refs": { } }, "ListEnvironmentsOutput": { "base": null, "refs": { } }, "ListRepositoriesInput": { "base": null, "refs": { } }, "ListRepositoriesOutput": { "base": null, "refs": { } }, "ListRepositorySyncDefinitionsInput": { "base": null, "refs": { } }, "ListRepositorySyncDefinitionsOutput": { "base": null, "refs": { } }, "ListServiceInstanceOutputsInput": { "base": null, "refs": { } }, "ListServiceInstanceOutputsOutput": { "base": null, "refs": { } }, "ListServiceInstanceProvisionedResourcesInput": { "base": null, "refs": { } }, "ListServiceInstanceProvisionedResourcesOutput": { "base": null, "refs": { } }, "ListServiceInstancesInput": { "base": null, "refs": { } }, "ListServiceInstancesOutput": { "base": null, "refs": { } }, "ListServicePipelineOutputsInput": { "base": null, "refs": { } }, "ListServicePipelineOutputsOutput": { "base": null, "refs": { } }, "ListServicePipelineProvisionedResourcesInput": { "base": null, "refs": { } }, "ListServicePipelineProvisionedResourcesOutput": { "base": null, "refs": { } }, "ListServiceTemplateVersionsInput": { "base": null, "refs": { } }, "ListServiceTemplateVersionsOutput": { "base": null, "refs": { } }, "ListServiceTemplatesInput": { "base": null, "refs": { } }, "ListServiceTemplatesOutput": { "base": null, "refs": { } }, "ListServicesInput": { "base": null, "refs": { } }, "ListServicesOutput": { "base": null, "refs": { } }, "ListTagsForResourceInput": { "base": null, "refs": { } }, "ListTagsForResourceOutput": { "base": null, "refs": { } }, "MaxPageResults": { "base": null, "refs": { "ListEnvironmentAccountConnectionsInput$maxResults": "The maximum number of environment account connections to list.
", "ListEnvironmentTemplateVersionsInput$maxResults": "The maximum number of major or minor versions of an environment template to list.
", "ListEnvironmentTemplatesInput$maxResults": "The maximum number of environment templates to list.
", "ListEnvironmentsInput$maxResults": "The maximum number of environments to list.
", "ListRepositoriesInput$maxResults": "The maximum number of repositories to list.
", "ListServiceInstancesInput$maxResults": "The maximum number of service instances to list.
", "ListServiceTemplateVersionsInput$maxResults": "The maximum number of major or minor versions of a service template to list.
", "ListServiceTemplatesInput$maxResults": "The maximum number of service templates to list.
", "ListServicesInput$maxResults": "The maximum number of services to list.
", "ListTagsForResourceInput$maxResults": "The maximum number of tags to list.
" } }, "NextToken": { "base": null, "refs": { "ListEnvironmentAccountConnectionsInput$nextToken": "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.
", "ListEnvironmentAccountConnectionsOutput$nextToken": "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.
", "ListEnvironmentTemplateVersionsInput$nextToken": "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.
", "ListEnvironmentTemplateVersionsOutput$nextToken": "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.
", "ListEnvironmentTemplatesInput$nextToken": "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.
", "ListEnvironmentTemplatesOutput$nextToken": "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.
", "ListEnvironmentsInput$nextToken": "A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.
", "ListEnvironmentsOutput$nextToken": "A token to indicate the location of the next environment in the array of environments, after the current requested list of environments.
", "ListRepositoriesInput$nextToken": "A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously requested.
", "ListRepositoriesOutput$nextToken": "A token to indicate the location of the next repository in the array of repositories, after the current requested list of repositories.
", "ListServiceInstancesInput$nextToken": "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.
", "ListServiceInstancesOutput$nextToken": "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.
", "ListServiceTemplateVersionsInput$nextToken": "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.
", "ListServiceTemplateVersionsOutput$nextToken": "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.
", "ListServiceTemplatesInput$nextToken": "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.
", "ListServiceTemplatesOutput$nextToken": "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.
", "ListServicesInput$nextToken": "A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.
", "ListServicesOutput$nextToken": "A token to indicate the location of the next service in the array of services, after the current requested list of services.
" } }, "NotifyResourceDeploymentStatusChangeInput": { "base": null, "refs": { } }, "NotifyResourceDeploymentStatusChangeInputOutputsList": { "base": null, "refs": { "NotifyResourceDeploymentStatusChangeInput$outputs": "The provisioned resource state change detail data that's returned by Proton.
" } }, "NotifyResourceDeploymentStatusChangeOutput": { "base": null, "refs": { } }, "Output": { "base": "An infrastructure as code defined resource output.
", "refs": { "NotifyResourceDeploymentStatusChangeInputOutputsList$member": null, "OutputsList$member": null } }, "OutputKey": { "base": null, "refs": { "Output$key": "The output key.
" } }, "OutputValueString": { "base": null, "refs": { "Output$valueString": "The output value.
" } }, "OutputsList": { "base": null, "refs": { "ListEnvironmentOutputsOutput$outputs": "An array of environment outputs with detail data.
", "ListServiceInstanceOutputsOutput$outputs": "An array of service instance infrastructure as code outputs.
", "ListServicePipelineOutputsOutput$outputs": "An array of outputs.
" } }, "PipelineRoleArn": { "base": null, "refs": { "AccountSettings$pipelineServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton pipeline service role.
", "UpdateAccountSettingsInput$pipelineServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton pipeline service role.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
Detail data for a provisioned resource.
", "refs": { "ProvisionedResourceList$member": null } }, "ProvisionedResourceEngine": { "base": "List of provisioning engines
", "refs": { "ProvisionedResource$provisioningEngine": "The resource provisioning engine.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The provisioned resource identifier.
" } }, "ProvisionedResourceList": { "base": null, "refs": { "ListEnvironmentProvisionedResourcesOutput$provisionedResources": "An array of environment provisioned resources.
", "ListServiceInstanceProvisionedResourcesOutput$provisionedResources": "An array of provisioned resources for a service instance.
", "ListServicePipelineProvisionedResourcesOutput$provisionedResources": "An array of provisioned resources for a service and pipeline.
" } }, "ProvisionedResourceName": { "base": null, "refs": { "ProvisionedResource$name": "The provisioned resource name.
" } }, "Provisioning": { "base": null, "refs": { "CreateEnvironmentTemplateInput$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", "CreateServiceTemplateInput$pipelineProvisioning": "Proton includes a service pipeline for your service by default. When included, this parameter indicates that an Proton service pipeline won't be included for your service. Once specified, this parameter can't be changed. For more information, see Service template bundles in the Proton Administrator Guide.
", "Environment$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", "EnvironmentSummary$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", "EnvironmentTemplate$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", "EnvironmentTemplateSummary$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", "ServiceTemplate$pipelineProvisioning": "If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
If pipelineProvisioning is true, a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template.
Detail date for a repository that has been registered with Proton.
", "refs": { "CreateRepositoryOutput$repository": "The repository detail data that's returned by Proton.
", "DeleteRepositoryOutput$repository": "The repository detail data that's returned by Proton.
", "GetRepositoryOutput$repository": "The repository detail data that's returned by Proton.
" } }, "RepositoryArn": { "base": null, "refs": { "Repository$arn": "The repository Amazon Resource Name (ARN).
", "RepositoryBranch$arn": "The Amazon Resource Name (ARN) of the repository branch.
", "RepositorySummary$arn": "The Amazon Resource Name (ARN) for a repository.
" } }, "RepositoryBranch": { "base": "Detail data for a repository branch.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
Detail input data for a repository branch.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
", "Service$repositoryId": "The ID of the source code repository.
" } }, "RepositoryName": { "base": null, "refs": { "CreateRepositoryInput$name": "The repository name, for example myrepos/myrepo.
The name of your repository, for example myrepos/myrepo.
The name of the repository.
", "GetRepositoryInput$name": "The repository name, for example myrepos/myrepo.
The repository name.
", "ListRepositorySyncDefinitionsInput$repositoryName": "The repository name.
", "Repository$name": "The repository name.
", "RepositoryBranch$name": "The repository name.
", "RepositoryBranchInput$name": "The repository name.
", "RepositorySummary$name": "The repository name.
", "Revision$repositoryName": "The repository name.
", "TemplateSyncConfig$repositoryName": "The name of the repository, for example myrepos/myrepo.
The name of the repository, for example myrepos/myrepo.
The repository provider.
", "CreateTemplateSyncConfigInput$repositoryProvider": "The provider type for your repository.
", "DeleteRepositoryInput$provider": "The repository provider.
", "GetRepositoryInput$provider": "The repository provider.
", "GetRepositorySyncStatusInput$repositoryProvider": "The repository provider.
", "ListRepositorySyncDefinitionsInput$repositoryProvider": "The repository provider.
", "Repository$provider": "The repository provider.
", "RepositoryBranch$provider": "The repository provider.
", "RepositoryBranchInput$provider": "The repository provider.
", "RepositorySummary$provider": "The repository provider.
", "Revision$repositoryProvider": "The repository provider.
", "TemplateSyncConfig$repositoryProvider": "The repository provider.
", "UpdateTemplateSyncConfigInput$repositoryProvider": "The repository provider.
" } }, "RepositorySummary": { "base": "A summary of detail data for a registered repository.
", "refs": { "RepositorySummaryList$member": null } }, "RepositorySummaryList": { "base": null, "refs": { "ListRepositoriesOutput$repositories": "An array of repositories.
" } }, "RepositorySyncAttempt": { "base": "Detail data for a repository sync attempt activated by a push to a repository.
", "refs": { "GetRepositorySyncStatusOutput$latestSync": "The repository sync status detail data that's returned by Proton.
" } }, "RepositorySyncDefinition": { "base": "The repository sync definition.
", "refs": { "RepositorySyncDefinitionList$member": null } }, "RepositorySyncDefinitionList": { "base": null, "refs": { "ListRepositorySyncDefinitionsOutput$syncDefinitions": "An array of repository sync definitions.
" } }, "RepositorySyncEvent": { "base": "Repository sync event detail data for a sync attempt.
", "refs": { "RepositorySyncEvents$member": null } }, "RepositorySyncEvents": { "base": null, "refs": { "RepositorySyncAttempt$events": "Detail data for sync attempt events.
" } }, "RepositorySyncStatus": { "base": null, "refs": { "RepositorySyncAttempt$status": "The sync attempt status.
" } }, "ResourceDeploymentStatus": { "base": "The state that a PR-based deployment can be updated to.
", "refs": { "NotifyResourceDeploymentStatusChangeInput$status": "The status of your provisioned resource.
" } }, "ResourceName": { "base": null, "refs": { "CancelEnvironmentDeploymentInput$environmentName": "The name of the environment with the deployment to cancel.
", "CancelServiceInstanceDeploymentInput$serviceInstanceName": "The name of the service instance with the deployment to cancel.
", "CancelServiceInstanceDeploymentInput$serviceName": "The name of the service with the service instance deployment to cancel.
", "CancelServicePipelineDeploymentInput$serviceName": "The name of the service with the service pipeline deployment to cancel.
", "CompatibleEnvironmentTemplate$templateName": "The compatible environment template name.
", "CompatibleEnvironmentTemplateInput$templateName": "The compatible environment template name.
", "CreateEnvironmentAccountConnectionInput$environmentName": "The name of the Proton environment that's created in the associated management account.
", "CreateEnvironmentInput$name": "The name of the environment.
", "CreateEnvironmentInput$templateName": "The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
", "CreateEnvironmentTemplateInput$name": "The name of the environment template.
", "CreateEnvironmentTemplateVersionInput$templateName": "The name of the environment template.
", "CreateServiceInput$name": "The service name.
", "CreateServiceInput$templateName": "The name of the service template that's used to create the service.
", "CreateServiceTemplateInput$name": "The name of the service template.
", "CreateServiceTemplateVersionInput$templateName": "The name of the service template.
", "CreateTemplateSyncConfigInput$templateName": "The name of your registered template.
", "DeleteEnvironmentInput$name": "The name of the environment to delete.
", "DeleteEnvironmentTemplateInput$name": "The name of the environment template to delete.
", "DeleteEnvironmentTemplateVersionInput$templateName": "The name of the environment template.
", "DeleteServiceInput$name": "The name of the service to delete.
", "DeleteServiceTemplateInput$name": "The name of the service template to delete.
", "DeleteServiceTemplateVersionInput$templateName": "The name of the service template.
", "DeleteTemplateSyncConfigInput$templateName": "The template name.
", "Environment$name": "The name of the environment.
", "Environment$templateName": "The Amazon Resource Name (ARN) of the environment template.
", "EnvironmentAccountConnection$environmentName": "The name of the environment that's associated with the environment account connection.
", "EnvironmentAccountConnectionSummary$environmentName": "The name of the environment that's associated with the environment account connection.
", "EnvironmentSummary$name": "The name of the environment.
", "EnvironmentSummary$templateName": "The name of the environment template.
", "EnvironmentTemplate$name": "The name of the environment template.
", "EnvironmentTemplateFilter$templateName": "Include templateName to filter search for a template name.
The name of the environment template.
", "EnvironmentTemplateVersion$templateName": "The name of the version of an environment template.
", "EnvironmentTemplateVersionSummary$templateName": "The name of the version of an environment template.
", "GetEnvironmentInput$name": "The name of the environment that you want to get the detail data for.
", "GetEnvironmentTemplateInput$name": "The name of the environment template that you want to get the detail data for.
", "GetEnvironmentTemplateVersionInput$templateName": "The name of the environment template.
", "GetServiceInput$name": "The name of the service that you want to get the detail data for.
", "GetServiceInstanceInput$name": "The name of a service instance that you want to get the detail data for.
", "GetServiceInstanceInput$serviceName": "The name of the service that the service instance belongs to.
", "GetServiceTemplateInput$name": "The name of the service template that you want to get detail data for.
", "GetServiceTemplateVersionInput$templateName": "The name of the service template.
", "GetTemplateSyncConfigInput$templateName": "The template name.
", "GetTemplateSyncStatusInput$templateName": "The template name.
", "ListEnvironmentAccountConnectionsInput$environmentName": "The environment name that's associated with each listed environment account connection.
", "ListEnvironmentOutputsInput$environmentName": "The environment name.
", "ListEnvironmentProvisionedResourcesInput$environmentName": "The environment name.
", "ListEnvironmentTemplateVersionsInput$templateName": "The name of the environment template.
", "ListServiceInstanceOutputsInput$serviceInstanceName": "The service instance name.
", "ListServiceInstanceOutputsInput$serviceName": "The service name.
", "ListServiceInstanceProvisionedResourcesInput$serviceInstanceName": "The service instance name.
", "ListServiceInstanceProvisionedResourcesInput$serviceName": "The service name.
", "ListServiceInstancesInput$serviceName": "The name of the service that the service instance belongs to.
", "ListServicePipelineOutputsInput$serviceName": "The service name.
", "ListServicePipelineProvisionedResourcesInput$serviceName": "The service name.
", "ListServiceTemplateVersionsInput$templateName": "The name of the service template.
", "Service$name": "The name of the service.
", "Service$templateName": "The name of the service template.
", "ServiceInstance$environmentName": "The name of the environment that the service instance was deployed into.
", "ServiceInstance$name": "The name of the service instance.
", "ServiceInstance$serviceName": "The name of the service that the service instance belongs to.
", "ServiceInstance$templateName": "The name of the service template that was used to create the service instance.
", "ServiceInstanceSummary$environmentName": "The name of the environment that the service instance was deployed into.
", "ServiceInstanceSummary$name": "The name of the service instance.
", "ServiceInstanceSummary$serviceName": "The name of the service that the service instance belongs to.
", "ServiceInstanceSummary$templateName": "The name of the service template.
", "ServicePipeline$templateName": "The name of the service template that was used to create the service pipeline.
", "ServiceSummary$name": "The name of the service.
", "ServiceSummary$templateName": "The name of the service template.
", "ServiceTemplate$name": "The name of the service template.
", "ServiceTemplateSummary$name": "The name of the service template.
", "ServiceTemplateVersion$templateName": "The name of the version of a service template.
", "ServiceTemplateVersionSummary$templateName": "The name of the service template.
", "TemplateSyncConfig$templateName": "The template name.
", "UpdateEnvironmentInput$name": "The name of the environment to update.
", "UpdateEnvironmentTemplateInput$name": "The name of the environment template to update.
", "UpdateEnvironmentTemplateVersionInput$templateName": "The name of the environment template.
", "UpdateServiceInput$name": "The name of the service to edit.
", "UpdateServiceInstanceInput$name": "The name of the service instance to update.
", "UpdateServiceInstanceInput$serviceName": "The name of the service that the service instance belongs to.
", "UpdateServicePipelineInput$serviceName": "The name of the service to that the pipeline is associated with.
", "UpdateServiceTemplateInput$name": "The name of the service template to update.
", "UpdateServiceTemplateVersionInput$templateName": "The name of the service template.
", "UpdateTemplateSyncConfigInput$templateName": "The synced template name.
" } }, "ResourceNotFoundException": { "base": "The requested resource wasn't found.
", "refs": { } }, "ResourceSyncAttempt": { "base": "Detail data for a resource sync attempt activated by a push to a repository.
", "refs": { "GetTemplateSyncStatusOutput$latestSuccessfulSync": "The details of the last successful sync that's returned by Proton.
", "GetTemplateSyncStatusOutput$latestSync": "The details of the last sync that's returned by Proton.
" } }, "ResourceSyncEvent": { "base": "Detail data for a resource sync event.
", "refs": { "ResourceSyncEvents$member": null } }, "ResourceSyncEvents": { "base": null, "refs": { "ResourceSyncAttempt$events": "An array of events with detail data.
" } }, "ResourceSyncStatus": { "base": null, "refs": { "ResourceSyncAttempt$status": "The status of the sync attempt.
" } }, "Revision": { "base": "Revision detail data for a commit and push that activates a sync attempt
", "refs": { "GetTemplateSyncStatusOutput$desiredState": "The template sync desired state that's returned by Proton.
", "ResourceSyncAttempt$initialRevision": "Detail data for the initial repository commit, path and push.
", "ResourceSyncAttempt$targetRevision": "Detail data for the target revision.
" } }, "S3Bucket": { "base": null, "refs": { "S3ObjectSource$bucket": "The name of the S3 bucket that contains a template bundle.
" } }, "S3Key": { "base": null, "refs": { "S3ObjectSource$key": "The path to the S3 bucket that contains a template bundle.
" } }, "S3ObjectSource": { "base": "Template bundle S3 bucket data.
", "refs": { "TemplateVersionSourceInput$s3": "An S3 source object that includes the template bundle S3 path and name for a template minor version.
" } }, "SHA": { "base": null, "refs": { "Revision$sha": "The secure hash algorithm (SHA) hash for the revision.
" } }, "Service": { "base": "The service detail data.
", "refs": { "CreateServiceOutput$service": "The service detail data that's returned by Proton.
", "DeleteServiceOutput$service": "The service detail data that's returned by Proton.
", "GetServiceOutput$service": "The service detail data that's returned by Proton.
", "UpdateServiceOutput$service": "The service detail data that's returned by Proton.
" } }, "ServiceArn": { "base": null, "refs": { "Service$arn": "The Amazon Resource Name (ARN) of the service.
", "ServiceSummary$arn": "The Amazon Resource Name (ARN) of the service.
" } }, "ServiceInstance": { "base": "The service instance detail data.
", "refs": { "CancelServiceInstanceDeploymentOutput$serviceInstance": "The service instance summary data that's returned by Proton.
", "GetServiceInstanceOutput$serviceInstance": "The service instance detail data that's returned by Proton.
", "UpdateServiceInstanceOutput$serviceInstance": "The service instance summary data returned by Proton.
" } }, "ServiceInstanceArn": { "base": null, "refs": { "ServiceInstance$arn": "The Amazon Resource Name (ARN) of the service instance.
", "ServiceInstanceSummary$arn": "The Amazon Resource Name (ARN) of the service instance.
" } }, "ServiceInstanceSummary": { "base": "A summary of the service instance detail data.
", "refs": { "ServiceInstanceSummaryList$member": null } }, "ServiceInstanceSummaryList": { "base": null, "refs": { "ListServiceInstancesOutput$serviceInstances": "An array of service instances with summaries of detail data.
" } }, "ServicePipeline": { "base": "The service pipeline detail data.
", "refs": { "CancelServicePipelineDeploymentOutput$pipeline": "The service pipeline detail data that's returned by Proton.
", "Service$pipeline": "The service pipeline detail data.
", "UpdateServicePipelineOutput$pipeline": "The pipeline details returned by Proton.
" } }, "ServiceQuotaExceededException": { "base": "A quota was exceeded. For more information, see Proton Quotas in the Proton Administrator Guide.
", "refs": { } }, "ServiceStatus": { "base": null, "refs": { "Service$status": "The status of the service.
", "ServiceSummary$status": "The status of the service.
" } }, "ServiceSummary": { "base": "A summary of the service detail data.
", "refs": { "ServiceSummaryList$member": null } }, "ServiceSummaryList": { "base": null, "refs": { "ListServicesOutput$services": "An array of services with summaries of detail data.
" } }, "ServiceTemplate": { "base": "The service template detail data.
", "refs": { "CreateServiceTemplateOutput$serviceTemplate": "The service template detail data that's returned by Proton.
", "DeleteServiceTemplateOutput$serviceTemplate": "The service template detail data that's returned by Proton.
", "GetServiceTemplateOutput$serviceTemplate": "The service template detail data that's returned by Proton.
", "UpdateServiceTemplateOutput$serviceTemplate": "The service template detail data that's returned by Proton.
" } }, "ServiceTemplateArn": { "base": null, "refs": { "ServiceTemplate$arn": "The Amazon Resource Name (ARN) of the service template.
", "ServiceTemplateSummary$arn": "The Amazon Resource Name (ARN) of the service template.
" } }, "ServiceTemplateSummary": { "base": "The service template summary data.
", "refs": { "ServiceTemplateSummaryList$member": null } }, "ServiceTemplateSummaryList": { "base": null, "refs": { "ListServiceTemplatesOutput$templates": "An array of service templates with detail data.
" } }, "ServiceTemplateVersion": { "base": "The version of a service template detail data.
", "refs": { "CreateServiceTemplateVersionOutput$serviceTemplateVersion": "The service template version summary of detail data that's returned by Proton.
", "DeleteServiceTemplateVersionOutput$serviceTemplateVersion": "The service template version detail data that's returned by Proton.
", "GetServiceTemplateVersionOutput$serviceTemplateVersion": "The service template version detail data that's returned by Proton.
", "UpdateServiceTemplateVersionOutput$serviceTemplateVersion": "The service template version detail data that's returned by Proton.
" } }, "ServiceTemplateVersionArn": { "base": null, "refs": { "ServiceTemplateVersion$arn": "The Amazon Resource Name (ARN) of the version of a service template.
", "ServiceTemplateVersionSummary$arn": "The Amazon Resource Name (ARN) of the version of a service template.
" } }, "ServiceTemplateVersionSummary": { "base": "A summary of the service template version detail data.
", "refs": { "ServiceTemplateVersionSummaryList$member": null } }, "ServiceTemplateVersionSummaryList": { "base": null, "refs": { "ListServiceTemplateVersionsOutput$templateVersions": "An array of major or minor versions of a service template with detail data.
" } }, "SpecContents": { "base": null, "refs": { "CreateEnvironmentInput$spec": "A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.
", "CreateServiceInput$spec": "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 doesn’t include a service pipeline. For more information, see Create a service in the Proton Administrator Guide and Create a service in the Proton User Guide.
", "Environment$spec": "The environment spec.
", "Service$spec": "The formatted specification that defines the service.
", "ServiceInstance$spec": "The service spec that was used to create the service instance.
", "ServicePipeline$spec": "The service spec that was used to create the service pipeline.
", "UpdateEnvironmentInput$spec": "The formatted specification that defines the update.
", "UpdateServiceInput$spec": "Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the Proton Administrator Guide or the Proton User Guide.
", "UpdateServiceInstanceInput$spec": "The formatted specification that defines the service instance update.
", "UpdateServicePipelineInput$spec": "The spec for the service pipeline to update.
" } }, "StatusMessage": { "base": null, "refs": { "Environment$deploymentStatusMessage": "An environment deployment status message.
", "EnvironmentSummary$deploymentStatusMessage": "An environment deployment status message.
", "EnvironmentTemplateVersion$statusMessage": "The status message of the version of an environment template.
", "EnvironmentTemplateVersionSummary$statusMessage": "The status message of the version of an environment template.
", "Service$statusMessage": "A service status message.
", "ServiceInstance$deploymentStatusMessage": "A service instance deployment status message.
", "ServiceInstanceSummary$deploymentStatusMessage": "A service instance deployment status message.
", "ServicePipeline$deploymentStatusMessage": "A service pipeline deployment status message.
", "ServiceSummary$statusMessage": "A service status message.
", "ServiceTemplateVersion$statusMessage": "A service template version status message.
", "ServiceTemplateVersionSummary$statusMessage": "A service template minor version status message.
" } }, "String": { "base": null, "refs": { "ListTagsForResourceInput$nextToken": "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.
", "ListTagsForResourceOutput$nextToken": "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.
", "RepositorySyncDefinition$directory": "The directory in the repository.
", "RepositorySyncDefinition$parent": "The resource that is synced from.
", "RepositorySyncDefinition$target": "The resource that is synced to.
", "RepositorySyncEvent$event": "Event detail for a repository sync attempt.
", "RepositorySyncEvent$externalId": "The external ID of the sync event.
", "RepositorySyncEvent$type": "The type of event.
", "ResourceSyncAttempt$target": "The resource that is synced to.
", "ResourceSyncEvent$event": "A resource sync event.
", "ResourceSyncEvent$externalId": "The external ID for the event.
", "ResourceSyncEvent$type": "The type of event.
", "Revision$directory": "The repository directory changed by a commit and push that activated the sync attempt.
" } }, "Subdirectory": { "base": null, "refs": { "CreateTemplateSyncConfigInput$subdirectory": "A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.
", "TemplateSyncConfig$subdirectory": "A subdirectory path to your template bundle version.
", "UpdateTemplateSyncConfigInput$subdirectory": "A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.
" } }, "SyncType": { "base": null, "refs": { "GetRepositorySyncStatusInput$syncType": "The repository sync type.
", "ListRepositorySyncDefinitionsInput$syncType": "The sync type. The only supported value is TEMPLATE_SYNC.
The deployment status message for your provisioned resource.
" } }, "Tag": { "base": "A description of a resource tag.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The key of the resource tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceInput$tagKeys": "An array of tag keys indicating the resource tags to be removed from the resource.
" } }, "TagList": { "base": null, "refs": { "CreateEnvironmentAccountConnectionInput$tags": "Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator Guide.
", "CreateEnvironmentInput$tags": "Create tags for your environment. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "CreateEnvironmentTemplateInput$tags": "Create tags for your environment template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "CreateEnvironmentTemplateVersionInput$tags": "Create tags for a new version of an environment template.
", "CreateServiceInput$tags": "Create tags for your service. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "CreateServiceTemplateInput$tags": "Create tags for your service template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "CreateServiceTemplateVersionInput$tags": "Create tags for a new version of a service template.
", "ListTagsForResourceOutput$tags": "An array of resource tags with detail data.
", "TagResourceInput$tags": "An array of resource tags to apply to a resource.
" } }, "TagResourceInput": { "base": null, "refs": { } }, "TagResourceOutput": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$value": "The value of the resource tag.
" } }, "TemplateSchema": { "base": null, "refs": { "EnvironmentTemplateVersion$schema": "The schema of the version of an environment template.
", "ServiceTemplateVersion$schema": "The schema of the version of a service template.
" } }, "TemplateSyncConfig": { "base": "The detail data for a template sync configuration.
", "refs": { "CreateTemplateSyncConfigOutput$templateSyncConfig": "The template sync configuration detail data that's returned by Proton.
", "DeleteTemplateSyncConfigOutput$templateSyncConfig": "The template sync configuration detail data that's returned by Proton.
", "GetTemplateSyncConfigOutput$templateSyncConfig": "The template sync configuration detail data that's returned by Proton.
", "UpdateTemplateSyncConfigOutput$templateSyncConfig": "The template sync configuration detail data that's returned by Proton.
" } }, "TemplateType": { "base": null, "refs": { "CreateTemplateSyncConfigInput$templateType": "The type of the registered template.
", "DeleteTemplateSyncConfigInput$templateType": "The template type.
", "GetTemplateSyncConfigInput$templateType": "The template type.
", "GetTemplateSyncStatusInput$templateType": "The template type.
", "TemplateSyncConfig$templateType": "The template type.
", "UpdateTemplateSyncConfigInput$templateType": "The synced template type.
" } }, "TemplateVersionPart": { "base": null, "refs": { "CompatibleEnvironmentTemplate$majorVersion": "The major version of the compatible environment template.
", "CompatibleEnvironmentTemplateInput$majorVersion": "The major version of the compatible environment template.
", "CreateEnvironmentInput$templateMajorVersion": "The major version of the environment template.
", "CreateEnvironmentInput$templateMinorVersion": "The minor version of the environment template.
", "CreateEnvironmentTemplateVersionInput$majorVersion": "To create a new minor version of the environment template, include a major Version.
To create a new major and minor version of the environment template, exclude major Version.
The major version of the service template that was used to create the service.
", "CreateServiceInput$templateMinorVersion": "The minor version of the service template that was used to create the service.
", "CreateServiceTemplateVersionInput$majorVersion": "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.
The environment template major version to delete.
", "DeleteEnvironmentTemplateVersionInput$minorVersion": "The environment template minor version to delete.
", "DeleteServiceTemplateVersionInput$majorVersion": "The service template major version to delete.
", "DeleteServiceTemplateVersionInput$minorVersion": "The service template minor version to delete.
", "Environment$templateMajorVersion": "The ID of the major version of the environment template.
", "Environment$templateMinorVersion": "The ID of the minor version of the environment template.
", "EnvironmentSummary$templateMajorVersion": "The major version of the environment template.
", "EnvironmentSummary$templateMinorVersion": "The minor version of the environment template.
", "EnvironmentTemplateFilter$majorVersion": "Include majorVersion to filter search for a major version.
The latest major version that's associated with the version of an environment template.
", "EnvironmentTemplateVersion$minorVersion": "The minor version of an environment template.
", "EnvironmentTemplateVersion$recommendedMinorVersion": "The recommended minor version of the environment template.
", "EnvironmentTemplateVersionSummary$majorVersion": "The latest major version that's associated with the version of an environment template.
", "EnvironmentTemplateVersionSummary$minorVersion": "The version of an environment template.
", "EnvironmentTemplateVersionSummary$recommendedMinorVersion": "The recommended minor version of the environment template.
", "GetEnvironmentTemplateVersionInput$majorVersion": "To view environment template major version detail data, include major Version.
To view environment template minor version detail data, include minorVersion.
To view service template major version detail data, include major Version.
To view service template minor version detail data, include minorVersion.
The template version.
", "ListEnvironmentTemplateVersionsInput$majorVersion": "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.
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 major version of the service template that was used to create the service instance.
", "ServiceInstance$templateMinorVersion": "The minor version of the service template that was used to create the service instance.
", "ServiceInstanceSummary$templateMajorVersion": "The service instance template major version.
", "ServiceInstanceSummary$templateMinorVersion": "The service instance template minor version.
", "ServicePipeline$templateMajorVersion": "The major version of the service template that was used to create the service pipeline.
", "ServicePipeline$templateMinorVersion": "The minor version of the service template that was used to create the service pipeline.
", "ServiceTemplateVersion$majorVersion": "The latest major version that's associated with the version of a service template.
", "ServiceTemplateVersion$minorVersion": "The minor version of a service template.
", "ServiceTemplateVersion$recommendedMinorVersion": "The recommended minor version of the service template.
", "ServiceTemplateVersionSummary$majorVersion": "The latest major version that's associated with the version of a service template.
", "ServiceTemplateVersionSummary$minorVersion": "The minor version of a service template.
", "ServiceTemplateVersionSummary$recommendedMinorVersion": "The recommended minor version of the service template.
", "UpdateEnvironmentInput$templateMajorVersion": "The major version of the environment to update.
", "UpdateEnvironmentInput$templateMinorVersion": "The minor version of the environment to update.
", "UpdateEnvironmentTemplateVersionInput$majorVersion": "To update a major version of an environment template, include major Version.
To update a minor version of an environment template, include minorVersion.
The major version of the service template to update.
", "UpdateServiceInstanceInput$templateMinorVersion": "The minor version of the service template to update.
", "UpdateServicePipelineInput$templateMajorVersion": "The major version of the service template that was used to create the service that the pipeline is associated with.
", "UpdateServicePipelineInput$templateMinorVersion": "The minor version of the service template that was used to create the service that the pipeline is associated with.
", "UpdateServiceTemplateVersionInput$majorVersion": "To update a major version of a service template, include major Version.
To update a minor version of a service template, include minorVersion.
Template version source data.
", "refs": { "CreateEnvironmentTemplateVersionInput$source": "An object that includes the template bundle S3 bucket path and name for the new version of an template.
", "CreateServiceTemplateVersionInput$source": "An object that includes the template bundle S3 bucket path and name for the new version of a service template.
" } }, "TemplateVersionStatus": { "base": null, "refs": { "EnvironmentTemplateVersion$status": "The status of the version of an environment template.
", "EnvironmentTemplateVersionSummary$status": "The status of the version of an environment template.
", "ServiceTemplateVersion$status": "The service template version status.
", "ServiceTemplateVersionSummary$status": "The service template minor version status.
", "UpdateEnvironmentTemplateVersionInput$status": "The status of the environment template minor version to update.
", "UpdateServiceTemplateVersionInput$status": "The status of the service template minor version to update.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "Environment$createdAt": "The time when the environment was created.
", "Environment$lastDeploymentAttemptedAt": "The time when a deployment of the environment was last attempted.
", "Environment$lastDeploymentSucceededAt": "The time when the environment was last deployed successfully.
", "EnvironmentAccountConnection$lastModifiedAt": "The time when the environment account connection was last modified.
", "EnvironmentAccountConnection$requestedAt": "The time when the environment account connection request was made.
", "EnvironmentAccountConnectionSummary$lastModifiedAt": "The time when the environment account connection was last modified.
", "EnvironmentAccountConnectionSummary$requestedAt": "The time when the environment account connection request was made.
", "EnvironmentSummary$createdAt": "The time when the environment was created.
", "EnvironmentSummary$lastDeploymentAttemptedAt": "The time when a deployment of the environment was last attempted.
", "EnvironmentSummary$lastDeploymentSucceededAt": "The time when the environment was last deployed successfully.
", "EnvironmentTemplate$createdAt": "The time when the environment template was created.
", "EnvironmentTemplate$lastModifiedAt": "The time when the environment template was last modified.
", "EnvironmentTemplateSummary$createdAt": "The time when the environment template was created.
", "EnvironmentTemplateSummary$lastModifiedAt": "The time when the environment template was last modified.
", "EnvironmentTemplateVersion$createdAt": "The time when the version of an environment template was created.
", "EnvironmentTemplateVersion$lastModifiedAt": "The time when the version of an environment template was last modified.
", "EnvironmentTemplateVersionSummary$createdAt": "The time when the version of an environment template was created.
", "EnvironmentTemplateVersionSummary$lastModifiedAt": "The time when the version of an environment template was last modified.
", "RepositorySyncAttempt$startedAt": "The time when the sync attempt started.
", "RepositorySyncEvent$time": "The time that the sync event occurred.
", "ResourceSyncAttempt$startedAt": "The time when the sync attempt started.
", "ResourceSyncEvent$time": "The time when the event occurred.
", "Service$createdAt": "The time when the service was created.
", "Service$lastModifiedAt": "The time when the service was last modified.
", "ServiceInstance$createdAt": "The time when the service instance was created.
", "ServiceInstance$lastDeploymentAttemptedAt": "The time when a deployment of the service instance was last attempted.
", "ServiceInstance$lastDeploymentSucceededAt": "The time when the service instance was last deployed successfully.
", "ServiceInstanceSummary$createdAt": "The time when the service instance was created.
", "ServiceInstanceSummary$lastDeploymentAttemptedAt": "The time when a deployment of the service was last attempted.
", "ServiceInstanceSummary$lastDeploymentSucceededAt": "The time when the service was last deployed successfully.
", "ServicePipeline$createdAt": "The time when the service pipeline was created.
", "ServicePipeline$lastDeploymentAttemptedAt": "The time when a deployment of the service pipeline was last attempted.
", "ServicePipeline$lastDeploymentSucceededAt": "The time when the service pipeline was last deployed successfully.
", "ServiceSummary$createdAt": "The time when the service was created.
", "ServiceSummary$lastModifiedAt": "The time when the service was last modified.
", "ServiceTemplate$createdAt": "The time when the service template was created.
", "ServiceTemplate$lastModifiedAt": "The time when the service template was last modified.
", "ServiceTemplateSummary$createdAt": "The time when the service template was created.
", "ServiceTemplateSummary$lastModifiedAt": "The time when the service template was last modified.
", "ServiceTemplateVersion$createdAt": "The time when the version of a service template was created.
", "ServiceTemplateVersion$lastModifiedAt": "The time when the version of a service template was last modified.
", "ServiceTemplateVersionSummary$createdAt": "The time when the version of a service template was created.
", "ServiceTemplateVersionSummary$lastModifiedAt": "The time when the version of a service template was last modified.
" } }, "UntagResourceInput": { "base": null, "refs": { } }, "UntagResourceOutput": { "base": null, "refs": { } }, "UpdateAccountSettingsInput": { "base": null, "refs": { } }, "UpdateAccountSettingsOutput": { "base": null, "refs": { } }, "UpdateEnvironmentAccountConnectionInput": { "base": null, "refs": { } }, "UpdateEnvironmentAccountConnectionOutput": { "base": null, "refs": { } }, "UpdateEnvironmentInput": { "base": null, "refs": { } }, "UpdateEnvironmentOutput": { "base": null, "refs": { } }, "UpdateEnvironmentTemplateInput": { "base": null, "refs": { } }, "UpdateEnvironmentTemplateOutput": { "base": null, "refs": { } }, "UpdateEnvironmentTemplateVersionInput": { "base": null, "refs": { } }, "UpdateEnvironmentTemplateVersionOutput": { "base": null, "refs": { } }, "UpdateServiceInput": { "base": null, "refs": { } }, "UpdateServiceInstanceInput": { "base": null, "refs": { } }, "UpdateServiceInstanceOutput": { "base": null, "refs": { } }, "UpdateServiceOutput": { "base": null, "refs": { } }, "UpdateServicePipelineInput": { "base": null, "refs": { } }, "UpdateServicePipelineOutput": { "base": null, "refs": { } }, "UpdateServiceTemplateInput": { "base": null, "refs": { } }, "UpdateServiceTemplateOutput": { "base": null, "refs": { } }, "UpdateServiceTemplateVersionInput": { "base": null, "refs": { } }, "UpdateServiceTemplateVersionOutput": { "base": null, "refs": { } }, "UpdateTemplateSyncConfigInput": { "base": null, "refs": { } }, "UpdateTemplateSyncConfigOutput": { "base": null, "refs": { } }, "ValidationException": { "base": "The input is invalid or an out-of-range value was supplied for the input parameter.
", "refs": { } } } }