AWSOpsWorks (AWS SDK for Java

All Known Subinterfaces:

AWSOpsWorksAsync

All Known Implementing Classes:

AbstractAWSOpsWorks, AbstractAWSOpsWorksAsync, AWSOpsWorksAsyncClient, AWSOpsWorksClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSOpsWorks
```
Interface for accessing AWS OpsWorks.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSOpsWorks instead.

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.eu-west-1.amazonaws.com
- opsworks.eu-west-2.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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AssignInstanceResult`	`assignInstance(AssignInstanceRequest assignInstanceRequest)` Assign a registered instance to a layer.
`AssignVolumeResult`	`assignVolume(AssignVolumeRequest assignVolumeRequest)` Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
`AssociateElasticIpResult`	`associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)` Associates one of the stack's registered Elastic IP addresses with a specified instance.
`AttachElasticLoadBalancerResult`	`attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)` Attaches an Elastic Load Balancing load balancer to a specified layer.
`CloneStackResult`	`cloneStack(CloneStackRequest cloneStackRequest)` Creates a clone of a specified stack.
`CreateAppResult`	`createApp(CreateAppRequest createAppRequest)` Creates an app for a specified stack.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest createDeploymentRequest)` Runs deployment or stack commands.
`CreateInstanceResult`	`createInstance(CreateInstanceRequest createInstanceRequest)` Creates an instance in a specified stack.
`CreateLayerResult`	`createLayer(CreateLayerRequest createLayerRequest)` Creates a layer.
`CreateStackResult`	`createStack(CreateStackRequest createStackRequest)` Creates a new stack.
`CreateUserProfileResult`	`createUserProfile(CreateUserProfileRequest createUserProfileRequest)` Creates a new user profile.
`DeleteAppResult`	`deleteApp(DeleteAppRequest deleteAppRequest)` Deletes a specified app.
`DeleteInstanceResult`	`deleteInstance(DeleteInstanceRequest deleteInstanceRequest)` Deletes a specified instance, which terminates the associated Amazon EC2 instance.
`DeleteLayerResult`	`deleteLayer(DeleteLayerRequest deleteLayerRequest)` Deletes a specified layer.
`DeleteStackResult`	`deleteStack(DeleteStackRequest deleteStackRequest)` Deletes a specified stack.
`DeleteUserProfileResult`	`deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)` Deletes a user profile.
`DeregisterEcsClusterResult`	`deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest)` Deregisters a specified Amazon ECS cluster from a stack.
`DeregisterElasticIpResult`	`deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)` Deregisters a specified Elastic IP address.
`DeregisterInstanceResult`	`deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)` Deregister a registered Amazon EC2 or on-premises instance.
`DeregisterRdsDbInstanceResult`	`deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)` Deregisters an Amazon RDS instance.
`DeregisterVolumeResult`	`deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)` Deregisters an Amazon EBS volume.
`DescribeAgentVersionsResult`	`describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest)` Describes the available AWS OpsWorks Stacks agent versions.
`DescribeAppsResult`	`describeApps(DescribeAppsRequest describeAppsRequest)` Requests a description of a specified set of apps.
`DescribeCommandsResult`	`describeCommands(DescribeCommandsRequest describeCommandsRequest)` Describes the results of specified commands.
`DescribeDeploymentsResult`	`describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)` Requests a description of a specified set of deployments.
`DescribeEcsClustersResult`	`describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest)` Describes Amazon ECS clusters that are registered with a stack.
`DescribeElasticIpsResult`	`describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)` Describes Elastic IP addresses.
`DescribeElasticLoadBalancersResult`	`describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)` Describes a stack's Elastic Load Balancing instances.
`DescribeInstancesResult`	`describeInstances(DescribeInstancesRequest describeInstancesRequest)` Requests a description of a set of instances.
`DescribeLayersResult`	`describeLayers(DescribeLayersRequest describeLayersRequest)` Requests a description of one or more layers in a specified stack.
`DescribeLoadBasedAutoScalingResult`	`describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)` Describes load-based auto scaling configurations for specified layers.
`DescribeMyUserProfileResult`	`describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)` Describes a user's SSH information.
`DescribePermissionsResult`	`describePermissions(DescribePermissionsRequest describePermissionsRequest)` Describes the permissions for a specified stack.
`DescribeRaidArraysResult`	`describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)` Describe an instance's RAID arrays.
`DescribeRdsDbInstancesResult`	`describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)` Describes Amazon RDS instances.
`DescribeServiceErrorsResult`	`describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)` Describes AWS OpsWorks Stacks service errors.
`DescribeStackProvisioningParametersResult`	`describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest)` Requests a description of a stack's provisioning parameters.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest describeStacksRequest)` Requests a description of one or more stacks.
`DescribeStackSummaryResult`	`describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)` 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`.
`DescribeTimeBasedAutoScalingResult`	`describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)` Describes time-based auto scaling configurations for specified instances.
`DescribeUserProfilesResult`	`describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)` Describe specified users.
`DescribeVolumesResult`	`describeVolumes(DescribeVolumesRequest describeVolumesRequest)` Describes an instance's Amazon EBS volumes.
`DetachElasticLoadBalancerResult`	`detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)` Detaches a specified Elastic Load Balancing instance from its layer.
`DisassociateElasticIpResult`	`disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)` Disassociates an Elastic IP address from its instance.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetHostnameSuggestionResult`	`getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)` Gets a generated host name for the specified layer, based on the current host name theme.
`GrantAccessResult`	`grantAccess(GrantAccessRequest grantAccessRequest)`
`ListTagsResult`	`listTags(ListTagsRequest listTagsRequest)` Returns a list of tags that are applied to the specified stack or layer.
`RebootInstanceResult`	`rebootInstance(RebootInstanceRequest rebootInstanceRequest)` Reboots a specified instance.
`RegisterEcsClusterResult`	`registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest)` Registers a specified Amazon ECS cluster with a stack.
`RegisterElasticIpResult`	`registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)` Registers an Elastic IP address with a specified stack.
`RegisterInstanceResult`	`registerInstance(RegisterInstanceRequest registerInstanceRequest)` Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
`RegisterRdsDbInstanceResult`	`registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)` Registers an Amazon RDS instance with a stack.
`RegisterVolumeResult`	`registerVolume(RegisterVolumeRequest registerVolumeRequest)` Registers an Amazon EBS volume with a specified stack.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`SetLoadBasedAutoScalingResult`	`setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)` Specify the load-based auto scaling configuration for a specified layer.
`SetPermissionResult`	`setPermission(SetPermissionRequest setPermissionRequest)` Specifies a user's permissions.
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`SetTimeBasedAutoScalingResult`	`setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)` Specify the time-based auto scaling configuration for a specified instance.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartInstanceResult`	`startInstance(StartInstanceRequest startInstanceRequest)` Starts a specified instance.
`StartStackResult`	`startStack(StartStackRequest startStackRequest)` Starts a stack's instances.
`StopInstanceResult`	`stopInstance(StopInstanceRequest stopInstanceRequest)` Stops a specified instance.
`StopStackResult`	`stopStack(StopStackRequest stopStackRequest)` Stops a specified stack.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
`UnassignInstanceResult`	`unassignInstance(UnassignInstanceRequest unassignInstanceRequest)` Unassigns a registered instance from all of it's layers.
`UnassignVolumeResult`	`unassignVolume(UnassignVolumeRequest unassignVolumeRequest)` Unassigns an assigned Amazon EBS volume.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags from a specified stack or layer.
`UpdateAppResult`	`updateApp(UpdateAppRequest updateAppRequest)` Updates a specified app.
`UpdateElasticIpResult`	`updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)` Updates a registered Elastic IP address's name.
`UpdateInstanceResult`	`updateInstance(UpdateInstanceRequest updateInstanceRequest)` Updates a specified instance.
`UpdateLayerResult`	`updateLayer(UpdateLayerRequest updateLayerRequest)` Updates a specified layer.
`UpdateMyUserProfileResult`	`updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)` Updates a user's SSH public key.
`UpdateRdsDbInstanceResult`	`updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)` Updates an Amazon RDS instance.
`UpdateStackResult`	`updateStack(UpdateStackRequest updateStackRequest)` Updates a specified stack.
`UpdateUserProfileResult`	`updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)` Updates a specified user profile.
`UpdateVolumeResult`	`updateVolume(UpdateVolumeRequest updateVolumeRequest)` Updates an Amazon EBS volume's name or mount point.
`AWSOpsWorksWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://opsworks.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://opsworks.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://opsworks.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - assignInstance
```
AssignInstanceResult assignInstance(AssignInstanceRequest assignInstanceRequest)
```
    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.
    Parameters:
    
    assignInstanceRequest -
    
    Returns:
    
    Result of the AssignInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - assignVolume
```
AssignVolumeResult assignVolume(AssignVolumeRequest assignVolumeRequest)
```
    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.
    
    Parameters:
    
    assignVolumeRequest -
    
    Returns:
    
    Result of the AssignVolume operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - associateElasticIp
```
AssociateElasticIpResult associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)
```
    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.
    
    Parameters:
    
    associateElasticIpRequest -
    
    Returns:
    
    Result of the AssociateElasticIp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - attachElasticLoadBalancer
```
AttachElasticLoadBalancerResult attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
```
    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.
    
    Parameters:
    
    attachElasticLoadBalancerRequest -
    
    Returns:
    
    Result of the AttachElasticLoadBalancer operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - cloneStack
```
CloneStackResult cloneStack(CloneStackRequest cloneStackRequest)
```
    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.
    
    Parameters:
    
    cloneStackRequest -
    
    Returns:
    
    Result of the CloneStack operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - createApp
```
CreateAppResult createApp(CreateAppRequest createAppRequest)
```
    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.
    
    Parameters:
    
    createAppRequest -
    
    Returns:
    
    Result of the CreateApp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - createDeployment
```
CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
```
    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.
    
    Parameters:
    
    createDeploymentRequest -
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - createInstance
```
CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest)
```
    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.
    
    Parameters:
    
    createInstanceRequest -
    
    Returns:
    
    Result of the CreateInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - createLayer
