

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).

# Data Types
<a name="API_Types"></a>

The AWS Proton API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AccountSettings](API_AccountSettings.md) 
+  [CompatibleEnvironmentTemplate](API_CompatibleEnvironmentTemplate.md) 
+  [CompatibleEnvironmentTemplateInput](API_CompatibleEnvironmentTemplateInput.md) 
+  [Component](API_Component.md) 
+  [ComponentState](API_ComponentState.md) 
+  [ComponentSummary](API_ComponentSummary.md) 
+  [CountsSummary](API_CountsSummary.md) 
+  [Deployment](API_Deployment.md) 
+  [DeploymentState](API_DeploymentState.md) 
+  [DeploymentSummary](API_DeploymentSummary.md) 
+  [Environment](API_Environment.md) 
+  [EnvironmentAccountConnection](API_EnvironmentAccountConnection.md) 
+  [EnvironmentAccountConnectionSummary](API_EnvironmentAccountConnectionSummary.md) 
+  [EnvironmentState](API_EnvironmentState.md) 
+  [EnvironmentSummary](API_EnvironmentSummary.md) 
+  [EnvironmentTemplate](API_EnvironmentTemplate.md) 
+  [EnvironmentTemplateFilter](API_EnvironmentTemplateFilter.md) 
+  [EnvironmentTemplateSummary](API_EnvironmentTemplateSummary.md) 
+  [EnvironmentTemplateVersion](API_EnvironmentTemplateVersion.md) 
+  [EnvironmentTemplateVersionSummary](API_EnvironmentTemplateVersionSummary.md) 
+  [ListServiceInstancesFilter](API_ListServiceInstancesFilter.md) 
+  [Output](API_Output.md) 
+  [ProvisionedResource](API_ProvisionedResource.md) 
+  [Repository](API_Repository.md) 
+  [RepositoryBranch](API_RepositoryBranch.md) 
+  [RepositoryBranchInput](API_RepositoryBranchInput.md) 
+  [RepositorySummary](API_RepositorySummary.md) 
+  [RepositorySyncAttempt](API_RepositorySyncAttempt.md) 
+  [RepositorySyncDefinition](API_RepositorySyncDefinition.md) 
+  [RepositorySyncEvent](API_RepositorySyncEvent.md) 
+  [ResourceCountsSummary](API_ResourceCountsSummary.md) 
+  [ResourceSyncAttempt](API_ResourceSyncAttempt.md) 
+  [ResourceSyncEvent](API_ResourceSyncEvent.md) 
+  [Revision](API_Revision.md) 
+  [S3ObjectSource](API_S3ObjectSource.md) 
+  [Service](API_Service.md) 
+  [ServiceInstance](API_ServiceInstance.md) 
+  [ServiceInstanceState](API_ServiceInstanceState.md) 
+  [ServiceInstanceSummary](API_ServiceInstanceSummary.md) 
+  [ServicePipeline](API_ServicePipeline.md) 
+  [ServicePipelineState](API_ServicePipelineState.md) 
+  [ServiceSummary](API_ServiceSummary.md) 
+  [ServiceSyncBlockerSummary](API_ServiceSyncBlockerSummary.md) 
+  [ServiceSyncConfig](API_ServiceSyncConfig.md) 
+  [ServiceTemplate](API_ServiceTemplate.md) 
+  [ServiceTemplateSummary](API_ServiceTemplateSummary.md) 
+  [ServiceTemplateVersion](API_ServiceTemplateVersion.md) 
+  [ServiceTemplateVersionSummary](API_ServiceTemplateVersionSummary.md) 
+  [SyncBlocker](API_SyncBlocker.md) 
+  [SyncBlockerContext](API_SyncBlockerContext.md) 
+  [Tag](API_Tag.md) 
+  [TemplateSyncConfig](API_TemplateSyncConfig.md) 
+  [TemplateVersionSourceInput](API_TemplateVersionSourceInput.md) 

# AccountSettings
<a name="API_AccountSettings"></a>

 AWS Proton settings that are used for multiple services in the AWS account.

## Contents
<a name="API_AccountSettings_Contents"></a>

 ** pipelineCodebuildRoleArn **   <a name="proton-Type-AccountSettings-pipelineCodebuildRoleArn"></a>
The Amazon Resource Name (ARN) of the service role that AWS Proton uses 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 **   <a name="proton-Type-AccountSettings-pipelineProvisioningRepository"></a>
The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with AWS Proton. For more information, see [CreateRepository](API_CreateRepository.md).  
Type: [RepositoryBranch](API_RepositoryBranch.md) object  
Required: No

 ** pipelineServiceRoleArn **   <a name="proton-Type-AccountSettings-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.  
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

## See Also
<a name="API_AccountSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/AccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/AccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/AccountSettings) 

# CompatibleEnvironmentTemplate
<a name="API_CompatibleEnvironmentTemplate"></a>

Compatible environment template data.

## Contents
<a name="API_CompatibleEnvironmentTemplate_Contents"></a>

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

 ** templateName **   <a name="proton-Type-CompatibleEnvironmentTemplate-templateName"></a>
The compatible environment 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

## See Also
<a name="API_CompatibleEnvironmentTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CompatibleEnvironmentTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CompatibleEnvironmentTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CompatibleEnvironmentTemplate) 

# CompatibleEnvironmentTemplateInput
<a name="API_CompatibleEnvironmentTemplateInput"></a>

Compatible environment template data.

## Contents
<a name="API_CompatibleEnvironmentTemplateInput_Contents"></a>

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

 ** templateName **   <a name="proton-Type-CompatibleEnvironmentTemplateInput-templateName"></a>
The compatible environment 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

## See Also
<a name="API_CompatibleEnvironmentTemplateInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CompatibleEnvironmentTemplateInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CompatibleEnvironmentTemplateInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CompatibleEnvironmentTemplateInput) 

# Component
<a name="API_Component"></a>

Detailed data of 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*.

## Contents
<a name="API_Component_Contents"></a>

 ** arn **   <a name="proton-Type-Component-arn"></a>
The Amazon Resource Name (ARN) of the component.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-Component-createdAt"></a>
The time when the component was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-Component-deploymentStatus"></a>
The component deployment status.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** environmentName **   <a name="proton-Type-Component-environmentName"></a>
The name of the AWS Proton environment that this component 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

 ** lastModifiedAt **   <a name="proton-Type-Component-lastModifiedAt"></a>
The time when the component was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-Component-name"></a>
The 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

 ** deploymentStatusMessage **   <a name="proton-Type-Component-deploymentStatusMessage"></a>
The message associated with the component deployment status.  
Type: String  
Required: No

 ** description **   <a name="proton-Type-Component-description"></a>
A description of the component.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-Component-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment of this component.  
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

 ** lastClientRequestToken **   <a name="proton-Type-Component-lastClientRequestToken"></a>
The last token the client requested.  
Type: String  
Required: No

 ** lastDeploymentAttemptedAt **   <a name="proton-Type-Component-lastDeploymentAttemptedAt"></a>
The time when a deployment of the component was last attempted.  
Type: Timestamp  
Required: No

 ** lastDeploymentSucceededAt **   <a name="proton-Type-Component-lastDeploymentSucceededAt"></a>
The time when the component was last deployed successfully.  
Type: Timestamp  
Required: No

 ** lastSucceededDeploymentId **   <a name="proton-Type-Component-lastSucceededDeploymentId"></a>
The ID of the last successful deployment of this component.  
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

 ** serviceInstanceName **   <a name="proton-Type-Component-serviceInstanceName"></a>
The name of the service instance that this component is attached to. Provided when a component is attached to a 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 **   <a name="proton-Type-Component-serviceName"></a>
The name of the service that `serviceInstanceName` is associated with. Provided when a component is attached to a 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

 ** serviceSpec **   <a name="proton-Type-Component-serviceSpec"></a>
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## See Also
<a name="API_Component_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Component) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Component) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Component) 

# ComponentState
<a name="API_ComponentState"></a>

The detailed data about the current state of the component.

## Contents
<a name="API_ComponentState_Contents"></a>

 ** serviceInstanceName **   <a name="proton-Type-ComponentState-serviceInstanceName"></a>
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `.*(^$)|^[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** serviceName **   <a name="proton-Type-ComponentState-serviceName"></a>
The name of the service that `serviceInstanceName` is associated with. Provided when a component is attached to a service instance.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `.*(^$)|^[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** serviceSpec **   <a name="proton-Type-ComponentState-serviceSpec"></a>
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** templateFile **   <a name="proton-Type-ComponentState-templateFile"></a>
The template file used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## See Also
<a name="API_ComponentState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ComponentState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ComponentState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ComponentState) 

# ComponentSummary
<a name="API_ComponentSummary"></a>

Summary data of 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*.

## Contents
<a name="API_ComponentSummary_Contents"></a>

 ** arn **   <a name="proton-Type-ComponentSummary-arn"></a>
The Amazon Resource Name (ARN) of the component.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-ComponentSummary-createdAt"></a>
The time when the component was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-ComponentSummary-deploymentStatus"></a>
The component deployment status.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** environmentName **   <a name="proton-Type-ComponentSummary-environmentName"></a>
The name of the AWS Proton environment that this component 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

 ** lastModifiedAt **   <a name="proton-Type-ComponentSummary-lastModifiedAt"></a>
The time when the component was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-ComponentSummary-name"></a>
The 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

 ** deploymentStatusMessage **   <a name="proton-Type-ComponentSummary-deploymentStatusMessage"></a>
The message associated with the component deployment status.  
Type: String  
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-ComponentSummary-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment of this component.  
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

 ** lastDeploymentAttemptedAt **   <a name="proton-Type-ComponentSummary-lastDeploymentAttemptedAt"></a>
The time when a deployment of the component was last attempted.  
Type: Timestamp  
Required: No

 ** lastDeploymentSucceededAt **   <a name="proton-Type-ComponentSummary-lastDeploymentSucceededAt"></a>
The time when the component was last deployed successfully.  
Type: Timestamp  
Required: No

 ** lastSucceededDeploymentId **   <a name="proton-Type-ComponentSummary-lastSucceededDeploymentId"></a>
The ID of the last successful deployment of this component.  
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

 ** serviceInstanceName **   <a name="proton-Type-ComponentSummary-serviceInstanceName"></a>
The name of the service instance that this component is attached to. Provided when a component is attached to a 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 **   <a name="proton-Type-ComponentSummary-serviceName"></a>
The name of the service that `serviceInstanceName` is associated with. Provided when a component is attached to a 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

## See Also
<a name="API_ComponentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ComponentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ComponentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ComponentSummary) 

# CountsSummary
<a name="API_CountsSummary"></a>

Summary counts of each AWS Proton resource type.

## Contents
<a name="API_CountsSummary_Contents"></a>

 ** components **   <a name="proton-Type-CountsSummary-components"></a>
The total number of components in the AWS account.  
The semantics of the `components` field are different from the semantics of results for other infrastructure-provisioning resources. That's because at this time components don't have associated templates, therefore they don't have the concept of staleness. The `components` object will only contain `total` and `failed` members.  
Type: [ResourceCountsSummary](API_ResourceCountsSummary.md) object  
Required: No

 ** environments **   <a name="proton-Type-CountsSummary-environments"></a>
The staleness counts for AWS Proton environments in the AWS account. The `environments` object will only contain `total` members.  
Type: [ResourceCountsSummary](API_ResourceCountsSummary.md) object  
Required: No

 ** environmentTemplates **   <a name="proton-Type-CountsSummary-environmentTemplates"></a>
The total number of environment templates in the AWS account. The `environmentTemplates` object will only contain `total` members.  
Type: [ResourceCountsSummary](API_ResourceCountsSummary.md) object  
Required: No

 ** pipelines **   <a name="proton-Type-CountsSummary-pipelines"></a>
The staleness counts for AWS Proton pipelines in the AWS account.  
Type: [ResourceCountsSummary](API_ResourceCountsSummary.md) object  
Required: No

 ** serviceInstances **   <a name="proton-Type-CountsSummary-serviceInstances"></a>
The staleness counts for AWS Proton service instances in the AWS account.  
Type: [ResourceCountsSummary](API_ResourceCountsSummary.md) object  
Required: No

 ** services **   <a name="proton-Type-CountsSummary-services"></a>
The staleness counts for AWS Proton services in the AWS account.  
Type: [ResourceCountsSummary](API_ResourceCountsSummary.md) object  
Required: No

 ** serviceTemplates **   <a name="proton-Type-CountsSummary-serviceTemplates"></a>
The total number of service templates in the AWS account. The `serviceTemplates` object will only contain `total` members.  
Type: [ResourceCountsSummary](API_ResourceCountsSummary.md) object  
Required: No

## See Also
<a name="API_CountsSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/CountsSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/CountsSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/CountsSummary) 

# Deployment
<a name="API_Deployment"></a>

The detailed information about a deployment.

## Contents
<a name="API_Deployment_Contents"></a>

 ** arn **   <a name="proton-Type-Deployment-arn"></a>
The Amazon Resource Name (ARN) of the deployment.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-Deployment-createdAt"></a>
The date and time the deployment was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-Deployment-deploymentStatus"></a>
The status of the deployment.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** environmentName **   <a name="proton-Type-Deployment-environmentName"></a>
The name of the environment associated with this deployment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** id **   <a name="proton-Type-Deployment-id"></a>
The ID of the deployment.  
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

 ** lastModifiedAt **   <a name="proton-Type-Deployment-lastModifiedAt"></a>
The date and time the deployment was last modified.  
Type: Timestamp  
Required: Yes

 ** targetArn **   <a name="proton-Type-Deployment-targetArn"></a>
The Amazon Resource Name (ARN) of the target of the deployment.  
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

 ** targetResourceCreatedAt **   <a name="proton-Type-Deployment-targetResourceCreatedAt"></a>
The date and time the depoyment target was created.  
Type: Timestamp  
Required: Yes

 ** targetResourceType **   <a name="proton-Type-Deployment-targetResourceType"></a>
The resource type of the deployment target. It can be an environment, service, service instance, or component.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE_PIPELINE | SERVICE_INSTANCE | COMPONENT`   
Required: Yes

 ** completedAt **   <a name="proton-Type-Deployment-completedAt"></a>
The date and time the deployment was completed.  
Type: Timestamp  
Required: No

 ** componentName **   <a name="proton-Type-Deployment-componentName"></a>
The name of the component associated with this deployment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** deploymentStatusMessage **   <a name="proton-Type-Deployment-deploymentStatusMessage"></a>
The deployment status message.  
Type: String  
Required: No

 ** initialState **   <a name="proton-Type-Deployment-initialState"></a>
The initial state of the target resource at the time of the deployment.  
Type: [DeploymentState](API_DeploymentState.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-Deployment-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment.  
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

 ** lastSucceededDeploymentId **   <a name="proton-Type-Deployment-lastSucceededDeploymentId"></a>
The ID of the last successful deployment.  
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

 ** serviceInstanceName **   <a name="proton-Type-Deployment-serviceInstanceName"></a>
The name of the deployment's 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 **   <a name="proton-Type-Deployment-serviceName"></a>
The name of the service in this deployment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** targetState **   <a name="proton-Type-Deployment-targetState"></a>
The target state of the target resource at the time of the deployment.  
Type: [DeploymentState](API_DeploymentState.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_Deployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Deployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Deployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Deployment) 

# DeploymentState
<a name="API_DeploymentState"></a>

The detailed data about the current state of the deployment.

## Contents
<a name="API_DeploymentState_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** component **   <a name="proton-Type-DeploymentState-component"></a>
The state of the component associated with the deployment.  
Type: [ComponentState](API_ComponentState.md) object  
Required: No

 ** environment **   <a name="proton-Type-DeploymentState-environment"></a>
The state of the environment associated with the deployment.  
Type: [EnvironmentState](API_EnvironmentState.md) object  
Required: No

 ** serviceInstance **   <a name="proton-Type-DeploymentState-serviceInstance"></a>
The state of the service instance associated with the deployment.  
Type: [ServiceInstanceState](API_ServiceInstanceState.md) object  
Required: No

 ** servicePipeline **   <a name="proton-Type-DeploymentState-servicePipeline"></a>
The state of the service pipeline associated with the deployment.  
Type: [ServicePipelineState](API_ServicePipelineState.md) object  
Required: No

## See Also
<a name="API_DeploymentState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeploymentState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeploymentState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeploymentState) 

# DeploymentSummary
<a name="API_DeploymentSummary"></a>

Summary data of the deployment.

## Contents
<a name="API_DeploymentSummary_Contents"></a>

 ** arn **   <a name="proton-Type-DeploymentSummary-arn"></a>
The Amazon Resource Name (ARN) of the deployment.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-DeploymentSummary-createdAt"></a>
The date and time the deployment was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-DeploymentSummary-deploymentStatus"></a>
The current status of the deployment.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** environmentName **   <a name="proton-Type-DeploymentSummary-environmentName"></a>
The name of the environment associated with the deployment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** id **   <a name="proton-Type-DeploymentSummary-id"></a>
The ID of the deployment.  
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

 ** lastModifiedAt **   <a name="proton-Type-DeploymentSummary-lastModifiedAt"></a>
The date and time the deployment was last modified.  
Type: Timestamp  
Required: Yes

 ** targetArn **   <a name="proton-Type-DeploymentSummary-targetArn"></a>
The Amazon Resource Name (ARN) of the target of the deployment.  
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

 ** targetResourceCreatedAt **   <a name="proton-Type-DeploymentSummary-targetResourceCreatedAt"></a>
The date and time the target resource was created.  
Type: Timestamp  
Required: Yes

 ** targetResourceType **   <a name="proton-Type-DeploymentSummary-targetResourceType"></a>
The resource type of the deployment target. It can be an environment, service, service instance, or component.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE_PIPELINE | SERVICE_INSTANCE | COMPONENT`   
Required: Yes

 ** completedAt **   <a name="proton-Type-DeploymentSummary-completedAt"></a>
The date and time the deployment was completed.  
Type: Timestamp  
Required: No

 ** componentName **   <a name="proton-Type-DeploymentSummary-componentName"></a>
The name of the component associated with the deployment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-DeploymentSummary-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment.  
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

 ** lastSucceededDeploymentId **   <a name="proton-Type-DeploymentSummary-lastSucceededDeploymentId"></a>
The ID of the last successful deployment.  
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

 ** serviceInstanceName **   <a name="proton-Type-DeploymentSummary-serviceInstanceName"></a>
The name of the service instance associated with the deployment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: No

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

## See Also
<a name="API_DeploymentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/DeploymentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/DeploymentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/DeploymentSummary) 

# Environment
<a name="API_Environment"></a>

Detailed data of an AWS Proton environment resource. An AWS Proton environment is a set of resources shared across AWS Proton services.

## Contents
<a name="API_Environment_Contents"></a>

 ** arn **   <a name="proton-Type-Environment-arn"></a>
The Amazon Resource Name (ARN) of the environment.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-Environment-createdAt"></a>
The time when the environment was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-Environment-deploymentStatus"></a>
The environment deployment status.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** lastDeploymentAttemptedAt **   <a name="proton-Type-Environment-lastDeploymentAttemptedAt"></a>
The time when a deployment of the environment was last attempted.  
Type: Timestamp  
Required: Yes

 ** lastDeploymentSucceededAt **   <a name="proton-Type-Environment-lastDeploymentSucceededAt"></a>
The time when the environment was last deployed successfully.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-Environment-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

 ** templateMajorVersion **   <a name="proton-Type-Environment-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 **   <a name="proton-Type-Environment-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: Yes

 ** templateName **   <a name="proton-Type-Environment-templateName"></a>
The Amazon Resource Name (ARN) 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

 ** codebuildRoleArn **   <a name="proton-Type-Environment-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 **   <a name="proton-Type-Environment-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

 ** deploymentStatusMessage **   <a name="proton-Type-Environment-deploymentStatusMessage"></a>
An environment deployment status message.  
Type: String  
Required: No

 ** description **   <a name="proton-Type-Environment-description"></a>
The description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** environmentAccountConnectionId **   <a name="proton-Type-Environment-environmentAccountConnectionId"></a>
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.  
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

 ** environmentAccountId **   <a name="proton-Type-Environment-environmentAccountId"></a>
The ID of the environment account that the environment infrastructure resources are provisioned in.  
Type: String  
Pattern: `\d{12}`   
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-Environment-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment of this 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

 ** lastSucceededDeploymentId **   <a name="proton-Type-Environment-lastSucceededDeploymentId"></a>
The ID of the last successful deployment of this 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

 ** protonServiceRoleArn **   <a name="proton-Type-Environment-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.  
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

 ** provisioning **   <a name="proton-Type-Environment-provisioning"></a>
When included, indicates that the environment template is for customer provisioned and managed infrastructure.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

 ** provisioningRepository **   <a name="proton-Type-Environment-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](https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html).  
Type: [RepositoryBranch](API_RepositoryBranch.md) object  
Required: No

 ** spec **   <a name="proton-Type-Environment-spec"></a>
The environment spec.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## See Also
<a name="API_Environment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Environment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Environment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Environment) 

# EnvironmentAccountConnection
<a name="API_EnvironmentAccountConnection"></a>

Detailed data of an AWS Proton environment account connection resource.

## Contents
<a name="API_EnvironmentAccountConnection_Contents"></a>

 ** arn **   <a name="proton-Type-EnvironmentAccountConnection-arn"></a>
The Amazon Resource Name (ARN) of the environment account connection.  
Type: String  
Required: Yes

 ** environmentAccountId **   <a name="proton-Type-EnvironmentAccountConnection-environmentAccountId"></a>
The environment account that's connected to the environment account connection.  
Type: String  
Pattern: `\d{12}`   
Required: Yes

 ** environmentName **   <a name="proton-Type-EnvironmentAccountConnection-environmentName"></a>
The name of the environment that's associated with the 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: Yes

 ** id **   <a name="proton-Type-EnvironmentAccountConnection-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

 ** lastModifiedAt **   <a name="proton-Type-EnvironmentAccountConnection-lastModifiedAt"></a>
The time when the environment account connection was last modified.  
Type: Timestamp  
Required: Yes

 ** managementAccountId **   <a name="proton-Type-EnvironmentAccountConnection-managementAccountId"></a>
The ID of the management account that's connected to the environment account connection.  
Type: String  
Pattern: `\d{12}`   
Required: Yes

 ** requestedAt **   <a name="proton-Type-EnvironmentAccountConnection-requestedAt"></a>
The time when the environment account connection request was made.  
Type: Timestamp  
Required: Yes

 ** roleArn **   <a name="proton-Type-EnvironmentAccountConnection-roleArn"></a>
The IAM service role that's associated with the environment account connection.  
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 **   <a name="proton-Type-EnvironmentAccountConnection-status"></a>
The status of the environment account connection.  
Type: String  
Valid Values: `PENDING | CONNECTED | REJECTED`   
Required: Yes

 ** codebuildRoleArn **   <a name="proton-Type-EnvironmentAccountConnection-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 **   <a name="proton-Type-EnvironmentAccountConnection-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

## See Also
<a name="API_EnvironmentAccountConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentAccountConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentAccountConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentAccountConnection) 

# EnvironmentAccountConnectionSummary
<a name="API_EnvironmentAccountConnectionSummary"></a>

Summary data of an AWS Proton environment account connection resource.

## Contents
<a name="API_EnvironmentAccountConnectionSummary_Contents"></a>

 ** arn **   <a name="proton-Type-EnvironmentAccountConnectionSummary-arn"></a>
The Amazon Resource Name (ARN) of the environment account connection.  
Type: String  
Required: Yes

 ** environmentAccountId **   <a name="proton-Type-EnvironmentAccountConnectionSummary-environmentAccountId"></a>
The ID of the environment account that's connected to the environment account connection.  
Type: String  
Pattern: `\d{12}`   
Required: Yes

 ** environmentName **   <a name="proton-Type-EnvironmentAccountConnectionSummary-environmentName"></a>
The name of the environment that's associated with the 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: Yes

 ** id **   <a name="proton-Type-EnvironmentAccountConnectionSummary-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

 ** lastModifiedAt **   <a name="proton-Type-EnvironmentAccountConnectionSummary-lastModifiedAt"></a>
The time when the environment account connection was last modified.  
Type: Timestamp  
Required: Yes

 ** managementAccountId **   <a name="proton-Type-EnvironmentAccountConnectionSummary-managementAccountId"></a>
The ID of the management account that's connected to the environment account connection.  
Type: String  
Pattern: `\d{12}`   
Required: Yes

 ** requestedAt **   <a name="proton-Type-EnvironmentAccountConnectionSummary-requestedAt"></a>
The time when the environment account connection request was made.  
Type: Timestamp  
Required: Yes

 ** roleArn **   <a name="proton-Type-EnvironmentAccountConnectionSummary-roleArn"></a>
The IAM service role that's associated with the environment account connection.  
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 **   <a name="proton-Type-EnvironmentAccountConnectionSummary-status"></a>
The status of the environment account connection.  
Type: String  
Valid Values: `PENDING | CONNECTED | REJECTED`   
Required: Yes

 ** componentRoleArn **   <a name="proton-Type-EnvironmentAccountConnectionSummary-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 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

## See Also
<a name="API_EnvironmentAccountConnectionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentAccountConnectionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentAccountConnectionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentAccountConnectionSummary) 

# EnvironmentState
<a name="API_EnvironmentState"></a>

The detailed data about the current state of the environment.

## Contents
<a name="API_EnvironmentState_Contents"></a>

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

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

 ** templateName **   <a name="proton-Type-EnvironmentState-templateName"></a>
The name of the environment template that was used to create 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

 ** spec **   <a name="proton-Type-EnvironmentState-spec"></a>
The environment spec that was used to create the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## See Also
<a name="API_EnvironmentState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentState) 

# EnvironmentSummary
<a name="API_EnvironmentSummary"></a>

Summary data of an AWS Proton environment resource. An AWS Proton environment is a set of resources shared across AWS Proton services.

## Contents
<a name="API_EnvironmentSummary_Contents"></a>

 ** arn **   <a name="proton-Type-EnvironmentSummary-arn"></a>
The Amazon Resource Name (ARN) of the environment.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-EnvironmentSummary-createdAt"></a>
The time when the environment was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-EnvironmentSummary-deploymentStatus"></a>
The environment deployment status.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** lastDeploymentAttemptedAt **   <a name="proton-Type-EnvironmentSummary-lastDeploymentAttemptedAt"></a>
The time when a deployment of the environment was last attempted.  
Type: Timestamp  
Required: Yes

 ** lastDeploymentSucceededAt **   <a name="proton-Type-EnvironmentSummary-lastDeploymentSucceededAt"></a>
The time when the environment was last deployed successfully.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-EnvironmentSummary-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

 ** templateMajorVersion **   <a name="proton-Type-EnvironmentSummary-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 **   <a name="proton-Type-EnvironmentSummary-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: Yes

 ** templateName **   <a name="proton-Type-EnvironmentSummary-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

 ** componentRoleArn **   <a name="proton-Type-EnvironmentSummary-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 200.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+`   
Required: No

 ** deploymentStatusMessage **   <a name="proton-Type-EnvironmentSummary-deploymentStatusMessage"></a>
An environment deployment status message.  
Type: String  
Required: No

 ** description **   <a name="proton-Type-EnvironmentSummary-description"></a>
The description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** environmentAccountConnectionId **   <a name="proton-Type-EnvironmentSummary-environmentAccountConnectionId"></a>
The ID of the environment account connection that the environment is associated with.  
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

 ** environmentAccountId **   <a name="proton-Type-EnvironmentSummary-environmentAccountId"></a>
The ID of the environment account that the environment infrastructure resources are provisioned in.  
Type: String  
Pattern: `\d{12}`   
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-EnvironmentSummary-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment of this 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

 ** lastSucceededDeploymentId **   <a name="proton-Type-EnvironmentSummary-lastSucceededDeploymentId"></a>
The ID of the last successful deployment of this 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

 ** protonServiceRoleArn **   <a name="proton-Type-EnvironmentSummary-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.  
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

 ** provisioning **   <a name="proton-Type-EnvironmentSummary-provisioning"></a>
When included, indicates that the environment template is for customer provisioned and managed infrastructure.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

## See Also
<a name="API_EnvironmentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentSummary) 

# EnvironmentTemplate
<a name="API_EnvironmentTemplate"></a>

The environment template data.

## Contents
<a name="API_EnvironmentTemplate_Contents"></a>

 ** arn **   <a name="proton-Type-EnvironmentTemplate-arn"></a>
The Amazon Resource Name (ARN) of the environment template.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-EnvironmentTemplate-createdAt"></a>
The time when the environment template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-EnvironmentTemplate-lastModifiedAt"></a>
The time when the environment template was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-EnvironmentTemplate-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

 ** description **   <a name="proton-Type-EnvironmentTemplate-description"></a>
A description of the environment template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** displayName **   <a name="proton-Type-EnvironmentTemplate-displayName"></a>
The name of the environment template as displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** encryptionKey **   <a name="proton-Type-EnvironmentTemplate-encryptionKey"></a>
The customer provided encryption key for the environment template.  
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

 ** provisioning **   <a name="proton-Type-EnvironmentTemplate-provisioning"></a>
When included, indicates that the environment template is for customer provisioned and managed infrastructure.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

 ** recommendedVersion **   <a name="proton-Type-EnvironmentTemplate-recommendedVersion"></a>
The ID of the recommended version of the environment template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))`   
Required: No

## See Also
<a name="API_EnvironmentTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentTemplate) 

# EnvironmentTemplateFilter
<a name="API_EnvironmentTemplateFilter"></a>

A search filter for environment templates.

## Contents
<a name="API_EnvironmentTemplateFilter_Contents"></a>

 ** majorVersion **   <a name="proton-Type-EnvironmentTemplateFilter-majorVersion"></a>
Include `majorVersion` to filter search for a major version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

 ** templateName **   <a name="proton-Type-EnvironmentTemplateFilter-templateName"></a>
Include `templateName` to filter search for a 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

## See Also
<a name="API_EnvironmentTemplateFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentTemplateFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentTemplateFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentTemplateFilter) 

# EnvironmentTemplateSummary
<a name="API_EnvironmentTemplateSummary"></a>

The environment template data.

## Contents
<a name="API_EnvironmentTemplateSummary_Contents"></a>

 ** arn **   <a name="proton-Type-EnvironmentTemplateSummary-arn"></a>
The Amazon Resource Name (ARN) of the environment template.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-EnvironmentTemplateSummary-createdAt"></a>
The time when the environment template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-EnvironmentTemplateSummary-lastModifiedAt"></a>
The time when the environment template was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-EnvironmentTemplateSummary-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

 ** description **   <a name="proton-Type-EnvironmentTemplateSummary-description"></a>
A description of the environment template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** displayName **   <a name="proton-Type-EnvironmentTemplateSummary-displayName"></a>
The name of the environment template as displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** provisioning **   <a name="proton-Type-EnvironmentTemplateSummary-provisioning"></a>
When included, indicates that the environment template is for customer provisioned and managed infrastructure.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

 ** recommendedVersion **   <a name="proton-Type-EnvironmentTemplateSummary-recommendedVersion"></a>
The recommended version of the environment template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))`   
Required: No

