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.
453 454 455 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 453 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.
502 503 504 505 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 502 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.
553 554 555 556 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 553 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.
622 623 624 625 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 622 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.
689 690 691 692 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 689 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.
748 749 750 751 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 748 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.
869 870 871 872 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 869 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.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1055 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.
1171 1172 1173 1174 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1171 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.
1262 1263 1264 1265 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1262 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.
1351 1352 1353 1354 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1351 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.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1436 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.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1563 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#create_service_instance(params = {}) ⇒ Types::CreateServiceInstanceOutput
Create a service instance.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1648 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.
1696 1697 1698 1699 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1696 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.
1785 1786 1787 1788 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1785 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.
1904 1905 1906 1907 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1904 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.
1972 1973 1974 1975 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1972 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.
2022 2023 2024 2025 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2022 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_deployment(params = {}) ⇒ Types::DeleteDeploymentOutput
Delete the deployment.
2105 2106 2107 2108 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2105 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentOutput
Delete an environment.
2156 2157 2158 2159 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2156 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.
2208 2209 2210 2211 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2208 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.
2245 2246 2247 2248 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2245 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.
2302 2303 2304 2305 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2302 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.
2338 2339 2340 2341 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2338 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.
2401 2402 2403 2404 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2401 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.
2434 2435 2436 2437 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2434 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.
2471 2472 2473 2474 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2471 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.
2533 2534 2535 2536 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2533 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.
2570 2571 2572 2573 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2570 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.
2594 2595 2596 2597 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2594 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
2650 2651 2652 2653 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2650 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.
2750 2751 2752 2753 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2750 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
2807 2808 2809 2810 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2807 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.
2854 2855 2856 2857 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2854 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.
2891 2892 2893 2894 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2891 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
2946 2947 2948 2949 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2946 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.
2982 2983 2984 2985 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2982 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.
3044 3045 3046 3047 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3044 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.
3120 3121 3122 3123 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3120 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
3179 3180 3181 3182 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3179 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
3234 3235 3236 3237 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3234 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.
3309 3310 3311 3312 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3309 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.
3357 3358 3359 3360 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3357 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.
3390 3391 3392 3393 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3390 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.
3427 3428 3429 3430 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3427 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
3486 3487 3488 3489 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3486 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.
3523 3524 3525 3526 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3523 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.
3601 3602 3603 3604 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3601 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.
3651 3652 3653 3654 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3651 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.
3699 3700 3701 3702 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3699 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.
3774 3775 3776 3777 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3774 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.
3848 3849 3850 3851 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3848 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.
3917 3918 3919 3920 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3917 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.
3961 3962 3963 3964 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3961 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.
4003 4004 4005 4006 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4003 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.
4066 4067 4068 4069 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4066 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.
4112 4113 4114 4115 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4112 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.
4177 4178 4179 4180 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4177 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.
4219 4220 4221 4222 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4219 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.
4269 4270 4271 4272 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4269 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.
4316 4317 4318 4319 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4316 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.
4361 4362 4363 4364 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4361 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.
4444 4445 4446 4447 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4444 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.
4487 4488 4489 4490 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4487 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.
4529 4530 4531 4532 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4529 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.
4590 4591 4592 4593 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4590 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.
4636 4637 4638 4639 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4636 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.
4681 4682 4683 4684 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4681 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.
4730 4731 4732 4733 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4730 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.
4782 4783 4784 4785 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4782 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.
4834 4835 4836 4837 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4834 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.
4874 4875 4876 4877 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4874 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.
4910 4911 4912 4913 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4910 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.
4977 4978 4979 4980 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4977 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.
5101 5102 5103 5104 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5101 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.
5329 5330 5331 5332 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5329 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.
5405 5406 5407 5408 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5405 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.
5450 5451 5452 5453 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5450 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.
5506 5507 5508 5509 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5506 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.
5595 5596 5597 5598 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5595 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.
5716 5717 5718 5719 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5716 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.
5849 5850 5851 5852 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5849 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.
5894 5895 5896 5897 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5894 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.
5944 5945 5946 5947 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5944 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.
5989 5990 5991 5992 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5989 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.
6081 6082 6083 6084 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6081 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.
6139 6140 6141 6142 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6139 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 |
6263 6264 6265 6266 6267 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6263 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |