Class: Aws::Proton::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Proton::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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` and `templateType`.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#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.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'lib/aws-sdk-proton/client.rb', line 429 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6277 6278 6279 |
# File 'lib/aws-sdk-proton/client.rb', line 6277 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6280 6281 6282 |
# File 'lib/aws-sdk-proton/client.rb', line 6280 def errors_module Errors 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
478 479 480 481 |
# File 'lib/aws-sdk-proton/client.rb', line 478 def accept_environment_account_connection(params = {}, = {}) req = build_request(:accept_environment_account_connection, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 |
# File 'lib/aws-sdk-proton/client.rb', line 6124 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-proton' context[:gem_version] = '1.40.0' Seahorse::Client::Request.new(handlers, context) 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
529 530 531 532 |
# File 'lib/aws-sdk-proton/client.rb', line 529 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][1
-
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.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html
598 599 600 601 |
# File 'lib/aws-sdk-proton/client.rb', line 598 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.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html
665 666 667 668 |
# File 'lib/aws-sdk-proton/client.rb', line 665 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.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html
724 725 726 727 |
# File 'lib/aws-sdk-proton/client.rb', line 724 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
845 846 847 848 |
# File 'lib/aws-sdk-proton/client.rb', line 845 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-environments.html [2]: docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html
1031 1032 1033 1034 |
# File 'lib/aws-sdk-proton/client.rb', line 1031 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
1147 1148 1149 1150 |
# File 'lib/aws-sdk-proton/client.rb', line 1147 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][1
-
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 to `CUSTOMER_MANAGED`. For more information, see [Register and publish an environment template] in the *Proton User Guide*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-templates.html [2]: docs.aws.amazon.com/proton/latest/userguide/template-create.html
1238 1239 1240 1241 |
# File 'lib/aws-sdk-proton/client.rb', line 1238 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.
1327 1328 1329 1330 |
# File 'lib/aws-sdk-proton/client.rb', line 1327 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html [2]: docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self [3]: docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles [4]: docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html
1412 1413 1414 1415 |
# File 'lib/aws-sdk-proton/client.rb', line 1412 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-services.html
1539 1540 1541 1542 |
# File 'lib/aws-sdk-proton/client.rb', line 1539 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#create_service_instance(params = {}) ⇒ Types::CreateServiceInstanceOutput
Create a service instance.
1624 1625 1626 1627 |
# File 'lib/aws-sdk-proton/client.rb', line 1624 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.
1672 1673 1674 1675 |
# File 'lib/aws-sdk-proton/client.rb', line 1672 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-templates.html
1761 1762 1763 1764 |
# File 'lib/aws-sdk-proton/client.rb', line 1761 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.
1880 1881 1882 1883 |
# File 'lib/aws-sdk-proton/client.rb', line 1880 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html
1948 1949 1950 1951 |
# File 'lib/aws-sdk-proton/client.rb', line 1948 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
1998 1999 2000 2001 |
# File 'lib/aws-sdk-proton/client.rb', line 1998 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_deployment(params = {}) ⇒ Types::DeleteDeploymentOutput
Delete the deployment.
2081 2082 2083 2084 |
# File 'lib/aws-sdk-proton/client.rb', line 2081 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentOutput
Delete an environment.
2132 2133 2134 2135 |
# File 'lib/aws-sdk-proton/client.rb', line 2132 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
2184 2185 2186 2187 |
# File 'lib/aws-sdk-proton/client.rb', line 2184 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.
2221 2222 2223 2224 |
# File 'lib/aws-sdk-proton/client.rb', line 2221 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.
2278 2279 2280 2281 |
# File 'lib/aws-sdk-proton/client.rb', line 2278 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.
2314 2315 2316 2317 |
# File 'lib/aws-sdk-proton/client.rb', line 2314 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.
<note markdown=“1”> You can’t delete a service if it has any service instances that have components attached to them.
For more information about components, see [Proton components][1] in
the *Proton User Guide*.
</note>
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
2377 2378 2379 2380 |
# File 'lib/aws-sdk-proton/client.rb', line 2377 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.
2410 2411 2412 2413 |
# File 'lib/aws-sdk-proton/client.rb', line 2410 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.
2447 2448 2449 2450 |
# File 'lib/aws-sdk-proton/client.rb', line 2447 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.
2509 2510 2511 2512 |
# File 'lib/aws-sdk-proton/client.rb', line 2509 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.
2546 2547 2548 2549 |
# File 'lib/aws-sdk-proton/client.rb', line 2546 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.
2570 2571 2572 2573 |
# File 'lib/aws-sdk-proton/client.rb', line 2570 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* component_deleted
* component_deployed
2626 2627 2628 2629 |
# File 'lib/aws-sdk-proton/client.rb', line 2626 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.
2726 2727 2728 2729 |
# File 'lib/aws-sdk-proton/client.rb', line 2726 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
2783 2784 2785 2786 |
# File 'lib/aws-sdk-proton/client.rb', line 2783 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
2830 2831 2832 2833 |
# File 'lib/aws-sdk-proton/client.rb', line 2830 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.
2867 2868 2869 2870 |
# File 'lib/aws-sdk-proton/client.rb', line 2867 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
2922 2923 2924 2925 |
# File 'lib/aws-sdk-proton/client.rb', line 2922 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.
2958 2959 2960 2961 |
# File 'lib/aws-sdk-proton/client.rb', line 2958 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 .
<note markdown=“1”> A repository sync status isn’t tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can’t use these tags to control access to this action using Attribute-based access control (ABAC).
For more information about ABAC, see [ABAC][1] in the *Proton User
Guide*.
</note>
3020 3021 3022 3023 |
# File 'lib/aws-sdk-proton/client.rb', line 3020 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html
3096 3097 3098 3099 |
# File 'lib/aws-sdk-proton/client.rb', line 3096 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
3155 3156 3157 3158 |
# File 'lib/aws-sdk-proton/client.rb', line 3155 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
3210 3211 3212 3213 |
# File 'lib/aws-sdk-proton/client.rb', line 3210 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.
3285 3286 3287 3288 |
# File 'lib/aws-sdk-proton/client.rb', line 3285 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.
3333 3334 3335 3336 |
# File 'lib/aws-sdk-proton/client.rb', line 3333 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.
3366 3367 3368 3369 |
# File 'lib/aws-sdk-proton/client.rb', line 3366 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.
3403 3404 3405 3406 |
# File 'lib/aws-sdk-proton/client.rb', line 3403 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
3462 3463 3464 3465 |
# File 'lib/aws-sdk-proton/client.rb', line 3462 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.
3499 3500 3501 3502 |
# File 'lib/aws-sdk-proton/client.rb', line 3499 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.
3577 3578 3579 3580 |
# File 'lib/aws-sdk-proton/client.rb', line 3577 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3627 3628 3629 3630 |
# File 'lib/aws-sdk-proton/client.rb', line 3627 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3675 3676 3677 3678 |
# File 'lib/aws-sdk-proton/client.rb', line 3675 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3750 3751 3752 3753 |
# File 'lib/aws-sdk-proton/client.rb', line 3750 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.
3824 3825 3826 3827 |
# File 'lib/aws-sdk-proton/client.rb', line 3824 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3893 3894 3895 3896 |
# File 'lib/aws-sdk-proton/client.rb', line 3893 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.
3937 3938 3939 3940 |
# File 'lib/aws-sdk-proton/client.rb', line 3937 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.
3979 3980 3981 3982 |
# File 'lib/aws-sdk-proton/client.rb', line 3979 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.
4042 4043 4044 4045 |
# File 'lib/aws-sdk-proton/client.rb', line 4042 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.
4088 4089 4090 4091 |
# File 'lib/aws-sdk-proton/client.rb', line 4088 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.
4153 4154 4155 4156 |
# File 'lib/aws-sdk-proton/client.rb', line 4153 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.
4195 4196 4197 4198 |
# File 'lib/aws-sdk-proton/client.rb', line 4195 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.
4245 4246 4247 4248 |
# File 'lib/aws-sdk-proton/client.rb', line 4245 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.
4292 4293 4294 4295 |
# File 'lib/aws-sdk-proton/client.rb', line 4292 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.
4337 4338 4339 4340 |
# File 'lib/aws-sdk-proton/client.rb', line 4337 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.
4420 4421 4422 4423 |
# File 'lib/aws-sdk-proton/client.rb', line 4420 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.
4463 4464 4465 4466 |
# File 'lib/aws-sdk-proton/client.rb', line 4463 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.
4505 4506 4507 4508 |
# File 'lib/aws-sdk-proton/client.rb', line 4505 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.
4566 4567 4568 4569 |
# File 'lib/aws-sdk-proton/client.rb', line 4566 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.
4612 4613 4614 4615 |
# File 'lib/aws-sdk-proton/client.rb', line 4612 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.
4657 4658 4659 4660 |
# File 'lib/aws-sdk-proton/client.rb', line 4657 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/resources.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4706 4707 4708 4709 |
# File 'lib/aws-sdk-proton/client.rb', line 4706 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self
4758 4759 4760 4761 |
# File 'lib/aws-sdk-proton/client.rb', line 4758 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
4810 4811 4812 4813 |
# File 'lib/aws-sdk-proton/client.rb', line 4810 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/resources.html
4850 4851 4852 4853 |
# File 'lib/aws-sdk-proton/client.rb', line 4850 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/resources.html
4886 4887 4888 4889 |
# File 'lib/aws-sdk-proton/client.rb', line 4886 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.
4953 4954 4955 4956 |
# File 'lib/aws-sdk-proton/client.rb', line 4953 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.
<note markdown=“1”> You can’t update a component while its deployment status, or the deployment status of a service instance attached to it, is ‘IN_PROGRESS`.
</note>
For more information about components, see [Proton components] in the *Proton User Guide*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
5077 5078 5079 5080 |
# File 'lib/aws-sdk-proton/client.rb', line 5077 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.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-environments.html [2]: docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html
5305 5306 5307 5308 |
# File 'lib/aws-sdk-proton/client.rb', line 5305 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*.
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
5381 5382 5383 5384 |
# File 'lib/aws-sdk-proton/client.rb', line 5381 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.
5426 5427 5428 5429 |
# File 'lib/aws-sdk-proton/client.rb', line 5426 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.
5482 5483 5484 5485 |
# File 'lib/aws-sdk-proton/client.rb', line 5482 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.
<note markdown=“1”> Existing service instances and the service pipeline *can’t* be edited using this API. They can only be deleted.
</note>
Use the ‘description` parameter to modify the description.
Edit the ‘spec` parameter to add or delete instances.
<note markdown=“1”> You can’t delete a service instance (remove it from the spec) if it has an attached component.
For more information about components, see [Proton components][1] in
the *Proton User Guide*.
</note>
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
5571 5572 5573 5574 |
# File 'lib/aws-sdk-proton/client.rb', line 5571 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.
<note markdown=“1”> You can’t update a service instance while its deployment status, or the deployment status of a component attached to it, is ‘IN_PROGRESS`.
For more information about components, see [Proton components][1] in
the *Proton User Guide*.
</note>
[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html
5692 5693 5694 5695 |
# File 'lib/aws-sdk-proton/client.rb', line 5692 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.
5825 5826 5827 5828 |
# File 'lib/aws-sdk-proton/client.rb', line 5825 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.
5870 5871 5872 5873 |
# File 'lib/aws-sdk-proton/client.rb', line 5870 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.
5920 5921 5922 5923 |
# File 'lib/aws-sdk-proton/client.rb', line 5920 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.
5965 5966 5967 5968 |
# File 'lib/aws-sdk-proton/client.rb', line 5965 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.
6057 6058 6059 6060 |
# File 'lib/aws-sdk-proton/client.rb', line 6057 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.
6115 6116 6117 6118 |
# File 'lib/aws-sdk-proton/client.rb', line 6115 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 |
6234 6235 6236 6237 6238 |
# File 'lib/aws-sdk-proton/client.rb', line 6234 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6242 6243 6244 |
# File 'lib/aws-sdk-proton/client.rb', line 6242 def waiter_names waiters.keys end |