## See Also
<a name="API_EnvironmentTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentTemplateSummary) 

# EnvironmentTemplateVersion
<a name="API_EnvironmentTemplateVersion"></a>

The environment template version data.

## Contents
<a name="API_EnvironmentTemplateVersion_Contents"></a>

 ** arn **   <a name="proton-Type-EnvironmentTemplateVersion-arn"></a>
The Amazon Resource Name (ARN) of the version of an environment template.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-EnvironmentTemplateVersion-createdAt"></a>
The time when the version of an environment template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-EnvironmentTemplateVersion-lastModifiedAt"></a>
The time when the version of an environment template was last modified.  
Type: Timestamp  
Required: Yes

 ** majorVersion **   <a name="proton-Type-EnvironmentTemplateVersion-majorVersion"></a>
The latest major version that's associated with the version of an environment template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

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

 ** status **   <a name="proton-Type-EnvironmentTemplateVersion-status"></a>
The status of the version of an environment template.  
Type: String  
Valid Values: `REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED`   
Required: Yes

 ** templateName **   <a name="proton-Type-EnvironmentTemplateVersion-templateName"></a>
The name of the version of an 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

 ** description **   <a name="proton-Type-EnvironmentTemplateVersion-description"></a>
A description of the minor version of an environment template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** recommendedMinorVersion **   <a name="proton-Type-EnvironmentTemplateVersion-recommendedMinorVersion"></a>
The recommended 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

 ** schema **   <a name="proton-Type-EnvironmentTemplateVersion-schema"></a>
The schema of the version of an environment template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** statusMessage **   <a name="proton-Type-EnvironmentTemplateVersion-statusMessage"></a>
The status message of the version of an environment template.  
Type: String  
Required: No

## See Also
<a name="API_EnvironmentTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentTemplateVersion) 

# EnvironmentTemplateVersionSummary
<a name="API_EnvironmentTemplateVersionSummary"></a>

A summary of the version of an environment template detail data.

## Contents
<a name="API_EnvironmentTemplateVersionSummary_Contents"></a>

 ** arn **   <a name="proton-Type-EnvironmentTemplateVersionSummary-arn"></a>
The Amazon Resource Name (ARN) of the version of an environment template.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-EnvironmentTemplateVersionSummary-createdAt"></a>
The time when the version of an environment template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-EnvironmentTemplateVersionSummary-lastModifiedAt"></a>
The time when the version of an environment template was last modified.  
Type: Timestamp  
Required: Yes

 ** majorVersion **   <a name="proton-Type-EnvironmentTemplateVersionSummary-majorVersion"></a>
The latest major version that's associated with the version of an environment template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

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

 ** status **   <a name="proton-Type-EnvironmentTemplateVersionSummary-status"></a>
The status of the version of an environment template.  
Type: String  
Valid Values: `REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED`   
Required: Yes

 ** templateName **   <a name="proton-Type-EnvironmentTemplateVersionSummary-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

 ** description **   <a name="proton-Type-EnvironmentTemplateVersionSummary-description"></a>
A description of the version of an environment template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** recommendedMinorVersion **   <a name="proton-Type-EnvironmentTemplateVersionSummary-recommendedMinorVersion"></a>
The recommended 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

 ** statusMessage **   <a name="proton-Type-EnvironmentTemplateVersionSummary-statusMessage"></a>
The status message of the version of an environment template.  
Type: String  
Required: No

## See Also
<a name="API_EnvironmentTemplateVersionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/EnvironmentTemplateVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/EnvironmentTemplateVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/EnvironmentTemplateVersionSummary) 

# ListServiceInstancesFilter
<a name="API_ListServiceInstancesFilter"></a>

A filtering criterion to scope down the result list of the [ListServiceInstances](API_ListServiceInstances.md) action.

## Contents
<a name="API_ListServiceInstancesFilter_Contents"></a>

 ** key **   <a name="proton-Type-ListServiceInstancesFilter-key"></a>
The name of a filtering criterion.  
Type: String  
Valid Values: `name | deploymentStatus | templateName | serviceName | deployedTemplateVersionStatus | environmentName | lastDeploymentAttemptedAtBefore | lastDeploymentAttemptedAtAfter | createdAtBefore | createdAtAfter`   
Required: No

 ** value **   <a name="proton-Type-ListServiceInstancesFilter-value"></a>
A value to filter by.  
With the date/time keys (`*At{Before,After}`), the value is a valid [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339.html) string with no UTC offset and with an optional fractional precision (for example, `1985-04-12T23:20:50.52Z`).  
Type: String  
Required: No

## See Also
<a name="API_ListServiceInstancesFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ListServiceInstancesFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ListServiceInstancesFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ListServiceInstancesFilter) 

# Output
<a name="API_Output"></a>

An infrastructure as code defined resource output.