```
CreateLayerResult createLayer(CreateLayerRequest createLayerRequest)
```
    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.
    
    Parameters:
    
    createLayerRequest -
    
    Returns:
    
    Result of the CreateLayer operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - createStack
```
CreateStackResult createStack(CreateStackRequest createStackRequest)
```
    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.
    
    Parameters:
    
    createStackRequest -
    
    Returns:
    
    Result of the CreateStack operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    See Also:
    
    AWS API Documentation
  - createUserProfile
```
CreateUserProfileResult createUserProfile(CreateUserProfileRequest createUserProfileRequest)
```
    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.
    
    Parameters:
    
    createUserProfileRequest -
    
    Returns:
    
    Result of the CreateUserProfile operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    See Also:
    
    AWS API Documentation
  - deleteApp
```
DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
```
    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.
    
    Parameters:
    
    deleteAppRequest -
    
    Returns:
    
    Result of the DeleteApp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteInstance
```
DeleteInstanceResult deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
```
    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.
    
    Parameters:
    
    deleteInstanceRequest -
    
    Returns:
    
    Result of the DeleteInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteLayer
```
DeleteLayerResult deleteLayer(DeleteLayerRequest deleteLayerRequest)
```
    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.
    
    Parameters:
    
    deleteLayerRequest -
    
    Returns:
    
    Result of the DeleteLayer operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteStack
```
DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)
```
    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.
    
    Parameters:
    
    deleteStackRequest -
    
    Returns:
    
    Result of the DeleteStack operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteUserProfile
```
DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
```
    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.
    
    Parameters:
    
    deleteUserProfileRequest -
    
    Returns:
    
    Result of the DeleteUserProfile operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deregisterEcsCluster
```
DeregisterEcsClusterResult deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest)
```
    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 http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
    
    Parameters:
    
    deregisterEcsClusterRequest -
    
    Returns:
    
    Result of the DeregisterEcsCluster operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deregisterElasticIp
```
DeregisterElasticIpResult deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
```
    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.
    
    Parameters:
    
    deregisterElasticIpRequest -
    
    Returns:
    
    Result of the DeregisterElasticIp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deregisterInstance
```
DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)
```
    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 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.
    
    Parameters:
    
    deregisterInstanceRequest -
    
    Returns:
    
    Result of the DeregisterInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deregisterRdsDbInstance
```
DeregisterRdsDbInstanceResult deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)
```
    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.
    
    Parameters:
    
    deregisterRdsDbInstanceRequest -
    
    Returns:
    
    Result of the DeregisterRdsDbInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deregisterVolume
```
DeregisterVolumeResult deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
```
    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.
    
    Parameters:
    
    deregisterVolumeRequest -
    
    Returns:
    
    Result of the DeregisterVolume operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeAgentVersions
```
DescribeAgentVersionsResult describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest)
```
    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.
    
    Parameters:
    
    describeAgentVersionsRequest -
    
    Returns:
    
    Result of the DescribeAgentVersions operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeApps
```
DescribeAppsResult describeApps(DescribeAppsRequest describeAppsRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeAppsRequest -
    
    Returns:
    
    Result of the DescribeApps operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeCommands
```
DescribeCommandsResult describeCommands(DescribeCommandsRequest describeCommandsRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeCommandsRequest -
    
    Returns:
    
    Result of the DescribeCommands operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeDeployments
```
DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeDeploymentsRequest -
    
    Returns:
    
    Result of the DescribeDeployments operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeEcsClusters
```
DescribeEcsClustersResult describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    This call accepts only one resource-identifying parameter.
    
    Parameters:
    
    describeEcsClustersRequest -
    
    Returns:
    
    Result of the DescribeEcsClusters operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeElasticIps
```
DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeElasticIpsRequest -
    
    Returns:
    
    Result of the DescribeElasticIps operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeElasticLoadBalancers
```
DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeElasticLoadBalancersRequest -
    
    Returns:
    
    Result of the DescribeElasticLoadBalancers operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeInstances
```
DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeInstancesRequest -
    
    Returns:
    
    Result of the DescribeInstances operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeLayers
```
DescribeLayersResult describeLayers(DescribeLayersRequest describeLayersRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeLayersRequest -
    
    Returns:
    
    Result of the DescribeLayers operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeLoadBasedAutoScaling
```
DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)
```
    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.
    
    Parameters:
    
    describeLoadBasedAutoScalingRequest -
    
    Returns:
    
    Result of the DescribeLoadBasedAutoScaling operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeMyUserProfile
```
DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)
```
    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.
    
    Parameters:
    
    describeMyUserProfileRequest -
    
    Returns:
    
    Result of the DescribeMyUserProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePermissions
```
DescribePermissionsResult describePermissions(DescribePermissionsRequest describePermissionsRequest)
```
    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.
    
    Parameters:
    
    describePermissionsRequest -
    
    Returns:
    
    Result of the DescribePermissions operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeRaidArrays
```
DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeRaidArraysRequest -
    
    Returns:
    
    Result of the DescribeRaidArrays operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeRdsDbInstances
```
DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)
```
    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.
    
    This call accepts only one resource-identifying parameter.
    
    Parameters:
    
    describeRdsDbInstancesRequest -
    
    Returns:
    
    Result of the DescribeRdsDbInstances operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeServiceErrors
```
DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    This call accepts only one resource-identifying parameter.
    
    Parameters:
    
    describeServiceErrorsRequest -
    
    Returns:
    
    Result of the DescribeServiceErrors operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeStackProvisioningParameters
```
DescribeStackProvisioningParametersResult describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest)
```
    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.
    
    Parameters:
    
    describeStackProvisioningParametersRequest -
    
    Returns:
    
    Result of the DescribeStackProvisioningParameters operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeStackSummary
```
DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)
```
    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.
    
    Parameters:
    
    describeStackSummaryRequest -
    
    Returns:
    
    Result of the DescribeStackSummary operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeStacks
```
DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
```
    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.
    
    Parameters:
    
    describeStacksRequest -
    
    Returns:
    
    Result of the DescribeStacks operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeTimeBasedAutoScaling
```
DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
```
    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.
    
    Parameters:
    
    describeTimeBasedAutoScalingRequest -
    
    Returns:
    
    Result of the DescribeTimeBasedAutoScaling operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeUserProfiles
```
DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
```
    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.
    
    Parameters:
    
    describeUserProfilesRequest -
    
    Returns:
    
    Result of the DescribeUserProfiles operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeVolumes
```
DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
```
    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 on user permissions, see Managing User Permissions.
    
    Parameters:
    
    describeVolumesRequest -
    
    Returns:
    
    Result of the DescribeVolumes operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - detachElasticLoadBalancer
```
DetachElasticLoadBalancerResult detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
```
    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.
    
    Parameters:
    
    detachElasticLoadBalancerRequest -
    
    Returns:
    
    Result of the DetachElasticLoadBalancer operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - disassociateElasticIp
```
DisassociateElasticIpResult disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)
```
    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.
    
    Parameters:
    
    disassociateElasticIpRequest -
    
    Returns:
    
    Result of the DisassociateElasticIp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - getHostnameSuggestion
```
GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
```
    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.
    
    Parameters:
    
    getHostnameSuggestionRequest -
    
    Returns:
    
    Result of the GetHostnameSuggestion operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - grantAccess
```
GrantAccessResult grantAccess(GrantAccessRequest grantAccessRequest)
```
    This action can be used only with Windows stacks.
    
    Grants RDP access to a Windows instance for a specified time period.
    
    Parameters:
    
    grantAccessRequest -
    
    Returns:
    
    Result of the GrantAccess operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
ListTagsResult listTags(ListTagsRequest listTagsRequest)
```
    Returns a list of tags that are applied to the specified stack or layer.
    
    Parameters:
    
    listTagsRequest -
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - rebootInstance
```
RebootInstanceResult rebootInstance(RebootInstanceRequest rebootInstanceRequest)
```
    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.
    
    Parameters:
    
    rebootInstanceRequest -
    
    Returns:
    
    Result of the RebootInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - registerEcsCluster
```
RegisterEcsClusterResult registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest)
```
    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.
    
    Parameters:
    
    registerEcsClusterRequest -
    
    Returns:
    
    Result of the RegisterEcsCluster operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - registerElasticIp
```
RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)
```
    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.
    
    Parameters:
    
    registerElasticIpRequest -
    
    Returns:
    
    Result of the RegisterElasticIp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - registerInstance
```
RegisterInstanceResult registerInstance(RegisterInstanceRequest registerInstanceRequest)
```
    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.
    
    Parameters:
    
    registerInstanceRequest -
    
    Returns:
    
    Result of the RegisterInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - registerRdsDbInstance
```
RegisterRdsDbInstanceResult registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)
```
    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.
    
    Parameters:
    
    registerRdsDbInstanceRequest -
    
    Returns:
    
    Result of the RegisterRdsDbInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - registerVolume
```
RegisterVolumeResult registerVolume(RegisterVolumeRequest registerVolumeRequest)
```
    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.
    
    Parameters:
    
    registerVolumeRequest -
    
    Returns:
    
    Result of the RegisterVolume operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - setLoadBasedAutoScaling
```
SetLoadBasedAutoScalingResult setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)
```
    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.
    
    Parameters:
    
    setLoadBasedAutoScalingRequest -
    
    Returns:
    
    Result of the SetLoadBasedAutoScaling operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - setPermission
```
SetPermissionResult setPermission(SetPermissionRequest setPermissionRequest)
```
    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.
    
    Parameters:
    
    setPermissionRequest -
    
    Returns:
    
    Result of the SetPermission operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - setTimeBasedAutoScaling
```
SetTimeBasedAutoScalingResult setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)
```
    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.
    
    Parameters:
    
    setTimeBasedAutoScalingRequest -
    
    Returns:
    
    Result of the SetTimeBasedAutoScaling operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - startInstance
```
StartInstanceResult startInstance(StartInstanceRequest startInstanceRequest)
```
    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.
    
    Parameters:
    
    startInstanceRequest -
    
    Returns:
    
    Result of the StartInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - startStack
```
StartStackResult startStack(StartStackRequest startStackRequest)
```
    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.
    
    Parameters:
    
    startStackRequest -
    
    Returns:
    
    Result of the StartStack operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - stopInstance
```
StopInstanceResult stopInstance(StopInstanceRequest stopInstanceRequest)
```
    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.
    
    Parameters:
    
    stopInstanceRequest -
    
    Returns:
    
    Result of the StopInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - stopStack
```
StopStackResult stopStack(StopStackRequest stopStackRequest)
```
    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.
    
    Parameters:
    
    stopStackRequest -
    
    Returns:
    
    Result of the StopStack operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - unassignInstance
```
UnassignInstanceResult unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
```
    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 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.
    
    Parameters:
    
    unassignInstanceRequest -
    
    Returns:
    
    Result of the UnassignInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - unassignVolume
```
UnassignVolumeResult unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
```
    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.
    
    Parameters:
    
    unassignVolumeRequest -
    
    Returns:
    
    Result of the UnassignVolume operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from a specified stack or layer.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateApp
```
UpdateAppResult updateApp(UpdateAppRequest updateAppRequest)
```
    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.
    
    Parameters:
    
    updateAppRequest -
    
    Returns:
    
    Result of the UpdateApp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateElasticIp
```
UpdateElasticIpResult updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
```
    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.
    
    Parameters:
    
    updateElasticIpRequest -
    
    Returns:
    
    Result of the UpdateElasticIp operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateInstance
```
UpdateInstanceResult updateInstance(UpdateInstanceRequest updateInstanceRequest)
```
    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.
    
    Parameters:
    
    updateInstanceRequest -
    
    Returns:
    
    Result of the UpdateInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateLayer
```
UpdateLayerResult updateLayer(UpdateLayerRequest updateLayerRequest)
```
    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.
    
    Parameters:
    
    updateLayerRequest -
    
    Returns:
    
    Result of the UpdateLayer operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateMyUserProfile
```
UpdateMyUserProfileResult updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)
```
    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.
    
    Parameters:
    
    updateMyUserProfileRequest -
    
    Returns:
    
    Result of the UpdateMyUserProfile operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    See Also:
    
    AWS API Documentation
  - updateRdsDbInstance
```
UpdateRdsDbInstanceResult updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)
```
    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.
    
    Parameters:
    
    updateRdsDbInstanceRequest -
    
    Returns:
    
    Result of the UpdateRdsDbInstance operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateStack
```
UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
```
    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.
    
    Parameters:
    
    updateStackRequest -
    
    Returns:
    
    Result of the UpdateStack operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateUserProfile
```
UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
```
    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.
    
    Parameters:
    
    updateUserProfileRequest -
    
    Returns:
    
    Result of the UpdateUserProfile operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateVolume
```
UpdateVolumeResult updateVolume(UpdateVolumeRequest updateVolumeRequest)
```
    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.
    
    Parameters:
    
    updateVolumeRequest -
    
    Returns:
    
    Result of the UpdateVolume operation returned by the service.
    
    Throws:
    
    ValidationException - Indicates that a request was not valid.
    
    ResourceNotFoundException - Indicates that a resource was not found.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AWSOpsWorksWaiters waiters()
```

