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.
447 448 449 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 447 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.
496 497 498 499 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 496 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.
547 548 549 550 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 547 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.
616 617 618 619 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 616 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.
683 684 685 686 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 683 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.
742 743 744 745 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 742 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.
863 864 865 866 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 863 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.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1049 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.
1165 1166 1167 1168 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1165 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.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1256 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.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1345 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.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1430 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1557 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#create_service_instance(params = {}) ⇒ Types::CreateServiceInstanceOutput
Create a service instance.
1642 1643 1644 1645 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1642 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.
1690 1691 1692 1693 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1690 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.
1779 1780 1781 1782 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1779 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.
1898 1899 1900 1901 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1898 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.
1966 1967 1968 1969 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1966 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.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2016 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_deployment(params = {}) ⇒ Types::DeleteDeploymentOutput
Delete the deployment.
2099 2100 2101 2102 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2099 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentOutput
Delete an environment.
2150 2151 2152 2153 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2150 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.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2202 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.
2239 2240 2241 2242 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2239 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.
2296 2297 2298 2299 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2296 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.
2332 2333 2334 2335 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2332 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.
2395 2396 2397 2398 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2395 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.
2428 2429 2430 2431 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2428 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.
2465 2466 2467 2468 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2465 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.
2527 2528 2529 2530 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2527 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.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2564 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.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2588 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
2644 2645 2646 2647 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2644 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.
2744 2745 2746 2747 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2744 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
2801 2802 2803 2804 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2801 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.
2848 2849 2850 2851 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2848 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.
2885 2886 2887 2888 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2885 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
2940 2941 2942 2943 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2940 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.
2976 2977 2978 2979 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2976 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.
3038 3039 3040 3041 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3038 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.
3114 3115 3116 3117 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3114 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
3173 3174 3175 3176 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3173 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
3228 3229 3230 3231 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3228 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.
3303 3304 3305 3306 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3303 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.
3351 3352 3353 3354 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3351 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.
3384 3385 3386 3387 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3384 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.
3421 3422 3423 3424 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3421 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
3480 3481 3482 3483 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3480 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.
3517 3518 3519 3520 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3517 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.
3595 3596 3597 3598 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3595 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.
3645 3646 3647 3648 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3645 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.
3693 3694 3695 3696 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3693 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.
3768 3769 3770 3771 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3768 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.
3842 3843 3844 3845 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3842 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.
3911 3912 3913 3914 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3911 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.
3955 3956 3957 3958 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3955 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.
3997 3998 3999 4000 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3997 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.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4060 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.
4106 4107 4108 4109 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4106 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.
4171 4172 4173 4174 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4171 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.
4213 4214 4215 4216 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4213 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.
4263 4264 4265 4266 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4263 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.
4310 4311 4312 4313 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4310 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.
4355 4356 4357 4358 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4355 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.
4438 4439 4440 4441 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4438 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.
4481 4482 4483 4484 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4481 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.
4523 4524 4525 4526 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4523 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.
4584 4585 4586 4587 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4584 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.
4630 4631 4632 4633 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4630 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.
4675 4676 4677 4678 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4675 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.
4724 4725 4726 4727 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4724 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.
4776 4777 4778 4779 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4776 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.
4828 4829 4830 4831 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4828 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.
4868 4869 4870 4871 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4868 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.
4904 4905 4906 4907 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4904 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.
4971 4972 4973 4974 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4971 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.
5095 5096 5097 5098 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5095 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.
5323 5324 5325 5326 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5323 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.
5399 5400 5401 5402 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5399 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.
5444 5445 5446 5447 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5444 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.
5500 5501 5502 5503 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5500 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.
5589 5590 5591 5592 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5589 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.
5710 5711 5712 5713 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5710 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.
5843 5844 5845 5846 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5843 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.
5888 5889 5890 5891 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5888 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.
5938 5939 5940 5941 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5938 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.
5983 5984 5985 5986 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 5983 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.
6075 6076 6077 6078 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6075 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.
6133 6134 6135 6136 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6133 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 |
6257 6258 6259 6260 6261 |
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 6257 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |