Amazon Web Services, Inc.

AWS OpsWorks

AWS OpsWorks Welcome to the AWS OpsWorks Stacks API Reference . This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 74

  • POSTAssignInstance/#X-Amz-Target=OpsWorks_20130218.AssignInstance<p>Assign a registered instance to a layer.</p> <ul> <li> <p>You can assign registered on-premises instances to any layer type.</p> </li> <li> <p>You can…
  • POSTAssignVolume/#X-Amz-Target=OpsWorks_20130218.AssignVolume<p>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…
  • POSTAssociateElasticIp/#X-Amz-Target=OpsWorks_20130218.AssociateElasticIp<p>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…
  • POSTAttachElasticLoadBalancer/#X-Amz-Target=OpsWorks_20130218.AttachElasticLoadBalancer<p>Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use…
  • POSTCloneStack/#X-Amz-Target=OpsWorks_20130218.CloneStack<p>Creates a clone of a specified stack. For more information, see <a…
  • POSTCreateApp/#X-Amz-Target=OpsWorks_20130218.CreateApp<p>Creates an app for a specified stack. For more information, see <a…
  • POSTCreateDeployment/#X-Amz-Target=OpsWorks_20130218.CreateDeployment<p>Runs deployment or stack commands. For more information, see <a…
  • POSTCreateInstance/#X-Amz-Target=OpsWorks_20130218.CreateInstance<p>Creates an instance in a specified stack. For more information, see <a…
  • POSTCreateLayer/#X-Amz-Target=OpsWorks_20130218.CreateLayer<p>Creates a layer. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html">How to Create a…
  • POSTCreateStack/#X-Amz-Target=OpsWorks_20130218.CreateStack<p>Creates a new stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html">Create a New…
  • POSTCreateUserProfile/#X-Amz-Target=OpsWorks_20130218.CreateUserProfile<p>Creates a new user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants…
  • POSTDeleteApp/#X-Amz-Target=OpsWorks_20130218.DeleteApp<p>Deletes a specified app.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an…
  • POSTDeleteInstance/#X-Amz-Target=OpsWorks_20130218.DeleteInstance<p>Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.</p> <p>For more…
  • POSTDeleteLayer/#X-Amz-Target=OpsWorks_20130218.DeleteLayer<p>Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see <a…
  • POSTDeleteStack/#X-Amz-Target=OpsWorks_20130218.DeleteStack<p>Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see <a…
  • POSTDeleteUserProfile/#X-Amz-Target=OpsWorks_20130218.DeleteUserProfile<p>Deletes a user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants…
  • POSTDeregisterEcsCluster/#X-Amz-Target=OpsWorks_20130218.DeregisterEcsCluster<p>Deregisters a specified Amazon ECS cluster from a stack. For more information, see <a…
  • POSTDeregisterElasticIp/#X-Amz-Target=OpsWorks_20130218.DeregisterElasticIp<p>Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see <a…
  • POSTDeregisterInstance/#X-Amz-Target=OpsWorks_20130218.DeregisterInstance<p>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…
  • POSTDeregisterRdsDbInstance/#X-Amz-Target=OpsWorks_20130218.DeregisterRdsDbInstance<p>Deregisters an Amazon RDS instance.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the…
  • POSTDeregisterVolume/#X-Amz-Target=OpsWorks_20130218.DeregisterVolume<p>Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see <a…
  • POSTDescribeAgentVersions/#X-Amz-Target=OpsWorks_20130218.DescribeAgentVersionsDescribes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. <code>DescribeAgentVersions</code> returns…
  • POSTDescribeApps/#X-Amz-Target=OpsWorks_20130218.DescribeApps<p>Requests a description of a specified set of apps.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required…
  • POSTDescribeCommands/#X-Amz-Target=OpsWorks_20130218.DescribeCommands<p>Describes the results of specified commands.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required…
  • POSTDescribeDeployments/#X-Amz-Target=OpsWorks_20130218.DescribeDeployments<p>Requests a description of a specified set of deployments.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p>…
  • POSTDescribeEcsClusters/#X-Amz-Target=OpsWorks_20130218.DescribeEcsClusters?MaxResults=string&NextToken=string<p>Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and…
  • POSTDescribeElasticIps/#X-Amz-Target=OpsWorks_20130218.DescribeElasticIps<p>Describes <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP addresses</a>.</p> <note> <p>This call…
  • POSTDescribeElasticLoadBalancers/#X-Amz-Target=OpsWorks_20130218.DescribeElasticLoadBalancers<p>Describes a stack's Elastic Load Balancing instances.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required…
  • POSTDescribeInstances/#X-Amz-Target=OpsWorks_20130218.DescribeInstances<p>Requests a description of a set of instances.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required…
  • POSTDescribeLayers/#X-Amz-Target=OpsWorks_20130218.DescribeLayers<p>Requests a description of one or more layers in a specified stack.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p>…
  • POSTDescribeLoadBasedAutoScaling/#X-Amz-Target=OpsWorks_20130218.DescribeLoadBasedAutoScaling<p>Describes load-based auto scaling configurations for specified layers.</p> <note> <p>You must specify at least one of the parameters.</p> </note> <p>…
  • POSTDescribeMyUserProfile/#X-Amz-Target=OpsWorks_20130218.DescribeMyUserProfile<p>Describes a user's SSH information.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached…
  • POSTDescribeOperatingSystems/#X-Amz-Target=OpsWorks_20130218.DescribeOperatingSystemsDescribes the operating systems that are supported by AWS OpsWorks Stacks.
  • POSTDescribePermissions/#X-Amz-Target=OpsWorks_20130218.DescribePermissions<p>Describes the permissions for a specified stack.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level…
  • POSTDescribeRaidArrays/#X-Amz-Target=OpsWorks_20130218.DescribeRaidArrays<p>Describe an instance's RAID arrays.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>:…
  • POSTDescribeRdsDbInstances/#X-Amz-Target=OpsWorks_20130218.DescribeRdsDbInstances<p>Describes Amazon RDS instances.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level…
  • POSTDescribeServiceErrors/#X-Amz-Target=OpsWorks_20130218.DescribeServiceErrors<p>Describes AWS OpsWorks Stacks service errors.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage…
  • POSTDescribeStackProvisioningParameters/#X-Amz-Target=OpsWorks_20130218.DescribeStackProvisioningParameters<p>Requests a description of a stack's provisioning parameters.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy,…
  • POSTDescribeStackSummary/#X-Amz-Target=OpsWorks_20130218.DescribeStackSummary<p>Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or…
  • POSTDescribeStacks/#X-Amz-Target=OpsWorks_20130218.DescribeStacks<p>Requests a description of one or more stacks.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage…
  • POSTDescribeTimeBasedAutoScaling/#X-Amz-Target=OpsWorks_20130218.DescribeTimeBasedAutoScaling<p>Describes time-based auto scaling configurations for specified instances.</p> <note> <p>You must specify at least one of the parameters.</p> </note> <p>…
  • POSTDescribeUserProfiles/#X-Amz-Target=OpsWorks_20130218.DescribeUserProfiles<p>Describe specified users.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants…
  • POSTDescribeVolumes/#X-Amz-Target=OpsWorks_20130218.DescribeVolumes<p>Describes an instance's Amazon EBS volumes.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required…
  • POSTDetachElasticLoadBalancer/#X-Amz-Target=OpsWorks_20130218.DetachElasticLoadBalancer<p>Detaches a specified Elastic Load Balancing instance from its layer.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a…
  • POSTDisassociateElasticIp/#X-Amz-Target=OpsWorks_20130218.DisassociateElasticIp<p>Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see <a…
  • POSTGetHostnameSuggestion/#X-Amz-Target=OpsWorks_20130218.GetHostnameSuggestion<p>Gets a generated host name for the specified layer, based on the current host name theme.</p> <p> <b>Required Permissions</b>: To use this action, an IAM…
  • POSTGrantAccess/#X-Amz-Target=OpsWorks_20130218.GrantAccess<note> <p>This action can be used only with Windows stacks.</p> </note> <p>Grants RDP access to a Windows instance for a specified time period.</p>
  • POSTListTags/#X-Amz-Target=OpsWorks_20130218.ListTagsReturns a list of tags that are applied to the specified stack or layer.
  • POSTRebootInstance/#X-Amz-Target=OpsWorks_20130218.RebootInstance<p>Reboots a specified instance. For more information, see <a…
  • POSTRegisterEcsCluster/#X-Amz-Target=OpsWorks_20130218.RegisterEcsCluster<p>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…
  • POSTRegisterElasticIp/#X-Amz-Target=OpsWorks_20130218.RegisterElasticIp<p>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,…
  • POSTRegisterInstance/#X-Amz-Target=OpsWorks_20130218.RegisterInstance<p>Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.</p> <note> <p>We do not recommend using this action to…
  • POSTRegisterRdsDbInstance/#X-Amz-Target=OpsWorks_20130218.RegisterRdsDbInstance<p>Registers an Amazon RDS instance with a stack.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level…
  • POSTRegisterVolume/#X-Amz-Target=OpsWorks_20130218.RegisterVolume<p>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…
  • POSTSetLoadBasedAutoScaling/#X-Amz-Target=OpsWorks_20130218.SetLoadBasedAutoScaling<p>Specify the load-based auto scaling configuration for a specified layer. For more information, see <a…
  • POSTSetPermission/#X-Amz-Target=OpsWorks_20130218.SetPermission<p>Specifies a user's permissions. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html">Security and…
  • POSTSetTimeBasedAutoScaling/#X-Amz-Target=OpsWorks_20130218.SetTimeBasedAutoScaling<p>Specify the time-based auto scaling configuration for a specified instance. For more information, see <a…
  • POSTStartInstance/#X-Amz-Target=OpsWorks_20130218.StartInstance<p>Starts a specified instance. For more information, see <a…
  • POSTStartStack/#X-Amz-Target=OpsWorks_20130218.StartStack<p>Starts a stack's instances.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an…
  • POSTStopInstance/#X-Amz-Target=OpsWorks_20130218.StopInstance<p>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…
  • POSTStopStack/#X-Amz-Target=OpsWorks_20130218.StopStack<p>Stops a specified stack.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an…
  • POSTTagResource/#X-Amz-Target=OpsWorks_20130218.TagResourceApply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see <a…
  • POSTUnassignInstance/#X-Amz-Target=OpsWorks_20130218.UnassignInstance<p>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…
  • POSTUnassignVolume/#X-Amz-Target=OpsWorks_20130218.UnassignVolume<p>Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see <a…
  • POSTUntagResource/#X-Amz-Target=OpsWorks_20130218.UntagResourceRemoves tags from a specified stack or layer.
  • POSTUpdateApp/#X-Amz-Target=OpsWorks_20130218.UpdateApp<p>Updates a specified app.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack,…
  • POSTUpdateElasticIp/#X-Amz-Target=OpsWorks_20130218.UpdateElasticIp<p>Updates a registered Elastic IP address's name. For more information, see <a…
  • POSTUpdateInstance/#X-Amz-Target=OpsWorks_20130218.UpdateInstance<p>Updates a specified instance.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or…
  • POSTUpdateLayer/#X-Amz-Target=OpsWorks_20130218.UpdateLayer<p>Updates a specified layer.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an…
  • POSTUpdateMyUserProfile/#X-Amz-Target=OpsWorks_20130218.UpdateMyUserProfile<p>Updates a user's SSH public key.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached…
  • POSTUpdateRdsDbInstance/#X-Amz-Target=OpsWorks_20130218.UpdateRdsDbInstance<p>Updates an Amazon RDS instance.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or…
  • POSTUpdateStack/#X-Amz-Target=OpsWorks_20130218.UpdateStack<p>Updates a specified stack.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an…
  • POSTUpdateUserProfile/#X-Amz-Target=OpsWorks_20130218.UpdateUserProfile<p>Updates a specified user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants…
  • POSTUpdateVolume/#X-Amz-Target=OpsWorks_20130218.UpdateVolume<p>Updates an Amazon EBS volume's name or mount point. For more information, see <a…

API details

Base URL
http://opsworks.{region}.amazonaws.com
https://opsworks.{region}.amazonaws.com
http://opsworks.{region}.amazonaws.com.cn
https://opsworks.{region}.amazonaws.com.cn
Authentication
An API key in the Authorization header
Operations
74 operations on 74 pathsPOST 74
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2013-02-18
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the AWS OpsWorks in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS OpsWorks collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “AssignInstance” (POST /#X-Amz-Target=OpsWorks_20130218.AssignInstance), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS OpsWorks?

AWS OpsWorks Welcome to the AWS OpsWorks Stacks API Reference . This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions… It is listed under Developer tools and has 74 endpoints.

Who publishes the AWS OpsWorks?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS OpsWorks?

Its description lists 4 base URLs: http://opsworks.{region}.amazonaws.com, https://opsworks.{region}.amazonaws.com, http://opsworks.{region}.amazonaws.com.cn, https://opsworks.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the AWS OpsWorks?

With an API key in the Authorization header.

How many endpoints does the AWS OpsWorks have?

74 operations on 74 paths (74 POST).

Is forking the AWS OpsWorks free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.