Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that AWS Proton can respond with.

Structs§

AccountSettings

Proton settings that are used for multiple services in the Amazon Web Services account.

CompatibleEnvironmentTemplate

Compatible environment template data.

CompatibleEnvironmentTemplateInput

Compatible environment template data.

Component

Detailed data of an Proton component resource.

For more information about components, see Proton components in the Proton User Guide.

ComponentState

The detailed data about the current state of the component.

ComponentSummary

Summary data of an Proton component resource.

For more information about components, see Proton components in the Proton User Guide.

CountsSummary

Summary counts of each Proton resource type.

Deployment

The detailed information about a deployment.

DeploymentSummary

Summary data of the deployment.

Environment

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

EnvironmentAccountConnection

Detailed data of an Proton environment account connection resource.

EnvironmentAccountConnectionSummary

Summary data of an Proton environment account connection resource.

EnvironmentState

The detailed data about the current state of the environment.

EnvironmentSummary

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

EnvironmentTemplate

The environment template data.

EnvironmentTemplateFilter

A search filter for environment templates.

EnvironmentTemplateSummary

The environment template data.

EnvironmentTemplateVersion

The environment template version data.

EnvironmentTemplateVersionSummary

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

ListServiceInstancesFilter

A filtering criterion to scope down the result list of the ListServiceInstances action.

Output

An infrastructure as code defined resource output.

ProvisionedResource

Detail data for a provisioned resource.

Repository

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

RepositoryBranch

Detail data for a linked repository branch.

RepositoryBranchInput

Detail input data for a linked repository branch.

RepositorySummary

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

RepositorySyncAttempt

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

RepositorySyncDefinition

A repository sync definition.

RepositorySyncEvent

Repository sync event detail data for a sync attempt.

ResourceCountsSummary

Summary counts of each Proton resource types.

ResourceSyncAttempt

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

ResourceSyncEvent

Detail data for a resource sync event.

Revision

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

S3ObjectSource

Template bundle S3 bucket data.

Service

Detailed data of an Proton service resource.

ServiceInstance

Detailed data of an Proton service instance resource.

ServiceInstanceState

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

ServiceInstanceSummary

Summary data of an Proton service instance resource.

ServicePipeline

Detailed data of an Proton service instance pipeline resource.

ServicePipelineState

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

ServiceSummary

Summary data of an Proton service resource.

ServiceSyncBlockerSummary

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.

ServiceSyncConfig

Detailed data of the service sync configuration.

ServiceTemplate

Detailed data of an Proton service template resource.

ServiceTemplateSummary

Summary data of an Proton service template resource.

ServiceTemplateVersion

Detailed data of an Proton service template version resource.

ServiceTemplateVersionSummary

Summary data of an Proton service template version resource.

SyncBlocker

Detailed data of the sync blocker.

SyncBlockerContext

Detailed data of the context of the sync blocker.

Tag

A description of a resource tag.

TemplateSyncConfig

The detail data for a template sync configuration.

Enums§

BlockerStatus
When writing a match expression against BlockerStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BlockerType
When writing a match expression against BlockerType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ComponentDeploymentUpdateType
When writing a match expression against ComponentDeploymentUpdateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DeploymentState

The detailed data about the current state of the deployment.

DeploymentStatus
When writing a match expression against DeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DeploymentTargetResourceType
When writing a match expression against DeploymentTargetResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DeploymentUpdateType
When writing a match expression against DeploymentUpdateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EnvironmentAccountConnectionRequesterAccountType
When writing a match expression against EnvironmentAccountConnectionRequesterAccountType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EnvironmentAccountConnectionStatus
When writing a match expression against EnvironmentAccountConnectionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListServiceInstancesFilterBy
When writing a match expression against ListServiceInstancesFilterBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListServiceInstancesSortBy
When writing a match expression against ListServiceInstancesSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProvisionedResourceEngine
When writing a match expression against ProvisionedResourceEngine, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Provisioning
When writing a match expression against Provisioning, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RepositoryProvider
When writing a match expression against RepositoryProvider, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RepositorySyncStatus
When writing a match expression against RepositorySyncStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceDeploymentStatus
When writing a match expression against ResourceDeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceSyncStatus
When writing a match expression against ResourceSyncStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ServiceStatus
When writing a match expression against ServiceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ServiceTemplateSupportedComponentSourceType
When writing a match expression against ServiceTemplateSupportedComponentSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortOrder
When writing a match expression against SortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SyncType
When writing a match expression against SyncType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TemplateType
When writing a match expression against TemplateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TemplateVersionSourceInput

Template version source data.

TemplateVersionStatus
When writing a match expression against TemplateVersionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.