AWS has decided to discontinue AWS Proton, with support ending on October 7, 2026. New customers will not be able to sign up after October 7, 2025, but existing customers can continue to use the service until October 7, 2026.For more information, see [AWS Proton Service Deprecation and Migration Guide](https://docs.aws.amazon.com/proton/latest/userguide/proton-end-of-support.html).

# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AcceptEnvironmentAccountConnection](API_AcceptEnvironmentAccountConnection.md) 
+  [CancelComponentDeployment](API_CancelComponentDeployment.md) 
+  [CancelEnvironmentDeployment](API_CancelEnvironmentDeployment.md) 
+  [CancelServiceInstanceDeployment](API_CancelServiceInstanceDeployment.md) 
+  [CancelServicePipelineDeployment](API_CancelServicePipelineDeployment.md) 
+  [CreateComponent](API_CreateComponent.md) 
+  [CreateEnvironment](API_CreateEnvironment.md) 
+  [CreateEnvironmentAccountConnection](API_CreateEnvironmentAccountConnection.md) 
+  [CreateEnvironmentTemplate](API_CreateEnvironmentTemplate.md) 
+  [CreateEnvironmentTemplateVersion](API_CreateEnvironmentTemplateVersion.md) 
+  [CreateRepository](API_CreateRepository.md) 
+  [CreateService](API_CreateService.md) 
+  [CreateServiceInstance](API_CreateServiceInstance.md) 
+  [CreateServiceSyncConfig](API_CreateServiceSyncConfig.md) 
+  [CreateServiceTemplate](API_CreateServiceTemplate.md) 
+  [CreateServiceTemplateVersion](API_CreateServiceTemplateVersion.md) 
+  [CreateTemplateSyncConfig](API_CreateTemplateSyncConfig.md) 
+  [DeleteComponent](API_DeleteComponent.md) 
+  [DeleteDeployment](API_DeleteDeployment.md) 
+  [DeleteEnvironment](API_DeleteEnvironment.md) 
+  [DeleteEnvironmentAccountConnection](API_DeleteEnvironmentAccountConnection.md) 
+  [DeleteEnvironmentTemplate](API_DeleteEnvironmentTemplate.md) 
+  [DeleteEnvironmentTemplateVersion](API_DeleteEnvironmentTemplateVersion.md) 
+  [DeleteRepository](API_DeleteRepository.md) 
+  [DeleteService](API_DeleteService.md) 
+  [DeleteServiceSyncConfig](API_DeleteServiceSyncConfig.md) 
+  [DeleteServiceTemplate](API_DeleteServiceTemplate.md) 
+  [DeleteServiceTemplateVersion](API_DeleteServiceTemplateVersion.md) 
+  [DeleteTemplateSyncConfig](API_DeleteTemplateSyncConfig.md) 
+  [GetAccountSettings](API_GetAccountSettings.md) 
+  [GetComponent](API_GetComponent.md) 
+  [GetDeployment](API_GetDeployment.md) 
+  [GetEnvironment](API_GetEnvironment.md) 
+  [GetEnvironmentAccountConnection](API_GetEnvironmentAccountConnection.md) 
+  [GetEnvironmentTemplate](API_GetEnvironmentTemplate.md) 
+  [GetEnvironmentTemplateVersion](API_GetEnvironmentTemplateVersion.md) 
+  [GetRepository](API_GetRepository.md) 
+  [GetRepositorySyncStatus](API_GetRepositorySyncStatus.md) 
+  [GetResourcesSummary](API_GetResourcesSummary.md) 
+  [GetService](API_GetService.md) 
+  [GetServiceInstance](API_GetServiceInstance.md) 
+  [GetServiceInstanceSyncStatus](API_GetServiceInstanceSyncStatus.md) 
+  [GetServiceSyncBlockerSummary](API_GetServiceSyncBlockerSummary.md) 
+  [GetServiceSyncConfig](API_GetServiceSyncConfig.md) 
+  [GetServiceTemplate](API_GetServiceTemplate.md) 
+  [GetServiceTemplateVersion](API_GetServiceTemplateVersion.md) 
+  [GetTemplateSyncConfig](API_GetTemplateSyncConfig.md) 
+  [GetTemplateSyncStatus](API_GetTemplateSyncStatus.md) 
+  [ListComponentOutputs](API_ListComponentOutputs.md) 
+  [ListComponentProvisionedResources](API_ListComponentProvisionedResources.md) 
+  [ListComponents](API_ListComponents.md) 
+  [ListDeployments](API_ListDeployments.md) 
+  [ListEnvironmentAccountConnections](API_ListEnvironmentAccountConnections.md) 
+  [ListEnvironmentOutputs](API_ListEnvironmentOutputs.md) 
+  [ListEnvironmentProvisionedResources](API_ListEnvironmentProvisionedResources.md) 
+  [ListEnvironments](API_ListEnvironments.md) 
+  [ListEnvironmentTemplates](API_ListEnvironmentTemplates.md) 
+  [ListEnvironmentTemplateVersions](API_ListEnvironmentTemplateVersions.md) 
+  [ListRepositories](API_ListRepositories.md) 
+  [ListRepositorySyncDefinitions](API_ListRepositorySyncDefinitions.md) 
+  [ListServiceInstanceOutputs](API_ListServiceInstanceOutputs.md) 
+  [ListServiceInstanceProvisionedResources](API_ListServiceInstanceProvisionedResources.md) 
+  [ListServiceInstances](API_ListServiceInstances.md) 
+  [ListServicePipelineOutputs](API_ListServicePipelineOutputs.md) 
+  [ListServicePipelineProvisionedResources](API_ListServicePipelineProvisionedResources.md) 
+  [ListServices](API_ListServices.md) 
+  [ListServiceTemplates](API_ListServiceTemplates.md) 
+  [ListServiceTemplateVersions](API_ListServiceTemplateVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [NotifyResourceDeploymentStatusChange](API_NotifyResourceDeploymentStatusChange.md) 
+  [RejectEnvironmentAccountConnection](API_RejectEnvironmentAccountConnection.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAccountSettings](API_UpdateAccountSettings.md) 
+  [UpdateComponent](API_UpdateComponent.md) 
+  [UpdateEnvironment](API_UpdateEnvironment.md) 
+  [UpdateEnvironmentAccountConnection](API_UpdateEnvironmentAccountConnection.md) 
+  [UpdateEnvironmentTemplate](API_UpdateEnvironmentTemplate.md) 
+  [UpdateEnvironmentTemplateVersion](API_UpdateEnvironmentTemplateVersion.md) 
+  [UpdateService](API_UpdateService.md) 
+  [UpdateServiceInstance](API_UpdateServiceInstance.md) 
+  [UpdateServicePipeline](API_UpdateServicePipeline.md) 
+  [UpdateServiceSyncBlocker](API_UpdateServiceSyncBlocker.md) 
+  [UpdateServiceSyncConfig](API_UpdateServiceSyncConfig.md) 
+  [UpdateServiceTemplate](API_UpdateServiceTemplate.md) 
+  [UpdateServiceTemplateVersion](API_UpdateServiceTemplateVersion.md) 
+  [UpdateTemplateSyncConfig](API_UpdateTemplateSyncConfig.md) 

# AcceptEnvironmentAccountConnection
<a name="API_AcceptEnvironmentAccountConnection"></a>

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

For more information, see [Environment account connections](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.

## Request Syntax
<a name="API_AcceptEnvironmentAccountConnection_RequestSyntax"></a>

```
{
   "id": "string"
}
```

## Request Parameters
<a name="API_AcceptEnvironmentAccountConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [id](#API_AcceptEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-AcceptEnvironmentAccountConnection-request-id"></a>
The ID of the environment account connection.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_AcceptEnvironmentAccountConnection_ResponseSyntax"></a>

```
{
   "environmentAccountConnection": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "environmentAccountId": "string",
      "environmentName": "string",
      "id": "string",
      "lastModifiedAt": number,
      "managementAccountId": "string",
      "requestedAt": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_AcceptEnvironmentAccountConnection_ResponseElements"></a>

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](#API_AcceptEnvironmentAccountConnection_ResponseSyntax) **   <a name="proton-AcceptEnvironmentAccountConnection-response-environmentAccountConnection"></a>
The environment account connection data that's returned by AWS Proton.  
Type: [EnvironmentAccountConnection](API_EnvironmentAccountConnection.md) object

## Errors
<a name="API_AcceptEnvironmentAccountConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_AcceptEnvironmentAccountConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/AcceptEnvironmentAccountConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/AcceptEnvironmentAccountConnection) 

# CancelComponentDeployment
<a name="API_CancelComponentDeployment"></a>

Attempts to cancel a component deployment (for a component that is in the `IN_PROGRESS` deployment status).

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CancelComponentDeployment_RequestSyntax"></a>

```
{
   "componentName": "string"
}
```

## Request Parameters
<a name="API_CancelComponentDeployment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [componentName](#API_CancelComponentDeployment_RequestSyntax) **   <a name="proton-CancelComponentDeployment-request-componentName"></a>
The name of the component 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

## Response Syntax
<a name="API_CancelComponentDeployment_ResponseSyntax"></a>

```
{
   "component": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "serviceSpec": "string"
   }
}
```

## Response Elements
<a name="API_CancelComponentDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [component](#API_CancelComponentDeployment_ResponseSyntax) **   <a name="proton-CancelComponentDeployment-response-component"></a>
The detailed data of the component with the deployment that is being canceled.  
Type: [Component](API_Component.md) object

## Errors
<a name="API_CancelComponentDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_CancelComponentDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CancelComponentDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CancelComponentDeployment) 

# CancelEnvironmentDeployment
<a name="API_CancelEnvironmentDeployment"></a>

Attempts to cancel an environment deployment on an [UpdateEnvironment](API_UpdateEnvironment.md) action, if the deployment is `IN_PROGRESS`. For more information, see [Update an environment](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html) in 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 [UpdateEnvironment](API_UpdateEnvironment.md) action succeeds before the cancellation attempt starts, the resulting deployment state is `SUCCEEDED` and the cancellation attempt has no effect.

## Request Syntax
<a name="API_CancelEnvironmentDeployment_RequestSyntax"></a>

```
{
   "environmentName": "string"
}
```

## Request Parameters
<a name="API_CancelEnvironmentDeployment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [environmentName](#API_CancelEnvironmentDeployment_RequestSyntax) **   <a name="proton-CancelEnvironmentDeployment-request-environmentName"></a>
The name of the environment 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

## Response Syntax
<a name="API_CancelEnvironmentDeployment_ResponseSyntax"></a>

```
{
   "environment": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentAccountConnectionId": "string",
      "environmentAccountId": "string",
      "lastAttemptedDeploymentId": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "protonServiceRoleArn": "string",
      "provisioning": "string",
      "provisioningRepository": { 
         "arn": "string",
         "branch": "string",
         "name": "string",
         "provider": "string"
      },
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_CancelEnvironmentDeployment_ResponseElements"></a>

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](#API_CancelEnvironmentDeployment_ResponseSyntax) **   <a name="proton-CancelEnvironmentDeployment-response-environment"></a>
The environment summary data that's returned by AWS Proton.  
Type: [Environment](API_Environment.md) object

## Errors
<a name="API_CancelEnvironmentDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_CancelEnvironmentDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CancelEnvironmentDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CancelEnvironmentDeployment) 

# CancelServiceInstanceDeployment
<a name="API_CancelServiceInstanceDeployment"></a>

Attempts to cancel a service instance deployment on an [UpdateServiceInstance](API_UpdateServiceInstance.md) action, if the deployment is `IN_PROGRESS`. For more information, see [Update a service instance](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html) in 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](API_UpdateServiceInstance.md) action succeeds before the cancellation attempt starts, the resulting deployment state is `SUCCEEDED` and the cancellation attempt has no effect.

## Request Syntax
<a name="API_CancelServiceInstanceDeployment_RequestSyntax"></a>

```
{
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_CancelServiceInstanceDeployment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [serviceInstanceName](#API_CancelServiceInstanceDeployment_RequestSyntax) **   <a name="proton-CancelServiceInstanceDeployment-request-serviceInstanceName"></a>
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](#API_CancelServiceInstanceDeployment_RequestSyntax) **   <a name="proton-CancelServiceInstanceDeployment-request-serviceName"></a>
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
<a name="API_CancelServiceInstanceDeployment_ResponseSyntax"></a>

```
{
   "serviceInstance": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceName": "string",
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_CancelServiceInstanceDeployment_ResponseElements"></a>

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](#API_CancelServiceInstanceDeployment_ResponseSyntax) **   <a name="proton-CancelServiceInstanceDeployment-response-serviceInstance"></a>
The service instance summary data that's returned by AWS Proton.  
Type: [ServiceInstance](API_ServiceInstance.md) object

## Errors
<a name="API_CancelServiceInstanceDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_CancelServiceInstanceDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CancelServiceInstanceDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CancelServiceInstanceDeployment) 

# CancelServicePipelineDeployment
<a name="API_CancelServicePipelineDeployment"></a>

Attempts to cancel a service pipeline deployment on an [UpdateServicePipeline](API_UpdateServicePipeline.md) action, if the deployment is `IN_PROGRESS`. For more information, see [Update a service pipeline](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html) in 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](API_UpdateServicePipeline.md) action succeeds before the cancellation attempt starts, the resulting deployment state is `SUCCEEDED` and the cancellation attempt has no effect.

## Request Syntax
<a name="API_CancelServicePipelineDeployment_RequestSyntax"></a>

```
{
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_CancelServicePipelineDeployment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [serviceName](#API_CancelServicePipelineDeployment_RequestSyntax) **   <a name="proton-CancelServicePipelineDeployment-request-serviceName"></a>
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_\-]*`   
Required: Yes

## Response Syntax
<a name="API_CancelServicePipelineDeployment_ResponseSyntax"></a>

```
{
   "pipeline": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "lastAttemptedDeploymentId": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_CancelServicePipelineDeployment_ResponseElements"></a>

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](#API_CancelServicePipelineDeployment_ResponseSyntax) **   <a name="proton-CancelServicePipelineDeployment-response-pipeline"></a>
The service pipeline detail data that's returned by AWS Proton.  
Type: [ServicePipeline](API_ServicePipeline.md) object

## Errors
<a name="API_CancelServicePipelineDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_CancelServicePipelineDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CancelServicePipelineDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CancelServicePipelineDeployment) 

# CreateComponent
<a name="API_CreateComponent"></a>

Create an AWS Proton component. A component is an infrastructure extension for a service instance.

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CreateComponent_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "description": "string",
   "environmentName": "string",
   "manifest": "string",
   "name": "string",
   "serviceInstanceName": "string",
   "serviceName": "string",
   "serviceSpec": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateFile": "string"
}
```

## Request Parameters
<a name="API_CreateComponent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-clientToken"></a>
The client token for the created component.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [description](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-description"></a>
An optional customer-provided description of the component.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [environmentName](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-environmentName"></a>
The name of the AWS Proton environment that you want to associate this component with. You must specify this when you don't specify `serviceInstanceName` and `serviceName`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [manifest](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-manifest"></a>
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** [name](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-name"></a>
The customer-provided name of the component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceInstanceName](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-serviceInstanceName"></a>
The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both `serviceInstanceName` and `serviceName` or neither of them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceName](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-serviceName"></a>
The name of the service that `serviceInstanceName` is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both `serviceInstanceName` and `serviceName` or neither of them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceSpec](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-serviceSpec"></a>
The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** [tags](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton component. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [templateFile](#API_CreateComponent_RequestSyntax) **   <a name="proton-CreateComponent-request-templateFile"></a>
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.  
Components support a single IaC file, even if you use Terraform as your template language.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: Yes

## Response Syntax
<a name="API_CreateComponent_ResponseSyntax"></a>

```
{
   "component": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "serviceSpec": "string"
   }
}
```

## Response Elements
<a name="API_CreateComponent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [component](#API_CreateComponent_ResponseSyntax) **   <a name="proton-CreateComponent-response-component"></a>
The detailed data of the created component.  
Type: [Component](API_Component.md) object

## Errors
<a name="API_CreateComponent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateComponent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateComponent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateComponent) 

# CreateEnvironment
<a name="API_CreateEnvironment"></a>

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:**
+  AWS-managed provisioning: AWS Proton makes direct calls to provision your resources.
+ Self-managed 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 [Environments](https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) and [Provisioning methods](https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CreateEnvironment_RequestSyntax"></a>

```
{
   "codebuildRoleArn": "string",
   "componentRoleArn": "string",
   "description": "string",
   "environmentAccountConnectionId": "string",
   "name": "string",
   "protonServiceRoleArn": "string",
   "provisioningRepository": { 
      "branch": "string",
      "name": "string",
      "provider": "string"
   },
   "spec": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateMajorVersion": "string",
   "templateMinorVersion": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_CreateEnvironment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [codebuildRoleArn](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-codebuildRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that allows AWS Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.  
To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the `environmentAccountConnectionId` or `codebuildRoleArn` parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [componentRoleArn](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-componentRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.  
You must specify `componentRoleArn` to allow directly defined components to be associated with this environment.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [description](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-description"></a>
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](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-environmentAccountConnectionId"></a>
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see [Environment account connections](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.  
To use AWS-managed provisioning for the environment, specify either the `environmentAccountConnectionId` or `protonServiceRoleArn` parameter and omit the `provisioningRepository` parameter.  
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](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-name"></a>
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](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-protonServiceRoleArn"></a>
The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.  
To use AWS-managed provisioning for the environment, specify either the `environmentAccountConnectionId` or `protonServiceRoleArn` parameter and omit the `provisioningRepository` parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

 ** [provisioningRepository](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-provisioningRepository"></a>
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with AWS Proton. For more information, see [CreateRepository](API_CreateRepository.md).  
To use self-managed provisioning for the environment, specify this parameter and omit the `environmentAccountConnectionId` and `protonServiceRoleArn` parameters.  
Type: [RepositoryBranchInput](API_RepositoryBranchInput.md) object  
Required: No

 ** [spec](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-spec"></a>
A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see [Environments](https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: Yes

 ** [tags](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton environment. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [templateMajorVersion](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-templateMajorVersion"></a>
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](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-templateMinorVersion"></a>
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](#API_CreateEnvironment_RequestSyntax) **   <a name="proton-CreateEnvironment-request-templateName"></a>
The name of the environment template. For more information, see [Environment Templates](https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the * AWS Proton User Guide*.  
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
<a name="API_CreateEnvironment_ResponseSyntax"></a>

```
{
   "environment": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentAccountConnectionId": "string",
      "environmentAccountId": "string",
      "lastAttemptedDeploymentId": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "protonServiceRoleArn": "string",
      "provisioning": "string",
      "provisioningRepository": { 
         "arn": "string",
         "branch": "string",
         "name": "string",
         "provider": "string"
      },
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_CreateEnvironment_ResponseElements"></a>

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](#API_CreateEnvironment_ResponseSyntax) **   <a name="proton-CreateEnvironment-response-environment"></a>
The environment detail data that's returned by AWS Proton.  
Type: [Environment](API_Environment.md) object

## Errors
<a name="API_CreateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateEnvironment) 

# CreateEnvironmentAccountConnection
<a name="API_CreateEnvironmentAccountConnection"></a>

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](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.

## Request Syntax
<a name="API_CreateEnvironmentAccountConnection_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "codebuildRoleArn": "string",
   "componentRoleArn": "string",
   "environmentName": "string",
   "managementAccountId": "string",
   "roleArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateEnvironmentAccountConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-request-clientToken"></a>
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

 ** [codebuildRoleArn](#API_CreateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-request-codebuildRoleArn"></a>
The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [componentRoleArn](#API_CreateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-request-componentRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.  
You must specify `componentRoleArn` to allow directly defined components to be associated with any environments running in this account.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [environmentName](#API_CreateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-request-environmentName"></a>
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](#API_CreateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-request-managementAccountId"></a>
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 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](#API_CreateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-request-roleArn"></a>
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 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [tags](#API_CreateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton environment account connection. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateEnvironmentAccountConnection_ResponseSyntax"></a>

```
{
   "environmentAccountConnection": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "environmentAccountId": "string",
      "environmentName": "string",
      "id": "string",
      "lastModifiedAt": number,
      "managementAccountId": "string",
      "requestedAt": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_CreateEnvironmentAccountConnection_ResponseElements"></a>

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](#API_CreateEnvironmentAccountConnection_ResponseSyntax) **   <a name="proton-CreateEnvironmentAccountConnection-response-environmentAccountConnection"></a>
The environment account connection detail data that's returned by AWS Proton.  
Type: [EnvironmentAccountConnection](API_EnvironmentAccountConnection.md) object

## Errors
<a name="API_CreateEnvironmentAccountConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateEnvironmentAccountConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateEnvironmentAccountConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateEnvironmentAccountConnection) 

# CreateEnvironmentTemplate
<a name="API_CreateEnvironmentTemplate"></a>

Create an environment template for AWS Proton. For more information, see [Environment Templates](https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the * AWS Proton User Guide*.

You can create an environment template in one of the two following ways:
+ Register and publish a *standard* environment template that instructs 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](https://docs.aws.amazon.com/proton/latest/userguide/template-create.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CreateEnvironmentTemplate_RequestSyntax"></a>

```
{
   "description": "string",
   "displayName": "string",
   "encryptionKey": "string",
   "name": "string",
   "provisioning": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateEnvironmentTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreateEnvironmentTemplate_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplate-request-description"></a>
A description of the environment template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [displayName](#API_CreateEnvironmentTemplate_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplate-request-displayName"></a>
The environment template name as displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [encryptionKey](#API_CreateEnvironmentTemplate_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplate-request-encryptionKey"></a>
A customer provided encryption key that AWS Proton uses to encrypt data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

 ** [name](#API_CreateEnvironmentTemplate_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplate-request-name"></a>
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](#API_CreateEnvironmentTemplate_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplate-request-provisioning"></a>
When included, indicates that the environment template is for customer provisioned and managed infrastructure.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

 ** [tags](#API_CreateEnvironmentTemplate_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplate-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton environment template. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateEnvironmentTemplate_ResponseSyntax"></a>

```
{
   "environmentTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "provisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_CreateEnvironmentTemplate_ResponseElements"></a>

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](#API_CreateEnvironmentTemplate_ResponseSyntax) **   <a name="proton-CreateEnvironmentTemplate-response-environmentTemplate"></a>
The environment template detail data that's returned by AWS Proton.  
Type: [EnvironmentTemplate](API_EnvironmentTemplate.md) object

## Errors
<a name="API_CreateEnvironmentTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateEnvironmentTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateEnvironmentTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateEnvironmentTemplate) 

# CreateEnvironmentTemplateVersion
<a name="API_CreateEnvironmentTemplateVersion"></a>

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
<a name="API_CreateEnvironmentTemplateVersion_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "description": "string",
   "majorVersion": "string",
   "source": { ... },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateName": "string"
}
```

## Request Parameters
<a name="API_CreateEnvironmentTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplateVersion-request-clientToken"></a>
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](#API_CreateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplateVersion-request-description"></a>
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](#API_CreateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplateVersion-request-majorVersion"></a>
To create a new minor version of the environment template, include `major Version`.  
To create a new major and minor version of the environment template, exclude `major Version`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [source](#API_CreateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplateVersion-request-source"></a>
An object that includes the template bundle S3 bucket path and name for the new version of an template.  
Type: [TemplateVersionSourceInput](API_TemplateVersionSourceInput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [tags](#API_CreateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplateVersion-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton environment template version. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [templateName](#API_CreateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-CreateEnvironmentTemplateVersion-request-templateName"></a>
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
<a name="API_CreateEnvironmentTemplateVersion_ResponseSyntax"></a>

```
{
   "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
<a name="API_CreateEnvironmentTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [environmentTemplateVersion](#API_CreateEnvironmentTemplateVersion_ResponseSyntax) **   <a name="proton-CreateEnvironmentTemplateVersion-response-environmentTemplateVersion"></a>
The environment template detail data that's returned by AWS Proton.  
Type: [EnvironmentTemplateVersion](API_EnvironmentTemplateVersion.md) object

## Errors
<a name="API_CreateEnvironmentTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateEnvironmentTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateEnvironmentTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateEnvironmentTemplateVersion) 

# CreateRepository
<a name="API_CreateRepository"></a>

Create and register a link to a repository. AWS Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, AWS Proton creates a [service-linked role](https://docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html) for you.

For more information, see [Self-managed provisioning](https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self), [Template bundles](https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles), and [Template sync configurations](https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CreateRepository_RequestSyntax"></a>

```
{
   "connectionArn": "string",
   "encryptionKey": "string",
   "name": "string",
   "provider": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateRepository_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [connectionArn](#API_CreateRepository_RequestSyntax) **   <a name="proton-CreateRepository-request-connectionArn"></a>
The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects AWS Proton to your repository provider account. For more information, see [Setting up for AWS Proton](https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: Yes

 ** [encryptionKey](#API_CreateRepository_RequestSyntax) **   <a name="proton-CreateRepository-request-encryptionKey"></a>
The ARN of your customer AWS Key Management Service (AWS KMS) key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

 ** [name](#API_CreateRepository_RequestSyntax) **   <a name="proton-CreateRepository-request-name"></a>
The repository name (for example, `myrepos/myrepo`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [provider](#API_CreateRepository_RequestSyntax) **   <a name="proton-CreateRepository-request-provider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** [tags](#API_CreateRepository_RequestSyntax) **   <a name="proton-CreateRepository-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton repository. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateRepository_ResponseSyntax"></a>

```
{
   "repository": { 
      "arn": "string",
      "connectionArn": "string",
      "encryptionKey": "string",
      "name": "string",
      "provider": "string"
   }
}
```

## Response Elements
<a name="API_CreateRepository_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [repository](#API_CreateRepository_ResponseSyntax) **   <a name="proton-CreateRepository-response-repository"></a>
The repository link's detail data that's returned by AWS Proton.  
Type: [Repository](API_Repository.md) object

## Errors
<a name="API_CreateRepository_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateRepository_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateRepository) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateRepository) 

# CreateService
<a name="API_CreateService"></a>

Create an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see [Services](https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CreateService_RequestSyntax"></a>

```
{
   "branchName": "string",
   "description": "string",
   "name": "string",
   "repositoryConnectionArn": "string",
   "repositoryId": "string",
   "spec": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateMajorVersion": "string",
   "templateMinorVersion": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_CreateService_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [branchName](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-branchName"></a>
The name of the code repository branch that holds the code that's deployed in AWS Proton. *Don't* include this parameter if your service template *doesn't* include a service pipeline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [description](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-description"></a>
A description of the AWS Proton service.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [name](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-name"></a>
The service name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [repositoryConnectionArn](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-repositoryConnectionArn"></a>
The Amazon Resource Name (ARN) of the repository connection. For more information, see [Setting up an AWS CodeStar connection](https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol) in the * AWS Proton User Guide*. *Don't* include this parameter if your service template *doesn't* include a service pipeline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

 ** [repositoryId](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-repositoryId"></a>
The ID of the code repository. *Don't* include this parameter if your service template *doesn't* include a service pipeline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [spec](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-spec"></a>
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](https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: Yes

 ** [tags](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton service. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [templateMajorVersion](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-templateMajorVersion"></a>
The major version of the service template that was used to create the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [templateMinorVersion](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-templateMinorVersion"></a>
The minor version of the service template that was used to create the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [templateName](#API_CreateService_RequestSyntax) **   <a name="proton-CreateService-request-templateName"></a>
The name of the service template that's used to create the service.  
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
<a name="API_CreateService_ResponseSyntax"></a>

```
{
   "service": { 
      "arn": "string",
      "branchName": "string",
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipeline": { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastSucceededDeploymentId": "string",
         "spec": "string",
         "templateMajorVersion": "string",
         "templateMinorVersion": "string",
         "templateName": "string"
      },
      "repositoryConnectionArn": "string",
      "repositoryId": "string",
      "spec": "string",
      "status": "string",
      "statusMessage": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_CreateService_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [service](#API_CreateService_ResponseSyntax) **   <a name="proton-CreateService-response-service"></a>
The service detail data that's returned by AWS Proton.  
Type: [Service](API_Service.md) object

## Errors
<a name="API_CreateService_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateService_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateService) 

# CreateServiceInstance
<a name="API_CreateServiceInstance"></a>

Create a service instance.

## Request Syntax
<a name="API_CreateServiceInstance_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "name": "string",
   "serviceName": "string",
   "spec": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateMajorVersion": "string",
   "templateMinorVersion": "string"
}
```

## Request Parameters
<a name="API_CreateServiceInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateServiceInstance_RequestSyntax) **   <a name="proton-CreateServiceInstance-request-clientToken"></a>
The client token of the service instance to create.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [name](#API_CreateServiceInstance_RequestSyntax) **   <a name="proton-CreateServiceInstance-request-name"></a>
The name of the service instance to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceName](#API_CreateServiceInstance_RequestSyntax) **   <a name="proton-CreateServiceInstance-request-serviceName"></a>
The name of the service the service instance is added to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [spec](#API_CreateServiceInstance_RequestSyntax) **   <a name="proton-CreateServiceInstance-request-spec"></a>
The spec for the service instance you want to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: Yes

 ** [tags](#API_CreateServiceInstance_RequestSyntax) **   <a name="proton-CreateServiceInstance-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton service instance. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [templateMajorVersion](#API_CreateServiceInstance_RequestSyntax) **   <a name="proton-CreateServiceInstance-request-templateMajorVersion"></a>
To create a new major and minor version of the service template, *exclude* `major Version`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [templateMinorVersion](#API_CreateServiceInstance_RequestSyntax) **   <a name="proton-CreateServiceInstance-request-templateMinorVersion"></a>
To create a new minor version of the service template, include a `major Version`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

## Response Syntax
<a name="API_CreateServiceInstance_ResponseSyntax"></a>

```
{
   "serviceInstance": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceName": "string",
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_CreateServiceInstance_ResponseElements"></a>

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](#API_CreateServiceInstance_ResponseSyntax) **   <a name="proton-CreateServiceInstance-response-serviceInstance"></a>
The detailed data of the service instance being created.  
Type: [ServiceInstance](API_ServiceInstance.md) object

## Errors
<a name="API_CreateServiceInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_CreateServiceInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateServiceInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateServiceInstance) 

# CreateServiceSyncConfig
<a name="API_CreateServiceSyncConfig"></a>

Create the AWS Proton Ops configuration file.

## Request Syntax
<a name="API_CreateServiceSyncConfig_RequestSyntax"></a>

```
{
   "branch": "string",
   "filePath": "string",
   "repositoryName": "string",
   "repositoryProvider": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_CreateServiceSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [branch](#API_CreateServiceSyncConfig_RequestSyntax) **   <a name="proton-CreateServiceSyncConfig-request-branch"></a>
The repository branch for your AWS Proton Ops file.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** [filePath](#API_CreateServiceSyncConfig_RequestSyntax) **   <a name="proton-CreateServiceSyncConfig-request-filePath"></a>
The path to the AWS Proton Ops file.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** [repositoryName](#API_CreateServiceSyncConfig_RequestSyntax) **   <a name="proton-CreateServiceSyncConfig-request-repositoryName"></a>
The repository name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [repositoryProvider](#API_CreateServiceSyncConfig_RequestSyntax) **   <a name="proton-CreateServiceSyncConfig-request-repositoryProvider"></a>
The provider type for your repository.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** [serviceName](#API_CreateServiceSyncConfig_RequestSyntax) **   <a name="proton-CreateServiceSyncConfig-request-serviceName"></a>
The name of the service the AWS Proton Ops file is for.  
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
<a name="API_CreateServiceSyncConfig_ResponseSyntax"></a>

```
{
   "serviceSyncConfig": { 
      "branch": "string",
      "filePath": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "serviceName": "string"
   }
}
```

## Response Elements
<a name="API_CreateServiceSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceSyncConfig](#API_CreateServiceSyncConfig_ResponseSyntax) **   <a name="proton-CreateServiceSyncConfig-response-serviceSyncConfig"></a>
The detailed data of the AWS Proton Ops file.  
Type: [ServiceSyncConfig](API_ServiceSyncConfig.md) object

## Errors
<a name="API_CreateServiceSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateServiceSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateServiceSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateServiceSyncConfig) 

# CreateServiceTemplate
<a name="API_CreateServiceTemplate"></a>

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from AWS Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see [AWS Proton templates](https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CreateServiceTemplate_RequestSyntax"></a>

```
{
   "description": "string",
   "displayName": "string",
   "encryptionKey": "string",
   "name": "string",
   "pipelineProvisioning": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateServiceTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreateServiceTemplate_RequestSyntax) **   <a name="proton-CreateServiceTemplate-request-description"></a>
A description of the service template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [displayName](#API_CreateServiceTemplate_RequestSyntax) **   <a name="proton-CreateServiceTemplate-request-displayName"></a>
The name of the service template as displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [encryptionKey](#API_CreateServiceTemplate_RequestSyntax) **   <a name="proton-CreateServiceTemplate-request-encryptionKey"></a>
A customer provided encryption key that's used to encrypt data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

 ** [name](#API_CreateServiceTemplate_RequestSyntax) **   <a name="proton-CreateServiceTemplate-request-name"></a>
The name of the service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [pipelineProvisioning](#API_CreateServiceTemplate_RequestSyntax) **   <a name="proton-CreateServiceTemplate-request-pipelineProvisioning"></a>
By default, AWS Proton provides a service pipeline for your service. When this parameter is included, it indicates that an AWS Proton service pipeline *isn't* provided for your service. After it's included, it *can't* be changed. For more information, see [Template bundles](https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles) in the * AWS Proton User Guide*.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

 ** [tags](#API_CreateServiceTemplate_RequestSyntax) **   <a name="proton-CreateServiceTemplate-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton service template. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateServiceTemplate_ResponseSyntax"></a>

```
{
   "serviceTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipelineProvisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_CreateServiceTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplate](#API_CreateServiceTemplate_ResponseSyntax) **   <a name="proton-CreateServiceTemplate-response-serviceTemplate"></a>
The service template detail data that's returned by AWS Proton.  
Type: [ServiceTemplate](API_ServiceTemplate.md) object

## Errors
<a name="API_CreateServiceTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateServiceTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateServiceTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateServiceTemplate) 

# CreateServiceTemplateVersion
<a name="API_CreateServiceTemplateVersion"></a>

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.

## Request Syntax
<a name="API_CreateServiceTemplateVersion_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "compatibleEnvironmentTemplates": [ 
      { 
         "majorVersion": "string",
         "templateName": "string"
      }
   ],
   "description": "string",
   "majorVersion": "string",
   "source": { ... },
   "supportedComponentSources": [ "string" ],
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateName": "string"
}
```

## Request Parameters
<a name="API_CreateServiceTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-clientToken"></a>
When included, if two identical requests are made with the same client token, AWS Proton returns the service template version that the first request created.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [compatibleEnvironmentTemplates](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-compatibleEnvironmentTemplates"></a>
An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.  
Type: Array of [CompatibleEnvironmentTemplateInput](API_CompatibleEnvironmentTemplateInput.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** [description](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-description"></a>
A description of the new version of a service template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [majorVersion](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-majorVersion"></a>
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`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [source](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-source"></a>
An object that includes the template bundle S3 bucket path and name for the new version of a service template.  
Type: [TemplateVersionSourceInput](API_TemplateVersionSourceInput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [supportedComponentSources](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-supportedComponentSources"></a>
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.  
Type: Array of strings  
Valid Values: `DIRECTLY_DEFINED`   
Required: No

 ** [tags](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-tags"></a>
An optional list of metadata items that you can associate with the AWS Proton service template version. A tag is a key-value pair.  
For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [templateName](#API_CreateServiceTemplateVersion_RequestSyntax) **   <a name="proton-CreateServiceTemplateVersion-request-templateName"></a>
The name of the service 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
<a name="API_CreateServiceTemplateVersion_ResponseSyntax"></a>

```
{
   "serviceTemplateVersion": { 
      "arn": "string",
      "compatibleEnvironmentTemplates": [ 
         { 
            "majorVersion": "string",
            "templateName": "string"
         }
      ],
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "majorVersion": "string",
      "minorVersion": "string",
      "recommendedMinorVersion": "string",
      "schema": "string",
      "status": "string",
      "statusMessage": "string",
      "supportedComponentSources": [ "string" ],
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_CreateServiceTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplateVersion](#API_CreateServiceTemplateVersion_ResponseSyntax) **   <a name="proton-CreateServiceTemplateVersion-response-serviceTemplateVersion"></a>
The service template version summary of detail data that's returned by AWS Proton.  
Type: [ServiceTemplateVersion](API_ServiceTemplateVersion.md) object

## Errors
<a name="API_CreateServiceTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateServiceTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateServiceTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateServiceTemplateVersion) 

# CreateTemplateSyncConfig
<a name="API_CreateTemplateSyncConfig"></a>

Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with AWS Proton. For more information, see [CreateRepository](API_CreateRepository.md).

When a commit is pushed to your linked repository, AWS Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see [Template sync configurations](https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_CreateTemplateSyncConfig_RequestSyntax"></a>

```
{
   "branch": "string",
   "repositoryName": "string",
   "repositoryProvider": "string",
   "subdirectory": "string",
   "templateName": "string",
   "templateType": "string"
}
```

## Request Parameters
<a name="API_CreateTemplateSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [branch](#API_CreateTemplateSyncConfig_RequestSyntax) **   <a name="proton-CreateTemplateSyncConfig-request-branch"></a>
The repository branch for your template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** [repositoryName](#API_CreateTemplateSyncConfig_RequestSyntax) **   <a name="proton-CreateTemplateSyncConfig-request-repositoryName"></a>
The repository name (for example, `myrepos/myrepo`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [repositoryProvider](#API_CreateTemplateSyncConfig_RequestSyntax) **   <a name="proton-CreateTemplateSyncConfig-request-repositoryProvider"></a>
The provider type for your repository.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** [subdirectory](#API_CreateTemplateSyncConfig_RequestSyntax) **   <a name="proton-CreateTemplateSyncConfig-request-subdirectory"></a>
A repository subdirectory path to your template bundle directory. When included, AWS Proton limits the template bundle search to this repository directory.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [templateName](#API_CreateTemplateSyncConfig_RequestSyntax) **   <a name="proton-CreateTemplateSyncConfig-request-templateName"></a>
The name of your registered template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [templateType](#API_CreateTemplateSyncConfig_RequestSyntax) **   <a name="proton-CreateTemplateSyncConfig-request-templateType"></a>
The type of the registered template.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE`   
Required: Yes

## Response Syntax
<a name="API_CreateTemplateSyncConfig_ResponseSyntax"></a>

```
{
   "templateSyncConfig": { 
      "branch": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "subdirectory": "string",
      "templateName": "string",
      "templateType": "string"
   }
}
```

## Response Elements
<a name="API_CreateTemplateSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [templateSyncConfig](#API_CreateTemplateSyncConfig_ResponseSyntax) **   <a name="proton-CreateTemplateSyncConfig-response-templateSyncConfig"></a>
The template sync configuration detail data that's returned by AWS Proton.  
Type: [TemplateSyncConfig](API_TemplateSyncConfig.md) object

## Errors
<a name="API_CreateTemplateSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_CreateTemplateSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/CreateTemplateSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CreateTemplateSyncConfig) 

# DeleteComponent
<a name="API_DeleteComponent"></a>

Delete an AWS Proton component resource.

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_DeleteComponent_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_DeleteComponent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeleteComponent_RequestSyntax) **   <a name="proton-DeleteComponent-request-name"></a>
The name of the component to delete.  
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
<a name="API_DeleteComponent_ResponseSyntax"></a>

```
{
   "component": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "serviceSpec": "string"
   }
}
```

## Response Elements
<a name="API_DeleteComponent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [component](#API_DeleteComponent_ResponseSyntax) **   <a name="proton-DeleteComponent-response-component"></a>
The detailed data of the component being deleted.  
Type: [Component](API_Component.md) object

## Errors
<a name="API_DeleteComponent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteComponent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteComponent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteComponent) 

# DeleteDeployment
<a name="API_DeleteDeployment"></a>

Delete the deployment.

## Request Syntax
<a name="API_DeleteDeployment_RequestSyntax"></a>

```
{
   "id": "string"
}
```

## Request Parameters
<a name="API_DeleteDeployment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [id](#API_DeleteDeployment_RequestSyntax) **   <a name="proton-DeleteDeployment-request-id"></a>
The ID of the deployment to delete.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_DeleteDeployment_ResponseSyntax"></a>

```
{
   "deployment": { 
      "arn": "string",
      "completedAt": number,
      "componentName": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "id": "string",
      "initialState": { ... },
      "lastAttemptedDeploymentId": "string",
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "targetArn": "string",
      "targetResourceCreatedAt": number,
      "targetResourceType": "string",
      "targetState": { ... }
   }
}
```

## Response Elements
<a name="API_DeleteDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [deployment](#API_DeleteDeployment_ResponseSyntax) **   <a name="proton-DeleteDeployment-response-deployment"></a>
The detailed data of the deployment being deleted.  
Type: [Deployment](API_Deployment.md) object

## Errors
<a name="API_DeleteDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_DeleteDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteDeployment) 

# DeleteEnvironment
<a name="API_DeleteEnvironment"></a>

Delete an environment.

## Request Syntax
<a name="API_DeleteEnvironment_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_DeleteEnvironment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeleteEnvironment_RequestSyntax) **   <a name="proton-DeleteEnvironment-request-name"></a>
The name of the environment to delete.  
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
<a name="API_DeleteEnvironment_ResponseSyntax"></a>

```
{
   "environment": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentAccountConnectionId": "string",
      "environmentAccountId": "string",
      "lastAttemptedDeploymentId": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "protonServiceRoleArn": "string",
      "provisioning": "string",
      "provisioningRepository": { 
         "arn": "string",
         "branch": "string",
         "name": "string",
         "provider": "string"
      },
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_DeleteEnvironment_ResponseElements"></a>

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](#API_DeleteEnvironment_ResponseSyntax) **   <a name="proton-DeleteEnvironment-response-environment"></a>
The detailed data of the environment being deleted.  
Type: [Environment](API_Environment.md) object

## Errors
<a name="API_DeleteEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteEnvironment) 

# DeleteEnvironmentAccountConnection
<a name="API_DeleteEnvironmentAccountConnection"></a>

In an environment account, delete an environment account connection.

After you delete an environment account connection that’s in use by an AWS Proton environment, AWS 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.

## Request Syntax
<a name="API_DeleteEnvironmentAccountConnection_RequestSyntax"></a>

```
{
   "id": "string"
}
```

## Request Parameters
<a name="API_DeleteEnvironmentAccountConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [id](#API_DeleteEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-DeleteEnvironmentAccountConnection-request-id"></a>
The ID of the environment account connection to delete.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_DeleteEnvironmentAccountConnection_ResponseSyntax"></a>

```
{
   "environmentAccountConnection": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "environmentAccountId": "string",
      "environmentName": "string",
      "id": "string",
      "lastModifiedAt": number,
      "managementAccountId": "string",
      "requestedAt": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_DeleteEnvironmentAccountConnection_ResponseElements"></a>

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](#API_DeleteEnvironmentAccountConnection_ResponseSyntax) **   <a name="proton-DeleteEnvironmentAccountConnection-response-environmentAccountConnection"></a>
The detailed data of the environment account connection being deleted.  
Type: [EnvironmentAccountConnection](API_EnvironmentAccountConnection.md) object

## Errors
<a name="API_DeleteEnvironmentAccountConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteEnvironmentAccountConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteEnvironmentAccountConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteEnvironmentAccountConnection) 

# DeleteEnvironmentTemplate
<a name="API_DeleteEnvironmentTemplate"></a>

If no other major or minor versions of an environment template exist, delete the environment template.

## Request Syntax
<a name="API_DeleteEnvironmentTemplate_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_DeleteEnvironmentTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeleteEnvironmentTemplate_RequestSyntax) **   <a name="proton-DeleteEnvironmentTemplate-request-name"></a>
The name of the environment template to delete.  
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
<a name="API_DeleteEnvironmentTemplate_ResponseSyntax"></a>

```
{
   "environmentTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "provisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_DeleteEnvironmentTemplate_ResponseElements"></a>

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](#API_DeleteEnvironmentTemplate_ResponseSyntax) **   <a name="proton-DeleteEnvironmentTemplate-response-environmentTemplate"></a>
The detailed data of the environment template being deleted.  
Type: [EnvironmentTemplate](API_EnvironmentTemplate.md) object

## Errors
<a name="API_DeleteEnvironmentTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteEnvironmentTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteEnvironmentTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteEnvironmentTemplate) 

# DeleteEnvironmentTemplateVersion
<a name="API_DeleteEnvironmentTemplateVersion"></a>

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.

## Request Syntax
<a name="API_DeleteEnvironmentTemplateVersion_RequestSyntax"></a>

```
{
   "majorVersion": "string",
   "minorVersion": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_DeleteEnvironmentTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [majorVersion](#API_DeleteEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-DeleteEnvironmentTemplateVersion-request-majorVersion"></a>
The environment template major version to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [minorVersion](#API_DeleteEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-DeleteEnvironmentTemplateVersion-request-minorVersion"></a>
The environment template minor version to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [templateName](#API_DeleteEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-DeleteEnvironmentTemplateVersion-request-templateName"></a>
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
<a name="API_DeleteEnvironmentTemplateVersion_ResponseSyntax"></a>

```
{
   "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
<a name="API_DeleteEnvironmentTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [environmentTemplateVersion](#API_DeleteEnvironmentTemplateVersion_ResponseSyntax) **   <a name="proton-DeleteEnvironmentTemplateVersion-response-environmentTemplateVersion"></a>
The detailed data of the environment template version being deleted.  
Type: [EnvironmentTemplateVersion](API_EnvironmentTemplateVersion.md) object

## Errors
<a name="API_DeleteEnvironmentTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteEnvironmentTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteEnvironmentTemplateVersion) 

# DeleteRepository
<a name="API_DeleteRepository"></a>

De-register and unlink your repository.

## Request Syntax
<a name="API_DeleteRepository_RequestSyntax"></a>

```
{
   "name": "string",
   "provider": "string"
}
```

## Request Parameters
<a name="API_DeleteRepository_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeleteRepository_RequestSyntax) **   <a name="proton-DeleteRepository-request-name"></a>
The repository name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [provider](#API_DeleteRepository_RequestSyntax) **   <a name="proton-DeleteRepository-request-provider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

## Response Syntax
<a name="API_DeleteRepository_ResponseSyntax"></a>

```
{
   "repository": { 
      "arn": "string",
      "connectionArn": "string",
      "encryptionKey": "string",
      "name": "string",
      "provider": "string"
   }
}
```

## Response Elements
<a name="API_DeleteRepository_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [repository](#API_DeleteRepository_ResponseSyntax) **   <a name="proton-DeleteRepository-response-repository"></a>
The deleted repository link's detail data that's returned by AWS Proton.  
Type: [Repository](API_Repository.md) object

## Errors
<a name="API_DeleteRepository_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteRepository_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteRepository) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteRepository) 

# DeleteService
<a name="API_DeleteService"></a>

Delete a service, with its instances and pipeline.

**Note**  
You can't delete a service if it has any service instances that have components attached to them.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_DeleteService_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_DeleteService_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeleteService_RequestSyntax) **   <a name="proton-DeleteService-request-name"></a>
The name of the service to delete.  
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
<a name="API_DeleteService_ResponseSyntax"></a>

```
{
   "service": { 
      "arn": "string",
      "branchName": "string",
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipeline": { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastSucceededDeploymentId": "string",
         "spec": "string",
         "templateMajorVersion": "string",
         "templateMinorVersion": "string",
         "templateName": "string"
      },
      "repositoryConnectionArn": "string",
      "repositoryId": "string",
      "spec": "string",
      "status": "string",
      "statusMessage": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_DeleteService_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [service](#API_DeleteService_ResponseSyntax) **   <a name="proton-DeleteService-response-service"></a>
The detailed data of the service being deleted.  
Type: [Service](API_Service.md) object

## Errors
<a name="API_DeleteService_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteService_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteService) 

# DeleteServiceSyncConfig
<a name="API_DeleteServiceSyncConfig"></a>

Delete the AWS Proton Ops file.

## Request Syntax
<a name="API_DeleteServiceSyncConfig_RequestSyntax"></a>

```
{
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_DeleteServiceSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [serviceName](#API_DeleteServiceSyncConfig_RequestSyntax) **   <a name="proton-DeleteServiceSyncConfig-request-serviceName"></a>
The name of the service that you want to delete the service sync configuration for.  
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
<a name="API_DeleteServiceSyncConfig_ResponseSyntax"></a>

```
{
   "serviceSyncConfig": { 
      "branch": "string",
      "filePath": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "serviceName": "string"
   }
}
```

## Response Elements
<a name="API_DeleteServiceSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceSyncConfig](#API_DeleteServiceSyncConfig_ResponseSyntax) **   <a name="proton-DeleteServiceSyncConfig-response-serviceSyncConfig"></a>
The detailed data for the service sync config.  
Type: [ServiceSyncConfig](API_ServiceSyncConfig.md) object

## Errors
<a name="API_DeleteServiceSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteServiceSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteServiceSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteServiceSyncConfig) 

# DeleteServiceTemplate
<a name="API_DeleteServiceTemplate"></a>

If no other major or minor versions of the service template exist, delete the service template.

## Request Syntax
<a name="API_DeleteServiceTemplate_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_DeleteServiceTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeleteServiceTemplate_RequestSyntax) **   <a name="proton-DeleteServiceTemplate-request-name"></a>
The name of the service template to delete.  
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
<a name="API_DeleteServiceTemplate_ResponseSyntax"></a>

```
{
   "serviceTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipelineProvisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_DeleteServiceTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplate](#API_DeleteServiceTemplate_ResponseSyntax) **   <a name="proton-DeleteServiceTemplate-response-serviceTemplate"></a>
The detailed data of the service template being deleted.  
Type: [ServiceTemplate](API_ServiceTemplate.md) object

## Errors
<a name="API_DeleteServiceTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteServiceTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteServiceTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteServiceTemplate) 

# DeleteServiceTemplateVersion
<a name="API_DeleteServiceTemplateVersion"></a>

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.

## Request Syntax
<a name="API_DeleteServiceTemplateVersion_RequestSyntax"></a>

```
{
   "majorVersion": "string",
   "minorVersion": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_DeleteServiceTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [majorVersion](#API_DeleteServiceTemplateVersion_RequestSyntax) **   <a name="proton-DeleteServiceTemplateVersion-request-majorVersion"></a>
The service template major version to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [minorVersion](#API_DeleteServiceTemplateVersion_RequestSyntax) **   <a name="proton-DeleteServiceTemplateVersion-request-minorVersion"></a>
The service template minor version to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [templateName](#API_DeleteServiceTemplateVersion_RequestSyntax) **   <a name="proton-DeleteServiceTemplateVersion-request-templateName"></a>
The name of the service 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
<a name="API_DeleteServiceTemplateVersion_ResponseSyntax"></a>

```
{
   "serviceTemplateVersion": { 
      "arn": "string",
      "compatibleEnvironmentTemplates": [ 
         { 
            "majorVersion": "string",
            "templateName": "string"
         }
      ],
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "majorVersion": "string",
      "minorVersion": "string",
      "recommendedMinorVersion": "string",
      "schema": "string",
      "status": "string",
      "statusMessage": "string",
      "supportedComponentSources": [ "string" ],
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_DeleteServiceTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplateVersion](#API_DeleteServiceTemplateVersion_ResponseSyntax) **   <a name="proton-DeleteServiceTemplateVersion-response-serviceTemplateVersion"></a>
The detailed data of the service template version being deleted.  
Type: [ServiceTemplateVersion](API_ServiceTemplateVersion.md) object

## Errors
<a name="API_DeleteServiceTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteServiceTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteServiceTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteServiceTemplateVersion) 

# DeleteTemplateSyncConfig
<a name="API_DeleteTemplateSyncConfig"></a>

Delete a template sync configuration.

## Request Syntax
<a name="API_DeleteTemplateSyncConfig_RequestSyntax"></a>

```
{
   "templateName": "string",
   "templateType": "string"
}
```

## Request Parameters
<a name="API_DeleteTemplateSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [templateName](#API_DeleteTemplateSyncConfig_RequestSyntax) **   <a name="proton-DeleteTemplateSyncConfig-request-templateName"></a>
The template name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [templateType](#API_DeleteTemplateSyncConfig_RequestSyntax) **   <a name="proton-DeleteTemplateSyncConfig-request-templateType"></a>
The template type.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE`   
Required: Yes

## Response Syntax
<a name="API_DeleteTemplateSyncConfig_ResponseSyntax"></a>

```
{
   "templateSyncConfig": { 
      "branch": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "subdirectory": "string",
      "templateName": "string",
      "templateType": "string"
   }
}
```

## Response Elements
<a name="API_DeleteTemplateSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [templateSyncConfig](#API_DeleteTemplateSyncConfig_ResponseSyntax) **   <a name="proton-DeleteTemplateSyncConfig-response-templateSyncConfig"></a>
The template sync configuration detail data that's returned by AWS Proton.  
Type: [TemplateSyncConfig](API_TemplateSyncConfig.md) object

## Errors
<a name="API_DeleteTemplateSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteTemplateSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/DeleteTemplateSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeleteTemplateSyncConfig) 

# GetAccountSettings
<a name="API_GetAccountSettings"></a>

Get detail data for AWS Proton account-wide settings.

## Response Syntax
<a name="API_GetAccountSettings_ResponseSyntax"></a>

```
{
   "accountSettings": { 
      "pipelineCodebuildRoleArn": "string",
      "pipelineProvisioningRepository": { 
         "arn": "string",
         "branch": "string",
         "name": "string",
         "provider": "string"
      },
      "pipelineServiceRoleArn": "string"
   }
}
```

## Response Elements
<a name="API_GetAccountSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountSettings](#API_GetAccountSettings_ResponseSyntax) **   <a name="proton-GetAccountSettings-response-accountSettings"></a>
The AWS Proton pipeline service role detail data that's returned by AWS Proton.  
Type: [AccountSettings](API_AccountSettings.md) object

## Errors
<a name="API_GetAccountSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetAccountSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetAccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetAccountSettings) 

# GetComponent
<a name="API_GetComponent"></a>

Get detailed data for a component.

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_GetComponent_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_GetComponent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetComponent_RequestSyntax) **   <a name="proton-GetComponent-request-name"></a>
The name of the component that you want to get the detailed data for.  
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
<a name="API_GetComponent_ResponseSyntax"></a>

```
{
   "component": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "serviceSpec": "string"
   }
}
```

## Response Elements
<a name="API_GetComponent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [component](#API_GetComponent_ResponseSyntax) **   <a name="proton-GetComponent-response-component"></a>
The detailed data of the requested component.  
Type: [Component](API_Component.md) object

## Errors
<a name="API_GetComponent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetComponent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetComponent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetComponent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetComponent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetComponent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetComponent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetComponent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetComponent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetComponent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetComponent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetComponent) 

# GetDeployment
<a name="API_GetDeployment"></a>

Get detailed data for a deployment.

## Request Syntax
<a name="API_GetDeployment_RequestSyntax"></a>

```
{
   "componentName": "string",
   "environmentName": "string",
   "id": "string",
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_GetDeployment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [componentName](#API_GetDeployment_RequestSyntax) **   <a name="proton-GetDeployment-request-componentName"></a>
The name of a component that you want to get the detailed data for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [environmentName](#API_GetDeployment_RequestSyntax) **   <a name="proton-GetDeployment-request-environmentName"></a>
The name of a environment that you want to get the detailed data for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [id](#API_GetDeployment_RequestSyntax) **   <a name="proton-GetDeployment-request-id"></a>
The ID of the deployment that you want to get the detailed data for.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [serviceInstanceName](#API_GetDeployment_RequestSyntax) **   <a name="proton-GetDeployment-request-serviceInstanceName"></a>
The name of the service instance associated with the given deployment ID. `serviceName` must be specified to identify the service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceName](#API_GetDeployment_RequestSyntax) **   <a name="proton-GetDeployment-request-serviceName"></a>
The name of the service associated with the given deployment ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

## Response Syntax
<a name="API_GetDeployment_ResponseSyntax"></a>

```
{
   "deployment": { 
      "arn": "string",
      "completedAt": number,
      "componentName": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "id": "string",
      "initialState": { ... },
      "lastAttemptedDeploymentId": "string",
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "targetArn": "string",
      "targetResourceCreatedAt": number,
      "targetResourceType": "string",
      "targetState": { ... }
   }
}
```

## Response Elements
<a name="API_GetDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [deployment](#API_GetDeployment_ResponseSyntax) **   <a name="proton-GetDeployment-response-deployment"></a>
The detailed data of the requested deployment.  
Type: [Deployment](API_Deployment.md) object

## Errors
<a name="API_GetDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetDeployment) 

# GetEnvironment
<a name="API_GetEnvironment"></a>

Get detailed data for an environment.

## Request Syntax
<a name="API_GetEnvironment_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_GetEnvironment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetEnvironment_RequestSyntax) **   <a name="proton-GetEnvironment-request-name"></a>
The name of the environment that you want to get the detailed data for.  
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
<a name="API_GetEnvironment_ResponseSyntax"></a>

```
{
   "environment": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentAccountConnectionId": "string",
      "environmentAccountId": "string",
      "lastAttemptedDeploymentId": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "protonServiceRoleArn": "string",
      "provisioning": "string",
      "provisioningRepository": { 
         "arn": "string",
         "branch": "string",
         "name": "string",
         "provider": "string"
      },
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_GetEnvironment_ResponseElements"></a>

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](#API_GetEnvironment_ResponseSyntax) **   <a name="proton-GetEnvironment-response-environment"></a>
The detailed data of the requested environment.  
Type: [Environment](API_Environment.md) object

## Errors
<a name="API_GetEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetEnvironment) 

# GetEnvironmentAccountConnection
<a name="API_GetEnvironmentAccountConnection"></a>

In an environment account, get the detailed data for an environment account connection.

For more information, see [Environment account connections](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.

## Request Syntax
<a name="API_GetEnvironmentAccountConnection_RequestSyntax"></a>

```
{
   "id": "string"
}
```

## Request Parameters
<a name="API_GetEnvironmentAccountConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [id](#API_GetEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-GetEnvironmentAccountConnection-request-id"></a>
The ID of the environment account connection that you want to get the detailed data for.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_GetEnvironmentAccountConnection_ResponseSyntax"></a>

```
{
   "environmentAccountConnection": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "environmentAccountId": "string",
      "environmentName": "string",
      "id": "string",
      "lastModifiedAt": number,
      "managementAccountId": "string",
      "requestedAt": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_GetEnvironmentAccountConnection_ResponseElements"></a>

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](#API_GetEnvironmentAccountConnection_ResponseSyntax) **   <a name="proton-GetEnvironmentAccountConnection-response-environmentAccountConnection"></a>
The detailed data of the requested environment account connection.  
Type: [EnvironmentAccountConnection](API_EnvironmentAccountConnection.md) object

## Errors
<a name="API_GetEnvironmentAccountConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetEnvironmentAccountConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetEnvironmentAccountConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetEnvironmentAccountConnection) 

# GetEnvironmentTemplate
<a name="API_GetEnvironmentTemplate"></a>

Get detailed data for an environment template.

## Request Syntax
<a name="API_GetEnvironmentTemplate_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_GetEnvironmentTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetEnvironmentTemplate_RequestSyntax) **   <a name="proton-GetEnvironmentTemplate-request-name"></a>
The name of the environment template that you want to get the detailed data for.  
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
<a name="API_GetEnvironmentTemplate_ResponseSyntax"></a>

```
{
   "environmentTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "provisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_GetEnvironmentTemplate_ResponseElements"></a>

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](#API_GetEnvironmentTemplate_ResponseSyntax) **   <a name="proton-GetEnvironmentTemplate-response-environmentTemplate"></a>
The detailed data of the requested environment template.  
Type: [EnvironmentTemplate](API_EnvironmentTemplate.md) object

## Errors
<a name="API_GetEnvironmentTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetEnvironmentTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetEnvironmentTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetEnvironmentTemplate) 

# GetEnvironmentTemplateVersion
<a name="API_GetEnvironmentTemplateVersion"></a>

Get detailed data for a major or minor version of an environment template.

## Request Syntax
<a name="API_GetEnvironmentTemplateVersion_RequestSyntax"></a>

```
{
   "majorVersion": "string",
   "minorVersion": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_GetEnvironmentTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [majorVersion](#API_GetEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-GetEnvironmentTemplateVersion-request-majorVersion"></a>
To get environment template major version detail data, include `major Version`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [minorVersion](#API_GetEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-GetEnvironmentTemplateVersion-request-minorVersion"></a>
To get environment template minor version detail data, include `minorVersion`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [templateName](#API_GetEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-GetEnvironmentTemplateVersion-request-templateName"></a>
The name of the environment template a version of which you want to get detailed data for.  
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
<a name="API_GetEnvironmentTemplateVersion_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetEnvironmentTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [environmentTemplateVersion](#API_GetEnvironmentTemplateVersion_ResponseSyntax) **   <a name="proton-GetEnvironmentTemplateVersion-response-environmentTemplateVersion"></a>
The detailed data of the requested environment template version.  
Type: [EnvironmentTemplateVersion](API_EnvironmentTemplateVersion.md) object

## Errors
<a name="API_GetEnvironmentTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetEnvironmentTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetEnvironmentTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetEnvironmentTemplateVersion) 

# GetRepository
<a name="API_GetRepository"></a>

Get detail data for a linked repository.

## Request Syntax
<a name="API_GetRepository_RequestSyntax"></a>

```
{
   "name": "string",
   "provider": "string"
}
```

## Request Parameters
<a name="API_GetRepository_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetRepository_RequestSyntax) **   <a name="proton-GetRepository-request-name"></a>
The repository name, for example `myrepos/myrepo`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [provider](#API_GetRepository_RequestSyntax) **   <a name="proton-GetRepository-request-provider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

## Response Syntax
<a name="API_GetRepository_ResponseSyntax"></a>

```
{
   "repository": { 
      "arn": "string",
      "connectionArn": "string",
      "encryptionKey": "string",
      "name": "string",
      "provider": "string"
   }
}
```

## Response Elements
<a name="API_GetRepository_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [repository](#API_GetRepository_ResponseSyntax) **   <a name="proton-GetRepository-response-repository"></a>
The repository link's detail data that's returned by AWS Proton.  
Type: [Repository](API_Repository.md) object

## Errors
<a name="API_GetRepository_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetRepository_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetRepository) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetRepository) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetRepository) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetRepository) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetRepository) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetRepository) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetRepository) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetRepository) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetRepository) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetRepository) 

# GetRepositorySyncStatus
<a name="API_GetRepositorySyncStatus"></a>

Get the sync status of a repository used for AWS Proton template sync. For more information about template sync, see .

**Note**  
A repository sync status isn't tied to the AWS Proton Repository resource (or any other AWS Proton resource). Therefore, tags on an AWS Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).  
For more information about ABAC, see [ABAC](https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_GetRepositorySyncStatus_RequestSyntax"></a>

```
{
   "branch": "string",
   "repositoryName": "string",
   "repositoryProvider": "string",
   "syncType": "string"
}
```

## Request Parameters
<a name="API_GetRepositorySyncStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [branch](#API_GetRepositorySyncStatus_RequestSyntax) **   <a name="proton-GetRepositorySyncStatus-request-branch"></a>
The repository branch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** [repositoryName](#API_GetRepositorySyncStatus_RequestSyntax) **   <a name="proton-GetRepositorySyncStatus-request-repositoryName"></a>
The repository name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [repositoryProvider](#API_GetRepositorySyncStatus_RequestSyntax) **   <a name="proton-GetRepositorySyncStatus-request-repositoryProvider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** [syncType](#API_GetRepositorySyncStatus_RequestSyntax) **   <a name="proton-GetRepositorySyncStatus-request-syncType"></a>
The repository sync type.  
Type: String  
Valid Values: `TEMPLATE_SYNC | SERVICE_SYNC`   
Required: Yes

## Response Syntax
<a name="API_GetRepositorySyncStatus_ResponseSyntax"></a>

```
{
   "latestSync": { 
      "events": [ 
         { 
            "event": "string",
            "externalId": "string",
            "time": number,
            "type": "string"
         }
      ],
      "startedAt": number,
      "status": "string"
   }
}
```

## Response Elements
<a name="API_GetRepositorySyncStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [latestSync](#API_GetRepositorySyncStatus_ResponseSyntax) **   <a name="proton-GetRepositorySyncStatus-response-latestSync"></a>
The repository sync status detail data that's returned by AWS Proton.  
Type: [RepositorySyncAttempt](API_RepositorySyncAttempt.md) object

## Errors
<a name="API_GetRepositorySyncStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetRepositorySyncStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetRepositorySyncStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetRepositorySyncStatus) 

# GetResourcesSummary
<a name="API_GetResourcesSummary"></a>

Get counts of AWS Proton resources.

For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it's behind the recommended version of the AWS Proton template that it uses and it needs an update to become current.

The action returns staleness counts (counts of resources that are up-to-date, behind a template major version, or behind a template minor version), the total number of resources, and the number of resources that are in a failed state, grouped by resource type. Components, environments, and service templates return less information - see the `components`, `environments`, and `serviceTemplates` field descriptions.

For context, the action also returns the total number of each type of AWS Proton template in the AWS account.

For more information, see [AWS Proton dashboard](https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html) in the * AWS Proton User Guide*.

## Response Syntax
<a name="API_GetResourcesSummary_ResponseSyntax"></a>

```
{
   "counts": { 
      "components": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "environments": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "environmentTemplates": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "pipelines": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "serviceInstances": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "services": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "serviceTemplates": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      }
   }
}
```

## Response Elements
<a name="API_GetResourcesSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [counts](#API_GetResourcesSummary_ResponseSyntax) **   <a name="proton-GetResourcesSummary-response-counts"></a>
Summary counts of each AWS Proton resource type.  
Type: [CountsSummary](API_CountsSummary.md) object

## Errors
<a name="API_GetResourcesSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed to register with the service.  
HTTP Status Code: 500

 ** 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
<a name="API_GetResourcesSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetResourcesSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetResourcesSummary) 

# GetService
<a name="API_GetService"></a>

Get detailed data for a service.

## Request Syntax
<a name="API_GetService_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_GetService_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetService_RequestSyntax) **   <a name="proton-GetService-request-name"></a>
The name of the service that you want to get the detailed data for.  
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
<a name="API_GetService_ResponseSyntax"></a>

```
{
   "service": { 
      "arn": "string",
      "branchName": "string",
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipeline": { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastSucceededDeploymentId": "string",
         "spec": "string",
         "templateMajorVersion": "string",
         "templateMinorVersion": "string",
         "templateName": "string"
      },
      "repositoryConnectionArn": "string",
      "repositoryId": "string",
      "spec": "string",
      "status": "string",
      "statusMessage": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_GetService_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [service](#API_GetService_ResponseSyntax) **   <a name="proton-GetService-response-service"></a>
The detailed data of the requested service.  
Type: [Service](API_Service.md) object

## Errors
<a name="API_GetService_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetService_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetService) 

# GetServiceInstance
<a name="API_GetServiceInstance"></a>

Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

## Request Syntax
<a name="API_GetServiceInstance_RequestSyntax"></a>

```
{
   "name": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_GetServiceInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetServiceInstance_RequestSyntax) **   <a name="proton-GetServiceInstance-request-name"></a>
The name of a service instance that you want to get the detailed data for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceName](#API_GetServiceInstance_RequestSyntax) **   <a name="proton-GetServiceInstance-request-serviceName"></a>
The name of the service that you want the service instance input for.  
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
<a name="API_GetServiceInstance_ResponseSyntax"></a>

```
{
   "serviceInstance": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceName": "string",
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_GetServiceInstance_ResponseElements"></a>

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](#API_GetServiceInstance_ResponseSyntax) **   <a name="proton-GetServiceInstance-response-serviceInstance"></a>
The detailed data of the requested service instance.  
Type: [ServiceInstance](API_ServiceInstance.md) object

## Errors
<a name="API_GetServiceInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetServiceInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetServiceInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetServiceInstance) 

# GetServiceInstanceSyncStatus
<a name="API_GetServiceInstanceSyncStatus"></a>

Get the status of the synced service instance.

## Request Syntax
<a name="API_GetServiceInstanceSyncStatus_RequestSyntax"></a>

```
{
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_GetServiceInstanceSyncStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [serviceInstanceName](#API_GetServiceInstanceSyncStatus_RequestSyntax) **   <a name="proton-GetServiceInstanceSyncStatus-request-serviceInstanceName"></a>
The name of the service instance that you want the sync status input for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceName](#API_GetServiceInstanceSyncStatus_RequestSyntax) **   <a name="proton-GetServiceInstanceSyncStatus-request-serviceName"></a>
The name of the service that the service instance belongs to.  
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
<a name="API_GetServiceInstanceSyncStatus_ResponseSyntax"></a>

```
{
   "desiredState": { 
      "branch": "string",
      "directory": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "sha": "string"
   },
   "latestSuccessfulSync": { 
      "events": [ 
         { 
            "event": "string",
            "externalId": "string",
            "time": number,
            "type": "string"
         }
      ],
      "initialRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      },
      "startedAt": number,
      "status": "string",
      "target": "string",
      "targetRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      }
   },
   "latestSync": { 
      "events": [ 
         { 
            "event": "string",
            "externalId": "string",
            "time": number,
            "type": "string"
         }
      ],
      "initialRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      },
      "startedAt": number,
      "status": "string",
      "target": "string",
      "targetRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetServiceInstanceSyncStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [desiredState](#API_GetServiceInstanceSyncStatus_ResponseSyntax) **   <a name="proton-GetServiceInstanceSyncStatus-response-desiredState"></a>
The service instance sync desired state that's returned by AWS Proton   
Type: [Revision](API_Revision.md) object

 ** [latestSuccessfulSync](#API_GetServiceInstanceSyncStatus_ResponseSyntax) **   <a name="proton-GetServiceInstanceSyncStatus-response-latestSuccessfulSync"></a>
The detailed data of the latest successful sync with the service instance.  
Type: [ResourceSyncAttempt](API_ResourceSyncAttempt.md) object

 ** [latestSync](#API_GetServiceInstanceSyncStatus_ResponseSyntax) **   <a name="proton-GetServiceInstanceSyncStatus-response-latestSync"></a>
The detailed data of the latest sync with the service instance.  
Type: [ResourceSyncAttempt](API_ResourceSyncAttempt.md) object

## Errors
<a name="API_GetServiceInstanceSyncStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetServiceInstanceSyncStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetServiceInstanceSyncStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetServiceInstanceSyncStatus) 

# GetServiceSyncBlockerSummary
<a name="API_GetServiceSyncBlockerSummary"></a>

Get detailed data for the service sync blocker summary.

## Request Syntax
<a name="API_GetServiceSyncBlockerSummary_RequestSyntax"></a>

```
{
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_GetServiceSyncBlockerSummary_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [serviceInstanceName](#API_GetServiceSyncBlockerSummary_RequestSyntax) **   <a name="proton-GetServiceSyncBlockerSummary-request-serviceInstanceName"></a>
The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceName](#API_GetServiceSyncBlockerSummary_RequestSyntax) **   <a name="proton-GetServiceSyncBlockerSummary-request-serviceName"></a>
The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.  
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
<a name="API_GetServiceSyncBlockerSummary_ResponseSyntax"></a>

```
{
   "serviceSyncBlockerSummary": { 
      "latestBlockers": [ 
         { 
            "contexts": [ 
               { 
                  "key": "string",
                  "value": "string"
               }
            ],
            "createdAt": number,
            "createdReason": "string",
            "id": "string",
            "resolvedAt": number,
            "resolvedReason": "string",
            "status": "string",
            "type": "string"
         }
      ],
      "serviceInstanceName": "string",
      "serviceName": "string"
   }
}
```

## Response Elements
<a name="API_GetServiceSyncBlockerSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceSyncBlockerSummary](#API_GetServiceSyncBlockerSummary_ResponseSyntax) **   <a name="proton-GetServiceSyncBlockerSummary-response-serviceSyncBlockerSummary"></a>
The detailed data of the requested service sync blocker summary.  
Type: [ServiceSyncBlockerSummary](API_ServiceSyncBlockerSummary.md) object

## Errors
<a name="API_GetServiceSyncBlockerSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetServiceSyncBlockerSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetServiceSyncBlockerSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetServiceSyncBlockerSummary) 

# GetServiceSyncConfig
<a name="API_GetServiceSyncConfig"></a>

Get detailed information for the service sync configuration.

## Request Syntax
<a name="API_GetServiceSyncConfig_RequestSyntax"></a>

```
{
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_GetServiceSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [serviceName](#API_GetServiceSyncConfig_RequestSyntax) **   <a name="proton-GetServiceSyncConfig-request-serviceName"></a>
The name of the service that you want to get the service sync configuration for.  
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
<a name="API_GetServiceSyncConfig_ResponseSyntax"></a>

```
{
   "serviceSyncConfig": { 
      "branch": "string",
      "filePath": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "serviceName": "string"
   }
}
```

## Response Elements
<a name="API_GetServiceSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceSyncConfig](#API_GetServiceSyncConfig_ResponseSyntax) **   <a name="proton-GetServiceSyncConfig-response-serviceSyncConfig"></a>
The detailed data of the requested service sync configuration.  
Type: [ServiceSyncConfig](API_ServiceSyncConfig.md) object

## Errors
<a name="API_GetServiceSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetServiceSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetServiceSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetServiceSyncConfig) 

# GetServiceTemplate
<a name="API_GetServiceTemplate"></a>

Get detailed data for a service template.

## Request Syntax
<a name="API_GetServiceTemplate_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_GetServiceTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetServiceTemplate_RequestSyntax) **   <a name="proton-GetServiceTemplate-request-name"></a>
The name of the service template that you want to get detailed data for.  
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
<a name="API_GetServiceTemplate_ResponseSyntax"></a>

```
{
   "serviceTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipelineProvisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_GetServiceTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplate](#API_GetServiceTemplate_ResponseSyntax) **   <a name="proton-GetServiceTemplate-response-serviceTemplate"></a>
The detailed data of the requested service template.  
Type: [ServiceTemplate](API_ServiceTemplate.md) object

## Errors
<a name="API_GetServiceTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetServiceTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetServiceTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetServiceTemplate) 

# GetServiceTemplateVersion
<a name="API_GetServiceTemplateVersion"></a>

Get detailed data for a major or minor version of a service template.

## Request Syntax
<a name="API_GetServiceTemplateVersion_RequestSyntax"></a>

```
{
   "majorVersion": "string",
   "minorVersion": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_GetServiceTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [majorVersion](#API_GetServiceTemplateVersion_RequestSyntax) **   <a name="proton-GetServiceTemplateVersion-request-majorVersion"></a>
To get service template major version detail data, include `major Version`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [minorVersion](#API_GetServiceTemplateVersion_RequestSyntax) **   <a name="proton-GetServiceTemplateVersion-request-minorVersion"></a>
To get service template minor version detail data, include `minorVersion`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [templateName](#API_GetServiceTemplateVersion_RequestSyntax) **   <a name="proton-GetServiceTemplateVersion-request-templateName"></a>
The name of the service template a version of which you want to get detailed data for.  
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
<a name="API_GetServiceTemplateVersion_ResponseSyntax"></a>

```
{
   "serviceTemplateVersion": { 
      "arn": "string",
      "compatibleEnvironmentTemplates": [ 
         { 
            "majorVersion": "string",
            "templateName": "string"
         }
      ],
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "majorVersion": "string",
      "minorVersion": "string",
      "recommendedMinorVersion": "string",
      "schema": "string",
      "status": "string",
      "statusMessage": "string",
      "supportedComponentSources": [ "string" ],
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_GetServiceTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplateVersion](#API_GetServiceTemplateVersion_ResponseSyntax) **   <a name="proton-GetServiceTemplateVersion-response-serviceTemplateVersion"></a>
The detailed data of the requested service template version.  
Type: [ServiceTemplateVersion](API_ServiceTemplateVersion.md) object

## Errors
<a name="API_GetServiceTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetServiceTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetServiceTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetServiceTemplateVersion) 

# GetTemplateSyncConfig
<a name="API_GetTemplateSyncConfig"></a>

Get detail data for a template sync configuration.

## Request Syntax
<a name="API_GetTemplateSyncConfig_RequestSyntax"></a>

```
{
   "templateName": "string",
   "templateType": "string"
}
```

## Request Parameters
<a name="API_GetTemplateSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [templateName](#API_GetTemplateSyncConfig_RequestSyntax) **   <a name="proton-GetTemplateSyncConfig-request-templateName"></a>
The template name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [templateType](#API_GetTemplateSyncConfig_RequestSyntax) **   <a name="proton-GetTemplateSyncConfig-request-templateType"></a>
The template type.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE`   
Required: Yes

## Response Syntax
<a name="API_GetTemplateSyncConfig_ResponseSyntax"></a>

```
{
   "templateSyncConfig": { 
      "branch": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "subdirectory": "string",
      "templateName": "string",
      "templateType": "string"
   }
}
```

## Response Elements
<a name="API_GetTemplateSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [templateSyncConfig](#API_GetTemplateSyncConfig_ResponseSyntax) **   <a name="proton-GetTemplateSyncConfig-response-templateSyncConfig"></a>
The template sync configuration detail data that's returned by AWS Proton.  
Type: [TemplateSyncConfig](API_TemplateSyncConfig.md) object

## Errors
<a name="API_GetTemplateSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetTemplateSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetTemplateSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetTemplateSyncConfig) 

# GetTemplateSyncStatus
<a name="API_GetTemplateSyncStatus"></a>

Get the status of a template sync.

## Request Syntax
<a name="API_GetTemplateSyncStatus_RequestSyntax"></a>

```
{
   "templateName": "string",
   "templateType": "string",
   "templateVersion": "string"
}
```

## Request Parameters
<a name="API_GetTemplateSyncStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [templateName](#API_GetTemplateSyncStatus_RequestSyntax) **   <a name="proton-GetTemplateSyncStatus-request-templateName"></a>
The template name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [templateType](#API_GetTemplateSyncStatus_RequestSyntax) **   <a name="proton-GetTemplateSyncStatus-request-templateType"></a>
The template type.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE`   
Required: Yes

 ** [templateVersion](#API_GetTemplateSyncStatus_RequestSyntax) **   <a name="proton-GetTemplateSyncStatus-request-templateVersion"></a>
The template major version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

## Response Syntax
<a name="API_GetTemplateSyncStatus_ResponseSyntax"></a>

```
{
   "desiredState": { 
      "branch": "string",
      "directory": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "sha": "string"
   },
   "latestSuccessfulSync": { 
      "events": [ 
         { 
            "event": "string",
            "externalId": "string",
            "time": number,
            "type": "string"
         }
      ],
      "initialRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      },
      "startedAt": number,
      "status": "string",
      "target": "string",
      "targetRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      }
   },
   "latestSync": { 
      "events": [ 
         { 
            "event": "string",
            "externalId": "string",
            "time": number,
            "type": "string"
         }
      ],
      "initialRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      },
      "startedAt": number,
      "status": "string",
      "target": "string",
      "targetRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetTemplateSyncStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [desiredState](#API_GetTemplateSyncStatus_ResponseSyntax) **   <a name="proton-GetTemplateSyncStatus-response-desiredState"></a>
The template sync desired state that's returned by AWS Proton.  
Type: [Revision](API_Revision.md) object

 ** [latestSuccessfulSync](#API_GetTemplateSyncStatus_ResponseSyntax) **   <a name="proton-GetTemplateSyncStatus-response-latestSuccessfulSync"></a>
The details of the last successful sync that's returned by AWS Proton.  
Type: [ResourceSyncAttempt](API_ResourceSyncAttempt.md) object

 ** [latestSync](#API_GetTemplateSyncStatus_ResponseSyntax) **   <a name="proton-GetTemplateSyncStatus-response-latestSync"></a>
The details of the last sync that's returned by AWS Proton.  
Type: [ResourceSyncAttempt](API_ResourceSyncAttempt.md) object

## Errors
<a name="API_GetTemplateSyncStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_GetTemplateSyncStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/GetTemplateSyncStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/GetTemplateSyncStatus) 

# ListComponentOutputs
<a name="API_ListComponentOutputs"></a>

Get a list of component Infrastructure as Code (IaC) outputs.

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_ListComponentOutputs_RequestSyntax"></a>

```
{
   "componentName": "string",
   "deploymentId": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListComponentOutputs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [componentName](#API_ListComponentOutputs_RequestSyntax) **   <a name="proton-ListComponentOutputs-request-componentName"></a>
The name of the component whose outputs you want.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [deploymentId](#API_ListComponentOutputs_RequestSyntax) **   <a name="proton-ListComponentOutputs-request-deploymentId"></a>
The ID of the deployment whose outputs you want.  
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

 ** [nextToken](#API_ListComponentOutputs_RequestSyntax) **   <a name="proton-ListComponentOutputs-request-nextToken"></a>
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

## Response Syntax
<a name="API_ListComponentOutputs_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "outputs": [ 
      { 
         "key": "string",
         "valueString": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListComponentOutputs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListComponentOutputs_ResponseSyntax) **   <a name="proton-ListComponentOutputs-response-nextToken"></a>
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [outputs](#API_ListComponentOutputs_ResponseSyntax) **   <a name="proton-ListComponentOutputs-response-outputs"></a>
An array of component Infrastructure as Code (IaC) outputs.  
Type: Array of [Output](API_Output.md) objects

## Errors
<a name="API_ListComponentOutputs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListComponentOutputs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListComponentOutputs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListComponentOutputs) 

# ListComponentProvisionedResources
<a name="API_ListComponentProvisionedResources"></a>

List provisioned resources for a component with details.

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_ListComponentProvisionedResources_RequestSyntax"></a>

```
{
   "componentName": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListComponentProvisionedResources_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [componentName](#API_ListComponentProvisionedResources_RequestSyntax) **   <a name="proton-ListComponentProvisionedResources-request-componentName"></a>
The name of the component whose provisioned resources you want.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [nextToken](#API_ListComponentProvisionedResources_RequestSyntax) **   <a name="proton-ListComponentProvisionedResources-request-nextToken"></a>
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

## Response Syntax
<a name="API_ListComponentProvisionedResources_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "provisionedResources": [ 
      { 
         "identifier": "string",
         "name": "string",
         "provisioningEngine": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListComponentProvisionedResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListComponentProvisionedResources_ResponseSyntax) **   <a name="proton-ListComponentProvisionedResources-response-nextToken"></a>
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [provisionedResources](#API_ListComponentProvisionedResources_ResponseSyntax) **   <a name="proton-ListComponentProvisionedResources-response-provisionedResources"></a>
An array of provisioned resources for a component.  
Type: Array of [ProvisionedResource](API_ProvisionedResource.md) objects

## Errors
<a name="API_ListComponentProvisionedResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListComponentProvisionedResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListComponentProvisionedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListComponentProvisionedResources) 

# ListComponents
<a name="API_ListComponents"></a>

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_ListComponents_RequestSyntax"></a>

```
{
   "environmentName": "string",
   "maxResults": number,
   "nextToken": "string",
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_ListComponents_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [environmentName](#API_ListComponents_RequestSyntax) **   <a name="proton-ListComponents-request-environmentName"></a>
The name of an environment for result list filtering. AWS Proton returns components associated with the environment or attached to service instances running in it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [maxResults](#API_ListComponents_RequestSyntax) **   <a name="proton-ListComponents-request-maxResults"></a>
The maximum number of components to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListComponents_RequestSyntax) **   <a name="proton-ListComponents-request-nextToken"></a>
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

 ** [serviceInstanceName](#API_ListComponents_RequestSyntax) **   <a name="proton-ListComponents-request-serviceInstanceName"></a>
The name of a service instance for result list filtering. AWS Proton returns the component attached to the service instance, if any.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceName](#API_ListComponents_RequestSyntax) **   <a name="proton-ListComponents-request-serviceName"></a>
The name of a service for result list filtering. AWS Proton returns components attached to service instances of the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

## Response Syntax
<a name="API_ListComponents_ResponseSyntax"></a>

```
{
   "components": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "environmentName": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastModifiedAt": number,
         "lastSucceededDeploymentId": "string",
         "name": "string",
         "serviceInstanceName": "string",
         "serviceName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListComponents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [components](#API_ListComponents_ResponseSyntax) **   <a name="proton-ListComponents-response-components"></a>
An array of components with summary data.  
Type: Array of [ComponentSummary](API_ComponentSummary.md) objects

 ** [nextToken](#API_ListComponents_ResponseSyntax) **   <a name="proton-ListComponents-response-nextToken"></a>
A token that indicates the location of the next component in the array of components, after the current requested list of components.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

## Errors
<a name="API_ListComponents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed to register with the service.  
HTTP Status Code: 500

 ** 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
<a name="API_ListComponents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListComponents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListComponents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListComponents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListComponents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListComponents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListComponents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListComponents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListComponents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListComponents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListComponents) 

# ListDeployments
<a name="API_ListDeployments"></a>

List deployments. You can filter the result list by environment, service, or a single service instance.

## Request Syntax
<a name="API_ListDeployments_RequestSyntax"></a>

```
{
   "componentName": "string",
   "environmentName": "string",
   "maxResults": number,
   "nextToken": "string",
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_ListDeployments_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [componentName](#API_ListDeployments_RequestSyntax) **   <a name="proton-ListDeployments-request-componentName"></a>
The name of a component for result list filtering. AWS Proton returns deployments associated with that component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [environmentName](#API_ListDeployments_RequestSyntax) **   <a name="proton-ListDeployments-request-environmentName"></a>
The name of an environment for result list filtering. AWS Proton returns deployments associated with the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [maxResults](#API_ListDeployments_RequestSyntax) **   <a name="proton-ListDeployments-request-maxResults"></a>
The maximum number of deployments to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListDeployments_RequestSyntax) **   <a name="proton-ListDeployments-request-nextToken"></a>
A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

 ** [serviceInstanceName](#API_ListDeployments_RequestSyntax) **   <a name="proton-ListDeployments-request-serviceInstanceName"></a>
The name of a service instance for result list filtering. AWS Proton returns the deployments associated with the service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceName](#API_ListDeployments_RequestSyntax) **   <a name="proton-ListDeployments-request-serviceName"></a>
The name of a service for result list filtering. AWS Proton returns deployments associated with service instances of the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

## Response Syntax
<a name="API_ListDeployments_ResponseSyntax"></a>

```
{
   "deployments": [ 
      { 
         "arn": "string",
         "completedAt": number,
         "componentName": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "environmentName": "string",
         "id": "string",
         "lastAttemptedDeploymentId": "string",
         "lastModifiedAt": number,
         "lastSucceededDeploymentId": "string",
         "serviceInstanceName": "string",
         "serviceName": "string",
         "targetArn": "string",
         "targetResourceCreatedAt": number,
         "targetResourceType": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDeployments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [deployments](#API_ListDeployments_ResponseSyntax) **   <a name="proton-ListDeployments-response-deployments"></a>
An array of deployment with summary data.  
Type: Array of [DeploymentSummary](API_DeploymentSummary.md) objects

 ** [nextToken](#API_ListDeployments_ResponseSyntax) **   <a name="proton-ListDeployments-response-nextToken"></a>
A token that indicates the location of the next deployment in the array of deployment, after the current requested list of deployment.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

## Errors
<a name="API_ListDeployments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListDeployments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListDeployments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListDeployments) 

# ListEnvironmentAccountConnections
<a name="API_ListEnvironmentAccountConnections"></a>

View a list of environment account connections.

For more information, see [Environment account connections](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.

## Request Syntax
<a name="API_ListEnvironmentAccountConnections_RequestSyntax"></a>

```
{
   "environmentName": "string",
   "maxResults": number,
   "nextToken": "string",
   "requestedBy": "string",
   "statuses": [ "string" ]
}
```

## Request Parameters
<a name="API_ListEnvironmentAccountConnections_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [environmentName](#API_ListEnvironmentAccountConnections_RequestSyntax) **   <a name="proton-ListEnvironmentAccountConnections-request-environmentName"></a>
The environment name that's associated with each listed environment account connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [maxResults](#API_ListEnvironmentAccountConnections_RequestSyntax) **   <a name="proton-ListEnvironmentAccountConnections-request-maxResults"></a>
The maximum number of environment account connections to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListEnvironmentAccountConnections_RequestSyntax) **   <a name="proton-ListEnvironmentAccountConnections-request-nextToken"></a>
A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

 ** [requestedBy](#API_ListEnvironmentAccountConnections_RequestSyntax) **   <a name="proton-ListEnvironmentAccountConnections-request-requestedBy"></a>
The type of account making the `ListEnvironmentAccountConnections` request.  
Type: String  
Valid Values: `MANAGEMENT_ACCOUNT | ENVIRONMENT_ACCOUNT`   
Required: Yes

 ** [statuses](#API_ListEnvironmentAccountConnections_RequestSyntax) **   <a name="proton-ListEnvironmentAccountConnections-request-statuses"></a>
The status details for each listed environment account connection.  
Type: Array of strings  
Valid Values: `PENDING | CONNECTED | REJECTED`   
Required: No

## Response Syntax
<a name="API_ListEnvironmentAccountConnections_ResponseSyntax"></a>

```
{
   "environmentAccountConnections": [ 
      { 
         "arn": "string",
         "componentRoleArn": "string",
         "environmentAccountId": "string",
         "environmentName": "string",
         "id": "string",
         "lastModifiedAt": number,
         "managementAccountId": "string",
         "requestedAt": number,
         "roleArn": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironmentAccountConnections_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [environmentAccountConnections](#API_ListEnvironmentAccountConnections_ResponseSyntax) **   <a name="proton-ListEnvironmentAccountConnections-response-environmentAccountConnections"></a>
An array of environment account connections with details that's returned by AWS Proton.   
Type: Array of [EnvironmentAccountConnectionSummary](API_EnvironmentAccountConnectionSummary.md) objects

 ** [nextToken](#API_ListEnvironmentAccountConnections_ResponseSyntax) **   <a name="proton-ListEnvironmentAccountConnections-response-nextToken"></a>
A token that indicates the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

## Errors
<a name="API_ListEnvironmentAccountConnections_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed to register with the service.  
HTTP Status Code: 500

 ** 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
<a name="API_ListEnvironmentAccountConnections_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListEnvironmentAccountConnections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListEnvironmentAccountConnections) 

# ListEnvironmentOutputs
<a name="API_ListEnvironmentOutputs"></a>

List the infrastructure as code outputs for your environment.

## Request Syntax
<a name="API_ListEnvironmentOutputs_RequestSyntax"></a>

```
{
   "deploymentId": "string",
   "environmentName": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListEnvironmentOutputs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deploymentId](#API_ListEnvironmentOutputs_RequestSyntax) **   <a name="proton-ListEnvironmentOutputs-request-deploymentId"></a>
The ID of the deployment whose outputs you want.  
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

 ** [environmentName](#API_ListEnvironmentOutputs_RequestSyntax) **   <a name="proton-ListEnvironmentOutputs-request-environmentName"></a>
The environment name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [nextToken](#API_ListEnvironmentOutputs_RequestSyntax) **   <a name="proton-ListEnvironmentOutputs-request-nextToken"></a>
A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

## Response Syntax
<a name="API_ListEnvironmentOutputs_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "outputs": [ 
      { 
         "key": "string",
         "valueString": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListEnvironmentOutputs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListEnvironmentOutputs_ResponseSyntax) **   <a name="proton-ListEnvironmentOutputs-response-nextToken"></a>
A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [outputs](#API_ListEnvironmentOutputs_ResponseSyntax) **   <a name="proton-ListEnvironmentOutputs-response-outputs"></a>
An array of environment outputs with detail data.  
Type: Array of [Output](API_Output.md) objects

## Errors
<a name="API_ListEnvironmentOutputs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListEnvironmentOutputs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListEnvironmentOutputs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListEnvironmentOutputs) 

# ListEnvironmentProvisionedResources
<a name="API_ListEnvironmentProvisionedResources"></a>

List the provisioned resources for your environment.

## Request Syntax
<a name="API_ListEnvironmentProvisionedResources_RequestSyntax"></a>

```
{
   "environmentName": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListEnvironmentProvisionedResources_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [environmentName](#API_ListEnvironmentProvisionedResources_RequestSyntax) **   <a name="proton-ListEnvironmentProvisionedResources-request-environmentName"></a>
The environment name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [nextToken](#API_ListEnvironmentProvisionedResources_RequestSyntax) **   <a name="proton-ListEnvironmentProvisionedResources-request-nextToken"></a>
A token that indicates 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.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

## Response Syntax
<a name="API_ListEnvironmentProvisionedResources_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "provisionedResources": [ 
      { 
         "identifier": "string",
         "name": "string",
         "provisioningEngine": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListEnvironmentProvisionedResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListEnvironmentProvisionedResources_ResponseSyntax) **   <a name="proton-ListEnvironmentProvisionedResources-response-nextToken"></a>
A token that indicates the location of the next environment provisioned resource in the array of provisioned resources, after the current requested list of environment provisioned resources.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [provisionedResources](#API_ListEnvironmentProvisionedResources_ResponseSyntax) **   <a name="proton-ListEnvironmentProvisionedResources-response-provisionedResources"></a>
An array of environment provisioned resources.  
Type: Array of [ProvisionedResource](API_ProvisionedResource.md) objects

## Errors
<a name="API_ListEnvironmentProvisionedResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListEnvironmentProvisionedResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListEnvironmentProvisionedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListEnvironmentProvisionedResources) 

# ListEnvironments
<a name="API_ListEnvironments"></a>

List environments with detail data summaries.

## Request Syntax
<a name="API_ListEnvironments_RequestSyntax"></a>

```
{
   "environmentTemplates": [ 
      { 
         "majorVersion": "string",
         "templateName": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListEnvironments_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [environmentTemplates](#API_ListEnvironments_RequestSyntax) **   <a name="proton-ListEnvironments-request-environmentTemplates"></a>
An array of the versions of the environment template.  
Type: Array of [EnvironmentTemplateFilter](API_EnvironmentTemplateFilter.md) objects  
Required: No

 ** [maxResults](#API_ListEnvironments_RequestSyntax) **   <a name="proton-ListEnvironments-request-maxResults"></a>
The maximum number of environments to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListEnvironments_RequestSyntax) **   <a name="proton-ListEnvironments-request-nextToken"></a>
A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

## Response Syntax
<a name="API_ListEnvironments_ResponseSyntax"></a>

```
{
   "environments": [ 
      { 
         "arn": "string",
         "componentRoleArn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "description": "string",
         "environmentAccountConnectionId": "string",
         "environmentAccountId": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastSucceededDeploymentId": "string",
         "name": "string",
         "protonServiceRoleArn": "string",
         "provisioning": "string",
         "templateMajorVersion": "string",
         "templateMinorVersion": "string",
         "templateName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [environments](#API_ListEnvironments_ResponseSyntax) **   <a name="proton-ListEnvironments-response-environments"></a>
An array of environment detail data summaries.  
Type: Array of [EnvironmentSummary](API_EnvironmentSummary.md) objects

 ** [nextToken](#API_ListEnvironments_ResponseSyntax) **   <a name="proton-ListEnvironments-response-nextToken"></a>
A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

## Errors
<a name="API_ListEnvironments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListEnvironments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListEnvironments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListEnvironments) 

# ListEnvironmentTemplates
<a name="API_ListEnvironmentTemplates"></a>

List environment templates.

## Request Syntax
<a name="API_ListEnvironmentTemplates_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListEnvironmentTemplates_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListEnvironmentTemplates_RequestSyntax) **   <a name="proton-ListEnvironmentTemplates-request-maxResults"></a>
The maximum number of environment templates to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListEnvironmentTemplates_RequestSyntax) **   <a name="proton-ListEnvironmentTemplates-request-nextToken"></a>
A token that indicates the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

## Response Syntax
<a name="API_ListEnvironmentTemplates_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "templates": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "description": "string",
         "displayName": "string",
         "lastModifiedAt": number,
         "name": "string",
         "provisioning": "string",
         "recommendedVersion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListEnvironmentTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListEnvironmentTemplates_ResponseSyntax) **   <a name="proton-ListEnvironmentTemplates-response-nextToken"></a>
A token that indicates the location of the next environment template in the array of environment templates, after the current requested list of environment templates.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

 ** [templates](#API_ListEnvironmentTemplates_ResponseSyntax) **   <a name="proton-ListEnvironmentTemplates-response-templates"></a>
An array of environment templates with detail data.  
Type: Array of [EnvironmentTemplateSummary](API_EnvironmentTemplateSummary.md) objects

## Errors
<a name="API_ListEnvironmentTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed to register with the service.  
HTTP Status Code: 500

 ** 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
<a name="API_ListEnvironmentTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListEnvironmentTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListEnvironmentTemplates) 

# ListEnvironmentTemplateVersions
<a name="API_ListEnvironmentTemplateVersions"></a>

List major or minor versions of an environment template with detail data.

## Request Syntax
<a name="API_ListEnvironmentTemplateVersions_RequestSyntax"></a>

```
{
   "majorVersion": "string",
   "maxResults": number,
   "nextToken": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_ListEnvironmentTemplateVersions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [majorVersion](#API_ListEnvironmentTemplateVersions_RequestSyntax) **   <a name="proton-ListEnvironmentTemplateVersions-request-majorVersion"></a>
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`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [maxResults](#API_ListEnvironmentTemplateVersions_RequestSyntax) **   <a name="proton-ListEnvironmentTemplateVersions-request-maxResults"></a>
The maximum number of major or minor versions of an environment template to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListEnvironmentTemplateVersions_RequestSyntax) **   <a name="proton-ListEnvironmentTemplateVersions-request-nextToken"></a>
A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

 ** [templateName](#API_ListEnvironmentTemplateVersions_RequestSyntax) **   <a name="proton-ListEnvironmentTemplateVersions-request-templateName"></a>
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
<a name="API_ListEnvironmentTemplateVersions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "templateVersions": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "description": "string",
         "lastModifiedAt": number,
         "majorVersion": "string",
         "minorVersion": "string",
         "recommendedMinorVersion": "string",
         "status": "string",
         "statusMessage": "string",
         "templateName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListEnvironmentTemplateVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListEnvironmentTemplateVersions_ResponseSyntax) **   <a name="proton-ListEnvironmentTemplateVersions-response-nextToken"></a>
A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

 ** [templateVersions](#API_ListEnvironmentTemplateVersions_ResponseSyntax) **   <a name="proton-ListEnvironmentTemplateVersions-response-templateVersions"></a>
An array of major or minor versions of an environment template detail data.  
Type: Array of [EnvironmentTemplateVersionSummary](API_EnvironmentTemplateVersionSummary.md) objects

## Errors
<a name="API_ListEnvironmentTemplateVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListEnvironmentTemplateVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListEnvironmentTemplateVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListEnvironmentTemplateVersions) 

# ListRepositories
<a name="API_ListRepositories"></a>

List linked repositories with detail data.

## Request Syntax
<a name="API_ListRepositories_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListRepositories_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListRepositories_RequestSyntax) **   <a name="proton-ListRepositories-request-maxResults"></a>
The maximum number of repositories to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListRepositories_RequestSyntax) **   <a name="proton-ListRepositories-request-nextToken"></a>
A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

## Response Syntax
<a name="API_ListRepositories_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "repositories": [ 
      { 
         "arn": "string",
         "connectionArn": "string",
         "name": "string",
         "provider": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRepositories_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListRepositories_ResponseSyntax) **   <a name="proton-ListRepositories-response-nextToken"></a>
A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories.   
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

 ** [repositories](#API_ListRepositories_ResponseSyntax) **   <a name="proton-ListRepositories-response-repositories"></a>
An array of repository links.  
Type: Array of [RepositorySummary](API_RepositorySummary.md) objects

## Errors
<a name="API_ListRepositories_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListRepositories_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListRepositories) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListRepositories) 

# ListRepositorySyncDefinitions
<a name="API_ListRepositorySyncDefinitions"></a>

List repository sync definitions with detail data.

## Request Syntax
<a name="API_ListRepositorySyncDefinitions_RequestSyntax"></a>

```
{
   "nextToken": "string",
   "repositoryName": "string",
   "repositoryProvider": "string",
   "syncType": "string"
}
```

## Request Parameters
<a name="API_ListRepositorySyncDefinitions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [nextToken](#API_ListRepositorySyncDefinitions_RequestSyntax) **   <a name="proton-ListRepositorySyncDefinitions-request-nextToken"></a>
A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

 ** [repositoryName](#API_ListRepositorySyncDefinitions_RequestSyntax) **   <a name="proton-ListRepositorySyncDefinitions-request-repositoryName"></a>
The repository name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [repositoryProvider](#API_ListRepositorySyncDefinitions_RequestSyntax) **   <a name="proton-ListRepositorySyncDefinitions-request-repositoryProvider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** [syncType](#API_ListRepositorySyncDefinitions_RequestSyntax) **   <a name="proton-ListRepositorySyncDefinitions-request-syncType"></a>
The sync type. The only supported value is `TEMPLATE_SYNC`.  
Type: String  
Valid Values: `TEMPLATE_SYNC | SERVICE_SYNC`   
Required: Yes

## Response Syntax
<a name="API_ListRepositorySyncDefinitions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "syncDefinitions": [ 
      { 
         "branch": "string",
         "directory": "string",
         "parent": "string",
         "target": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRepositorySyncDefinitions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListRepositorySyncDefinitions_ResponseSyntax) **   <a name="proton-ListRepositorySyncDefinitions-response-nextToken"></a>
A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [syncDefinitions](#API_ListRepositorySyncDefinitions_ResponseSyntax) **   <a name="proton-ListRepositorySyncDefinitions-response-syncDefinitions"></a>
An array of repository sync definitions.  
Type: Array of [RepositorySyncDefinition](API_RepositorySyncDefinition.md) objects

## Errors
<a name="API_ListRepositorySyncDefinitions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed to register with the service.  
HTTP Status Code: 500

 ** 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
<a name="API_ListRepositorySyncDefinitions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListRepositorySyncDefinitions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListRepositorySyncDefinitions) 

# ListServiceInstanceOutputs
<a name="API_ListServiceInstanceOutputs"></a>

Get a list service of instance Infrastructure as Code (IaC) outputs.

## Request Syntax
<a name="API_ListServiceInstanceOutputs_RequestSyntax"></a>

```
{
   "deploymentId": "string",
   "nextToken": "string",
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_ListServiceInstanceOutputs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deploymentId](#API_ListServiceInstanceOutputs_RequestSyntax) **   <a name="proton-ListServiceInstanceOutputs-request-deploymentId"></a>
The ID of the deployment whose outputs you want.  
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

 ** [nextToken](#API_ListServiceInstanceOutputs_RequestSyntax) **   <a name="proton-ListServiceInstanceOutputs-request-nextToken"></a>
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

 ** [serviceInstanceName](#API_ListServiceInstanceOutputs_RequestSyntax) **   <a name="proton-ListServiceInstanceOutputs-request-serviceInstanceName"></a>
The name of the service instance whose outputs you want.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceName](#API_ListServiceInstanceOutputs_RequestSyntax) **   <a name="proton-ListServiceInstanceOutputs-request-serviceName"></a>
The name of the service that `serviceInstanceName` is associated to.  
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
<a name="API_ListServiceInstanceOutputs_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "outputs": [ 
      { 
         "key": "string",
         "valueString": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServiceInstanceOutputs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServiceInstanceOutputs_ResponseSyntax) **   <a name="proton-ListServiceInstanceOutputs-response-nextToken"></a>
A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [outputs](#API_ListServiceInstanceOutputs_ResponseSyntax) **   <a name="proton-ListServiceInstanceOutputs-response-outputs"></a>
An array of service instance Infrastructure as Code (IaC) outputs.  
Type: Array of [Output](API_Output.md) objects

## Errors
<a name="API_ListServiceInstanceOutputs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListServiceInstanceOutputs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServiceInstanceOutputs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServiceInstanceOutputs) 

# ListServiceInstanceProvisionedResources
<a name="API_ListServiceInstanceProvisionedResources"></a>

List provisioned resources for a service instance with details.

## Request Syntax
<a name="API_ListServiceInstanceProvisionedResources_RequestSyntax"></a>

```
{
   "nextToken": "string",
   "serviceInstanceName": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_ListServiceInstanceProvisionedResources_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [nextToken](#API_ListServiceInstanceProvisionedResources_RequestSyntax) **   <a name="proton-ListServiceInstanceProvisionedResources-request-nextToken"></a>
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

 ** [serviceInstanceName](#API_ListServiceInstanceProvisionedResources_RequestSyntax) **   <a name="proton-ListServiceInstanceProvisionedResources-request-serviceInstanceName"></a>
The name of the service instance whose provisioned resources you want.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceName](#API_ListServiceInstanceProvisionedResources_RequestSyntax) **   <a name="proton-ListServiceInstanceProvisionedResources-request-serviceName"></a>
The name of the service that `serviceInstanceName` is associated to.  
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
<a name="API_ListServiceInstanceProvisionedResources_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "provisionedResources": [ 
      { 
         "identifier": "string",
         "name": "string",
         "provisioningEngine": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServiceInstanceProvisionedResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServiceInstanceProvisionedResources_ResponseSyntax) **   <a name="proton-ListServiceInstanceProvisionedResources-response-nextToken"></a>
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [provisionedResources](#API_ListServiceInstanceProvisionedResources_ResponseSyntax) **   <a name="proton-ListServiceInstanceProvisionedResources-response-provisionedResources"></a>
An array of provisioned resources for a service instance.  
Type: Array of [ProvisionedResource](API_ProvisionedResource.md) objects

## Errors
<a name="API_ListServiceInstanceProvisionedResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListServiceInstanceProvisionedResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServiceInstanceProvisionedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServiceInstanceProvisionedResources) 

# ListServiceInstances
<a name="API_ListServiceInstances"></a>

List service instances with summary data. This action lists service instances of all services in the AWS account.

## Request Syntax
<a name="API_ListServiceInstances_RequestSyntax"></a>

```
{
   "filters": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "serviceName": "string",
   "sortBy": "string",
   "sortOrder": "string"
}
```

## Request Parameters
<a name="API_ListServiceInstances_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filters](#API_ListServiceInstances_RequestSyntax) **   <a name="proton-ListServiceInstances-request-filters"></a>
An array of filtering criteria that scope down the result list. By default, all service instances in the AWS account are returned.  
Type: Array of [ListServiceInstancesFilter](API_ListServiceInstancesFilter.md) objects  
Required: No

 ** [maxResults](#API_ListServiceInstances_RequestSyntax) **   <a name="proton-ListServiceInstances-request-maxResults"></a>
The maximum number of service instances to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListServiceInstances_RequestSyntax) **   <a name="proton-ListServiceInstances-request-nextToken"></a>
A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

 ** [serviceName](#API_ListServiceInstances_RequestSyntax) **   <a name="proton-ListServiceInstances-request-serviceName"></a>
The name of the service that the service instance belongs to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [sortBy](#API_ListServiceInstances_RequestSyntax) **   <a name="proton-ListServiceInstances-request-sortBy"></a>
The field that the result list is sorted by.  
When you choose to sort by `serviceName`, service instances within each service are sorted by service instance name.  
Default: `serviceName`   
Type: String  
Valid Values: `name | deploymentStatus | templateName | serviceName | environmentName | lastDeploymentAttemptedAt | createdAt`   
Required: No

 ** [sortOrder](#API_ListServiceInstances_RequestSyntax) **   <a name="proton-ListServiceInstances-request-sortOrder"></a>
Result list sort order.  
Default: `ASCENDING`   
Type: String  
Valid Values: `ASCENDING | DESCENDING`   
Required: No

## Response Syntax
<a name="API_ListServiceInstances_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "serviceInstances": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "environmentName": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastSucceededDeploymentId": "string",
         "name": "string",
         "serviceName": "string",
         "templateMajorVersion": "string",
         "templateMinorVersion": "string",
         "templateName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServiceInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServiceInstances_ResponseSyntax) **   <a name="proton-ListServiceInstances-response-nextToken"></a>
A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

 ** [serviceInstances](#API_ListServiceInstances_ResponseSyntax) **   <a name="proton-ListServiceInstances-response-serviceInstances"></a>
An array of service instances with summary data.  
Type: Array of [ServiceInstanceSummary](API_ServiceInstanceSummary.md) objects

## Errors
<a name="API_ListServiceInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListServiceInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServiceInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServiceInstances) 

# ListServicePipelineOutputs
<a name="API_ListServicePipelineOutputs"></a>

Get a list of service pipeline Infrastructure as Code (IaC) outputs.

## Request Syntax
<a name="API_ListServicePipelineOutputs_RequestSyntax"></a>

```
{
   "deploymentId": "string",
   "nextToken": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_ListServicePipelineOutputs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deploymentId](#API_ListServicePipelineOutputs_RequestSyntax) **   <a name="proton-ListServicePipelineOutputs-request-deploymentId"></a>
The ID of the deployment you want the outputs for.  
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

 ** [nextToken](#API_ListServicePipelineOutputs_RequestSyntax) **   <a name="proton-ListServicePipelineOutputs-request-nextToken"></a>
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

 ** [serviceName](#API_ListServicePipelineOutputs_RequestSyntax) **   <a name="proton-ListServicePipelineOutputs-request-serviceName"></a>
The name of the service whose pipeline's outputs you want.  
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
<a name="API_ListServicePipelineOutputs_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "outputs": [ 
      { 
         "key": "string",
         "valueString": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServicePipelineOutputs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServicePipelineOutputs_ResponseSyntax) **   <a name="proton-ListServicePipelineOutputs-response-nextToken"></a>
A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [outputs](#API_ListServicePipelineOutputs_ResponseSyntax) **   <a name="proton-ListServicePipelineOutputs-response-outputs"></a>
An array of service pipeline Infrastructure as Code (IaC) outputs.  
Type: Array of [Output](API_Output.md) objects

## Errors
<a name="API_ListServicePipelineOutputs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListServicePipelineOutputs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServicePipelineOutputs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServicePipelineOutputs) 

# ListServicePipelineProvisionedResources
<a name="API_ListServicePipelineProvisionedResources"></a>

List provisioned resources for a service and pipeline with details.

## Request Syntax
<a name="API_ListServicePipelineProvisionedResources_RequestSyntax"></a>

```
{
   "nextToken": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_ListServicePipelineProvisionedResources_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [nextToken](#API_ListServicePipelineProvisionedResources_RequestSyntax) **   <a name="proton-ListServicePipelineProvisionedResources-request-nextToken"></a>
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.  
Type: String  
Length Constraints: Fixed length of 0.  
Required: No

 ** [serviceName](#API_ListServicePipelineProvisionedResources_RequestSyntax) **   <a name="proton-ListServicePipelineProvisionedResources-request-serviceName"></a>
The name of the service whose pipeline's provisioned resources you want.  
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
<a name="API_ListServicePipelineProvisionedResources_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "provisionedResources": [ 
      { 
         "identifier": "string",
         "name": "string",
         "provisioningEngine": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServicePipelineProvisionedResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServicePipelineProvisionedResources_ResponseSyntax) **   <a name="proton-ListServicePipelineProvisionedResources-response-nextToken"></a>
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.  
Type: String  
Length Constraints: Fixed length of 0.

 ** [provisionedResources](#API_ListServicePipelineProvisionedResources_ResponseSyntax) **   <a name="proton-ListServicePipelineProvisionedResources-response-provisionedResources"></a>
An array of provisioned resources for a service and pipeline.  
Type: Array of [ProvisionedResource](API_ProvisionedResource.md) objects

## Errors
<a name="API_ListServicePipelineProvisionedResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListServicePipelineProvisionedResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServicePipelineProvisionedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServicePipelineProvisionedResources) 

# ListServices
<a name="API_ListServices"></a>

List services with summaries of detail data.

## Request Syntax
<a name="API_ListServices_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListServices_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListServices_RequestSyntax) **   <a name="proton-ListServices-request-maxResults"></a>
The maximum number of services to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListServices_RequestSyntax) **   <a name="proton-ListServices-request-nextToken"></a>
A token that indicates the location of the next service in the array of services, after the list of services that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

## Response Syntax
<a name="API_ListServices_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "services": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "description": "string",
         "lastModifiedAt": number,
         "name": "string",
         "status": "string",
         "statusMessage": "string",
         "templateName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServices_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServices_ResponseSyntax) **   <a name="proton-ListServices-response-nextToken"></a>
A token that indicates the location of the next service in the array of services, after the current requested list of services.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

 ** [services](#API_ListServices_ResponseSyntax) **   <a name="proton-ListServices-response-services"></a>
An array of services with summaries of detail data.  
Type: Array of [ServiceSummary](API_ServiceSummary.md) objects

## Errors
<a name="API_ListServices_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed to register with the service.  
HTTP Status Code: 500

 ** 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
<a name="API_ListServices_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServices) 

# ListServiceTemplates
<a name="API_ListServiceTemplates"></a>

List service templates with detail data.

## Request Syntax
<a name="API_ListServiceTemplates_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListServiceTemplates_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListServiceTemplates_RequestSyntax) **   <a name="proton-ListServiceTemplates-request-maxResults"></a>
The maximum number of service templates to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListServiceTemplates_RequestSyntax) **   <a name="proton-ListServiceTemplates-request-nextToken"></a>
A token that indicates the location of the next service template in the array of service templates, after the list of service templates previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

## Response Syntax
<a name="API_ListServiceTemplates_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "templates": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "description": "string",
         "displayName": "string",
         "lastModifiedAt": number,
         "name": "string",
         "pipelineProvisioning": "string",
         "recommendedVersion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServiceTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServiceTemplates_ResponseSyntax) **   <a name="proton-ListServiceTemplates-response-nextToken"></a>
A token that indicates the location of the next service template in the array of service templates, after the current requested list of service templates.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

 ** [templates](#API_ListServiceTemplates_ResponseSyntax) **   <a name="proton-ListServiceTemplates-response-templates"></a>
An array of service templates with detail data.  
Type: Array of [ServiceTemplateSummary](API_ServiceTemplateSummary.md) objects

## Errors
<a name="API_ListServiceTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed to register with the service.  
HTTP Status Code: 500

 ** 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
<a name="API_ListServiceTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServiceTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServiceTemplates) 

# ListServiceTemplateVersions
<a name="API_ListServiceTemplateVersions"></a>

List major or minor versions of a service template with detail data.

## Request Syntax
<a name="API_ListServiceTemplateVersions_RequestSyntax"></a>

```
{
   "majorVersion": "string",
   "maxResults": number,
   "nextToken": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_ListServiceTemplateVersions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [majorVersion](#API_ListServiceTemplateVersions_RequestSyntax) **   <a name="proton-ListServiceTemplateVersions-request-majorVersion"></a>
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`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [maxResults](#API_ListServiceTemplateVersions_RequestSyntax) **   <a name="proton-ListServiceTemplateVersions-request-maxResults"></a>
The maximum number of major or minor versions of a service template to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListServiceTemplateVersions_RequestSyntax) **   <a name="proton-ListServiceTemplateVersions-request-nextToken"></a>
A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+`   
Required: No

 ** [templateName](#API_ListServiceTemplateVersions_RequestSyntax) **   <a name="proton-ListServiceTemplateVersions-request-templateName"></a>
The name of the service 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
<a name="API_ListServiceTemplateVersions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "templateVersions": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "description": "string",
         "lastModifiedAt": number,
         "majorVersion": "string",
         "minorVersion": "string",
         "recommendedMinorVersion": "string",
         "status": "string",
         "statusMessage": "string",
         "templateName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServiceTemplateVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListServiceTemplateVersions_ResponseSyntax) **   <a name="proton-ListServiceTemplateVersions-response-nextToken"></a>
A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions.  
Type: String  
Pattern: `[A-Za-z0-9+=/]+` 

 ** [templateVersions](#API_ListServiceTemplateVersions_ResponseSyntax) **   <a name="proton-ListServiceTemplateVersions-response-templateVersions"></a>
An array of major or minor versions of a service template with detail data.  
Type: Array of [ServiceTemplateVersionSummary](API_ServiceTemplateVersionSummary.md) objects

## Errors
<a name="API_ListServiceTemplateVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListServiceTemplateVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListServiceTemplateVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServiceTemplateVersions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

List tags for a resource. For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListTagsForResource_RequestSyntax) **   <a name="proton-ListTagsForResource-request-maxResults"></a>
The maximum number of tags to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="proton-ListTagsForResource-request-nextToken"></a>
A token that indicates the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.  
Type: String  
Required: No

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="proton-ListTagsForResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource for the listed tags.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="proton-ListTagsForResource-response-nextToken"></a>
A token that indicates the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.  
Type: String

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="proton-ListTagsForResource-response-tags"></a>
A list of resource tags with detail data.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
There *isn't* sufficient access for performing this action.  
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
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListTagsForResource) 

# NotifyResourceDeploymentStatusChange
<a name="API_NotifyResourceDeploymentStatusChange"></a>

Notify AWS Proton of status changes to a provisioned resource when you use self-managed provisioning.

For more information, see [Self-managed provisioning](https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_NotifyResourceDeploymentStatusChange_RequestSyntax"></a>

```
{
   "deploymentId": "string",
   "outputs": [ 
      { 
         "key": "string",
         "valueString": "string"
      }
   ],
   "resourceArn": "string",
   "status": "string",
   "statusMessage": "string"
}
```

## Request Parameters
<a name="API_NotifyResourceDeploymentStatusChange_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deploymentId](#API_NotifyResourceDeploymentStatusChange_RequestSyntax) **   <a name="proton-NotifyResourceDeploymentStatusChange-request-deploymentId"></a>
The deployment ID for your provisioned resource.  
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

 ** [outputs](#API_NotifyResourceDeploymentStatusChange_RequestSyntax) **   <a name="proton-NotifyResourceDeploymentStatusChange-request-outputs"></a>
The provisioned resource state change detail data that's returned by AWS Proton.  
Type: Array of [Output](API_Output.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [resourceArn](#API_NotifyResourceDeploymentStatusChange_RequestSyntax) **   <a name="proton-NotifyResourceDeploymentStatusChange-request-resourceArn"></a>
The provisioned resource Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: Yes

 ** [status](#API_NotifyResourceDeploymentStatusChange_RequestSyntax) **   <a name="proton-NotifyResourceDeploymentStatusChange-request-status"></a>
The status of your provisioned resource.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED`   
Required: No

 ** [statusMessage](#API_NotifyResourceDeploymentStatusChange_RequestSyntax) **   <a name="proton-NotifyResourceDeploymentStatusChange-request-statusMessage"></a>
The deployment status message for your provisioned resource.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 5000.  
Required: No

## Response Elements
<a name="API_NotifyResourceDeploymentStatusChange_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_NotifyResourceDeploymentStatusChange_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_NotifyResourceDeploymentStatusChange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/NotifyResourceDeploymentStatusChange) 

# RejectEnvironmentAccountConnection
<a name="API_RejectEnvironmentAccountConnection"></a>

In a management account, reject an environment account connection from another environment account.

After you reject an environment account connection request, you *can't* accept or use the rejected environment account connection.

You *can’t* reject an environment account connection that's connected to an environment.

For more information, see [Environment account connections](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.

## Request Syntax
<a name="API_RejectEnvironmentAccountConnection_RequestSyntax"></a>

```
{
   "id": "string"
}
```

## Request Parameters
<a name="API_RejectEnvironmentAccountConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [id](#API_RejectEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-RejectEnvironmentAccountConnection-request-id"></a>
The ID of the environment account connection to reject.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_RejectEnvironmentAccountConnection_ResponseSyntax"></a>

```
{
   "environmentAccountConnection": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "environmentAccountId": "string",
      "environmentName": "string",
      "id": "string",
      "lastModifiedAt": number,
      "managementAccountId": "string",
      "requestedAt": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_RejectEnvironmentAccountConnection_ResponseElements"></a>

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](#API_RejectEnvironmentAccountConnection_ResponseSyntax) **   <a name="proton-RejectEnvironmentAccountConnection-response-environmentAccountConnection"></a>
The environment connection account detail data that's returned by AWS Proton.  
Type: [EnvironmentAccountConnection](API_EnvironmentAccountConnection.md) object

## Errors
<a name="API_RejectEnvironmentAccountConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_RejectEnvironmentAccountConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/RejectEnvironmentAccountConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/RejectEnvironmentAccountConnection) 

# TagResource
<a name="API_TagResource"></a>

Tag a resource. A tag is a key-value pair of metadata that you associate with an AWS Proton resource.

For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="proton-TagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the AWS Proton resource to apply customer tags to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: Yes

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="proton-TagResource-request-tags"></a>
A list of customer tags to apply to the AWS Proton resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an AWS Proton resource.

For more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="proton-UntagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to remove customer tags from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="proton-UntagResource-request-tagKeys"></a>
A list of customer tag keys that indicate the customer tags to be removed from the resource.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UntagResource) 

# UpdateAccountSettings
<a name="API_UpdateAccountSettings"></a>

Update AWS Proton settings that are used for multiple services in the AWS account.

## Request Syntax
<a name="API_UpdateAccountSettings_RequestSyntax"></a>

```
{
   "deletePipelineProvisioningRepository": boolean,
   "pipelineCodebuildRoleArn": "string",
   "pipelineProvisioningRepository": { 
      "branch": "string",
      "name": "string",
      "provider": "string"
   },
   "pipelineServiceRoleArn": "string"
}
```

## Request Parameters
<a name="API_UpdateAccountSettings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deletePipelineProvisioningRepository](#API_UpdateAccountSettings_RequestSyntax) **   <a name="proton-UpdateAccountSettings-request-deletePipelineProvisioningRepository"></a>
Set to `true` to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the configured pipeline repository.  
Type: Boolean  
Required: No

 ** [pipelineCodebuildRoleArn](#API_UpdateAccountSettings_RequestSyntax) **   <a name="proton-UpdateAccountSettings-request-pipelineCodebuildRoleArn"></a>
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. AWS Proton assumes this role for CodeBuild-based provisioning.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*(^$)|(^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$).*`   
Required: No

 ** [pipelineProvisioningRepository](#API_UpdateAccountSettings_RequestSyntax) **   <a name="proton-UpdateAccountSettings-request-pipelineProvisioningRepository"></a>
A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with AWS Proton. For more information, see [CreateRepository](API_CreateRepository.md).  
To remove a previously configured repository, set `deletePipelineProvisioningRepository` to `true`, and don't set `pipelineProvisioningRepository`.  
Type: [RepositoryBranchInput](API_RepositoryBranchInput.md) object  
Required: No

 ** [pipelineServiceRoleArn](#API_UpdateAccountSettings_RequestSyntax) **   <a name="proton-UpdateAccountSettings-request-pipelineServiceRoleArn"></a>
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by AWS Proton for AWS-managed provisioning, and by customer-owned automation for self-managed provisioning.  
To remove a previously configured ARN, specify an empty string.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*(^$)|(^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$).*`   
Required: No

## Response Syntax
<a name="API_UpdateAccountSettings_ResponseSyntax"></a>

```
{
   "accountSettings": { 
      "pipelineCodebuildRoleArn": "string",
      "pipelineProvisioningRepository": { 
         "arn": "string",
         "branch": "string",
         "name": "string",
         "provider": "string"
      },
      "pipelineServiceRoleArn": "string"
   }
}
```

## Response Elements
<a name="API_UpdateAccountSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountSettings](#API_UpdateAccountSettings_ResponseSyntax) **   <a name="proton-UpdateAccountSettings-response-accountSettings"></a>
The AWS Proton pipeline service role and repository data shared across the AWS account.  
Type: [AccountSettings](API_AccountSettings.md) object

## Errors
<a name="API_UpdateAccountSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_UpdateAccountSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateAccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateAccountSettings) 

# UpdateComponent
<a name="API_UpdateComponent"></a>

Update a component.

There are a few modes for updating a component. The `deploymentType` field defines the mode.

**Note**  
You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is `IN_PROGRESS`.

For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_UpdateComponent_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "deploymentType": "string",
   "description": "string",
   "name": "string",
   "serviceInstanceName": "string",
   "serviceName": "string",
   "serviceSpec": "string",
   "templateFile": "string"
}
```

## Request Parameters
<a name="API_UpdateComponent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-clientToken"></a>
The client token for the updated component.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [deploymentType](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-deploymentType"></a>
The deployment type. It defines the mode for updating a component, as follows:    
  
 `NONE`   
In this mode, a deployment *doesn't* occur. Only the requested metadata parameters are updated. You can only specify `description` in this mode.  
  
 `CURRENT_VERSION`   
In this mode, the component is deployed and updated with the new `serviceSpec`, `templateSource`, and/or `type` that you provide. Only requested parameters are updated.
Type: String  
Valid Values: `NONE | CURRENT_VERSION`   
Required: Yes

 ** [description](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-description"></a>
An optional customer-provided description of the component.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [name](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-name"></a>
The name of the component to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceInstanceName](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-serviceInstanceName"></a>
The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both `serviceInstanceName` and `serviceName` or for neither of them.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `.*(^$)|^[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceName](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-serviceName"></a>
The name of the service that `serviceInstanceName` is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both `serviceInstanceName` and `serviceName` or for neither of them.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `.*(^$)|^[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** [serviceSpec](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-serviceSpec"></a>
The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** [templateFile](#API_UpdateComponent_RequestSyntax) **   <a name="proton-UpdateComponent-request-templateFile"></a>
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.  
Components support a single IaC file, even if you use Terraform as your template language.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## Response Syntax
<a name="API_UpdateComponent_ResponseSyntax"></a>

```
{
   "component": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "serviceSpec": "string"
   }
}
```

## Response Elements
<a name="API_UpdateComponent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [component](#API_UpdateComponent_ResponseSyntax) **   <a name="proton-UpdateComponent-response-component"></a>
The detailed data of the updated component.  
Type: [Component](API_Component.md) object

## Errors
<a name="API_UpdateComponent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_UpdateComponent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateComponent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateComponent) 

# UpdateEnvironment
<a name="API_UpdateEnvironment"></a>

Update an environment.

If the environment is associated with an environment account connection, *don't* update or include the `protonServiceRoleArn` and `provisioningRepository` parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.

If the environment *isn't* associated with an environment account connection, *don't* update or include the `environmentAccountConnectionId` parameter. You *can't* update or connect the environment to an environment account connection if it *isn't* already associated with an environment connection.

You can update either the `environmentAccountConnectionId` or `protonServiceRoleArn` parameter and value. You can’t update both.

If the environment was configured for AWS-managed provisioning, omit the `provisioningRepository` parameter.

If the environment was configured for self-managed provisioning, specify the `provisioningRepository` parameter and omit the `protonServiceRoleArn` and `environmentAccountConnectionId` parameters.

For more information, see [Environments](https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) and [Provisioning methods](https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html) in the * AWS Proton User Guide*.

There are four modes for updating an environment. The `deploymentType` field defines the mode.

  
 `NONE`   
In this mode, a deployment *doesn't* occur. Only the requested metadata parameters are updated.

  
 `CURRENT_VERSION`   
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. *Don’t* include minor or major version parameters when you use this `deployment-type`.

  
 `MINOR_VERSION`   
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

  
 `MAJOR_VERSION`   
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.

## Request Syntax
<a name="API_UpdateEnvironment_RequestSyntax"></a>

```
{
   "codebuildRoleArn": "string",
   "componentRoleArn": "string",
   "deploymentType": "string",
   "description": "string",
   "environmentAccountConnectionId": "string",
   "name": "string",
   "protonServiceRoleArn": "string",
   "provisioningRepository": { 
      "branch": "string",
      "name": "string",
      "provider": "string"
   },
   "spec": "string",
   "templateMajorVersion": "string",
   "templateMinorVersion": "string"
}
```

## Request Parameters
<a name="API_UpdateEnvironment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [codebuildRoleArn](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-codebuildRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that allows AWS Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [componentRoleArn](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-componentRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.  
The environment must have a `componentRoleArn` to allow directly defined components to be associated with the environment.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [deploymentType](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-deploymentType"></a>
There are four modes for updating an environment. The `deploymentType` field defines the mode.    
  
 `NONE`   
In this mode, a deployment *doesn't* occur. Only the requested metadata parameters are updated.  
  
 `CURRENT_VERSION`   
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. *Don’t* include major or minor version parameters when you use this `deployment-type`.  
  
 `MINOR_VERSION`   
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.  
  
 `MAJOR_VERSION`   
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
Type: String  
Valid Values: `NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSION`   
Required: Yes

 ** [description](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-description"></a>
A description of the environment update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [environmentAccountConnectionId](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-environmentAccountConnectionId"></a>
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.  
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](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-name"></a>
The name of the environment to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [protonServiceRoleArn](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-protonServiceRoleArn"></a>
The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

 ** [provisioningRepository](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-provisioningRepository"></a>
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with AWS Proton. For more information, see [CreateRepository](API_CreateRepository.md).  
Type: [RepositoryBranchInput](API_RepositoryBranchInput.md) object  
Required: No

 ** [spec](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-spec"></a>
The formatted specification that defines the update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** [templateMajorVersion](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-templateMajorVersion"></a>
The major version of the environment to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [templateMinorVersion](#API_UpdateEnvironment_RequestSyntax) **   <a name="proton-UpdateEnvironment-request-templateMinorVersion"></a>
The minor version of the environment to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

## Response Syntax
<a name="API_UpdateEnvironment_ResponseSyntax"></a>

```
{
   "environment": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentAccountConnectionId": "string",
      "environmentAccountId": "string",
      "lastAttemptedDeploymentId": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "protonServiceRoleArn": "string",
      "provisioning": "string",
      "provisioningRepository": { 
         "arn": "string",
         "branch": "string",
         "name": "string",
         "provider": "string"
      },
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateEnvironment_ResponseElements"></a>

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](#API_UpdateEnvironment_ResponseSyntax) **   <a name="proton-UpdateEnvironment-response-environment"></a>
The environment detail data that's returned by AWS Proton.  
Type: [Environment](API_Environment.md) object

## Errors
<a name="API_UpdateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateEnvironment) 

# UpdateEnvironmentAccountConnection
<a name="API_UpdateEnvironmentAccountConnection"></a>

In an environment account, update an environment account connection to use a new IAM role.

For more information, see [Environment account connections](https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) in the * AWS Proton User guide*.

## Request Syntax
<a name="API_UpdateEnvironmentAccountConnection_RequestSyntax"></a>

```
{
   "codebuildRoleArn": "string",
   "componentRoleArn": "string",
   "id": "string",
   "roleArn": "string"
}
```

## Request Parameters
<a name="API_UpdateEnvironmentAccountConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [codebuildRoleArn](#API_UpdateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-UpdateEnvironmentAccountConnection-request-codebuildRoleArn"></a>
The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [componentRoleArn](#API_UpdateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-UpdateEnvironmentAccountConnection-request-componentRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.  
The environment account connection must have a `componentRoleArn` to allow directly defined components to be associated with any environments running in the account.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

 ** [id](#API_UpdateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-UpdateEnvironmentAccountConnection-request-id"></a>
The ID of the environment account connection to update.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [roleArn](#API_UpdateEnvironmentAccountConnection_RequestSyntax) **   <a name="proton-UpdateEnvironmentAccountConnection-request-roleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})`   
Required: No

## Response Syntax
<a name="API_UpdateEnvironmentAccountConnection_ResponseSyntax"></a>

```
{
   "environmentAccountConnection": { 
      "arn": "string",
      "codebuildRoleArn": "string",
      "componentRoleArn": "string",
      "environmentAccountId": "string",
      "environmentName": "string",
      "id": "string",
      "lastModifiedAt": number,
      "managementAccountId": "string",
      "requestedAt": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_UpdateEnvironmentAccountConnection_ResponseElements"></a>

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](#API_UpdateEnvironmentAccountConnection_ResponseSyntax) **   <a name="proton-UpdateEnvironmentAccountConnection-response-environmentAccountConnection"></a>
The environment account connection detail data that's returned by AWS Proton.  
Type: [EnvironmentAccountConnection](API_EnvironmentAccountConnection.md) object

## Errors
<a name="API_UpdateEnvironmentAccountConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateEnvironmentAccountConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateEnvironmentAccountConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateEnvironmentAccountConnection) 

# UpdateEnvironmentTemplate
<a name="API_UpdateEnvironmentTemplate"></a>

Update an environment template.

## Request Syntax
<a name="API_UpdateEnvironmentTemplate_RequestSyntax"></a>

```
{
   "description": "string",
   "displayName": "string",
   "name": "string"
}
```

## Request Parameters
<a name="API_UpdateEnvironmentTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_UpdateEnvironmentTemplate_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplate-request-description"></a>
A description of the environment template update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [displayName](#API_UpdateEnvironmentTemplate_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplate-request-displayName"></a>
The name of the environment template to update as displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [name](#API_UpdateEnvironmentTemplate_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplate-request-name"></a>
The name of the environment template to update.  
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
<a name="API_UpdateEnvironmentTemplate_ResponseSyntax"></a>

```
{
   "environmentTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "provisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_UpdateEnvironmentTemplate_ResponseElements"></a>

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](#API_UpdateEnvironmentTemplate_ResponseSyntax) **   <a name="proton-UpdateEnvironmentTemplate-response-environmentTemplate"></a>
The environment template detail data that's returned by AWS Proton.  
Type: [EnvironmentTemplate](API_EnvironmentTemplate.md) object

## Errors
<a name="API_UpdateEnvironmentTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateEnvironmentTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateEnvironmentTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateEnvironmentTemplate) 

# UpdateEnvironmentTemplateVersion
<a name="API_UpdateEnvironmentTemplateVersion"></a>

Update a major or minor version of an environment template.

## Request Syntax
<a name="API_UpdateEnvironmentTemplateVersion_RequestSyntax"></a>

```
{
   "description": "string",
   "majorVersion": "string",
   "minorVersion": "string",
   "status": "string",
   "templateName": "string"
}
```

## Request Parameters
<a name="API_UpdateEnvironmentTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_UpdateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplateVersion-request-description"></a>
A description of environment template version to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [majorVersion](#API_UpdateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplateVersion-request-majorVersion"></a>
To update a major version of an environment template, include `major Version`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [minorVersion](#API_UpdateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplateVersion-request-minorVersion"></a>
To update a minor version of an environment template, include `minorVersion`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [status](#API_UpdateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplateVersion-request-status"></a>
The status of the environment template minor version to update.  
Type: String  
Valid Values: `REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED`   
Required: No

 ** [templateName](#API_UpdateEnvironmentTemplateVersion_RequestSyntax) **   <a name="proton-UpdateEnvironmentTemplateVersion-request-templateName"></a>
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
<a name="API_UpdateEnvironmentTemplateVersion_ResponseSyntax"></a>

```
{
   "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
<a name="API_UpdateEnvironmentTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [environmentTemplateVersion](#API_UpdateEnvironmentTemplateVersion_ResponseSyntax) **   <a name="proton-UpdateEnvironmentTemplateVersion-response-environmentTemplateVersion"></a>
The environment template version detail data that's returned by AWS Proton.  
Type: [EnvironmentTemplateVersion](API_EnvironmentTemplateVersion.md) object

## Errors
<a name="API_UpdateEnvironmentTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateEnvironmentTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateEnvironmentTemplateVersion) 

# UpdateService
<a name="API_UpdateService"></a>

Edit a service description or use a spec to add and delete service instances.

**Note**  
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.

**Note**  
You can't delete a service instance (remove it from the spec) if it has an attached component.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_UpdateService_RequestSyntax"></a>

```
{
   "description": "string",
   "name": "string",
   "spec": "string"
}
```

## Request Parameters
<a name="API_UpdateService_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_UpdateService_RequestSyntax) **   <a name="proton-UpdateService-request-description"></a>
The edited service description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [name](#API_UpdateService_RequestSyntax) **   <a name="proton-UpdateService-request-name"></a>
The name of the service to edit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [spec](#API_UpdateService_RequestSyntax) **   <a name="proton-UpdateService-request-spec"></a>
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](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html) in the * AWS Proton User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## Response Syntax
<a name="API_UpdateService_ResponseSyntax"></a>

```
{
   "service": { 
      "arn": "string",
      "branchName": "string",
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipeline": { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastSucceededDeploymentId": "string",
         "spec": "string",
         "templateMajorVersion": "string",
         "templateMinorVersion": "string",
         "templateName": "string"
      },
      "repositoryConnectionArn": "string",
      "repositoryId": "string",
      "spec": "string",
      "status": "string",
      "statusMessage": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateService_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [service](#API_UpdateService_ResponseSyntax) **   <a name="proton-UpdateService-response-service"></a>
The service detail data that's returned by AWS Proton.  
Type: [Service](API_Service.md) object

## Errors
<a name="API_UpdateService_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the * AWS Proton User 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
<a name="API_UpdateService_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateService) 

# UpdateServiceInstance
<a name="API_UpdateServiceInstance"></a>

Update a service instance.

There are a few modes for updating a service instance. The `deploymentType` field defines the mode.

**Note**  
You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is `IN_PROGRESS`.  
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.

## Request Syntax
<a name="API_UpdateServiceInstance_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "deploymentType": "string",
   "name": "string",
   "serviceName": "string",
   "spec": "string",
   "templateMajorVersion": "string",
   "templateMinorVersion": "string"
}
```

## Request Parameters
<a name="API_UpdateServiceInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateServiceInstance_RequestSyntax) **   <a name="proton-UpdateServiceInstance-request-clientToken"></a>
The client token of the service instance to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [deploymentType](#API_UpdateServiceInstance_RequestSyntax) **   <a name="proton-UpdateServiceInstance-request-deploymentType"></a>
The deployment type. It defines the mode for updating a service instance, as follows:    
  
 `NONE`   
In this mode, a deployment *doesn't* occur. Only the requested metadata parameters are updated.  
  
 `CURRENT_VERSION`   
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. *Don’t* include major or minor version parameters when you use this deployment type.  
  
 `MINOR_VERSION`   
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.  
  
 `MAJOR_VERSION`   
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
Type: String  
Valid Values: `NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSION`   
Required: Yes

 ** [name](#API_UpdateServiceInstance_RequestSyntax) **   <a name="proton-UpdateServiceInstance-request-name"></a>
The name of the service instance to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [serviceName](#API_UpdateServiceInstance_RequestSyntax) **   <a name="proton-UpdateServiceInstance-request-serviceName"></a>
The name of the service that the service instance belongs to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [spec](#API_UpdateServiceInstance_RequestSyntax) **   <a name="proton-UpdateServiceInstance-request-spec"></a>
The formatted specification that defines the service instance update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** [templateMajorVersion](#API_UpdateServiceInstance_RequestSyntax) **   <a name="proton-UpdateServiceInstance-request-templateMajorVersion"></a>
The major version of the service template to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [templateMinorVersion](#API_UpdateServiceInstance_RequestSyntax) **   <a name="proton-UpdateServiceInstance-request-templateMinorVersion"></a>
The minor version of the service template to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

## Response Syntax
<a name="API_UpdateServiceInstance_ResponseSyntax"></a>

```
{
   "serviceInstance": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceName": "string",
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateServiceInstance_ResponseElements"></a>

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](#API_UpdateServiceInstance_ResponseSyntax) **   <a name="proton-UpdateServiceInstance-response-serviceInstance"></a>
The service instance summary data that's returned by AWS Proton.  
Type: [ServiceInstance](API_ServiceInstance.md) object

## Errors
<a name="API_UpdateServiceInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateServiceInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateServiceInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateServiceInstance) 

# UpdateServicePipeline
<a name="API_UpdateServicePipeline"></a>

Update the service pipeline.

There are four modes for updating a service pipeline. The `deploymentType` field defines the mode.

  
 `NONE`   
In this mode, a deployment *doesn't* occur. Only the requested metadata parameters are updated.

  
 `CURRENT_VERSION`   
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. *Don’t* include major or minor version parameters when you use this `deployment-type`.

  
 `MINOR_VERSION`   
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.

  
 `MAJOR_VERSION`   
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that's higher than the major version in use and a minor version.

## Request Syntax
<a name="API_UpdateServicePipeline_RequestSyntax"></a>

```
{
   "deploymentType": "string",
   "serviceName": "string",
   "spec": "string",
   "templateMajorVersion": "string",
   "templateMinorVersion": "string"
}
```

## Request Parameters
<a name="API_UpdateServicePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deploymentType](#API_UpdateServicePipeline_RequestSyntax) **   <a name="proton-UpdateServicePipeline-request-deploymentType"></a>
The deployment type.  
There are four modes for updating a service pipeline. The `deploymentType` field defines the mode.    
  
 `NONE`   
In this mode, a deployment *doesn't* occur. Only the requested metadata parameters are updated.  
  
 `CURRENT_VERSION`   
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. *Don’t* include major or minor version parameters when you use this `deployment-type`.  
  
 `MINOR_VERSION`   
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.  
  
 `MAJOR_VERSION`   
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
Type: String  
Valid Values: `NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSION`   
Required: Yes

 ** [serviceName](#API_UpdateServicePipeline_RequestSyntax) **   <a name="proton-UpdateServicePipeline-request-serviceName"></a>
The name of the service to that the pipeline is associated with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [spec](#API_UpdateServicePipeline_RequestSyntax) **   <a name="proton-UpdateServicePipeline-request-spec"></a>
The spec for the service pipeline to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: Yes

 ** [templateMajorVersion](#API_UpdateServicePipeline_RequestSyntax) **   <a name="proton-UpdateServicePipeline-request-templateMajorVersion"></a>
The major version of the service template that was used to create the service that the pipeline is associated with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** [templateMinorVersion](#API_UpdateServicePipeline_RequestSyntax) **   <a name="proton-UpdateServicePipeline-request-templateMinorVersion"></a>
The minor version of the service template that was used to create the service that the pipeline is associated with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

## Response Syntax
<a name="API_UpdateServicePipeline_ResponseSyntax"></a>

```
{
   "pipeline": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "lastAttemptedDeploymentId": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "spec": "string",
      "templateMajorVersion": "string",
      "templateMinorVersion": "string",
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateServicePipeline_ResponseElements"></a>

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](#API_UpdateServicePipeline_ResponseSyntax) **   <a name="proton-UpdateServicePipeline-response-pipeline"></a>
The pipeline details that are returned by AWS Proton.  
Type: [ServicePipeline](API_ServicePipeline.md) object

## Errors
<a name="API_UpdateServicePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateServicePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateServicePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateServicePipeline) 

# UpdateServiceSyncBlocker
<a name="API_UpdateServiceSyncBlocker"></a>

Update the service sync blocker by resolving it.

## Request Syntax
<a name="API_UpdateServiceSyncBlocker_RequestSyntax"></a>

```
{
   "id": "string",
   "resolvedReason": "string"
}
```

## Request Parameters
<a name="API_UpdateServiceSyncBlocker_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [id](#API_UpdateServiceSyncBlocker_RequestSyntax) **   <a name="proton-UpdateServiceSyncBlocker-request-id"></a>
The ID of the service sync blocker.  
Type: String  
Required: Yes

 ** [resolvedReason](#API_UpdateServiceSyncBlocker_RequestSyntax) **   <a name="proton-UpdateServiceSyncBlocker-request-resolvedReason"></a>
The reason the service sync blocker was resolved.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateServiceSyncBlocker_ResponseSyntax"></a>

```
{
   "serviceInstanceName": "string",
   "serviceName": "string",
   "serviceSyncBlocker": { 
      "contexts": [ 
         { 
            "key": "string",
            "value": "string"
         }
      ],
      "createdAt": number,
      "createdReason": "string",
      "id": "string",
      "resolvedAt": number,
      "resolvedReason": "string",
      "status": "string",
      "type": "string"
   }
}
```

## Response Elements
<a name="API_UpdateServiceSyncBlocker_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceInstanceName](#API_UpdateServiceSyncBlocker_ResponseSyntax) **   <a name="proton-UpdateServiceSyncBlocker-response-serviceInstanceName"></a>
The name of the service instance that you want to update the service sync blocker for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*` 

 ** [serviceName](#API_UpdateServiceSyncBlocker_ResponseSyntax) **   <a name="proton-UpdateServiceSyncBlocker-response-serviceName"></a>
The name of the service that you want to update the service sync blocker for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*` 

 ** [serviceSyncBlocker](#API_UpdateServiceSyncBlocker_ResponseSyntax) **   <a name="proton-UpdateServiceSyncBlocker-response-serviceSyncBlocker"></a>
The detailed data on the service sync blocker that was updated.  
Type: [SyncBlocker](API_SyncBlocker.md) object

## Errors
<a name="API_UpdateServiceSyncBlocker_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateServiceSyncBlocker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateServiceSyncBlocker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateServiceSyncBlocker) 

# UpdateServiceSyncConfig
<a name="API_UpdateServiceSyncConfig"></a>

Update the AWS Proton Ops config file.

## Request Syntax
<a name="API_UpdateServiceSyncConfig_RequestSyntax"></a>

```
{
   "branch": "string",
   "filePath": "string",
   "repositoryName": "string",
   "repositoryProvider": "string",
   "serviceName": "string"
}
```

## Request Parameters
<a name="API_UpdateServiceSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [branch](#API_UpdateServiceSyncConfig_RequestSyntax) **   <a name="proton-UpdateServiceSyncConfig-request-branch"></a>
The name of the code repository branch where the AWS Proton Ops file is found.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** [filePath](#API_UpdateServiceSyncConfig_RequestSyntax) **   <a name="proton-UpdateServiceSyncConfig-request-filePath"></a>
The path to the AWS Proton Ops file.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** [repositoryName](#API_UpdateServiceSyncConfig_RequestSyntax) **   <a name="proton-UpdateServiceSyncConfig-request-repositoryName"></a>
The name of the repository where the AWS Proton Ops file is found.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [repositoryProvider](#API_UpdateServiceSyncConfig_RequestSyntax) **   <a name="proton-UpdateServiceSyncConfig-request-repositoryProvider"></a>
The name of the repository provider where the AWS Proton Ops file is found.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** [serviceName](#API_UpdateServiceSyncConfig_RequestSyntax) **   <a name="proton-UpdateServiceSyncConfig-request-serviceName"></a>
The name of the service the AWS Proton Ops file is for.  
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
<a name="API_UpdateServiceSyncConfig_ResponseSyntax"></a>

```
{
   "serviceSyncConfig": { 
      "branch": "string",
      "filePath": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "serviceName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateServiceSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceSyncConfig](#API_UpdateServiceSyncConfig_ResponseSyntax) **   <a name="proton-UpdateServiceSyncConfig-response-serviceSyncConfig"></a>
The detailed data of the AWS Proton Ops file.  
Type: [ServiceSyncConfig](API_ServiceSyncConfig.md) object

## Errors
<a name="API_UpdateServiceSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateServiceSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateServiceSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateServiceSyncConfig) 

# UpdateServiceTemplate
<a name="API_UpdateServiceTemplate"></a>

Update a service template.

## Request Syntax
<a name="API_UpdateServiceTemplate_RequestSyntax"></a>

```
{
   "description": "string",
   "displayName": "string",
   "name": "string"
}
```

## Request Parameters
<a name="API_UpdateServiceTemplate_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_UpdateServiceTemplate_RequestSyntax) **   <a name="proton-UpdateServiceTemplate-request-description"></a>
A description of the service template update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [displayName](#API_UpdateServiceTemplate_RequestSyntax) **   <a name="proton-UpdateServiceTemplate-request-displayName"></a>
The name of the service template to update that's displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [name](#API_UpdateServiceTemplate_RequestSyntax) **   <a name="proton-UpdateServiceTemplate-request-name"></a>
The name of the service template to update.  
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
<a name="API_UpdateServiceTemplate_ResponseSyntax"></a>

```
{
   "serviceTemplate": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "displayName": "string",
      "encryptionKey": "string",
      "lastModifiedAt": number,
      "name": "string",
      "pipelineProvisioning": "string",
      "recommendedVersion": "string"
   }
}
```

## Response Elements
<a name="API_UpdateServiceTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplate](#API_UpdateServiceTemplate_ResponseSyntax) **   <a name="proton-UpdateServiceTemplate-response-serviceTemplate"></a>
The service template detail data that's returned by AWS Proton.  
Type: [ServiceTemplate](API_ServiceTemplate.md) object

## Errors
<a name="API_UpdateServiceTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateServiceTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateServiceTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateServiceTemplate) 

# UpdateServiceTemplateVersion
<a name="API_UpdateServiceTemplateVersion"></a>

Update a major or minor version of a service template.

## Request Syntax
<a name="API_UpdateServiceTemplateVersion_RequestSyntax"></a>

```
{
   "compatibleEnvironmentTemplates": [ 
      { 
         "majorVersion": "string",
         "templateName": "string"
      }
   ],
   "description": "string",
   "majorVersion": "string",
   "minorVersion": "string",
   "status": "string",
   "supportedComponentSources": [ "string" ],
   "templateName": "string"
}
```

## Request Parameters
<a name="API_UpdateServiceTemplateVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [compatibleEnvironmentTemplates](#API_UpdateServiceTemplateVersion_RequestSyntax) **   <a name="proton-UpdateServiceTemplateVersion-request-compatibleEnvironmentTemplates"></a>
An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.  
Type: Array of [CompatibleEnvironmentTemplateInput](API_CompatibleEnvironmentTemplateInput.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [description](#API_UpdateServiceTemplateVersion_RequestSyntax) **   <a name="proton-UpdateServiceTemplateVersion-request-description"></a>
A description of a service template version to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [majorVersion](#API_UpdateServiceTemplateVersion_RequestSyntax) **   <a name="proton-UpdateServiceTemplateVersion-request-majorVersion"></a>
To update a major version of a service template, include `major Version`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [minorVersion](#API_UpdateServiceTemplateVersion_RequestSyntax) **   <a name="proton-UpdateServiceTemplateVersion-request-minorVersion"></a>
To update a minor version of a service template, include `minorVersion`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** [status](#API_UpdateServiceTemplateVersion_RequestSyntax) **   <a name="proton-UpdateServiceTemplateVersion-request-status"></a>
The status of the service template minor version to update.  
Type: String  
Valid Values: `REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED`   
Required: No

 ** [supportedComponentSources](#API_UpdateServiceTemplateVersion_RequestSyntax) **   <a name="proton-UpdateServiceTemplateVersion-request-supportedComponentSources"></a>
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.  
A change to `supportedComponentSources` doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.
For more information about components, see [AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the * AWS Proton User Guide*.  
Type: Array of strings  
Valid Values: `DIRECTLY_DEFINED`   
Required: No

 ** [templateName](#API_UpdateServiceTemplateVersion_RequestSyntax) **   <a name="proton-UpdateServiceTemplateVersion-request-templateName"></a>
The name of the service 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
<a name="API_UpdateServiceTemplateVersion_ResponseSyntax"></a>

```
{
   "serviceTemplateVersion": { 
      "arn": "string",
      "compatibleEnvironmentTemplates": [ 
         { 
            "majorVersion": "string",
            "templateName": "string"
         }
      ],
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "majorVersion": "string",
      "minorVersion": "string",
      "recommendedMinorVersion": "string",
      "schema": "string",
      "status": "string",
      "statusMessage": "string",
      "supportedComponentSources": [ "string" ],
      "templateName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateServiceTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [serviceTemplateVersion](#API_UpdateServiceTemplateVersion_ResponseSyntax) **   <a name="proton-UpdateServiceTemplateVersion-response-serviceTemplateVersion"></a>
The service template version detail data that's returned by AWS Proton.  
Type: [ServiceTemplateVersion](API_ServiceTemplateVersion.md) object

## Errors
<a name="API_UpdateServiceTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateServiceTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateServiceTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateServiceTemplateVersion) 

# UpdateTemplateSyncConfig
<a name="API_UpdateTemplateSyncConfig"></a>

Update template sync configuration parameters, except for the `templateName` and `templateType`. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with AWS Proton. For more information, see [CreateRepository](API_CreateRepository.md).

## Request Syntax
<a name="API_UpdateTemplateSyncConfig_RequestSyntax"></a>

```
{
   "branch": "string",
   "repositoryName": "string",
   "repositoryProvider": "string",
   "subdirectory": "string",
   "templateName": "string",
   "templateType": "string"
}
```

## Request Parameters
<a name="API_UpdateTemplateSyncConfig_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [branch](#API_UpdateTemplateSyncConfig_RequestSyntax) **   <a name="proton-UpdateTemplateSyncConfig-request-branch"></a>
The repository branch for your template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** [repositoryName](#API_UpdateTemplateSyncConfig_RequestSyntax) **   <a name="proton-UpdateTemplateSyncConfig-request-repositoryName"></a>
The repository name (for example, `myrepos/myrepo`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** [repositoryProvider](#API_UpdateTemplateSyncConfig_RequestSyntax) **   <a name="proton-UpdateTemplateSyncConfig-request-repositoryProvider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** [subdirectory](#API_UpdateTemplateSyncConfig_RequestSyntax) **   <a name="proton-UpdateTemplateSyncConfig-request-subdirectory"></a>
A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [templateName](#API_UpdateTemplateSyncConfig_RequestSyntax) **   <a name="proton-UpdateTemplateSyncConfig-request-templateName"></a>
The synced template name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** [templateType](#API_UpdateTemplateSyncConfig_RequestSyntax) **   <a name="proton-UpdateTemplateSyncConfig-request-templateType"></a>
The synced template type.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE`   
Required: Yes

## Response Syntax
<a name="API_UpdateTemplateSyncConfig_ResponseSyntax"></a>

```
{
   "templateSyncConfig": { 
      "branch": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "subdirectory": "string",
      "templateName": "string",
      "templateType": "string"
   }
}
```

## Response Elements
<a name="API_UpdateTemplateSyncConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [templateSyncConfig](#API_UpdateTemplateSyncConfig_ResponseSyntax) **   <a name="proton-UpdateTemplateSyncConfig-response-templateSyncConfig"></a>
The template sync configuration detail data that's returned by AWS Proton.  
Type: [TemplateSyncConfig](API_TemplateSyncConfig.md) object

## Errors
<a name="API_UpdateTemplateSyncConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateTemplateSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/proton-2020-07-20/UpdateTemplateSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/UpdateTemplateSyncConfig)