## Contents
<a name="API_Output_Contents"></a>

 ** key **   <a name="proton-Type-Output-key"></a>
The output key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** valueString **   <a name="proton-Type-Output-valueString"></a>
The output value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_Output_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Output) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Output) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Output) 

# ProvisionedResource
<a name="API_ProvisionedResource"></a>

Detail data for a provisioned resource.

## Contents
<a name="API_ProvisionedResource_Contents"></a>

 ** identifier **   <a name="proton-Type-ProvisionedResource-identifier"></a>
The provisioned resource identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** name **   <a name="proton-Type-ProvisionedResource-name"></a>
The provisioned resource name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** provisioningEngine **   <a name="proton-Type-ProvisionedResource-provisioningEngine"></a>
The resource provisioning engine. At this time, `CLOUDFORMATION` can be used for AWS-managed provisioning, and `TERRAFORM` can be used for 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*.  
Type: String  
Valid Values: `CLOUDFORMATION | TERRAFORM`   
Required: No

## See Also
<a name="API_ProvisionedResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ProvisionedResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ProvisionedResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ProvisionedResource) 

# Repository
<a name="API_Repository"></a>

Detailed data of a linked repository—a repository that has been registered with AWS Proton.

## Contents
<a name="API_Repository_Contents"></a>

 ** arn **   <a name="proton-Type-Repository-arn"></a>
The Amazon Resource Name (ARN) of the linked repository.  
Type: String  
Required: Yes

 ** connectionArn **   <a name="proton-Type-Repository-connectionArn"></a>
The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects AWS Proton to your repository provider account.  
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

 ** name **   <a name="proton-Type-Repository-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 **   <a name="proton-Type-Repository-provider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** encryptionKey **   <a name="proton-Type-Repository-encryptionKey"></a>
Your customer AWS KMS encryption 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

## See Also
<a name="API_Repository_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Repository) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Repository) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Repository) 

# RepositoryBranch
<a name="API_RepositoryBranch"></a>

Detail data for a linked repository branch.

## Contents
<a name="API_RepositoryBranch_Contents"></a>

 ** arn **   <a name="proton-Type-RepositoryBranch-arn"></a>
The Amazon Resource Name (ARN) of the linked repository.  
Type: String  
Required: Yes

 ** branch **   <a name="proton-Type-RepositoryBranch-branch"></a>
The repository branch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** name **   <a name="proton-Type-RepositoryBranch-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 **   <a name="proton-Type-RepositoryBranch-provider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

## See Also
<a name="API_RepositoryBranch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/RepositoryBranch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/RepositoryBranch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/RepositoryBranch) 

# RepositoryBranchInput
<a name="API_RepositoryBranchInput"></a>

Detail input data for a linked repository branch.

## Contents
<a name="API_RepositoryBranchInput_Contents"></a>

 ** branch **   <a name="proton-Type-RepositoryBranchInput-branch"></a>
The repository branch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** name **   <a name="proton-Type-RepositoryBranchInput-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 **   <a name="proton-Type-RepositoryBranchInput-provider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

## See Also
<a name="API_RepositoryBranchInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/RepositoryBranchInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/RepositoryBranchInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/RepositoryBranchInput) 

# RepositorySummary
<a name="API_RepositorySummary"></a>

Summary data of a linked repository—a repository that has been registered with AWS Proton.

## Contents
<a name="API_RepositorySummary_Contents"></a>

 ** arn **   <a name="proton-Type-RepositorySummary-arn"></a>
The Amazon Resource Name (ARN) of the linked repository.  
Type: String  
Required: Yes

 ** connectionArn **   <a name="proton-Type-RepositorySummary-connectionArn"></a>
The Amazon Resource Name (ARN) of the of your connection that connects AWS Proton to your repository.  
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

 ** name **   <a name="proton-Type-RepositorySummary-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 **   <a name="proton-Type-RepositorySummary-provider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

## See Also
<a name="API_RepositorySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/RepositorySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/RepositorySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/RepositorySummary) 

# RepositorySyncAttempt
<a name="API_RepositorySyncAttempt"></a>

Detail data for a repository sync attempt activated by a push to a repository.

## Contents
<a name="API_RepositorySyncAttempt_Contents"></a>

 ** events **   <a name="proton-Type-RepositorySyncAttempt-events"></a>
Detail data for sync attempt events.  
Type: Array of [RepositorySyncEvent](API_RepositorySyncEvent.md) objects  
Required: Yes

 ** startedAt **   <a name="proton-Type-RepositorySyncAttempt-startedAt"></a>
The time when the sync attempt started.  
Type: Timestamp  
Required: Yes

 ** status **   <a name="proton-Type-RepositorySyncAttempt-status"></a>
The sync attempt status.  
Type: String  
Valid Values: `INITIATED | IN_PROGRESS | SUCCEEDED | FAILED | QUEUED`   
Required: Yes

## See Also
<a name="API_RepositorySyncAttempt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/RepositorySyncAttempt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/RepositorySyncAttempt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/RepositorySyncAttempt) 

# RepositorySyncDefinition
<a name="API_RepositorySyncDefinition"></a>

A repository sync definition.

## Contents
<a name="API_RepositorySyncDefinition_Contents"></a>

 ** branch **   <a name="proton-Type-RepositorySyncDefinition-branch"></a>
The repository branch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** directory **   <a name="proton-Type-RepositorySyncDefinition-directory"></a>
The directory in the repository.  
Type: String  
Required: Yes

 ** parent **   <a name="proton-Type-RepositorySyncDefinition-parent"></a>
The resource that is synced from.  
Type: String  
Required: Yes

 ** target **   <a name="proton-Type-RepositorySyncDefinition-target"></a>
The resource that is synced to.  
Type: String  
Required: Yes

## See Also
<a name="API_RepositorySyncDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/RepositorySyncDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/RepositorySyncDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/RepositorySyncDefinition) 

# RepositorySyncEvent
<a name="API_RepositorySyncEvent"></a>

Repository sync event detail data for a sync attempt.

## Contents
<a name="API_RepositorySyncEvent_Contents"></a>

 ** event **   <a name="proton-Type-RepositorySyncEvent-event"></a>
Event detail for a repository sync attempt.  
Type: String  
Required: Yes

 ** time **   <a name="proton-Type-RepositorySyncEvent-time"></a>
The time that the sync event occurred.  
Type: Timestamp  
Required: Yes

 ** type **   <a name="proton-Type-RepositorySyncEvent-type"></a>
The type of event.  
Type: String  
Required: Yes

 ** externalId **   <a name="proton-Type-RepositorySyncEvent-externalId"></a>
The external ID of the sync event.  
Type: String  
Required: No

## See Also
<a name="API_RepositorySyncEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/RepositorySyncEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/RepositorySyncEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/RepositorySyncEvent) 

# ResourceCountsSummary
<a name="API_ResourceCountsSummary"></a>

Summary counts of each AWS Proton resource types.

## Contents
<a name="API_ResourceCountsSummary_Contents"></a>

 ** total **   <a name="proton-Type-ResourceCountsSummary-total"></a>
The total number of resources of this type in the AWS account.  
Type: Integer  
Required: Yes

 ** behindMajor **   <a name="proton-Type-ResourceCountsSummary-behindMajor"></a>
The number of resources of this type in the AWS account that need a major template version update.  
Type: Integer  
Required: No

 ** behindMinor **   <a name="proton-Type-ResourceCountsSummary-behindMinor"></a>
The number of resources of this type in the AWS account that need a minor template version update.  
Type: Integer  
Required: No

 ** failed **   <a name="proton-Type-ResourceCountsSummary-failed"></a>
The number of resources of this type in the AWS account that failed to deploy.  
Type: Integer  
Required: No

 ** upToDate **   <a name="proton-Type-ResourceCountsSummary-upToDate"></a>
The number of resources of this type in the AWS account that are up-to-date with their template.  
Type: Integer  
Required: No

## See Also
<a name="API_ResourceCountsSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ResourceCountsSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ResourceCountsSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ResourceCountsSummary) 

# ResourceSyncAttempt
<a name="API_ResourceSyncAttempt"></a>

Detail data for a resource sync attempt activated by a push to a repository.

## Contents
<a name="API_ResourceSyncAttempt_Contents"></a>

 ** events **   <a name="proton-Type-ResourceSyncAttempt-events"></a>
An array of events with detail data.  
Type: Array of [ResourceSyncEvent](API_ResourceSyncEvent.md) objects  
Required: Yes

 ** initialRevision **   <a name="proton-Type-ResourceSyncAttempt-initialRevision"></a>
Detail data for the initial repository commit, path and push.  
Type: [Revision](API_Revision.md) object  
Required: Yes

 ** startedAt **   <a name="proton-Type-ResourceSyncAttempt-startedAt"></a>
The time when the sync attempt started.  
Type: Timestamp  
Required: Yes

 ** status **   <a name="proton-Type-ResourceSyncAttempt-status"></a>
The status of the sync attempt.  
Type: String  
Valid Values: `INITIATED | IN_PROGRESS | SUCCEEDED | FAILED`   
Required: Yes

 ** target **   <a name="proton-Type-ResourceSyncAttempt-target"></a>
The resource that is synced to.  
Type: String  
Required: Yes

 ** targetRevision **   <a name="proton-Type-ResourceSyncAttempt-targetRevision"></a>
Detail data for the target revision.  
Type: [Revision](API_Revision.md) object  
Required: Yes

## See Also
<a name="API_ResourceSyncAttempt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ResourceSyncAttempt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ResourceSyncAttempt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ResourceSyncAttempt) 

# ResourceSyncEvent
<a name="API_ResourceSyncEvent"></a>

Detail data for a resource sync event.

## Contents
<a name="API_ResourceSyncEvent_Contents"></a>

 ** event **   <a name="proton-Type-ResourceSyncEvent-event"></a>
A resource sync event.  
Type: String  
Required: Yes

 ** time **   <a name="proton-Type-ResourceSyncEvent-time"></a>
The time when the event occurred.  
Type: Timestamp  
Required: Yes

 ** type **   <a name="proton-Type-ResourceSyncEvent-type"></a>
The type of event.  
Type: String  
Required: Yes

 ** externalId **   <a name="proton-Type-ResourceSyncEvent-externalId"></a>
The external ID for the event.  
Type: String  
Required: No

## See Also
<a name="API_ResourceSyncEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ResourceSyncEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ResourceSyncEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ResourceSyncEvent) 

# Revision
<a name="API_Revision"></a>

Revision detail data for a commit and push that activates a sync attempt

## Contents
<a name="API_Revision_Contents"></a>

 ** branch **   <a name="proton-Type-Revision-branch"></a>
The repository branch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** directory **   <a name="proton-Type-Revision-directory"></a>
The repository directory changed by a commit and push that activated the sync attempt.  
Type: String  
Required: Yes

 ** repositoryName **   <a name="proton-Type-Revision-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 **   <a name="proton-Type-Revision-repositoryProvider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** sha **   <a name="proton-Type-Revision-sha"></a>
The secure hash algorithm (SHA) hash for the revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## See Also
<a name="API_Revision_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Revision) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Revision) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Revision) 

# S3ObjectSource
<a name="API_S3ObjectSource"></a>

Template bundle S3 bucket data.

## Contents
<a name="API_S3ObjectSource_Contents"></a>

 ** bucket **   <a name="proton-Type-S3ObjectSource-bucket"></a>
The name of the S3 bucket that contains a template bundle.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9]+[a-z0-9-\.]+[a-z0-9]+`   
Required: Yes

 ** key **   <a name="proton-Type-S3ObjectSource-key"></a>
The path to the S3 bucket that contains a template bundle.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## See Also
<a name="API_S3ObjectSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/S3ObjectSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/S3ObjectSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/S3ObjectSource) 

# Service
<a name="API_Service"></a>

Detailed data of an AWS Proton service resource.

## Contents
<a name="API_Service_Contents"></a>

 ** arn **   <a name="proton-Type-Service-arn"></a>
The Amazon Resource Name (ARN) of the service.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-Service-createdAt"></a>
The time when the service was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-Service-lastModifiedAt"></a>
The time when the service was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-Service-name"></a>
The name 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: Yes

 ** spec **   <a name="proton-Type-Service-spec"></a>
The formatted specification that defines the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: Yes

 ** status **   <a name="proton-Type-Service-status"></a>
The status of the service.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED_CLEANUP_IN_PROGRESS | CREATE_FAILED_CLEANUP_COMPLETE | CREATE_FAILED_CLEANUP_FAILED | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_FAILED_CLEANUP_IN_PROGRESS | UPDATE_FAILED_CLEANUP_COMPLETE | UPDATE_FAILED_CLEANUP_FAILED | UPDATE_FAILED | UPDATE_COMPLETE_CLEANUP_FAILED`   
Required: Yes

 ** templateName **   <a name="proton-Type-Service-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

 ** branchName **   <a name="proton-Type-Service-branchName"></a>
The name of the code repository branch that holds the code that's deployed in AWS Proton.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** description **   <a name="proton-Type-Service-description"></a>
A description of the service.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** pipeline **   <a name="proton-Type-Service-pipeline"></a>
The service pipeline detail data.  
Type: [ServicePipeline](API_ServicePipeline.md) object  
Required: No

 ** repositoryConnectionArn **   <a name="proton-Type-Service-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*.  
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 **   <a name="proton-Type-Service-repositoryId"></a>
The ID of the source code repository.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** statusMessage **   <a name="proton-Type-Service-statusMessage"></a>
A service status message.  
Type: String  
Required: No

## See Also
<a name="API_Service_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Service) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Service) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Service) 

# ServiceInstance
<a name="API_ServiceInstance"></a>

Detailed data of an AWS Proton service instance resource.

## Contents
<a name="API_ServiceInstance_Contents"></a>

 ** arn **   <a name="proton-Type-ServiceInstance-arn"></a>
The Amazon Resource Name (ARN) of the service instance.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-ServiceInstance-createdAt"></a>
The time when the service instance was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-ServiceInstance-deploymentStatus"></a>
The service instance deployment status.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** environmentName **   <a name="proton-Type-ServiceInstance-environmentName"></a>
The name of the environment that the service instance was deployed into.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** lastDeploymentAttemptedAt **   <a name="proton-Type-ServiceInstance-lastDeploymentAttemptedAt"></a>
The time when a deployment of the service instance was last attempted.  
Type: Timestamp  
Required: Yes

 ** lastDeploymentSucceededAt **   <a name="proton-Type-ServiceInstance-lastDeploymentSucceededAt"></a>
The time when the service instance was last deployed successfully.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-ServiceInstance-name"></a>
The name of 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: Yes

 ** serviceName **   <a name="proton-Type-ServiceInstance-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

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

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

 ** templateName **   <a name="proton-Type-ServiceInstance-templateName"></a>
The name of the service template that was used to create 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: Yes

 ** deploymentStatusMessage **   <a name="proton-Type-ServiceInstance-deploymentStatusMessage"></a>
The message associated with the service instance deployment status.  
Type: String  
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-ServiceInstance-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment of this service instance.  
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

 ** lastClientRequestToken **   <a name="proton-Type-ServiceInstance-lastClientRequestToken"></a>
The last client request token received.  
Type: String  
Required: No

 ** lastSucceededDeploymentId **   <a name="proton-Type-ServiceInstance-lastSucceededDeploymentId"></a>
The ID of the last successful deployment of this service instance.  
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

 ** spec **   <a name="proton-Type-ServiceInstance-spec"></a>
The service spec that was used to create the service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## See Also
<a name="API_ServiceInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceInstance) 

# ServiceInstanceState
<a name="API_ServiceInstanceState"></a>

The detailed data about the current state of this service instance.

## Contents
<a name="API_ServiceInstanceState_Contents"></a>

 ** spec **   <a name="proton-Type-ServiceInstanceState-spec"></a>
The service spec that was used to create the service instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: Yes

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

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

 ** templateName **   <a name="proton-Type-ServiceInstanceState-templateName"></a>
The name of the service template that was used to create 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: Yes

 ** lastSuccessfulComponentDeploymentIds **   <a name="proton-Type-ServiceInstanceState-lastSuccessfulComponentDeploymentIds"></a>
The IDs for the last successful components deployed for this service instance.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** lastSuccessfulEnvironmentDeploymentId **   <a name="proton-Type-ServiceInstanceState-lastSuccessfulEnvironmentDeploymentId"></a>
The ID for the last successful environment deployed for this service instance.  
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

 ** lastSuccessfulServicePipelineDeploymentId **   <a name="proton-Type-ServiceInstanceState-lastSuccessfulServicePipelineDeploymentId"></a>
The ID for the last successful service pipeline deployed for this service instance.  
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

## See Also
<a name="API_ServiceInstanceState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceInstanceState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceInstanceState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceInstanceState) 

# ServiceInstanceSummary
<a name="API_ServiceInstanceSummary"></a>

Summary data of an AWS Proton service instance resource.

## Contents
<a name="API_ServiceInstanceSummary_Contents"></a>

 ** arn **   <a name="proton-Type-ServiceInstanceSummary-arn"></a>
The Amazon Resource Name (ARN) of the service instance.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-ServiceInstanceSummary-createdAt"></a>
The time when the service instance was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-ServiceInstanceSummary-deploymentStatus"></a>
The service instance deployment status.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** environmentName **   <a name="proton-Type-ServiceInstanceSummary-environmentName"></a>
The name of the environment that the service instance was deployed into.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** lastDeploymentAttemptedAt **   <a name="proton-Type-ServiceInstanceSummary-lastDeploymentAttemptedAt"></a>
The time when a deployment of the service was last attempted.  
Type: Timestamp  
Required: Yes

 ** lastDeploymentSucceededAt **   <a name="proton-Type-ServiceInstanceSummary-lastDeploymentSucceededAt"></a>
The time when the service was last deployed successfully.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-ServiceInstanceSummary-name"></a>
The name of 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: Yes

 ** serviceName **   <a name="proton-Type-ServiceInstanceSummary-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

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

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

 ** templateName **   <a name="proton-Type-ServiceInstanceSummary-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

 ** deploymentStatusMessage **   <a name="proton-Type-ServiceInstanceSummary-deploymentStatusMessage"></a>
A service instance deployment status message.  
Type: String  
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-ServiceInstanceSummary-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment of this service instance.  
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

 ** lastSucceededDeploymentId **   <a name="proton-Type-ServiceInstanceSummary-lastSucceededDeploymentId"></a>
The ID of the last successful deployment of this service instance.  
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

## See Also
<a name="API_ServiceInstanceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceInstanceSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceInstanceSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceInstanceSummary) 

# ServicePipeline
<a name="API_ServicePipeline"></a>

Detailed data of an AWS Proton service instance pipeline resource.

## Contents
<a name="API_ServicePipeline_Contents"></a>

 ** arn **   <a name="proton-Type-ServicePipeline-arn"></a>
The Amazon Resource Name (ARN) of the 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: Yes

 ** createdAt **   <a name="proton-Type-ServicePipeline-createdAt"></a>
The time when the service pipeline was created.  
Type: Timestamp  
Required: Yes

 ** deploymentStatus **   <a name="proton-Type-ServicePipeline-deploymentStatus"></a>
The deployment status of the service pipeline.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED`   
Required: Yes

 ** lastDeploymentAttemptedAt **   <a name="proton-Type-ServicePipeline-lastDeploymentAttemptedAt"></a>
The time when a deployment of the service pipeline was last attempted.  
Type: Timestamp  
Required: Yes

 ** lastDeploymentSucceededAt **   <a name="proton-Type-ServicePipeline-lastDeploymentSucceededAt"></a>
The time when the service pipeline was last deployed successfully.  
Type: Timestamp  
Required: Yes

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

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

 ** templateName **   <a name="proton-Type-ServicePipeline-templateName"></a>
The name of the service template that was used to create the service pipeline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** deploymentStatusMessage **   <a name="proton-Type-ServicePipeline-deploymentStatusMessage"></a>
A service pipeline deployment status message.  
Type: String  
Required: No

 ** lastAttemptedDeploymentId **   <a name="proton-Type-ServicePipeline-lastAttemptedDeploymentId"></a>
The ID of the last attempted deployment of this service pipeline.  
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

 ** lastSucceededDeploymentId **   <a name="proton-Type-ServicePipeline-lastSucceededDeploymentId"></a>
The ID of the last successful deployment of this service pipeline.  
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

 ** spec **   <a name="proton-Type-ServicePipeline-spec"></a>
The service spec that was used to create the service pipeline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## See Also
<a name="API_ServicePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServicePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServicePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServicePipeline) 

# ServicePipelineState
<a name="API_ServicePipelineState"></a>

The detailed data about the current state of the service pipeline.

## Contents
<a name="API_ServicePipelineState_Contents"></a>

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

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

 ** templateName **   <a name="proton-Type-ServicePipelineState-templateName"></a>
The name of the service template that was used to create the service pipeline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z]+[0-9A-Za-z_\-]*`   
Required: Yes

 ** spec **   <a name="proton-Type-ServicePipelineState-spec"></a>
The service spec that was used to create the service pipeline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

## See Also
<a name="API_ServicePipelineState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServicePipelineState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServicePipelineState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServicePipelineState) 

# ServiceSummary
<a name="API_ServiceSummary"></a>

Summary data of an AWS Proton service resource.

## Contents
<a name="API_ServiceSummary_Contents"></a>

 ** arn **   <a name="proton-Type-ServiceSummary-arn"></a>
The Amazon Resource Name (ARN) of the service.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-ServiceSummary-createdAt"></a>
The time when the service was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-ServiceSummary-lastModifiedAt"></a>
The time when the service was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-ServiceSummary-name"></a>
The name 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: Yes

 ** status **   <a name="proton-Type-ServiceSummary-status"></a>
The status of the service.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED_CLEANUP_IN_PROGRESS | CREATE_FAILED_CLEANUP_COMPLETE | CREATE_FAILED_CLEANUP_FAILED | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_FAILED_CLEANUP_IN_PROGRESS | UPDATE_FAILED_CLEANUP_COMPLETE | UPDATE_FAILED_CLEANUP_FAILED | UPDATE_FAILED | UPDATE_COMPLETE_CLEANUP_FAILED`   
Required: Yes

 ** templateName **   <a name="proton-Type-ServiceSummary-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

 ** description **   <a name="proton-Type-ServiceSummary-description"></a>
A description of the service.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** statusMessage **   <a name="proton-Type-ServiceSummary-statusMessage"></a>
A service status message.  
Type: String  
Required: No

## See Also
<a name="API_ServiceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceSummary) 

# ServiceSyncBlockerSummary
<a name="API_ServiceSyncBlockerSummary"></a>

If a service instance is manually updated, Proton wants to prevent accidentally overriding a manual change.

A blocker is created because of the manual update or deletion of a service instance. The summary describes the blocker as being active or resolved.

## Contents
<a name="API_ServiceSyncBlockerSummary_Contents"></a>

 ** serviceName **   <a name="proton-Type-ServiceSyncBlockerSummary-serviceName"></a>
The name of the service that you want to get the sync blocker summary for. If given a service instance name and a service name, it will return the blockers only applying to the instance that is blocked.  
If given only a service name, it will return the blockers that apply to all of the instances. In order to get the blockers for a single instance, you will need to make two distinct calls, one to get the sync blocker summary for the service and the other to get the sync blocker for the service instance.  
Type: String  
Required: Yes

 ** latestBlockers **   <a name="proton-Type-ServiceSyncBlockerSummary-latestBlockers"></a>
The latest active blockers for the synced service.  
Type: Array of [SyncBlocker](API_SyncBlocker.md) objects  
Required: No

 ** serviceInstanceName **   <a name="proton-Type-ServiceSyncBlockerSummary-serviceInstanceName"></a>
The name of the service instance that you want sync your service configuration with.  
Type: String  
Required: No

## See Also
<a name="API_ServiceSyncBlockerSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceSyncBlockerSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceSyncBlockerSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceSyncBlockerSummary) 

# ServiceSyncConfig
<a name="API_ServiceSyncConfig"></a>

Detailed data of the service sync configuration.

## Contents
<a name="API_ServiceSyncConfig_Contents"></a>

 ** branch **   <a name="proton-Type-ServiceSyncConfig-branch"></a>
The name of the code repository branch that holds the service code AWS Proton will sync with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** filePath **   <a name="proton-Type-ServiceSyncConfig-filePath"></a>
The file path to the service sync configuration file.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** repositoryName **   <a name="proton-Type-ServiceSyncConfig-repositoryName"></a>
The name of the code repository that holds the service code AWS Proton will sync with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`   
Required: Yes

 ** repositoryProvider **   <a name="proton-Type-ServiceSyncConfig-repositoryProvider"></a>
The name of the repository provider that holds the repository AWS Proton will sync with.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** serviceName **   <a name="proton-Type-ServiceSyncConfig-serviceName"></a>
The name of the service that 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

## See Also
<a name="API_ServiceSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceSyncConfig) 

# ServiceTemplate
<a name="API_ServiceTemplate"></a>

Detailed data of an AWS Proton service template resource.

## Contents
<a name="API_ServiceTemplate_Contents"></a>

 ** arn **   <a name="proton-Type-ServiceTemplate-arn"></a>
The Amazon Resource Name (ARN) of the service template.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-ServiceTemplate-createdAt"></a>
The time when the service template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-ServiceTemplate-lastModifiedAt"></a>
The time when the service template was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-ServiceTemplate-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

 ** description **   <a name="proton-Type-ServiceTemplate-description"></a>
A description of the service template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** displayName **   <a name="proton-Type-ServiceTemplate-displayName"></a>
The service template name as displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** encryptionKey **   <a name="proton-Type-ServiceTemplate-encryptionKey"></a>
The customer provided service template 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

 ** pipelineProvisioning **   <a name="proton-Type-ServiceTemplate-pipelineProvisioning"></a>
If `pipelineProvisioning` is `true`, a service pipeline is included in the service template. Otherwise, a service pipeline *isn't* included in the service template.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

 ** recommendedVersion **   <a name="proton-Type-ServiceTemplate-recommendedVersion"></a>
The recommended version of the service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))`   
Required: No

## See Also
<a name="API_ServiceTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceTemplate) 

# ServiceTemplateSummary
<a name="API_ServiceTemplateSummary"></a>

Summary data of an AWS Proton service template resource.

## Contents
<a name="API_ServiceTemplateSummary_Contents"></a>

 ** arn **   <a name="proton-Type-ServiceTemplateSummary-arn"></a>
The Amazon Resource Name (ARN) of the service template.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-ServiceTemplateSummary-createdAt"></a>
The time when the service template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-ServiceTemplateSummary-lastModifiedAt"></a>
The time when the service template was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="proton-Type-ServiceTemplateSummary-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

 ** description **   <a name="proton-Type-ServiceTemplateSummary-description"></a>
A description of the service template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** displayName **   <a name="proton-Type-ServiceTemplateSummary-displayName"></a>
The service template name as displayed in the developer interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** pipelineProvisioning **   <a name="proton-Type-ServiceTemplateSummary-pipelineProvisioning"></a>
If `pipelineProvisioning` is `true`, a service pipeline is included in the service template, otherwise a service pipeline *isn't* included in the service template.  
Type: String  
Valid Values: `CUSTOMER_MANAGED`   
Required: No

 ** recommendedVersion **   <a name="proton-Type-ServiceTemplateSummary-recommendedVersion"></a>
The recommended version of the service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))`   
Required: No

## See Also
<a name="API_ServiceTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceTemplateSummary) 

# ServiceTemplateVersion
<a name="API_ServiceTemplateVersion"></a>

Detailed data of an AWS Proton service template version resource.

## Contents
<a name="API_ServiceTemplateVersion_Contents"></a>

 ** arn **   <a name="proton-Type-ServiceTemplateVersion-arn"></a>
The Amazon Resource Name (ARN) of the version of a service template.  
Type: String  
Required: Yes

 ** compatibleEnvironmentTemplates **   <a name="proton-Type-ServiceTemplateVersion-compatibleEnvironmentTemplates"></a>
An array of compatible environment template names for the major version of a service template.  
Type: Array of [CompatibleEnvironmentTemplate](API_CompatibleEnvironmentTemplate.md) objects  
Required: Yes

 ** createdAt **   <a name="proton-Type-ServiceTemplateVersion-createdAt"></a>
The time when the version of a service template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-ServiceTemplateVersion-lastModifiedAt"></a>
The time when the version of a service template was last modified.  
Type: Timestamp  
Required: Yes

 ** majorVersion **   <a name="proton-Type-ServiceTemplateVersion-majorVersion"></a>
The latest major version that's associated with the version of a service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

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

 ** status **   <a name="proton-Type-ServiceTemplateVersion-status"></a>
The service template version status.  
Type: String  
Valid Values: `REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED`   
Required: Yes

 ** templateName **   <a name="proton-Type-ServiceTemplateVersion-templateName"></a>
The name of the version of a 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

 ** description **   <a name="proton-Type-ServiceTemplateVersion-description"></a>
A description of the version of a service template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** recommendedMinorVersion **   <a name="proton-Type-ServiceTemplateVersion-recommendedMinorVersion"></a>
The recommended minor version of the service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** schema **   <a name="proton-Type-ServiceTemplateVersion-schema"></a>
The schema of the version of a service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 51200.  
Required: No

 ** statusMessage **   <a name="proton-Type-ServiceTemplateVersion-statusMessage"></a>
A service template version status message.  
Type: String  
Required: No

 ** supportedComponentSources **   <a name="proton-Type-ServiceTemplateVersion-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

## See Also
<a name="API_ServiceTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceTemplateVersion) 

# ServiceTemplateVersionSummary
<a name="API_ServiceTemplateVersionSummary"></a>

Summary data of an AWS Proton service template version resource.

## Contents
<a name="API_ServiceTemplateVersionSummary_Contents"></a>

 ** arn **   <a name="proton-Type-ServiceTemplateVersionSummary-arn"></a>
The Amazon Resource Name (ARN) of the version of a service template.  
Type: String  
Required: Yes

 ** createdAt **   <a name="proton-Type-ServiceTemplateVersionSummary-createdAt"></a>
The time when the version of a service template was created.  
Type: Timestamp  
Required: Yes

 ** lastModifiedAt **   <a name="proton-Type-ServiceTemplateVersionSummary-lastModifiedAt"></a>
The time when the version of a service template was last modified.  
Type: Timestamp  
Required: Yes

 ** majorVersion **   <a name="proton-Type-ServiceTemplateVersionSummary-majorVersion"></a>
The latest major version that's associated with the version of a service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: Yes

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

 ** status **   <a name="proton-Type-ServiceTemplateVersionSummary-status"></a>
The service template minor version status.  
Type: String  
Valid Values: `REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED`   
Required: Yes

 ** templateName **   <a name="proton-Type-ServiceTemplateVersionSummary-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

 ** description **   <a name="proton-Type-ServiceTemplateVersionSummary-description"></a>
A description of the version of a service template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** recommendedMinorVersion **   <a name="proton-Type-ServiceTemplateVersionSummary-recommendedMinorVersion"></a>
The recommended minor version of the service template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `(0|([1-9]{1}\d*))`   
Required: No

 ** statusMessage **   <a name="proton-Type-ServiceTemplateVersionSummary-statusMessage"></a>
A service template minor version status message.  
Type: String  
Required: No

## See Also
<a name="API_ServiceTemplateVersionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/ServiceTemplateVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/ServiceTemplateVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/ServiceTemplateVersionSummary) 

# SyncBlocker
<a name="API_SyncBlocker"></a>

Detailed data of the sync blocker.

## Contents
<a name="API_SyncBlocker_Contents"></a>

 ** createdAt **   <a name="proton-Type-SyncBlocker-createdAt"></a>
The time when the sync blocker was created.  
Type: Timestamp  
Required: Yes

 ** createdReason **   <a name="proton-Type-SyncBlocker-createdReason"></a>
The reason why the sync blocker was created.  
Type: String  
Required: Yes

 ** id **   <a name="proton-Type-SyncBlocker-id"></a>
The ID of the sync blocker.  
Type: String  
Required: Yes

 ** status **   <a name="proton-Type-SyncBlocker-status"></a>
The status of the sync blocker.  
Type: String  
Valid Values: `ACTIVE | RESOLVED`   
Required: Yes

 ** type **   <a name="proton-Type-SyncBlocker-type"></a>
The type of the sync blocker.  
Type: String  
Valid Values: `AUTOMATED`   
Required: Yes

 ** contexts **   <a name="proton-Type-SyncBlocker-contexts"></a>
The contexts for the sync blocker.  
Type: Array of [SyncBlockerContext](API_SyncBlockerContext.md) objects  
Required: No

 ** resolvedAt **   <a name="proton-Type-SyncBlocker-resolvedAt"></a>
The time the sync blocker was resolved.  
Type: Timestamp  
Required: No

 ** resolvedReason **   <a name="proton-Type-SyncBlocker-resolvedReason"></a>
The reason the sync blocker was resolved.  
Type: String  
Required: No

## See Also
<a name="API_SyncBlocker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/SyncBlocker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/SyncBlocker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/SyncBlocker) 

# SyncBlockerContext
<a name="API_SyncBlockerContext"></a>

Detailed data of the context of the sync blocker.

## Contents
<a name="API_SyncBlockerContext_Contents"></a>

 ** key **   <a name="proton-Type-SyncBlockerContext-key"></a>
The key for the sync blocker context.  
Type: String  
Required: Yes

 ** value **   <a name="proton-Type-SyncBlockerContext-value"></a>
The value of the sync blocker context.  
Type: String  
Required: Yes

## See Also
<a name="API_SyncBlockerContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/SyncBlockerContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/SyncBlockerContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/SyncBlockerContext) 

# Tag
<a name="API_Tag"></a>

A description of a resource tag.

## Contents
<a name="API_Tag_Contents"></a>

 ** key **   <a name="proton-Type-Tag-key"></a>
The key of the resource tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** value **   <a name="proton-Type-Tag-value"></a>
The value of the resource tag.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/Tag) 

# TemplateSyncConfig
<a name="API_TemplateSyncConfig"></a>

The detail data for a template sync configuration.

## Contents
<a name="API_TemplateSyncConfig_Contents"></a>

 ** branch **   <a name="proton-Type-TemplateSyncConfig-branch"></a>
The repository branch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** repositoryName **   <a name="proton-Type-TemplateSyncConfig-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 **   <a name="proton-Type-TemplateSyncConfig-repositoryProvider"></a>
The repository provider.  
Type: String  
Valid Values: `GITHUB | GITHUB_ENTERPRISE | BITBUCKET`   
Required: Yes

 ** templateName **   <a name="proton-Type-TemplateSyncConfig-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 **   <a name="proton-Type-TemplateSyncConfig-templateType"></a>
The template type.  
Type: String  
Valid Values: `ENVIRONMENT | SERVICE`   
Required: Yes

 ** subdirectory **   <a name="proton-Type-TemplateSyncConfig-subdirectory"></a>
A subdirectory path to your template bundle version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_TemplateSyncConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/TemplateSyncConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/TemplateSyncConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/TemplateSyncConfig) 

# TemplateVersionSourceInput
<a name="API_TemplateVersionSourceInput"></a>

Template version source data.

## Contents
<a name="API_TemplateVersionSourceInput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** s3 **   <a name="proton-Type-TemplateVersionSourceInput-s3"></a>
An S3 source object that includes the template bundle S3 path and name for a template minor version.  
Type: [S3ObjectSource](API_S3ObjectSource.md) object  
Required: No

## See Also
<a name="API_TemplateVersionSourceInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/proton-2020-07-20/TemplateVersionSourceInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/proton-2020-07-20/TemplateVersionSourceInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/proton-2020-07-20/TemplateVersionSourceInput) 