aws_ops_works

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:

• AWS CLI

• AWS SDK for Java

• AWS SDK for .NET

• AWS SDK for PHP 2

• AWS SDK for Ruby

• AWS SDK for Node.js

• AWS SDK for Python(Boto)

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.

Summary

Functions

• assign_instance(Client, Input)
  Assign a registered instance to a layer.
• assign_instance(Client, Input, Options)
• assign_volume(Client, Input)
  Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
• assign_volume(Client, Input, Options)
• associate_elastic_ip(Client, Input)
  Associates one of the stack's registered Elastic IP addresses with a specified instance.
• associate_elastic_ip(Client, Input, Options)
• attach_elastic_load_balancer(Client, Input)
  Attaches an Elastic Load Balancing load balancer to a specified layer.
• attach_elastic_load_balancer(Client, Input, Options)
• clone_stack(Client, Input)
  Creates a clone of a specified stack.
• clone_stack(Client, Input, Options)
• create_app(Client, Input)
  Creates an app for a specified stack.
• create_app(Client, Input, Options)
• create_deployment(Client, Input)
  Runs deployment or stack commands.
• create_deployment(Client, Input, Options)
• create_instance(Client, Input)
  Creates an instance in a specified stack.
• create_instance(Client, Input, Options)
• create_layer(Client, Input)
  Creates a layer.
• create_layer(Client, Input, Options)
• create_stack(Client, Input)
  Creates a new stack.
• create_stack(Client, Input, Options)
• create_user_profile(Client, Input)
  Creates a new user profile.
• create_user_profile(Client, Input, Options)
• delete_app(Client, Input)
  Deletes a specified app.
• delete_app(Client, Input, Options)
• delete_instance(Client, Input)
  Deletes a specified instance, which terminates the associated Amazon EC2 instance.
• delete_instance(Client, Input, Options)
• delete_layer(Client, Input)
  Deletes a specified layer.
• delete_layer(Client, Input, Options)
• delete_stack(Client, Input)
  Deletes a specified stack.
• delete_stack(Client, Input, Options)
• delete_user_profile(Client, Input)
  Deletes a user profile.
• delete_user_profile(Client, Input, Options)
• deregister_ecs_cluster(Client, Input)
  Deregisters a specified Amazon ECS cluster from a stack.
• deregister_ecs_cluster(Client, Input, Options)
• deregister_elastic_ip(Client, Input)
  Deregisters a specified Elastic IP address.
• deregister_elastic_ip(Client, Input, Options)
• deregister_instance(Client, Input)
  Deregister a registered Amazon EC2 or on-premises instance.
• deregister_instance(Client, Input, Options)
• deregister_rds_db_instance(Client, Input)
  Deregisters an Amazon RDS instance.
• deregister_rds_db_instance(Client, Input, Options)
• deregister_volume(Client, Input)
  Deregisters an Amazon EBS volume.
• deregister_volume(Client, Input, Options)
• describe_agent_versions(Client, Input)
  Describes the available AWS OpsWorks Stacks agent versions.
• describe_agent_versions(Client, Input, Options)
• describe_apps(Client, Input)
  Requests a description of a specified set of apps.
• describe_apps(Client, Input, Options)
• describe_commands(Client, Input)
  Describes the results of specified commands.
• describe_commands(Client, Input, Options)
• describe_deployments(Client, Input)
  Requests a description of a specified set of deployments.
• describe_deployments(Client, Input, Options)
• describe_ecs_clusters(Client, Input)
  Describes Amazon ECS clusters that are registered with a stack.
• describe_ecs_clusters(Client, Input, Options)
• describe_elastic_ips(Client, Input)
  Describes Elastic IP addresses.
• describe_elastic_ips(Client, Input, Options)
• describe_elastic_load_balancers(Client, Input)
  Describes a stack's Elastic Load Balancing instances.
• describe_elastic_load_balancers(Client, Input, Options)
• describe_instances(Client, Input)
  Requests a description of a set of instances.
• describe_instances(Client, Input, Options)
• describe_layers(Client, Input)
  Requests a description of one or more layers in a specified stack.
• describe_layers(Client, Input, Options)
• describe_load_based_auto_scaling(Client, Input)
  Describes load-based auto scaling configurations for specified layers.
• describe_load_based_auto_scaling(Client, Input, Options)
• describe_my_user_profile(Client, Input)
  Describes a user's SSH information.
• describe_my_user_profile(Client, Input, Options)
• describe_operating_systems(Client, Input)
  Describes the operating systems that are supported by AWS OpsWorks Stacks.
• describe_operating_systems(Client, Input, Options)
• describe_permissions(Client, Input)
  Describes the permissions for a specified stack.
• describe_permissions(Client, Input, Options)
• describe_raid_arrays(Client, Input)
  Describe an instance's RAID arrays.
• describe_raid_arrays(Client, Input, Options)
• describe_rds_db_instances(Client, Input)
  Describes Amazon RDS instances.
• describe_rds_db_instances(Client, Input, Options)
• describe_service_errors(Client, Input)
  Describes AWS OpsWorks Stacks service errors.
• describe_service_errors(Client, Input, Options)
• describe_stack_provisioning_parameters(Client, Input)
  Requests a description of a stack's provisioning parameters.
• describe_stack_provisioning_parameters(Client, Input, Options)
• describe_stack_summary(Client, Input)
  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_stack_summary(Client, Input, Options)
• describe_stacks(Client, Input)
  Requests a description of one or more stacks.
• describe_stacks(Client, Input, Options)
• describe_time_based_auto_scaling(Client, Input)
  Describes time-based auto scaling configurations for specified instances.
• describe_time_based_auto_scaling(Client, Input, Options)
• describe_user_profiles(Client, Input)
  Describe specified users.
• describe_user_profiles(Client, Input, Options)
• describe_volumes(Client, Input)
  Describes an instance's Amazon EBS volumes.
• describe_volumes(Client, Input, Options)
• detach_elastic_load_balancer(Client, Input)
  Detaches a specified Elastic Load Balancing instance from its layer.
• detach_elastic_load_balancer(Client, Input, Options)
• disassociate_elastic_ip(Client, Input)
  Disassociates an Elastic IP address from its instance.
• disassociate_elastic_ip(Client, Input, Options)
• get_hostname_suggestion(Client, Input)
  Gets a generated host name for the specified layer, based on the current host name theme.
• get_hostname_suggestion(Client, Input, Options)
• grant_access(Client, Input)
  This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period.
• grant_access(Client, Input, Options)
• list_tags(Client, Input)
  Returns a list of tags that are applied to the specified stack or layer.
• list_tags(Client, Input, Options)
• reboot_instance(Client, Input)
  Reboots a specified instance.
• reboot_instance(Client, Input, Options)
• register_ecs_cluster(Client, Input)
  Registers a specified Amazon ECS cluster with a stack.
• register_ecs_cluster(Client, Input, Options)
• register_elastic_ip(Client, Input)
  Registers an Elastic IP address with a specified stack.
• register_elastic_ip(Client, Input, Options)
• register_instance(Client, Input)
  Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
• register_instance(Client, Input, Options)
• register_rds_db_instance(Client, Input)
  Registers an Amazon RDS instance with a stack.
• register_rds_db_instance(Client, Input, Options)
• register_volume(Client, Input)
  Registers an Amazon EBS volume with a specified stack.
• register_volume(Client, Input, Options)
• set_load_based_auto_scaling(Client, Input)
  Specify the load-based auto scaling configuration for a specified layer.
• set_load_based_auto_scaling(Client, Input, Options)
• set_permission(Client, Input)
  Specifies a user's permissions.
• set_permission(Client, Input, Options)
• set_time_based_auto_scaling(Client, Input)
  Specify the time-based auto scaling configuration for a specified instance.
• set_time_based_auto_scaling(Client, Input, Options)
• start_instance(Client, Input)
  Starts a specified instance.
• start_instance(Client, Input, Options)
• start_stack(Client, Input)
  Starts a stack's instances.
• start_stack(Client, Input, Options)
• stop_instance(Client, Input)
  Stops a specified instance.
• stop_instance(Client, Input, Options)
• stop_stack(Client, Input)
  Stops a specified stack.
• stop_stack(Client, Input, Options)
• tag_resource(Client, Input)
  Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
• tag_resource(Client, Input, Options)
• unassign_instance(Client, Input)
  Unassigns a registered instance from all layers that are using the instance.
• unassign_instance(Client, Input, Options)
• unassign_volume(Client, Input)
  Unassigns an assigned Amazon EBS volume.
• unassign_volume(Client, Input, Options)
• untag_resource(Client, Input)
  Removes tags from a specified stack or layer.
• untag_resource(Client, Input, Options)
• update_app(Client, Input)
  Updates a specified app.
• update_app(Client, Input, Options)
• update_elastic_ip(Client, Input)
  Updates a registered Elastic IP address's name.
• update_elastic_ip(Client, Input, Options)
• update_instance(Client, Input)
  Updates a specified instance.
• update_instance(Client, Input, Options)
• update_layer(Client, Input)
  Updates a specified layer.
• update_layer(Client, Input, Options)
• update_my_user_profile(Client, Input)
  Updates a user's SSH public key.
• update_my_user_profile(Client, Input, Options)
• update_rds_db_instance(Client, Input)
  Updates an Amazon RDS instance.
• update_rds_db_instance(Client, Input, Options)
• update_stack(Client, Input)
  Updates a specified stack.
• update_stack(Client, Input, Options)
• update_user_profile(Client, Input)
  Updates a specified user profile.
• update_user_profile(Client, Input, Options)
• update_volume(Client, Input)
  Updates an Amazon EBS volume's name or mount point.
• update_volume(Client, Input, Options)

Functions

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.

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.

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.

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.

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.

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

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

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

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

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

Creates a new user profile.

Deletes a specified app.

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.

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.

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.

Deletes a user profile.

Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

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

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.

Deregisters an Amazon RDS instance.

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

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.

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. 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.

Describes Elastic IP addresses.

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 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.

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.

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.

Describe specified users.

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. The address remains registered with the stack. For more information, see Resource Management.

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. Grants RDP access to a Windows instance for a specified time period.

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

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

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.

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.

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.

Registers an Amazon RDS instance with a stack.

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.

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

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

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

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

Starts a stack's instances.

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.

Stops a specified stack.

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.

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.

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

Removes tags from a specified stack or layer.

Updates a specified app.

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

Updates a specified instance.

Updates a specified layer.

Updates a user's SSH public key.

Updates an Amazon RDS instance.

Updates a specified stack.

Updates a specified user profile.

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