AWS.OpsWorks (aws-elixir v0.8.0) View Source

AWS OpsWorks

Welcome to the AWS OpsWorks Stacks API Reference.

This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.

AWS OpsWorks Stacks 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 Stacks 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 Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.

  • opsworks.us-east-1.amazonaws.com

  • opsworks.us-east-2.amazonaws.com

  • opsworks.us-west-1.amazonaws.com

  • opsworks.us-west-2.amazonaws.com

  • opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)

  • opsworks.eu-west-1.amazonaws.com

  • opsworks.eu-west-2.amazonaws.com

  • opsworks.eu-west-3.amazonaws.com

  • opsworks.eu-central-1.amazonaws.com

  • opsworks.ap-northeast-1.amazonaws.com

  • opsworks.ap-northeast-2.amazonaws.com

  • opsworks.ap-south-1.amazonaws.com

  • opsworks.ap-southeast-1.amazonaws.com

  • opsworks.ap-southeast-2.amazonaws.com

  • opsworks.sa-east-1.amazonaws.com

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

Link to this section Summary

Functions

Assign a registered instance to a layer.

Assigns one of the stack's registered Amazon EBS volumes to a specified instance.

Associates one of the stack's registered Elastic IP addresses with a specified instance.

Attaches an Elastic Load Balancing load balancer to a specified layer.

Creates a clone of a specified stack.

Creates an app for a specified stack.

Runs deployment or stack commands.

Creates an instance in a specified stack.

Deletes a specified app.

Deletes a specified instance, which terminates the associated Amazon EC2 instance.

Deletes a specified layer.

Deletes a specified stack.

Deregisters a specified Amazon ECS cluster from a stack.

Deregisters a specified Elastic IP address.

Deregister a registered Amazon EC2 or on-premises instance.

Deregisters an Amazon RDS instance.

Deregisters an Amazon EBS volume.

Describes the available AWS OpsWorks Stacks agent versions.

Requests a description of a specified set of apps.

Describes the results of specified commands.

Requests a description of a specified set of deployments.

Describes Amazon ECS clusters that are registered with a stack.

Describes a stack's Elastic Load Balancing instances.

Requests a description of a set of instances.

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

Describes load-based auto scaling configurations for specified layers.

Describes a user's SSH information.

Describes the operating systems that are supported by AWS OpsWorks Stacks.

Describes the permissions for a specified stack.

Describe an instance's RAID arrays.

Describes AWS OpsWorks Stacks service errors.

Requests a description of a stack's provisioning parameters.

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.

Requests a description of one or more stacks.

Describes time-based auto scaling configurations for specified instances.

Describes an instance's Amazon EBS volumes.

Detaches a specified Elastic Load Balancing instance from its layer.

Disassociates an Elastic IP address from its instance.

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

This action can be used only with Windows stacks.

Returns a list of tags that are applied to the specified stack or layer.

Reboots a specified instance.

Registers a specified Amazon ECS cluster with a stack.

Registers an Elastic IP address with a specified stack.

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

Registers an Amazon RDS instance with a stack.

Registers an Amazon EBS volume with a specified stack.

Specify the load-based auto scaling configuration for a specified layer.

Specifies a user's permissions.

Specify the time-based auto scaling configuration for a specified instance.

Starts a specified instance.

Starts a stack's instances.

Stops a specified instance.

Stops a specified stack.

Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.

Unassigns a registered instance from all layers that are using the instance.

Unassigns an assigned Amazon EBS volume.

Removes tags from a specified stack or layer.

Updates a specified app.

Updates a registered Elastic IP address's name.

Updates a specified instance.

Updates a specified layer.

Updates a user's SSH public key.

Updates a specified stack.

Updates a specified user profile.

Updates an Amazon EBS volume's name or mount point.

Link to this section Functions

Link to this function

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

View Source

Assign a registered instance to a layer.

  • You can assign registered on-premises instances to any layer type.

  • You can assign registered Amazon EC2 instances only to custom layers.

  • You cannot use this action with instances that were created with AWS OpsWorks Stacks.

Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Attaches an Elastic Load Balancing load balancer to a specified layer.

AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Deregister a registered Amazon EC2 or on-premises instance.

This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Describes the available AWS OpsWorks Stacks agent versions.

You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

Link to this function

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

View Source

Requests a description of a specified set of apps.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

Describes the results of specified commands.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

Requests a description of a specified set of deployments.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

Describes Amazon ECS clusters that are registered with a stack.

If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Link to this function

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

View Source

Describes Elastic IP addresses.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

Describes a stack's Elastic Load Balancing instances.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

Requests a description of a set of instances.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

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

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

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

Link to this function

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

View Source

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.

Link to this function

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

View Source

Describes the operating systems that are supported by AWS OpsWorks Stacks.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Describe an instance's RAID arrays.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Describes AWS OpsWorks Stacks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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

Link to this function

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

View Source

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.

Link to this function

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

View Source

Describes an instance's Amazon EBS volumes.

This call accepts only one resource-identifying parameter.

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

This action can be used only with Windows stacks.

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

Link to this function

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

View Source

Returns a list of tags that are applied to the specified stack or layer.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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

We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks 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 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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.

For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.

Link to this function

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

View Source

Unassigns a registered instance from all layers that are using the instance.

The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Removes tags from a specified stack or layer.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.