Did this page help you?

Interface AWSOpsWorks

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

assignInstance

assignVolume

associateElasticIp

attachElasticLoadBalancer

cloneStack

createApp

createDeployment

createInstance

createLayer

createStack

createUserProfile

deleteApp

deleteInstance

deleteLayer

deleteStack

deleteUserProfile

deregisterEcsCluster

deregisterElasticIp

deregisterInstance

deregisterRdsDbInstance

deregisterVolume

describeAgentVersions

describeApps

describeCommands

describeDeployments

describeEcsClusters

describeElasticIps

describeElasticLoadBalancers

describeInstances

describeLayers

describeLoadBasedAutoScaling

describeMyUserProfile

describePermissions

describeRaidArrays

describeRdsDbInstances

describeServiceErrors

describeStackProvisioningParameters

describeStackSummary

describeStacks

describeTimeBasedAutoScaling

describeUserProfiles

describeVolumes

detachElasticLoadBalancer

disassociateElasticIp

getHostnameSuggestion

grantAccess

listTags

rebootInstance

registerEcsCluster

registerElasticIp

registerInstance

registerRdsDbInstance

registerVolume

setLoadBasedAutoScaling

setPermission

setTimeBasedAutoScaling

startInstance

startStack

stopInstance

stopStack

tagResource

unassignInstance

unassignVolume

untagResource

updateApp

updateElasticIp

updateInstance

updateLayer

updateMyUserProfile

updateRdsDbInstance

updateStack