HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CancelServiceInstanceDeployment
CancelServiceInstanceDeployment
Attempts to cancel a service instance deployment on an UpdateServiceInstance (p. 192) action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the AWS Proton Administrator guide or the AWS 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 (p. 192) action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.
Request Syntax
{ "serviceInstanceName": "string", "serviceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
serviceInstanceName (p. 11)
The name of the service instance with the deployment to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes serviceName (p. 11)
The name of the service with the service instance deployment to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
Response Syntax
{
Response Elements
"serviceInstance": { "arn": "string", "createdAt": number,
"deploymentStatus": "string",
"deploymentStatusMessage": "string", "environmentName": "string",
"lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "name": "string",
"serviceName": "string", "spec": "string",
"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
serviceInstance (p. 11)
The service instance summary data that's returned by AWS Proton.
Type: ServiceInstance (p. 255) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 ConflictException
The request couldn't be made due to a conflicting operation or resource.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CancelServicePipelineDeployment
CancelServicePipelineDeployment
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline (p. 196) action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the AWS Proton Administrator guide or the AWS 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 (p. 196) action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.
Request Syntax
{
"serviceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
serviceName (p. 14)
The name of the service with the service pipeline deployment to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
"deploymentStatus": "string",
"deploymentStatusMessage": "string", "lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "spec": "string",
"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"
}}
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
pipeline (p. 14)
The service pipeline detail data that's returned by AWS Proton.
Type: ServicePipeline (p. 261) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 ConflictException
The request couldn't be made due to a conflicting operation or resource.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateEnvironment
CreateEnvironment
Deploy a new environment. An AWS 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: AWS Proton makes direct calls to provision your resources.
• Pull request provisioning: AWS 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 AWS Proton Administrator Guide.
Request Syntax
{ "description": "string",
"environmentAccountConnectionId": "string", "name": "string",
"protonServiceRoleArn": "string", "provisioningRepository": { "branch": "string", "name": "string", "provider": "string"
},
"spec": "string", "tags": [
"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
description (p. 17)
A description of the environment that's being created and deployed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
environmentAccountConnectionId (p. 17)
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
Request Parameters
environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter and values. For more information, see Environment account connections in the AWS Proton Administrator guide.
Type: String
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Required: No name (p. 17)
The name of the environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
protonServiceRoleArn (p. 17)
The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
provisioningRepository (p. 17)
The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
Important
Provisioning by pull request is currently in feature preview and is only usable with Terraform based AWS Proton Templates. To learn more about AWS Feature Preview terms, see section 2 on Beta and Previews.
Type: RepositoryBranchInput (p. 241) object Required: No
spec (p. 17)
A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the AWS Proton Administrator Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 51200.
Required: Yes tags (p. 17)
Create tags for your environment. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
Type: Array of Tag (p. 274) objects
Response Syntax
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
templateMajorVersion (p. 17)
The major version of the environment template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^(0|([1-9]{1}\d*))$
Required: Yes
templateMinorVersion (p. 17)
The minor version of the environment template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^(0|([1-9]{1}\d*))$
Required: No templateName (p. 17)
The name of the environment template. For more information, see Environment Templates in the AWS Proton Administrator Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
"deploymentStatus": "string",
"deploymentStatusMessage": "string", "description": "string",
"environmentAccountConnectionId": "string", "environmentAccountId": "string",
"lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "name": "string",
"protonServiceRoleArn": "string", "provisioning": "string",
"provisioningRepository": {
Response Elements
"spec": "string",
"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
environment (p. 19)
The environment detail data that's returned by AWS Proton.
Type: Environment (p. 215) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 ConflictException
The request couldn't be made due to a conflicting operation or resource.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ServiceQuotaExceededException
A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
See Also
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateEnvironmentAccountConnection
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 AWS Proton Administrator guide.
Request Syntax
{ "clientToken": "string", "environmentName": "string", "managementAccountId": "string", "roleArn": "string",
"tags": [
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
clientToken (p. 22)
When included, if two identical requests are made with the same client token, AWS Proton returns the environment account connection that the first request created.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: ^[!-~]*$
Required: No
environmentName (p. 22)
The name of the AWS Proton environment that's created in the associated management account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
managementAccountId (p. 22)
The ID of the management account that accepts or rejects the environment account connection.
You create and manage the AWS Proton environment in this account. If the management account
Response Syntax
accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
Type: String Pattern: ^\d{12}$
Required: Yes roleArn (p. 22)
The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account.
AWS Proton uses this role to provision infrastructure resources in the associated environment account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes tags (p. 22)
Tags for your environment account connection. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide.
Type: Array of Tag (p. 274) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{ "environmentAccountConnection": { "arn": "string",
"environmentAccountId": "string", "environmentName": "string", "id": "string",
"lastModifiedAt": number, "managementAccountId": "string", "requestedAt": number,
"roleArn": "string", "status": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
environmentAccountConnection (p. 23)
The environment account connection detail data that's returned by AWS Proton.
Type: EnvironmentAccountConnection (p. 218) object
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 ConflictException
The request couldn't be made due to a conflicting operation or resource.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ServiceQuotaExceededException
A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateEnvironmentTemplate
CreateEnvironmentTemplate
Create an environment template for AWS Proton. For more information, see Environment Templates in the AWS 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 AWS Proton to deploy and manage environment infrastructure.
• Register and publish a customer managed environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS 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 AWS Proton Administrator Guide.
Request Syntax
{
"description": "string", "displayName": "string", "encryptionKey": "string", "name": "string",
"provisioning": "string", "tags": [
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
description (p. 25)
A description of the environment template.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No displayName (p. 25)
The environment template name as displayed in the developer interface.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Response Syntax
Required: No encryptionKey (p. 25)
A customer provided encryption key that AWS Proton uses to encrypt data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No name (p. 25)
The name of the environment template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes provisioning (p. 25)
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
Type: String
Valid Values: CUSTOMER_MANAGED Required: No
tags (p. 25)
Create tags for your environment template. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
Type: Array of Tag (p. 274) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{ "environmentTemplate": { "arn": "string", "createdAt": number, "description": "string", "displayName": "string", "encryptionKey": "string", "lastModifiedAt": number, "name": "string",
"provisioning": "string", "recommendedVersion": "string"
}}
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
environmentTemplate (p. 26)
The environment template detail data that's returned by AWS Proton.
Type: EnvironmentTemplate (p. 225) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 ConflictException
The request couldn't be made due to a conflicting operation or resource.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ServiceQuotaExceededException
A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
See Also
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateEnvironmentTemplateVersion
CreateEnvironmentTemplateVersion
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.
Request Syntax
{ "clientToken": "string", "description": "string", "majorVersion": "string", "source": {
"templateName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
clientToken (p. 29)
When included, if two identical requests are made with the same client token, AWS Proton returns the environment template version that the first request created.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: ^[!-~]*$
Required: No description (p. 29)
A description of the new version of an environment template.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No majorVersion (p. 29)
To create a new minor version of the environment template, include major Version.
Response Syntax
To create a new major and minor version of the environment template, exclude major Version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^(0|([1-9]{1}\d*))$
Required: No source (p. 29)
An object that includes the template bundle S3 bucket path and name for the new version of an template.
Type: TemplateVersionSourceInput (p. 277) object Required: Yes
tags (p. 29)
Create tags for a new version of an environment template.
Type: Array of Tag (p. 274) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No templateName (p. 29)
The name of the environment template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
Response Syntax
{ "environmentTemplateVersion": { "arn": "string",
"createdAt": number, "description": "string", "lastModifiedAt": number, "majorVersion": "string", "minorVersion": "string",
"recommendedMinorVersion": "string", "schema": "string",
"status": "string",
"statusMessage": "string", "templateName": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
environmentTemplateVersion (p. 30)
The environment template detail data that's returned by AWS Proton.
Type: EnvironmentTemplateVersion (p. 230) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 ConflictException
The request couldn't be made due to a conflicting operation or resource.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ServiceQuotaExceededException
A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
For more information about using this API in one of the language-specific AWS SDKs, see the following: