Class: Aws::OpsWorks::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::OpsWorks::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb
Overview
An API client for OpsWorks. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::OpsWorks::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
-
#assign_instance(params = {}) ⇒ Struct
Assign a registered instance to a layer.
-
#assign_volume(params = {}) ⇒ Struct
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
-
#associate_elastic_ip(params = {}) ⇒ Struct
Associates one of the stack's registered Elastic IP addresses with a specified instance.
-
#attach_elastic_load_balancer(params = {}) ⇒ Struct
Attaches an Elastic Load Balancing load balancer to a specified layer.
-
#clone_stack(params = {}) ⇒ Types::CloneStackResult
Creates a clone of a specified stack.
-
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates an app for a specified stack.
-
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResult
Runs deployment or stack commands.
-
#create_instance(params = {}) ⇒ Types::CreateInstanceResult
Creates an instance in a specified stack.
-
#create_layer(params = {}) ⇒ Types::CreateLayerResult
Creates a layer.
-
#create_stack(params = {}) ⇒ Types::CreateStackResult
Creates a new stack.
-
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResult
Creates a new user profile.
-
#delete_app(params = {}) ⇒ Struct
Deletes a specified app.
-
#delete_instance(params = {}) ⇒ Struct
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
-
#delete_layer(params = {}) ⇒ Struct
Deletes a specified layer.
-
#delete_stack(params = {}) ⇒ Struct
Deletes a specified stack.
-
#delete_user_profile(params = {}) ⇒ Struct
Deletes a user profile.
-
#deregister_ecs_cluster(params = {}) ⇒ Struct
Deregisters a specified Amazon ECS cluster from a stack.
-
#deregister_elastic_ip(params = {}) ⇒ Struct
Deregisters a specified Elastic IP address.
-
#deregister_instance(params = {}) ⇒ Struct
Deregister a registered Amazon EC2 or on-premises instance.
-
#deregister_rds_db_instance(params = {}) ⇒ Struct
Deregisters an Amazon RDS instance.
-
#deregister_volume(params = {}) ⇒ Struct
Deregisters an Amazon EBS volume.
-
#describe_agent_versions(params = {}) ⇒ Types::DescribeAgentVersionsResult
Describes the available AWS OpsWorks Stacks agent versions.
-
#describe_apps(params = {}) ⇒ Types::DescribeAppsResult
Requests a description of a specified set of apps.
-
#describe_commands(params = {}) ⇒ Types::DescribeCommandsResult
Describes the results of specified commands.
-
#describe_deployments(params = {}) ⇒ Types::DescribeDeploymentsResult
Requests a description of a specified set of deployments.
-
#describe_ecs_clusters(params = {}) ⇒ Types::DescribeEcsClustersResult
Describes Amazon ECS clusters that are registered with a stack.
-
#describe_elastic_ips(params = {}) ⇒ Types::DescribeElasticIpsResult
Describes [Elastic IP addresses][1].
-
#describe_elastic_load_balancers(params = {}) ⇒ Types::DescribeElasticLoadBalancersResult
Describes a stack's Elastic Load Balancing instances.
-
#describe_instances(params = {}) ⇒ Types::DescribeInstancesResult
Requests a description of a set of instances.
-
#describe_layers(params = {}) ⇒ Types::DescribeLayersResult
Requests a description of one or more layers in a specified stack.
-
#describe_load_based_auto_scaling(params = {}) ⇒ Types::DescribeLoadBasedAutoScalingResult
Describes load-based auto scaling configurations for specified layers.
-
#describe_my_user_profile(params = {}) ⇒ Types::DescribeMyUserProfileResult
Describes a user's SSH information.
-
#describe_operating_systems(params = {}) ⇒ Types::DescribeOperatingSystemsResponse
Describes the operating systems that are supported by AWS OpsWorks Stacks.
-
#describe_permissions(params = {}) ⇒ Types::DescribePermissionsResult
Describes the permissions for a specified stack.
-
#describe_raid_arrays(params = {}) ⇒ Types::DescribeRaidArraysResult
Describe an instance's RAID arrays.
-
#describe_rds_db_instances(params = {}) ⇒ Types::DescribeRdsDbInstancesResult
Describes Amazon RDS instances.
-
#describe_service_errors(params = {}) ⇒ Types::DescribeServiceErrorsResult
Describes AWS OpsWorks Stacks service errors.
-
#describe_stack_provisioning_parameters(params = {}) ⇒ Types::DescribeStackProvisioningParametersResult
Requests a description of a stack's provisioning parameters.
-
#describe_stack_summary(params = {}) ⇒ Types::DescribeStackSummaryResult
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup
oronline
. -
#describe_stacks(params = {}) ⇒ Types::DescribeStacksResult
Requests a description of one or more stacks.
-
#describe_time_based_auto_scaling(params = {}) ⇒ Types::DescribeTimeBasedAutoScalingResult
Describes time-based auto scaling configurations for specified instances.
-
#describe_user_profiles(params = {}) ⇒ Types::DescribeUserProfilesResult
Describe specified users.
-
#describe_volumes(params = {}) ⇒ Types::DescribeVolumesResult
Describes an instance's Amazon EBS volumes.
-
#detach_elastic_load_balancer(params = {}) ⇒ Struct
Detaches a specified Elastic Load Balancing instance from its layer.
-
#disassociate_elastic_ip(params = {}) ⇒ Struct
Disassociates an Elastic IP address from its instance.
-
#get_hostname_suggestion(params = {}) ⇒ Types::GetHostnameSuggestionResult
Gets a generated host name for the specified layer, based on the current host name theme.
-
#grant_access(params = {}) ⇒ Types::GrantAccessResult
This action can be used only with Windows stacks. -
#list_tags(params = {}) ⇒ Types::ListTagsResult
Returns a list of tags that are applied to the specified stack or layer.
-
#reboot_instance(params = {}) ⇒ Struct
Reboots a specified instance.
-
#register_ecs_cluster(params = {}) ⇒ Types::RegisterEcsClusterResult
Registers a specified Amazon ECS cluster with a stack.
-
#register_elastic_ip(params = {}) ⇒ Types::RegisterElasticIpResult
Registers an Elastic IP address with a specified stack.
-
#register_instance(params = {}) ⇒ Types::RegisterInstanceResult
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
-
#register_rds_db_instance(params = {}) ⇒ Struct
Registers an Amazon RDS instance with a stack.
-
#register_volume(params = {}) ⇒ Types::RegisterVolumeResult
Registers an Amazon EBS volume with a specified stack.
-
#set_load_based_auto_scaling(params = {}) ⇒ Struct
Specify the load-based auto scaling configuration for a specified layer.
-
#set_permission(params = {}) ⇒ Struct
Specifies a user's permissions.
-
#set_time_based_auto_scaling(params = {}) ⇒ Struct
Specify the time-based auto scaling configuration for a specified instance.
-
#start_instance(params = {}) ⇒ Struct
Starts a specified instance.
-
#start_stack(params = {}) ⇒ Struct
Starts a stack's instances.
-
#stop_instance(params = {}) ⇒ Struct
Stops a specified instance.
-
#stop_stack(params = {}) ⇒ Struct
Stops a specified stack.
-
#tag_resource(params = {}) ⇒ Struct
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
-
#unassign_instance(params = {}) ⇒ Struct
Unassigns a registered instance from all layers that are using the instance.
-
#unassign_volume(params = {}) ⇒ Struct
Unassigns an assigned Amazon EBS volume.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a specified stack or layer.
-
#update_app(params = {}) ⇒ Struct
Updates a specified app.
-
#update_elastic_ip(params = {}) ⇒ Struct
Updates a registered Elastic IP address's name.
-
#update_instance(params = {}) ⇒ Struct
Updates a specified instance.
-
#update_layer(params = {}) ⇒ Struct
Updates a specified layer.
-
#update_my_user_profile(params = {}) ⇒ Struct
Updates a user's SSH public key.
-
#update_rds_db_instance(params = {}) ⇒ Struct
Updates an Amazon RDS instance.
-
#update_stack(params = {}) ⇒ Struct
Updates a specified stack.
-
#update_user_profile(params = {}) ⇒ Struct
Updates a specified user profile.
-
#update_volume(params = {}) ⇒ Struct
Updates an Amazon EBS volume's name or mount point.
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.
334 335 336 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#assign_instance(params = {}) ⇒ Struct
Assign a registered instance to a layer.
You can assign registered on-premises instances to any layer type.
You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
380 381 382 383 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 380 def assign_instance(params = {}, = {}) req = build_request(:assign_instance, params) req.send_request() end |
#assign_volume(params = {}) ⇒ Struct
Assigns one of the stack's registered Amazon EBS volumes to a
specified instance. The volume must first be registered with the stack
by calling RegisterVolume. After you register the volume, you must
call UpdateVolume to specify a mount point before calling
AssignVolume
. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
420 421 422 423 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 420 def assign_volume(params = {}, = {}) req = build_request(:assign_volume, params) req.send_request() end |
#associate_elastic_ip(params = {}) ⇒ Struct
Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
459 460 461 462 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 459 def associate_elastic_ip(params = {}, = {}) req = build_request(:associate_elastic_ip, params) req.send_request() end |
#attach_elastic_load_balancer(params = {}) ⇒ Struct
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
506 507 508 509 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 506 def attach_elastic_load_balancer(params = {}, = {}) req = build_request(:attach_elastic_load_balancer, params) req.send_request() end |
#clone_stack(params = {}) ⇒ Types::CloneStackResult
Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
878 879 880 881 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 878 def clone_stack(params = {}, = {}) req = build_request(:clone_stack, params) req.send_request() end |
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1012 def create_app(params = {}, = {}) req = build_request(:create_app, params) req.send_request() end |
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResult
Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1096 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_instance(params = {}) ⇒ Types::CreateInstanceResult
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1338 def create_instance(params = {}, = {}) req = build_request(:create_instance, params) req.send_request() end |
#create_layer(params = {}) ⇒ Types::CreateLayerResult
Creates a layer. For more information, see How to Create a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
1550 1551 1552 1553 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1550 def create_layer(params = {}, = {}) req = build_request(:create_layer, params) req.send_request() end |
#create_stack(params = {}) ⇒ Types::CreateStackResult
Creates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
1916 1917 1918 1919 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1916 def create_stack(params = {}, = {}) req = build_request(:create_stack, params) req.send_request() end |
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResult
Creates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
1976 1977 1978 1979 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1976 def create_user_profile(params = {}, = {}) req = build_request(:create_user_profile, params) req.send_request() end |
#delete_app(params = {}) ⇒ Struct
Deletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2007 2008 2009 2010 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2007 def delete_app(params = {}, = {}) req = build_request(:delete_app, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Struct
Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2050 2051 2052 2053 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2050 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#delete_layer(params = {}) ⇒ Struct
Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2084 def delete_layer(params = {}, = {}) req = build_request(:delete_layer, params) req.send_request() end |
#delete_stack(params = {}) ⇒ Struct
Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2118 2119 2120 2121 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2118 def delete_stack(params = {}, = {}) req = build_request(:delete_stack, params) req.send_request() end |
#delete_user_profile(params = {}) ⇒ Struct
Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
2149 2150 2151 2152 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2149 def delete_user_profile(params = {}, = {}) req = build_request(:delete_user_profile, params) req.send_request() end |
#deregister_ecs_cluster(params = {}) ⇒ Struct
Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2183 def deregister_ecs_cluster(params = {}, = {}) req = build_request(:deregister_ecs_cluster, params) req.send_request() end |
#deregister_elastic_ip(params = {}) ⇒ Struct
Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2217 2218 2219 2220 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2217 def deregister_elastic_ip(params = {}, = {}) req = build_request(:deregister_elastic_ip, params) req.send_request() end |
#deregister_instance(params = {}) ⇒ Struct
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2251 def deregister_instance(params = {}, = {}) req = build_request(:deregister_instance, params) req.send_request() end |
#deregister_rds_db_instance(params = {}) ⇒ Struct
Deregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2282 2283 2284 2285 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2282 def deregister_rds_db_instance(params = {}, = {}) req = build_request(:deregister_rds_db_instance, params) req.send_request() end |
#deregister_volume(params = {}) ⇒ Struct
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
2317 2318 2319 2320 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2317 def deregister_volume(params = {}, = {}) req = build_request(:deregister_volume, params) req.send_request() end |
#describe_agent_versions(params = {}) ⇒ Types::DescribeAgentVersionsResult
Describes the available AWS OpsWorks Stacks agent versions. You must
specify a stack ID or a configuration manager. DescribeAgentVersions
returns a list of available agent versions for the specified stack or
configuration manager.
2358 2359 2360 2361 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2358 def describe_agent_versions(params = {}, = {}) req = build_request(:describe_agent_versions, params) req.send_request() end |
#describe_apps(params = {}) ⇒ Types::DescribeAppsResult
Requests a description of a specified set of apps.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- app_exists
2441 2442 2443 2444 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2441 def describe_apps(params = {}, = {}) req = build_request(:describe_apps, params) req.send_request() end |
#describe_commands(params = {}) ⇒ Types::DescribeCommandsResult
Describes the results of specified commands.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
2507 2508 2509 2510 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2507 def describe_commands(params = {}, = {}) req = build_request(:describe_commands, params) req.send_request() end |
#describe_deployments(params = {}) ⇒ Types::DescribeDeploymentsResult
Requests a description of a specified set of deployments.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- deployment_successful
2582 2583 2584 2585 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2582 def describe_deployments(params = {}, = {}) req = build_request(:describe_deployments, params) req.send_request() end |
#describe_ecs_clusters(params = {}) ⇒ Types::DescribeEcsClustersResult
Describes Amazon ECS clusters that are registered with a stack. If you
specify only a stack ID, you can use the MaxResults
and NextToken
parameters to paginate the response. However, AWS OpsWorks Stacks
currently supports only one cluster per layer, so the result set has a
maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2655 2656 2657 2658 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2655 def describe_ecs_clusters(params = {}, = {}) req = build_request(:describe_ecs_clusters, params) req.send_request() end |
#describe_elastic_ips(params = {}) ⇒ Types::DescribeElasticIpsResult
Describes Elastic IP addresses.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
2718 2719 2720 2721 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2718 def describe_elastic_ips(params = {}, = {}) req = build_request(:describe_elastic_ips, params) req.send_request() end |
#describe_elastic_load_balancers(params = {}) ⇒ Types::DescribeElasticLoadBalancersResult
Describes a stack's Elastic Load Balancing instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
2778 2779 2780 2781 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2778 def describe_elastic_load_balancers(params = {}, = {}) req = build_request(:describe_elastic_load_balancers, params) req.send_request() end |
#describe_instances(params = {}) ⇒ Types::DescribeInstancesResult
Requests a description of a set of instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- instance_online
- instance_registered
- instance_stopped
- instance_terminated
2893 2894 2895 2896 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2893 def describe_instances(params = {}, = {}) req = build_request(:describe_instances, params) req.send_request() end |
#describe_layers(params = {}) ⇒ Types::DescribeLayersResult
Requests a description of one or more layers in a specified stack.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3006 3007 3008 3009 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3006 def describe_layers(params = {}, = {}) req = build_request(:describe_layers, params) req.send_request() end |
#describe_load_based_auto_scaling(params = {}) ⇒ Types::DescribeLoadBasedAutoScalingResult
Describes load-based auto scaling configurations for specified layers.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3066 3067 3068 3069 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3066 def describe_load_based_auto_scaling(params = {}, = {}) req = build_request(:describe_load_based_auto_scaling, params) req.send_request() end |
#describe_my_user_profile(params = {}) ⇒ Types::DescribeMyUserProfileResult
Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3097 3098 3099 3100 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3097 def describe_my_user_profile(params = {}, = {}) req = build_request(:describe_my_user_profile, params) req.send_request() end |
#describe_operating_systems(params = {}) ⇒ Types::DescribeOperatingSystemsResponse
Describes the operating systems that are supported by AWS OpsWorks Stacks.
3126 3127 3128 3129 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3126 def (params = {}, = {}) req = build_request(:describe_operating_systems, params) req.send_request() end |
#describe_permissions(params = {}) ⇒ Types::DescribePermissionsResult
Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
3177 3178 3179 3180 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3177 def (params = {}, = {}) req = build_request(:describe_permissions, params) req.send_request() end |
#describe_raid_arrays(params = {}) ⇒ Types::DescribeRaidArraysResult
Describe an instance's RAID arrays.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3244 3245 3246 3247 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3244 def describe_raid_arrays(params = {}, = {}) req = build_request(:describe_raid_arrays, params) req.send_request() end |
#describe_rds_db_instances(params = {}) ⇒ Types::DescribeRdsDbInstancesResult
Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
3298 3299 3300 3301 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3298 def describe_rds_db_instances(params = {}, = {}) req = build_request(:describe_rds_db_instances, params) req.send_request() end |
#describe_service_errors(params = {}) ⇒ Types::DescribeServiceErrorsResult
Describes AWS OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
3358 3359 3360 3361 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3358 def describe_service_errors(params = {}, = {}) req = build_request(:describe_service_errors, params) req.send_request() end |
#describe_stack_provisioning_parameters(params = {}) ⇒ Types::DescribeStackProvisioningParametersResult
Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3398 3399 3400 3401 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3398 def describe_stack_provisioning_parameters(params = {}, = {}) req = build_request(:describe_stack_provisioning_parameters, params) req.send_request() end |
#describe_stack_summary(params = {}) ⇒ Types::DescribeStackSummaryResult
Describes the number of layers and apps in a specified stack, and the
number of instances in each state, such as running_setup
or
online
.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3462 3463 3464 3465 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3462 def describe_stack_summary(params = {}, = {}) req = build_request(:describe_stack_summary, params) req.send_request() end |
#describe_stacks(params = {}) ⇒ Types::DescribeStacksResult
Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3532 3533 3534 3535 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3532 def describe_stacks(params = {}, = {}) req = build_request(:describe_stacks, params) req.send_request() end |
#describe_time_based_auto_scaling(params = {}) ⇒ Types::DescribeTimeBasedAutoScalingResult
Describes time-based auto scaling configurations for specified instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3590 3591 3592 3593 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3590 def describe_time_based_auto_scaling(params = {}, = {}) req = build_request(:describe_time_based_auto_scaling, params) req.send_request() end |
#describe_user_profiles(params = {}) ⇒ Types::DescribeUserProfilesResult
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3633 3634 3635 3636 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3633 def describe_user_profiles(params = {}, = {}) req = build_request(:describe_user_profiles, params) req.send_request() end |
#describe_volumes(params = {}) ⇒ Types::DescribeVolumesResult
Describes an instance's Amazon EBS volumes.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
3707 3708 3709 3710 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3707 def describe_volumes(params = {}, = {}) req = build_request(:describe_volumes, params) req.send_request() end |
#detach_elastic_load_balancer(params = {}) ⇒ Struct
Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
3743 3744 3745 3746 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3743 def detach_elastic_load_balancer(params = {}, = {}) req = build_request(:detach_elastic_load_balancer, params) req.send_request() end |
#disassociate_elastic_ip(params = {}) ⇒ Struct
Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
3777 3778 3779 3780 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3777 def disassociate_elastic_ip(params = {}, = {}) req = build_request(:disassociate_elastic_ip, params) req.send_request() end |
#get_hostname_suggestion(params = {}) ⇒ Types::GetHostnameSuggestionResult
Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
3817 3818 3819 3820 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3817 def get_hostname_suggestion(params = {}, = {}) req = build_request(:get_hostname_suggestion, params) req.send_request() end |
#grant_access(params = {}) ⇒ Types::GrantAccessResult
Grants RDP access to a Windows instance for a specified time period.
3859 3860 3861 3862 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3859 def grant_access(params = {}, = {}) req = build_request(:grant_access, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResult
Returns a list of tags that are applied to the specified stack or layer.
3901 3902 3903 3904 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3901 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#reboot_instance(params = {}) ⇒ Struct
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
3934 3935 3936 3937 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3934 def reboot_instance(params = {}, = {}) req = build_request(:reboot_instance, params) req.send_request() end |
#register_ecs_cluster(params = {}) ⇒ Types::RegisterEcsClusterResult
Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
3979 3980 3981 3982 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3979 def register_ecs_cluster(params = {}, = {}) req = build_request(:register_ecs_cluster, params) req.send_request() end |
#register_elastic_ip(params = {}) ⇒ Types::RegisterElasticIpResult
Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4025 4026 4027 4028 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4025 def register_elastic_ip(params = {}, = {}) req = build_request(:register_elastic_ip, params) req.send_request() end |
#register_instance(params = {}) ⇒ Types::RegisterInstanceResult
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
RegisterInstance
handles only the second step. You
should instead use the AWS CLI register
command, which performs the
entire registration operation. For more information, see Registering
an Instance with an AWS OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4110 4111 4112 4113 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4110 def register_instance(params = {}, = {}) req = build_request(:register_instance, params) req.send_request() end |
#register_rds_db_instance(params = {}) ⇒ Struct
Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4153 4154 4155 4156 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4153 def register_rds_db_instance(params = {}, = {}) req = build_request(:register_rds_db_instance, params) req.send_request() end |
#register_volume(params = {}) ⇒ Types::RegisterVolumeResult
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4198 4199 4200 4201 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4198 def register_volume(params = {}, = {}) req = build_request(:register_volume, params) req.send_request() end |
#set_load_based_auto_scaling(params = {}) ⇒ Struct
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4273 4274 4275 4276 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4273 def set_load_based_auto_scaling(params = {}, = {}) req = build_request(:set_load_based_auto_scaling, params) req.send_request() end |
#set_permission(params = {}) ⇒ Struct
Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4340 4341 4342 4343 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4340 def (params = {}, = {}) req = build_request(:set_permission, params) req.send_request() end |
#set_time_based_auto_scaling(params = {}) ⇒ Struct
Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4400 4401 4402 4403 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4400 def set_time_based_auto_scaling(params = {}, = {}) req = build_request(:set_time_based_auto_scaling, params) req.send_request() end |
#start_instance(params = {}) ⇒ Struct
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4433 4434 4435 4436 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4433 def start_instance(params = {}, = {}) req = build_request(:start_instance, params) req.send_request() end |
#start_stack(params = {}) ⇒ Struct
Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4464 4465 4466 4467 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4464 def start_stack(params = {}, = {}) req = build_request(:start_stack, params) req.send_request() end |
#stop_instance(params = {}) ⇒ Struct
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4510 4511 4512 4513 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4510 def stop_instance(params = {}, = {}) req = build_request(:stop_instance, params) req.send_request() end |
#stop_stack(params = {}) ⇒ Struct
Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4541 4542 4543 4544 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4541 def stop_stack(params = {}, = {}) req = build_request(:stop_stack, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
4591 4592 4593 4594 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4591 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#unassign_instance(params = {}) ⇒ Struct
Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
4625 4626 4627 4628 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4625 def unassign_instance(params = {}, = {}) req = build_request(:unassign_instance, params) req.send_request() end |
#unassign_volume(params = {}) ⇒ Struct
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4658 4659 4660 4661 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4658 def unassign_volume(params = {}, = {}) req = build_request(:unassign_volume, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a specified stack or layer.
4684 4685 4686 4687 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4684 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app(params = {}) ⇒ Struct
Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4801 4802 4803 4804 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4801 def update_app(params = {}, = {}) req = build_request(:update_app, params) req.send_request() end |
#update_elastic_ip(params = {}) ⇒ Struct
Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
4838 4839 4840 4841 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4838 def update_elastic_ip(params = {}, = {}) req = build_request(:update_elastic_ip, params) req.send_request() end |
#update_instance(params = {}) ⇒ Struct
Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
5000 5001 5002 5003 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5000 def update_instance(params = {}, = {}) req = build_request(:update_instance, params) req.send_request() end |
#update_layer(params = {}) ⇒ Struct
Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
5184 5185 5186 5187 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5184 def update_layer(params = {}, = {}) req = build_request(:update_layer, params) req.send_request() end |
#update_my_user_profile(params = {}) ⇒ Struct
Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
5215 5216 5217 5218 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5215 def update_my_user_profile(params = {}, = {}) req = build_request(:update_my_user_profile, params) req.send_request() end |
#update_rds_db_instance(params = {}) ⇒ Struct
Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
5254 5255 5256 5257 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5254 def update_rds_db_instance(params = {}, = {}) req = build_request(:update_rds_db_instance, params) req.send_request() end |
#update_stack(params = {}) ⇒ Struct
Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
5539 5540 5541 5542 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5539 def update_stack(params = {}, = {}) req = build_request(:update_stack, params) req.send_request() end |
#update_user_profile(params = {}) ⇒ Struct
Updates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
5593 5594 5595 5596 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5593 def update_user_profile(params = {}, = {}) req = build_request(:update_user_profile, params) req.send_request() end |
#update_volume(params = {}) ⇒ Struct
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
5634 5635 5636 5637 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5634 def update_volume(params = {}, = {}) req = build_request(:update_volume, 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 |
---|---|---|---|
app_exists | #describe_apps | 1 | 40 |
deployment_successful | #describe_deployments | 15 | 40 |
instance_online | #describe_instances | 15 | 40 |
instance_registered | #describe_instances | 15 | 40 |
instance_stopped | #describe_instances | 15 | 40 |
instance_terminated | #describe_instances | 15 | 40 |
5749 5750 5751 5752 5753 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5749 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |