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 an instance from OpsWorks Stacks.
-
#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 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 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 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 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 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.
447 448 449 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 447 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 OpsWorks Stacks.
Required Permissions: To use this action, an 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.
493 494 495 496 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 493 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.
533 534 535 536 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 533 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.
572 573 574 575 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 572 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. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with 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.
619 620 621 622 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 619 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.
992 993 994 995 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 992 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.
1126 1127 1128 1129 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1126 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.
1210 1211 1212 1213 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1210 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.
1456 1457 1458 1459 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1456 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.
1669 1670 1671 1672 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 1669 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.
2036 2037 2038 2039 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2036 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.
2095 2096 2097 2098 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2095 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.
2126 2127 2128 2129 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2126 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.
2169 2170 2171 2172 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2169 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.
2203 2204 2205 2206 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2203 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.
2237 2238 2239 2240 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2237 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.
2268 2269 2270 2271 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2268 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.
2302 2303 2304 2305 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2302 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 be registered by another stack after it is deregistered. 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.
2336 2337 2338 2339 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2336 def deregister_elastic_ip(params = {}, = {}) req = build_request(:deregister_elastic_ip, params) req.send_request() end |
#deregister_instance(params = {}) ⇒ Struct
Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.
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.
2370 2371 2372 2373 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2370 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.
2401 2402 2403 2404 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2401 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.
2436 2437 2438 2439 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2436 def deregister_volume(params = {}, = {}) req = build_request(:deregister_volume, params) req.send_request() end |
#describe_agent_versions(params = {}) ⇒ Types::DescribeAgentVersionsResult
Describes the available 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.
2477 2478 2479 2480 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2477 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
2560 2561 2562 2563 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2560 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.
2626 2627 2628 2629 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2626 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
2701 2702 2703 2704 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2701 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, 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.
2774 2775 2776 2777 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2774 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.
2837 2838 2839 2840 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2837 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.
2897 2898 2899 2900 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 2897 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
3012 3013 3014 3015 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3012 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.
3125 3126 3127 3128 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3125 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.
3185 3186 3187 3188 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3185 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.
3216 3217 3218 3219 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3216 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 OpsWorks Stacks.
3244 3245 3246 3247 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3244 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.
3295 3296 3297 3298 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3295 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.
3362 3363 3364 3365 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3362 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.
3416 3417 3418 3419 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3416 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 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.
3476 3477 3478 3479 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3476 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.
3516 3517 3518 3519 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3516 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.
3580 3581 3582 3583 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3580 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.
3654 3655 3656 3657 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3654 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.
3712 3713 3714 3715 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3712 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.
3755 3756 3757 3758 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3755 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.
3829 3830 3831 3832 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3829 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.
3865 3866 3867 3868 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3865 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.
3899 3900 3901 3902 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3899 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.
3939 3940 3941 3942 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3939 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.
3981 3982 3983 3984 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 3981 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.
4023 4024 4025 4026 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4023 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.
4056 4057 4058 4059 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4056 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.
4101 4102 4103 4104 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4101 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.
4147 4148 4149 4150 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4147 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 OpsWorks Stacks with a specified stack.
RegisterInstance
handles only the second step. You
should instead use the CLI register
command, which performs the
entire registration operation. For more information, see Registering
an Instance with an 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.
4237 4238 4239 4240 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4237 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.
4280 4281 4282 4283 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4280 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.
4325 4326 4327 4328 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4325 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.
4400 4401 4402 4403 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4400 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.
4467 4468 4469 4470 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4467 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.
4527 4528 4529 4530 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4527 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.
4560 4561 4562 4563 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4560 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.
4591 4592 4593 4594 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4591 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.
4637 4638 4639 4640 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4637 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.
4668 4669 4670 4671 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4668 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 OpsWorks Stacks. For more information about how tagging works, see Tags in the OpsWorks User Guide.
4718 4719 4720 4721 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4718 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 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.
4752 4753 4754 4755 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4752 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.
4785 4786 4787 4788 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4785 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.
4811 4812 4813 4814 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4811 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.
4928 4929 4930 4931 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4928 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.
4965 4966 4967 4968 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 4965 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.
5131 5132 5133 5134 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5131 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.
5316 5317 5318 5319 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5316 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.
5347 5348 5349 5350 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5347 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.
5386 5387 5388 5389 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5386 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.
5672 5673 5674 5675 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5672 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.
5725 5726 5727 5728 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5725 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.
5766 5767 5768 5769 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5766 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 |
5886 5887 5888 5889 5890 |
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/client.rb', line 5886 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |