Class: Aws::Proton::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Proton::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb
Overview
An API client for Proton. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Proton::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_environment_account_connection(params = {}) ⇒ Types::AcceptEnvironmentAccountConnectionOutput
In a management account, an environment account connection request is accepted.
-
#cancel_component_deployment(params = {}) ⇒ Types::CancelComponentDeploymentOutput
Attempts to cancel a component deployment (for a component that is in the
IN_PROGRESS
deployment status). -
#cancel_environment_deployment(params = {}) ⇒ Types::CancelEnvironmentDeploymentOutput
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is
IN_PROGRESS
. -
#cancel_service_instance_deployment(params = {}) ⇒ Types::CancelServiceInstanceDeploymentOutput
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is
IN_PROGRESS
. -
#cancel_service_pipeline_deployment(params = {}) ⇒ Types::CancelServicePipelineDeploymentOutput
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is
IN_PROGRESS
. -
#create_component(params = {}) ⇒ Types::CreateComponentOutput
Create an Proton component.
-
#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput
Deploy a new environment.
-
#create_environment_account_connection(params = {}) ⇒ Types::CreateEnvironmentAccountConnectionOutput
Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
-
#create_environment_template(params = {}) ⇒ Types::CreateEnvironmentTemplateOutput
Create an environment template for Proton.
-
#create_environment_template_version(params = {}) ⇒ Types::CreateEnvironmentTemplateVersionOutput
Create a new major or minor version of an environment template.
-
#create_repository(params = {}) ⇒ Types::CreateRepositoryOutput
Create and register a link to a repository.
-
#create_service(params = {}) ⇒ Types::CreateServiceOutput
Create an Proton service.
-
#create_service_instance(params = {}) ⇒ Types::CreateServiceInstanceOutput
Create a service instance.
-
#create_service_sync_config(params = {}) ⇒ Types::CreateServiceSyncConfigOutput
Create the Proton Ops configuration file.
-
#create_service_template(params = {}) ⇒ Types::CreateServiceTemplateOutput
Create a service template.
-
#create_service_template_version(params = {}) ⇒ Types::CreateServiceTemplateVersionOutput
Create a new major or minor version of a service template.
-
#create_template_sync_config(params = {}) ⇒ Types::CreateTemplateSyncConfigOutput
Set up a template to create new template versions automatically by tracking a linked repository.
-
#delete_component(params = {}) ⇒ Types::DeleteComponentOutput
Delete an Proton component resource.
-
#delete_deployment(params = {}) ⇒ Types::DeleteDeploymentOutput
Delete the deployment.
-
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentOutput
Delete an environment.
-
#delete_environment_account_connection(params = {}) ⇒ Types::DeleteEnvironmentAccountConnectionOutput
In an environment account, delete an environment account connection.
-
#delete_environment_template(params = {}) ⇒ Types::DeleteEnvironmentTemplateOutput
If no other major or minor versions of an environment template exist, delete the environment template.
-
#delete_environment_template_version(params = {}) ⇒ Types::DeleteEnvironmentTemplateVersionOutput
If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the
Recommended
version. -
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryOutput
De-register and unlink your repository.
-
#delete_service(params = {}) ⇒ Types::DeleteServiceOutput
Delete a service, with its instances and pipeline.
-
#delete_service_sync_config(params = {}) ⇒ Types::DeleteServiceSyncConfigOutput
Delete the Proton Ops file.
-
#delete_service_template(params = {}) ⇒ Types::DeleteServiceTemplateOutput
If no other major or minor versions of the service template exist, delete the service template.
-
#delete_service_template_version(params = {}) ⇒ Types::DeleteServiceTemplateVersionOutput
If no other minor versions of a service template exist, delete a major version of the service template if it's not the
Recommended
version. -
#delete_template_sync_config(params = {}) ⇒ Types::DeleteTemplateSyncConfigOutput
Delete a template sync configuration.
-
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsOutput
Get detail data for Proton account-wide settings.
-
#get_component(params = {}) ⇒ Types::GetComponentOutput
Get detailed data for a component.
-
#get_deployment(params = {}) ⇒ Types::GetDeploymentOutput
Get detailed data for a deployment.
-
#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput
Get detailed data for an environment.
-
#get_environment_account_connection(params = {}) ⇒ Types::GetEnvironmentAccountConnectionOutput
In an environment account, get the detailed data for an environment account connection.
-
#get_environment_template(params = {}) ⇒ Types::GetEnvironmentTemplateOutput
Get detailed data for an environment template.
-
#get_environment_template_version(params = {}) ⇒ Types::GetEnvironmentTemplateVersionOutput
Get detailed data for a major or minor version of an environment template.
-
#get_repository(params = {}) ⇒ Types::GetRepositoryOutput
Get detail data for a linked repository.
-
#get_repository_sync_status(params = {}) ⇒ Types::GetRepositorySyncStatusOutput
Get the sync status of a repository used for Proton template sync.
-
#get_resources_summary(params = {}) ⇒ Types::GetResourcesSummaryOutput
Get counts of Proton resources.
-
#get_service(params = {}) ⇒ Types::GetServiceOutput
Get detailed data for a service.
-
#get_service_instance(params = {}) ⇒ Types::GetServiceInstanceOutput
Get detailed data for a service instance.
-
#get_service_instance_sync_status(params = {}) ⇒ Types::GetServiceInstanceSyncStatusOutput
Get the status of the synced service instance.
-
#get_service_sync_blocker_summary(params = {}) ⇒ Types::GetServiceSyncBlockerSummaryOutput
Get detailed data for the service sync blocker summary.
-
#get_service_sync_config(params = {}) ⇒ Types::GetServiceSyncConfigOutput
Get detailed information for the service sync configuration.
-
#get_service_template(params = {}) ⇒ Types::GetServiceTemplateOutput
Get detailed data for a service template.
-
#get_service_template_version(params = {}) ⇒ Types::GetServiceTemplateVersionOutput
Get detailed data for a major or minor version of a service template.
-
#get_template_sync_config(params = {}) ⇒ Types::GetTemplateSyncConfigOutput
Get detail data for a template sync configuration.
-
#get_template_sync_status(params = {}) ⇒ Types::GetTemplateSyncStatusOutput
Get the status of a template sync.
-
#list_component_outputs(params = {}) ⇒ Types::ListComponentOutputsOutput
Get a list of component Infrastructure as Code (IaC) outputs.
-
#list_component_provisioned_resources(params = {}) ⇒ Types::ListComponentProvisionedResourcesOutput
List provisioned resources for a component with details.
-
#list_components(params = {}) ⇒ Types::ListComponentsOutput
List components with summary data.
-
#list_deployments(params = {}) ⇒ Types::ListDeploymentsOutput
List deployments.
-
#list_environment_account_connections(params = {}) ⇒ Types::ListEnvironmentAccountConnectionsOutput
View a list of environment account connections.
-
#list_environment_outputs(params = {}) ⇒ Types::ListEnvironmentOutputsOutput
List the infrastructure as code outputs for your environment.
-
#list_environment_provisioned_resources(params = {}) ⇒ Types::ListEnvironmentProvisionedResourcesOutput
List the provisioned resources for your environment.
-
#list_environment_template_versions(params = {}) ⇒ Types::ListEnvironmentTemplateVersionsOutput
List major or minor versions of an environment template with detail data.
-
#list_environment_templates(params = {}) ⇒ Types::ListEnvironmentTemplatesOutput
List environment templates.
-
#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput
List environments with detail data summaries.
-
#list_repositories(params = {}) ⇒ Types::ListRepositoriesOutput
List linked repositories with detail data.
-
#list_repository_sync_definitions(params = {}) ⇒ Types::ListRepositorySyncDefinitionsOutput
List repository sync definitions with detail data.
-
#list_service_instance_outputs(params = {}) ⇒ Types::ListServiceInstanceOutputsOutput
Get a list service of instance Infrastructure as Code (IaC) outputs.
-
#list_service_instance_provisioned_resources(params = {}) ⇒ Types::ListServiceInstanceProvisionedResourcesOutput
List provisioned resources for a service instance with details.
-
#list_service_instances(params = {}) ⇒ Types::ListServiceInstancesOutput
List service instances with summary data.
-
#list_service_pipeline_outputs(params = {}) ⇒ Types::ListServicePipelineOutputsOutput
Get a list of service pipeline Infrastructure as Code (IaC) outputs.
-
#list_service_pipeline_provisioned_resources(params = {}) ⇒ Types::ListServicePipelineProvisionedResourcesOutput
List provisioned resources for a service and pipeline with details.
-
#list_service_template_versions(params = {}) ⇒ Types::ListServiceTemplateVersionsOutput
List major or minor versions of a service template with detail data.
-
#list_service_templates(params = {}) ⇒ Types::ListServiceTemplatesOutput
List service templates with detail data.
-
#list_services(params = {}) ⇒ Types::ListServicesOutput
List services with summaries of detail data.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List tags for a resource.
-
#notify_resource_deployment_status_change(params = {}) ⇒ Struct
Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
-
#reject_environment_account_connection(params = {}) ⇒ Types::RejectEnvironmentAccountConnectionOutput
In a management account, reject an environment account connection from another environment account.
-
#tag_resource(params = {}) ⇒ Struct
Tag a resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove a customer tag from a resource.
-
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsOutput
Update Proton settings that are used for multiple services in the Amazon Web Services account.
-
#update_component(params = {}) ⇒ Types::UpdateComponentOutput
Update a component.
-
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput
Update an environment.
-
#update_environment_account_connection(params = {}) ⇒ Types::UpdateEnvironmentAccountConnectionOutput
In an environment account, update an environment account connection to use a new IAM role.
-
#update_environment_template(params = {}) ⇒ Types::UpdateEnvironmentTemplateOutput
Update an environment template.
-
#update_environment_template_version(params = {}) ⇒ Types::UpdateEnvironmentTemplateVersionOutput
Update a major or minor version of an environment template.
-
#update_service(params = {}) ⇒ Types::UpdateServiceOutput
Edit a service description or use a spec to add and delete service instances.
-
#update_service_instance(params = {}) ⇒ Types::UpdateServiceInstanceOutput
Update a service instance.
-
#update_service_pipeline(params = {}) ⇒ Types::UpdateServicePipelineOutput
Update the service pipeline.
-
#update_service_sync_blocker(params = {}) ⇒ Types::UpdateServiceSyncBlockerOutput
Update the service sync blocker by resolving it.
-
#update_service_sync_config(params = {}) ⇒ Types::UpdateServiceSyncConfigOutput
Update the Proton Ops config file.
-
#update_service_template(params = {}) ⇒ Types::UpdateServiceTemplateOutput
Update a service template.
-
#update_service_template_version(params = {}) ⇒ Types::UpdateServiceTemplateVersionOutput
Update a major or minor version of a service template.
-
#update_template_sync_config(params = {}) ⇒ Types::UpdateTemplateSyncConfigOutput
Update template sync configuration parameters, except for the
templateName
andtemplateType
.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#accept_environment_account_connection(params = {}) ⇒ Types::AcceptEnvironmentAccountConnectionOutput
In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
For more information, see Environment account connections in the Proton User guide.
468 469 470 471 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 468 def accept_environment_account_connection(params = {}, = {}) req = build_request(:accept_environment_account_connection, params) req.send_request() end |
#cancel_component_deployment(params = {}) ⇒ Types::CancelComponentDeploymentOutput
Attempts to cancel a component deployment (for a component that is in
the IN_PROGRESS
deployment status).
For more information about components, see Proton components in the Proton User Guide.
519 520 521 522 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 519 def cancel_component_deployment(params = {}, = {}) req = build_request(:cancel_component_deployment, params) req.send_request() end |
#cancel_environment_deployment(params = {}) ⇒ Types::CancelEnvironmentDeploymentOutput
Attempts to cancel an environment deployment on an UpdateEnvironment
action, if the deployment is IN_PROGRESS
. For more information, see
Update an environment in the Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is
CANCELLED
.If the cancellation attempt fails, the resulting deployment state is
FAILED
.If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is
SUCCEEDED
and the cancellation attempt has no effect.
588 589 590 591 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 588 def cancel_environment_deployment(params = {}, = {}) req = build_request(:cancel_environment_deployment, params) req.send_request() end |
#cancel_service_instance_deployment(params = {}) ⇒ Types::CancelServiceInstanceDeploymentOutput
Attempts to cancel a service instance deployment on an
UpdateServiceInstance action, if the deployment is IN_PROGRESS
. For
more information, see Update a service instance in the Proton
User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is
CANCELLED
.If the cancellation attempt fails, the resulting deployment state is
FAILED
.If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is
SUCCEEDED
and the cancellation attempt has no effect.
655 656 657 658 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 655 def cancel_service_instance_deployment(params = {}, = {}) req = build_request(:cancel_service_instance_deployment, params) req.send_request() end |
#cancel_service_pipeline_deployment(params = {}) ⇒ Types::CancelServicePipelineDeploymentOutput
Attempts to cancel a service pipeline deployment on an
UpdateServicePipeline action, if the deployment is IN_PROGRESS
. For
more information, see Update a service pipeline in the Proton
User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is
CANCELLED
.If the cancellation attempt fails, the resulting deployment state is
FAILED
.If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is
SUCCEEDED
and the cancellation attempt has no effect.
714 715 716 717 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 714 def cancel_service_pipeline_deployment(params = {}, = {}) req = build_request(:cancel_service_pipeline_deployment, params) req.send_request() end |
#create_component(params = {}) ⇒ Types::CreateComponentOutput
Create an Proton component. A component is an infrastructure extension for a service instance.
For more information about components, see Proton components in the Proton User Guide.
835 836 837 838 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 835 def create_component(params = {}, = {}) req = build_request(:create_component, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput
Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.
You can provision environments using the following methods:
Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.
For more information, see Environments and Provisioning methods in the Proton User Guide.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1021 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#create_environment_account_connection(params = {}) ⇒ Types::CreateEnvironmentAccountConnectionOutput
Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton User guide.
1137 1138 1139 1140 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1137 def create_environment_account_connection(params = {}, = {}) req = build_request(:create_environment_account_connection, params) req.send_request() end |
#create_environment_template(params = {}) ⇒ Types::CreateEnvironmentTemplateOutput
Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide.
You can create an environment template in one of the two following ways:
Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure.
Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the
provisioning
parameter and set the value toCUSTOMER_MANAGED
. For more information, see Register and publish an environment template in the Proton User Guide.
1228 1229 1230 1231 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1228 def create_environment_template(params = {}, = {}) req = build_request(:create_environment_template, params) req.send_request() end |
#create_environment_template_version(params = {}) ⇒ Types::CreateEnvironmentTemplateVersionOutput
Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.
1317 1318 1319 1320 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1317 def create_environment_template_version(params = {}, = {}) req = build_request(:create_environment_template_version, params) req.send_request() end |
#create_repository(params = {}) ⇒ Types::CreateRepositoryOutput
Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you.
For more information, see Self-managed provisioning, Template bundles, and Template sync configurations in the Proton User Guide.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1402 def create_repository(params = {}, = {}) req = build_request(:create_repository, params) req.send_request() end |
#create_service(params = {}) ⇒ Types::CreateServiceOutput
Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton User Guide.
1529 1530 1531 1532 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1529 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#create_service_instance(params = {}) ⇒ Types::CreateServiceInstanceOutput
Create a service instance.
1614 1615 1616 1617 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1614 def create_service_instance(params = {}, = {}) req = build_request(:create_service_instance, params) req.send_request() end |
#create_service_sync_config(params = {}) ⇒ Types::CreateServiceSyncConfigOutput
Create the Proton Ops configuration file.
1662 1663 1664 1665 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1662 def create_service_sync_config(params = {}, = {}) req = build_request(:create_service_sync_config, params) req.send_request() end |
#create_service_template(params = {}) ⇒ Types::CreateServiceTemplateOutput
Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Proton templates in the Proton User Guide.
1751 1752 1753 1754 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1751 def create_service_template(params = {}, = {}) req = build_request(:create_service_template, params) req.send_request() end |
#create_service_template_version(params = {}) ⇒ Types::CreateServiceTemplateVersionOutput
Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.
1870 1871 1872 1873 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1870 def create_service_template_version(params = {}, = {}) req = build_request(:create_service_template_version, params) req.send_request() end |
#create_template_sync_config(params = {}) ⇒ Types::CreateTemplateSyncConfigOutput
Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton User Guide.
1938 1939 1940 1941 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1938 def create_template_sync_config(params = {}, = {}) req = build_request(:create_template_sync_config, params) req.send_request() end |
#delete_component(params = {}) ⇒ Types::DeleteComponentOutput
Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.
1988 1989 1990 1991 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1988 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_deployment(params = {}) ⇒ Types::DeleteDeploymentOutput
Delete the deployment.
2071 2072 2073 2074 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2071 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentOutput
Delete an environment.
2122 2123 2124 2125 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2122 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#delete_environment_account_connection(params = {}) ⇒ Types::DeleteEnvironmentAccountConnectionOutput
In an environment account, delete an environment account connection.
After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.
For more information, see Environment account connections in the Proton User guide.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2174 def delete_environment_account_connection(params = {}, = {}) req = build_request(:delete_environment_account_connection, params) req.send_request() end |
#delete_environment_template(params = {}) ⇒ Types::DeleteEnvironmentTemplateOutput
If no other major or minor versions of an environment template exist, delete the environment template.
2211 2212 2213 2214 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2211 def delete_environment_template(params = {}, = {}) req = build_request(:delete_environment_template, params) req.send_request() end |
#delete_environment_template_version(params = {}) ⇒ Types::DeleteEnvironmentTemplateVersionOutput
If no other minor versions of an environment template exist, delete a
major version of the environment template if it's not the
Recommended
version. Delete the Recommended
version of the
environment template if no other major versions or minor versions of
the environment template exist. A major version of an environment
template is a version that's not backward compatible.
Delete a minor version of an environment template if it isn't the
Recommended
version. Delete a Recommended
minor version of the
environment template if no other minor versions of the environment
template exist. A minor version of an environment template is a
version that's backward compatible.
2268 2269 2270 2271 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2268 def delete_environment_template_version(params = {}, = {}) req = build_request(:delete_environment_template_version, params) req.send_request() end |
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryOutput
De-register and unlink your repository.
2304 2305 2306 2307 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2304 def delete_repository(params = {}, = {}) req = build_request(:delete_repository, params) req.send_request() end |
#delete_service(params = {}) ⇒ Types::DeleteServiceOutput
Delete a service, with its instances and pipeline.
For more information about components, see Proton components in the Proton User Guide.
2367 2368 2369 2370 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2367 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() end |
#delete_service_sync_config(params = {}) ⇒ Types::DeleteServiceSyncConfigOutput
Delete the Proton Ops file.
2400 2401 2402 2403 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2400 def delete_service_sync_config(params = {}, = {}) req = build_request(:delete_service_sync_config, params) req.send_request() end |
#delete_service_template(params = {}) ⇒ Types::DeleteServiceTemplateOutput
If no other major or minor versions of the service template exist, delete the service template.
2437 2438 2439 2440 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2437 def delete_service_template(params = {}, = {}) req = build_request(:delete_service_template, params) req.send_request() end |
#delete_service_template_version(params = {}) ⇒ Types::DeleteServiceTemplateVersionOutput
If no other minor versions of a service template exist, delete a major
version of the service template if it's not the Recommended
version. Delete the Recommended
version of the service template if
no other major versions or minor versions of the service template
exist. A major version of a service template is a version that
isn't backwards compatible.
Delete a minor version of a service template if it's not the
Recommended
version. Delete a Recommended
minor version of the
service template if no other minor versions of the service template
exist. A minor version of a service template is a version that's
backwards compatible.
2499 2500 2501 2502 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2499 def delete_service_template_version(params = {}, = {}) req = build_request(:delete_service_template_version, params) req.send_request() end |
#delete_template_sync_config(params = {}) ⇒ Types::DeleteTemplateSyncConfigOutput
Delete a template sync configuration.
2536 2537 2538 2539 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2536 def delete_template_sync_config(params = {}, = {}) req = build_request(:delete_template_sync_config, params) req.send_request() end |
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsOutput
Get detail data for Proton account-wide settings.
2560 2561 2562 2563 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2560 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, params) req.send_request() end |
#get_component(params = {}) ⇒ Types::GetComponentOutput
Get detailed data for a component.
For more information about components, see Proton components in the Proton User Guide.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- component_deleted
- component_deployed
2616 2617 2618 2619 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2616 def get_component(params = {}, = {}) req = build_request(:get_component, params) req.send_request() end |
#get_deployment(params = {}) ⇒ Types::GetDeploymentOutput
Get detailed data for a deployment.
2716 2717 2718 2719 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2716 def get_deployment(params = {}, = {}) req = build_request(:get_deployment, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput
Get detailed data for an environment.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- environment_deployed
2773 2774 2775 2776 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2773 def get_environment(params = {}, = {}) req = build_request(:get_environment, params) req.send_request() end |
#get_environment_account_connection(params = {}) ⇒ Types::GetEnvironmentAccountConnectionOutput
In an environment account, get the detailed data for an environment account connection.
For more information, see Environment account connections in the Proton User guide.
2820 2821 2822 2823 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2820 def get_environment_account_connection(params = {}, = {}) req = build_request(:get_environment_account_connection, params) req.send_request() end |
#get_environment_template(params = {}) ⇒ Types::GetEnvironmentTemplateOutput
Get detailed data for an environment template.
2857 2858 2859 2860 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2857 def get_environment_template(params = {}, = {}) req = build_request(:get_environment_template, params) req.send_request() end |
#get_environment_template_version(params = {}) ⇒ Types::GetEnvironmentTemplateVersionOutput
Get detailed data for a major or minor version of an environment template.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- environment_template_version_registered
2912 2913 2914 2915 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2912 def get_environment_template_version(params = {}, = {}) req = build_request(:get_environment_template_version, params) req.send_request() end |
#get_repository(params = {}) ⇒ Types::GetRepositoryOutput
Get detail data for a linked repository.
2948 2949 2950 2951 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2948 def get_repository(params = {}, = {}) req = build_request(:get_repository, params) req.send_request() end |
#get_repository_sync_status(params = {}) ⇒ Types::GetRepositorySyncStatusOutput
Get the sync status of a repository used for Proton template sync. For more information about template sync, see .
For more information about ABAC, see ABAC in the Proton User Guide.
3010 3011 3012 3013 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3010 def get_repository_sync_status(params = {}, = {}) req = build_request(:get_repository_sync_status, params) req.send_request() end |
#get_resources_summary(params = {}) ⇒ Types::GetResourcesSummaryOutput
Get counts of Proton resources.
For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it's behind the recommended version of the Proton template that it uses and it needs an update to become current.
The action returns staleness counts (counts of resources that are
up-to-date, behind a template major version, or behind a template
minor version), the total number of resources, and the number of
resources that are in a failed state, grouped by resource type.
Components, environments, and service templates return less
information - see the components
, environments
, and
serviceTemplates
field descriptions.
For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account.
For more information, see Proton dashboard in the Proton User Guide.
3086 3087 3088 3089 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3086 def get_resources_summary(params = {}, = {}) req = build_request(:get_resources_summary, params) req.send_request() end |
#get_service(params = {}) ⇒ Types::GetServiceOutput
Get detailed data for a service.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- service_created
- service_deleted
- service_pipeline_deployed
- service_updated
3145 3146 3147 3148 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3145 def get_service(params = {}, = {}) req = build_request(:get_service, params) req.send_request() end |
#get_service_instance(params = {}) ⇒ Types::GetServiceInstanceOutput
Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- service_instance_deployed
3200 3201 3202 3203 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3200 def get_service_instance(params = {}, = {}) req = build_request(:get_service_instance, params) req.send_request() end |
#get_service_instance_sync_status(params = {}) ⇒ Types::GetServiceInstanceSyncStatusOutput
Get the status of the synced service instance.
3275 3276 3277 3278 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3275 def get_service_instance_sync_status(params = {}, = {}) req = build_request(:get_service_instance_sync_status, params) req.send_request() end |
#get_service_sync_blocker_summary(params = {}) ⇒ Types::GetServiceSyncBlockerSummaryOutput
Get detailed data for the service sync blocker summary.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3323 def get_service_sync_blocker_summary(params = {}, = {}) req = build_request(:get_service_sync_blocker_summary, params) req.send_request() end |
#get_service_sync_config(params = {}) ⇒ Types::GetServiceSyncConfigOutput
Get detailed information for the service sync configuration.
3356 3357 3358 3359 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3356 def get_service_sync_config(params = {}, = {}) req = build_request(:get_service_sync_config, params) req.send_request() end |
#get_service_template(params = {}) ⇒ Types::GetServiceTemplateOutput
Get detailed data for a service template.
3393 3394 3395 3396 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3393 def get_service_template(params = {}, = {}) req = build_request(:get_service_template, params) req.send_request() end |
#get_service_template_version(params = {}) ⇒ Types::GetServiceTemplateVersionOutput
Get detailed data for a major or minor version of a service template.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- service_template_version_registered
3452 3453 3454 3455 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3452 def get_service_template_version(params = {}, = {}) req = build_request(:get_service_template_version, params) req.send_request() end |
#get_template_sync_config(params = {}) ⇒ Types::GetTemplateSyncConfigOutput
Get detail data for a template sync configuration.
3489 3490 3491 3492 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3489 def get_template_sync_config(params = {}, = {}) req = build_request(:get_template_sync_config, params) req.send_request() end |
#get_template_sync_status(params = {}) ⇒ Types::GetTemplateSyncStatusOutput
Get the status of a template sync.
3567 3568 3569 3570 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3567 def get_template_sync_status(params = {}, = {}) req = build_request(:get_template_sync_status, params) req.send_request() end |
#list_component_outputs(params = {}) ⇒ Types::ListComponentOutputsOutput
Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3617 3618 3619 3620 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3617 def list_component_outputs(params = {}, = {}) req = build_request(:list_component_outputs, params) req.send_request() end |
#list_component_provisioned_resources(params = {}) ⇒ Types::ListComponentProvisionedResourcesOutput
List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3665 3666 3667 3668 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3665 def list_component_provisioned_resources(params = {}, = {}) req = build_request(:list_component_provisioned_resources, params) req.send_request() end |
#list_components(params = {}) ⇒ Types::ListComponentsOutput
List components with summary data. You can filter the result list by environment, service, or a single service instance.
For more information about components, see Proton components in the Proton User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3740 3741 3742 3743 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3740 def list_components(params = {}, = {}) req = build_request(:list_components, params) req.send_request() end |
#list_deployments(params = {}) ⇒ Types::ListDeploymentsOutput
List deployments. You can filter the result list by environment, service, or a single service instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3814 3815 3816 3817 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3814 def list_deployments(params = {}, = {}) req = build_request(:list_deployments, params) req.send_request() end |
#list_environment_account_connections(params = {}) ⇒ Types::ListEnvironmentAccountConnectionsOutput
View a list of environment account connections.
For more information, see Environment account connections in the Proton User guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3883 3884 3885 3886 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3883 def list_environment_account_connections(params = {}, = {}) req = build_request(:list_environment_account_connections, params) req.send_request() end |
#list_environment_outputs(params = {}) ⇒ Types::ListEnvironmentOutputsOutput
List the infrastructure as code outputs for your environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3927 3928 3929 3930 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3927 def list_environment_outputs(params = {}, = {}) req = build_request(:list_environment_outputs, params) req.send_request() end |
#list_environment_provisioned_resources(params = {}) ⇒ Types::ListEnvironmentProvisionedResourcesOutput
List the provisioned resources for your environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3969 3970 3971 3972 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3969 def list_environment_provisioned_resources(params = {}, = {}) req = build_request(:list_environment_provisioned_resources, params) req.send_request() end |
#list_environment_template_versions(params = {}) ⇒ Types::ListEnvironmentTemplateVersionsOutput
List major or minor versions of an environment template with detail data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4032 4033 4034 4035 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4032 def list_environment_template_versions(params = {}, = {}) req = build_request(:list_environment_template_versions, params) req.send_request() end |
#list_environment_templates(params = {}) ⇒ Types::ListEnvironmentTemplatesOutput
List environment templates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4078 4079 4080 4081 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4078 def list_environment_templates(params = {}, = {}) req = build_request(:list_environment_templates, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput
List environments with detail data summaries.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4143 4144 4145 4146 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4143 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_repositories(params = {}) ⇒ Types::ListRepositoriesOutput
List linked repositories with detail data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4185 4186 4187 4188 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4185 def list_repositories(params = {}, = {}) req = build_request(:list_repositories, params) req.send_request() end |
#list_repository_sync_definitions(params = {}) ⇒ Types::ListRepositorySyncDefinitionsOutput
List repository sync definitions with detail data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4235 4236 4237 4238 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4235 def list_repository_sync_definitions(params = {}, = {}) req = build_request(:list_repository_sync_definitions, params) req.send_request() end |
#list_service_instance_outputs(params = {}) ⇒ Types::ListServiceInstanceOutputsOutput
Get a list service of instance Infrastructure as Code (IaC) outputs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4282 4283 4284 4285 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4282 def list_service_instance_outputs(params = {}, = {}) req = build_request(:list_service_instance_outputs, params) req.send_request() end |
#list_service_instance_provisioned_resources(params = {}) ⇒ Types::ListServiceInstanceProvisionedResourcesOutput
List provisioned resources for a service instance with details.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4327 4328 4329 4330 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4327 def list_service_instance_provisioned_resources(params = {}, = {}) req = build_request(:list_service_instance_provisioned_resources, params) req.send_request() end |
#list_service_instances(params = {}) ⇒ Types::ListServiceInstancesOutput
List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4410 4411 4412 4413 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4410 def list_service_instances(params = {}, = {}) req = build_request(:list_service_instances, params) req.send_request() end |
#list_service_pipeline_outputs(params = {}) ⇒ Types::ListServicePipelineOutputsOutput
Get a list of service pipeline Infrastructure as Code (IaC) outputs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4453 4454 4455 4456 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4453 def list_service_pipeline_outputs(params = {}, = {}) req = build_request(:list_service_pipeline_outputs, params) req.send_request() end |
#list_service_pipeline_provisioned_resources(params = {}) ⇒ Types::ListServicePipelineProvisionedResourcesOutput
List provisioned resources for a service and pipeline with details.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4495 4496 4497 4498 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4495 def list_service_pipeline_provisioned_resources(params = {}, = {}) req = build_request(:list_service_pipeline_provisioned_resources, params) req.send_request() end |
#list_service_template_versions(params = {}) ⇒ Types::ListServiceTemplateVersionsOutput
List major or minor versions of a service template with detail data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4556 4557 4558 4559 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4556 def list_service_template_versions(params = {}, = {}) req = build_request(:list_service_template_versions, params) req.send_request() end |
#list_service_templates(params = {}) ⇒ Types::ListServiceTemplatesOutput
List service templates with detail data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4602 4603 4604 4605 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4602 def list_service_templates(params = {}, = {}) req = build_request(:list_service_templates, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesOutput
List services with summaries of detail data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4647 4648 4649 4650 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4647 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4696 4697 4698 4699 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4696 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#notify_resource_deployment_status_change(params = {}) ⇒ Struct
Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide.
4748 4749 4750 4751 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4748 def notify_resource_deployment_status_change(params = {}, = {}) req = build_request(:notify_resource_deployment_status_change, params) req.send_request() end |
#reject_environment_account_connection(params = {}) ⇒ Types::RejectEnvironmentAccountConnectionOutput
In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you can't accept or use the rejected environment account connection.
You can’t reject an environment account connection that's connected to an environment.
For more information, see Environment account connections in the Proton User guide.
4800 4801 4802 4803 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4800 def reject_environment_account_connection(params = {}, = {}) req = build_request(:reject_environment_account_connection, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.
4840 4841 4842 4843 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4840 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.
4876 4877 4878 4879 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4876 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsOutput
Update Proton settings that are used for multiple services in the Amazon Web Services account.
4943 4944 4945 4946 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4943 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, params) req.send_request() end |
#update_component(params = {}) ⇒ Types::UpdateComponentOutput
Update a component.
There are a few modes for updating a component. The deploymentType
field defines the mode.
IN_PROGRESS
.
For more information about components, see Proton components in the Proton User Guide.
5067 5068 5069 5070 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5067 def update_component(params = {}, = {}) req = build_request(:update_component, params) req.send_request() end |
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput
Update an environment.
If the environment is associated with an environment account
connection, don't update or include the protonServiceRoleArn
and
provisioningRepository
parameter to update or connect to an
environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account
connection, don't update or include the
environmentAccountConnectionId
parameter. You can't update or
connect the environment to an environment account connection if it
isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId
or
protonServiceRoleArn
parameter and value. You can’t update both.
If the environment was configured for Amazon Web Services-managed
provisioning, omit the provisioningRepository
parameter.
If the environment was configured for self-managed provisioning,
specify the provisioningRepository
parameter and omit the
protonServiceRoleArn
and environmentAccountConnectionId
parameters.
For more information, see Environments and Provisioning methods in the Proton User Guide.
- There are four modes for updating an environment. The
deploymentType
- field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this
deployment-type
.MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.
5295 5296 5297 5298 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5295 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |
#update_environment_account_connection(params = {}) ⇒ Types::UpdateEnvironmentAccountConnectionOutput
In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton User guide.
5371 5372 5373 5374 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5371 def update_environment_account_connection(params = {}, = {}) req = build_request(:update_environment_account_connection, params) req.send_request() end |
#update_environment_template(params = {}) ⇒ Types::UpdateEnvironmentTemplateOutput
Update an environment template.
5416 5417 5418 5419 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5416 def update_environment_template(params = {}, = {}) req = build_request(:update_environment_template, params) req.send_request() end |
#update_environment_template_version(params = {}) ⇒ Types::UpdateEnvironmentTemplateVersionOutput
Update a major or minor version of an environment template.
5472 5473 5474 5475 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5472 def update_environment_template_version(params = {}, = {}) req = build_request(:update_environment_template_version, params) req.send_request() end |
#update_service(params = {}) ⇒ Types::UpdateServiceOutput
Edit a service description or use a spec to add and delete service instances.
Use the description
parameter to modify the description.
Edit the spec
parameter to add or delete instances.
For more information about components, see Proton components in the Proton User Guide.
5561 5562 5563 5564 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5561 def update_service(params = {}, = {}) req = build_request(:update_service, params) req.send_request() end |
#update_service_instance(params = {}) ⇒ Types::UpdateServiceInstanceOutput
Update a service instance.
There are a few modes for updating a service instance. The
deploymentType
field defines the mode.
IN_PROGRESS
.
For more information about components, see Proton components in the Proton User Guide.
5682 5683 5684 5685 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5682 def update_service_instance(params = {}, = {}) req = build_request(:update_service_instance, params) req.send_request() end |
#update_service_pipeline(params = {}) ⇒ Types::UpdateServicePipelineOutput
Update the service pipeline.
- There are four modes for updating a service pipeline. The
deploymentType
field defines the mode.NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this
deployment-type
.MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that's higher than the major version in use and a minor version.
5815 5816 5817 5818 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5815 def update_service_pipeline(params = {}, = {}) req = build_request(:update_service_pipeline, params) req.send_request() end |
#update_service_sync_blocker(params = {}) ⇒ Types::UpdateServiceSyncBlockerOutput
Update the service sync blocker by resolving it.
5860 5861 5862 5863 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5860 def update_service_sync_blocker(params = {}, = {}) req = build_request(:update_service_sync_blocker, params) req.send_request() end |
#update_service_sync_config(params = {}) ⇒ Types::UpdateServiceSyncConfigOutput
Update the Proton Ops config file.
5910 5911 5912 5913 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5910 def update_service_sync_config(params = {}, = {}) req = build_request(:update_service_sync_config, params) req.send_request() end |
#update_service_template(params = {}) ⇒ Types::UpdateServiceTemplateOutput
Update a service template.
5955 5956 5957 5958 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5955 def update_service_template(params = {}, = {}) req = build_request(:update_service_template, params) req.send_request() end |
#update_service_template_version(params = {}) ⇒ Types::UpdateServiceTemplateVersionOutput
Update a major or minor version of a service template.
6047 6048 6049 6050 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6047 def update_service_template_version(params = {}, = {}) req = build_request(:update_service_template_version, params) req.send_request() end |
#update_template_sync_config(params = {}) ⇒ Types::UpdateTemplateSyncConfigOutput
Update template sync configuration parameters, except for the
templateName
and templateType
. Repository details (branch, name,
and provider) should be of a linked repository. A linked repository is
a repository that has been registered with Proton. For more
information, see CreateRepository.
6105 6106 6107 6108 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6105 def update_template_sync_config(params = {}, = {}) req = build_request(:update_template_sync_config, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
component_deleted | #get_component | 5 | 999 |
component_deployed | #get_component | 5 | 999 |
environment_deployed | #get_environment | 5 | 999 |
environment_template_version_registered | #get_environment_template_version | 2 | 150 |
service_created | #get_service | 5 | 999 |
service_deleted | #get_service | 5 | 999 |
service_instance_deployed | #get_service_instance | 5 | 999 |
service_pipeline_deployed | #get_service | 10 | 360 |
service_template_version_registered | #get_service_template_version | 2 | 150 |
service_updated | #get_service | 5 | 999 |
6224 6225 6226 6227 6228 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6224 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |