AWS.OpsWorks

AWS OpsWorks

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.10. For more information, see Chef Versions.

You can still specify Chef 0.9 for your stack, but new features are not available for Chef 0.9 stacks, and support is scheduled to end on July 24, 2014. We do not recommend using Chef 0.9 for new stacks, and we recommend migrating your existing Chef 0.9 stacks to Chef 11.10 as soon as possible.

Summary

assign_instance(client, input, options \\ [])

Assign a registered instance to a layer

assign_volume(client, input, options \\ [])

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

associate_elastic_ip(client, input, options \\ [])

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

attach_elastic_load_balancer(client, input, options \\ [])

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing

clone_stack(client, input, options \\ [])

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

create_app(client, input, options \\ [])

Creates an app for a specified stack. For more information, see Creating Apps

create_deployment(client, input, options \\ [])

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands

create_instance(client, input, options \\ [])

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer

create_layer(client, input, options \\ [])

Creates a layer. For more information, see How to Create a Layer

create_stack(client, input, options \\ [])

Creates a new stack. For more information, see Create a New Stack

create_user_profile(client, input, options \\ [])

Creates a new user profile

delete_app(client, input, options \\ [])

Deletes a specified app

delete_instance(client, input, options \\ [])

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it

delete_layer(client, input, options \\ [])

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

delete_stack(client, input, options \\ [])

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

delete_user_profile(client, input, options \\ [])

Deletes a user profile

deregister_elastic_ip(client, input, options \\ [])

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management

deregister_instance(client, input, options \\ [])

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 can not be used with instances that were created with AWS OpsWorks

deregister_rds_db_instance(client, input, options \\ [])

Deregisters an Amazon RDS instance

deregister_volume(client, input, options \\ [])

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management

describe_agent_versions(client, input, options \\ [])

Describes the available AWS OpsWorks 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

describe_apps(client, input, options \\ [])

Requests a description of a specified set of apps

describe_commands(client, input, options \\ [])

Describes the results of specified commands

describe_deployments(client, input, options \\ [])

Requests a description of a specified set of deployments

describe_elastic_ips(client, input, options \\ [])

Describes Elastic IP addresses

describe_elastic_load_balancers(client, input, options \\ [])

Describes a stack's Elastic Load Balancing instances

describe_instances(client, input, options \\ [])

Requests a description of a set of instances

describe_layers(client, input, options \\ [])

Requests a description of one or more layers in a specified stack

describe_load_based_auto_scaling(client, input, options \\ [])

Describes load-based auto scaling configurations for specified layers

describe_my_user_profile(client, input, options \\ [])

Describes a user's SSH information

describe_permissions(client, input, options \\ [])

Describes the permissions for a specified stack

describe_raid_arrays(client, input, options \\ [])

Describe an instance's RAID arrays

describe_rds_db_instances(client, input, options \\ [])

Describes Amazon RDS instances

describe_service_errors(client, input, options \\ [])

Describes AWS OpsWorks service errors

describe_stack_provisioning_parameters(client, input, options \\ [])

Requests a description of a stack's provisioning parameters

describe_stack_summary(client, input, options \\ [])

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

describe_stacks(client, input, options \\ [])

Requests a description of one or more stacks

describe_time_based_auto_scaling(client, input, options \\ [])

Describes time-based auto scaling configurations for specified instances

describe_user_profiles(client, input, options \\ [])

Describe specified users

describe_volumes(client, input, options \\ [])

Describes an instance's Amazon EBS volumes

detach_elastic_load_balancer(client, input, options \\ [])

Detaches a specified Elastic Load Balancing instance from its layer

disassociate_elastic_ip(client, input, options \\ [])

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management

get_hostname_suggestion(client, input, options \\ [])

Gets a generated host name for the specified layer, based on the current host name theme

grant_access(client, input, options \\ []) This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period

reboot_instance(client, input, options \\ [])

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances

register_elastic_ip(client, input, options \\ [])

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

register_instance(client, input, options \\ [])

Registers instances with a specified stack that were created outside of AWS OpsWorks

register_rds_db_instance(client, input, options \\ [])

Registers an Amazon RDS instance with a stack

register_volume(client, input, options \\ [])

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

set_load_based_auto_scaling(client, input, options \\ [])

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances

set_permission(client, input, options \\ [])

Specifies a user's permissions. For more information, see Security and Permissions

set_time_based_auto_scaling(client, input, options \\ [])

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances

start_instance(client, input, options \\ [])

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances

start_stack(client, input, options \\ [])

Starts a stack's instances

stop_instance(client, input, options \\ [])

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

stop_stack(client, input, options \\ [])

Stops a specified stack

unassign_instance(client, input, options \\ [])

Unassigns a registered instance from all of it's layers. 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

unassign_volume(client, input, options \\ [])

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management

update_app(client, input, options \\ [])

Updates a specified app

update_elastic_ip(client, input, options \\ [])

Updates a registered Elastic IP address's name. For more information, see Resource Management

update_instance(client, input, options \\ [])

Updates a specified instance

update_layer(client, input, options \\ [])

Updates a specified layer

update_my_user_profile(client, input, options \\ [])

Updates a user's SSH public key

update_rds_db_instance(client, input, options \\ [])

Updates an Amazon RDS instance

update_stack(client, input, options \\ [])

Updates a specified stack

update_user_profile(client, input, options \\ [])

Updates a specified user profile

update_volume(client, input, options \\ [])

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management

Functions

assign_instance(client, input, options \\ [])

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.

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.

assign_volume(client, input, options \\ [])

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.

associate_elastic_ip(client, input, options \\ [])

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.

attach_elastic_load_balancer(client, input, options \\ [])

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

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.

clone_stack(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

create_app(client, input, options \\ [])

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.

create_deployment(client, input, options \\ [])

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.

create_instance(client, input, options \\ [])

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.

create_layer(client, input, options \\ [])

Creates a layer. For more information, see How to Create a Layer.

You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

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.

create_stack(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

create_user_profile(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

delete_app(client, input, options \\ [])

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.

delete_instance(client, input, options \\ [])

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.

delete_layer(client, input, options \\ [])

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.

delete_stack(client, input, options \\ [])

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.

delete_user_profile(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

deregister_elastic_ip(client, input, options \\ [])

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.

deregister_instance(client, input, options \\ [])

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 can not be used with instances that were created with AWS OpsWorks.

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.

deregister_rds_db_instance(client, input, options \\ [])

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.

deregister_volume(client, input, options \\ [])

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.

describe_agent_versions(client, input, options \\ [])

Describes the available AWS OpsWorks 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.

describe_apps(client, input, options \\ [])

Requests a description of a specified set of apps.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_commands(client, input, options \\ [])

Describes the results of specified commands.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_deployments(client, input, options \\ [])

Requests a description of a specified set of deployments.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_elastic_ips(client, input, options \\ [])

Describes Elastic IP addresses.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_elastic_load_balancers(client, input, options \\ [])

Describes a stack's Elastic Load Balancing instances.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_instances(client, input, options \\ [])

Requests a description of a set of instances.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_layers(client, input, options \\ [])

Requests a description of one or more layers in a specified stack.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_load_based_auto_scaling(client, input, options \\ [])

Describes load-based auto scaling configurations for specified layers.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_my_user_profile(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

describe_permissions(client, input, options \\ [])

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.

describe_raid_arrays(client, input, options \\ [])

Describe an instance's RAID arrays.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_rds_db_instances(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

describe_service_errors(client, input, options \\ [])

Describes AWS OpsWorks 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 on user permissions, see Managing User Permissions.

describe_stack_provisioning_parameters(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

describe_stack_summary(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

describe_stacks(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

describe_time_based_auto_scaling(client, input, options \\ [])

Describes time-based auto scaling configurations for specified instances.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

describe_user_profiles(client, input, options \\ [])

Describe specified users.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

describe_volumes(client, input, options \\ [])

Describes an instance's Amazon EBS volumes.

You must specify at least one of the 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 on user permissions, see Managing User Permissions.

detach_elastic_load_balancer(client, input, options \\ [])

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.

disassociate_elastic_ip(client, input, options \\ [])

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.

get_hostname_suggestion(client, input, options \\ [])

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.

grant_access(client, input, options \\ [])
This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

reboot_instance(client, input, options \\ [])

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.

register_elastic_ip(client, input, options \\ [])

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.

register_instance(client, input, options \\ [])

Registers instances with a specified stack that were created outside of AWS OpsWorks.

We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the 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 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.

register_rds_db_instance(client, input, options \\ [])

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.

register_volume(client, input, options \\ [])

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.

set_load_based_auto_scaling(client, input, options \\ [])

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

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.

set_permission(client, input, options \\ [])

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.

set_time_based_auto_scaling(client, input, options \\ [])

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.

start_instance(client, input, options \\ [])

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.

start_stack(client, input, options \\ [])

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.

stop_instance(client, input, options \\ [])

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.

stop_stack(client, input, options \\ [])

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.

unassign_instance(client, input, options \\ [])

Unassigns a registered instance from all of it's layers. 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.

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.

unassign_volume(client, input, options \\ [])

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.

update_app(client, input, options \\ [])

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.

update_elastic_ip(client, input, options \\ [])

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.

update_instance(client, input, options \\ [])

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.

update_layer(client, input, options \\ [])

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.

update_my_user_profile(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

update_rds_db_instance(client, input, options \\ [])

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.

update_stack(client, input, options \\ [])

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.

update_user_profile(client, input, options \\ [])

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 on user permissions, see Managing User Permissions.

update_volume(client, input, options \\ [])

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.