AWSOpsWorksClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.opsworks.AWSOpsWorksClient

All Implemented Interfaces:

AWSOpsWorks

Direct Known Subclasses:

AWSOpsWorksAsyncClient
```
public class AWSOpsWorksClient
extends AmazonWebServiceClient
implements AWSOpsWorks
```
Client for accessing AWSOpsWorks. All service calls made using this client are blocking, and will not return until the service call completes.
AWS OpsWorks
Welcome to the AWS OpsWorks API Reference . This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

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

Endpoints

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

Chef Version

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version, 0.9 or 11.4. The default value is currently 0.9. However, we expect to change the default value to 11.4 in September 2013.

Constructor Summary

Constructors
Constructor and Description
`AWSOpsWorksClient()` Constructs a new client to invoke service methods on AWSOpsWorks.
`AWSOpsWorksClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials.
`AWSOpsWorksClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials and client configuration options.
`AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials provider.
`AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials provider and client configuration options.
`AWSOpsWorksClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AWSOpsWorks.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`assignVolume(AssignVolumeRequest assignVolumeRequest)` Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
`void`	`associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)` Associates one of the stack's registered Elastic IP addresses with a specified instance.
`void`	`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)` Deploys a stack or app.
`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.
`void`	`deleteApp(DeleteAppRequest deleteAppRequest)` Deletes a specified app.
`void`	`deleteInstance(DeleteInstanceRequest deleteInstanceRequest)` Deletes a specified instance.
`void`	`deleteLayer(DeleteLayerRequest deleteLayerRequest)` Deletes a specified layer.
`void`	`deleteStack(DeleteStackRequest deleteStackRequest)` Deletes a specified stack.
`void`	`deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)` Deletes a user profile.
`void`	`deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)` Deregisters a specified Elastic IP address.
`void`	`deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)` Deregisters an Amazon EBS volume.
`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.
`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.
`DescribePermissionsResult`	`describePermissions(DescribePermissionsRequest describePermissionsRequest)` Describes the permissions for a specified stack.
`DescribeRaidArraysResult`	`describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)` Describe an instance's RAID arrays.
`DescribeServiceErrorsResult`	`describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)` Describes AWS OpsWorks service errors.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest describeStacksRequest)` Requests a description of one or more stacks.
`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.
`void`	`detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)` Detaches a specified Elastic Load Balancing instance from its layer.
`void`	`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.
`void`	`rebootInstance(RebootInstanceRequest rebootInstanceRequest)` Reboots a specified instance.
`RegisterElasticIpResult`	`registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)` Registers an Elastic IP address with a specified stack.
`RegisterVolumeResult`	`registerVolume(RegisterVolumeRequest registerVolumeRequest)` Registers an Amazon EBS volume with a specified stack.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client.
`void`	`setEndpoint(String endpoint, String serviceName, String regionId)` Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.
`void`	`setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)` Specify the load-based auto scaling configuration for a specified layer.
`void`	`setPermission(SetPermissionRequest setPermissionRequest)` Specifies a stack's permissions.
`void`	`setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)` Specify the time-based auto scaling configuration for a specified instance.
`void`	`startInstance(StartInstanceRequest startInstanceRequest)` Starts a specified instance.
`void`	`startStack(StartStackRequest startStackRequest)` Starts stack's instances.
`void`	`stopInstance(StopInstanceRequest stopInstanceRequest)` Stops a specified instance.
`void`	`stopStack(StopStackRequest stopStackRequest)` Stops a specified stack.
`void`	`unassignVolume(UnassignVolumeRequest unassignVolumeRequest)` Unassigns an assigned Amazon EBS volume.
`void`	`updateApp(UpdateAppRequest updateAppRequest)` Updates a specified app.
`void`	`updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)` Updates a registered Elastic IP address's name.
`void`	`updateInstance(UpdateInstanceRequest updateInstanceRequest)` Updates a specified instance.
`void`	`updateLayer(UpdateLayerRequest updateLayerRequest)` Updates a specified layer.
`void`	`updateStack(UpdateStackRequest updateStackRequest)` Updates a specified stack.
`void`	`updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)` Updates a specified user profile.
`void`	`updateVolume(UpdateVolumeRequest updateVolumeRequest)` Updates an Amazon EBS volume's name or mount point.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setRegion, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.opsworks.AWSOpsWorks
setRegion, shutdown

- Constructor Detail
  - AWSOpsWorksClient
```
public AWSOpsWorksClient()
```
    Constructs a new client to invoke service methods on AWSOpsWorks. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    DefaultAWSCredentialsProviderChain
  - AWSOpsWorksClient
```
public AWSOpsWorksClient(ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AWSOpsWorks. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    clientConfiguration - The client configuration options controlling how this client connects to AWSOpsWorks (ex: proxy settings, retry counts, etc.).
    See Also:
    DefaultAWSCredentialsProviderChain
  - AWSOpsWorksClient
```
public AWSOpsWorksClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSOpsWorksClient
```
public AWSOpsWorksClient(AWSCredentials awsCredentials,
                 ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to AWSOpsWorks (ex: proxy settings, retry counts, etc.).
  - AWSOpsWorksClient
```
public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSOpsWorksClient
```
public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider,
                 ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AWSOpsWorks using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to AWSOpsWorks (ex: proxy settings, retry counts, etc.).
- Method Detail
  - deregisterVolume
```
public void deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
```
    Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see .
    
    Specified by:
    
    deregisterVolume in interface AWSOpsWorks
    
    Parameters:
    deregisterVolumeRequest - Container for the necessary parameters to execute the DeregisterVolume service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - setPermission
```
public void setPermission(SetPermissionRequest setPermissionRequest)
```
    Specifies a stack's permissions. For more information, see Security and Permissions .
    
    Specified by:
    
    setPermission in interface AWSOpsWorks
    
    Parameters:
    setPermissionRequest - Container for the necessary parameters to execute the SetPermission service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeInstances
```
public DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)
```
    Requests a description of a set of instances.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeInstances in interface AWSOpsWorks
    
    Parameters:
    describeInstancesRequest - Container for the necessary parameters to execute the DescribeInstances service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeInstances service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describePermissions
```
public DescribePermissionsResult describePermissions(DescribePermissionsRequest describePermissionsRequest)
```
    Describes the permissions for a specified stack.
    
    Specified by:
    
    describePermissions in interface AWSOpsWorks
    
    Parameters:
    describePermissionsRequest - Container for the necessary parameters to execute the DescribePermissions service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribePermissions service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - deleteInstance
```
public void deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
```
    Deletes a specified instance. You must stop an instance before you can delete it. For more information, see Deleting Instances .
    
    Specified by:
    
    deleteInstance in interface AWSOpsWorks
    
    Parameters:
    deleteInstanceRequest - Container for the necessary parameters to execute the DeleteInstance service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - cloneStack
```
public CloneStackResult cloneStack(CloneStackRequest cloneStackRequest)
```
    Creates a clone of a specified stack. For more information, see Clone a Stack .
    
    Specified by:
    
    cloneStack in interface AWSOpsWorks
    
    Parameters:
    cloneStackRequest - Container for the necessary parameters to execute the CloneStack service method on AWSOpsWorks.
    
    Returns:
    The response from the CloneStack service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - detachElasticLoadBalancer
```
public void detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
```
    Detaches a specified Elastic Load Balancing instance from its layer.
    
    Specified by:
    
    detachElasticLoadBalancer in interface AWSOpsWorks
    
    Parameters:
    detachElasticLoadBalancerRequest - Container for the necessary parameters to execute the DetachElasticLoadBalancer service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - stopInstance
```
public void 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 .
    
    Specified by:
    
    stopInstance in interface AWSOpsWorks
    
    Parameters:
    stopInstanceRequest - Container for the necessary parameters to execute the StopInstance service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - updateApp
```
public void updateApp(UpdateAppRequest updateAppRequest)
```
    Updates a specified app.
    
    Specified by:
    
    updateApp in interface AWSOpsWorks
    
    Parameters:
    updateAppRequest - Container for the necessary parameters to execute the UpdateApp service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeCommands
```
public DescribeCommandsResult describeCommands(DescribeCommandsRequest describeCommandsRequest)
```
    Describes the results of specified commands.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeCommands in interface AWSOpsWorks
    
    Parameters:
    describeCommandsRequest - Container for the necessary parameters to execute the DescribeCommands service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeCommands service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - associateElasticIp
```
public void 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 .
    
    Specified by:
    
    associateElasticIp in interface AWSOpsWorks
    
    Parameters:
    associateElasticIpRequest - Container for the necessary parameters to execute the AssociateElasticIp service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - unassignVolume
```
public void unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
```
    Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see .
    
    Specified by:
    
    unassignVolume in interface AWSOpsWorks
    
    Parameters:
    unassignVolumeRequest - Container for the necessary parameters to execute the UnassignVolume service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeRaidArrays
```
public DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
```
    Describe an instance's RAID arrays.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeRaidArrays in interface AWSOpsWorks
    
    Parameters:
    describeRaidArraysRequest - Container for the necessary parameters to execute the DescribeRaidArrays service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeRaidArrays service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - getHostnameSuggestion
```
public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
```
    Gets a generated host name for the specified layer, based on the current host name theme.
    
    Specified by:
    
    getHostnameSuggestion in interface AWSOpsWorks
    
    Parameters:
    getHostnameSuggestionRequest - Container for the necessary parameters to execute the GetHostnameSuggestion service method on AWSOpsWorks.
    
    Returns:
    The response from the GetHostnameSuggestion service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - setLoadBasedAutoScaling
```
public void 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 .
    
    NOTE: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.
    
    Specified by:
    
    setLoadBasedAutoScaling in interface AWSOpsWorks
    
    Parameters:
    setLoadBasedAutoScalingRequest - Container for the necessary parameters to execute the SetLoadBasedAutoScaling service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeVolumes
```
public DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
```
    Describes an instance's Amazon EBS volumes.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeVolumes in interface AWSOpsWorks
    
    Parameters:
    describeVolumesRequest - Container for the necessary parameters to execute the DescribeVolumes service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeVolumes service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - assignVolume
```
public void 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. For more information, see .
    
    Specified by:
    
    assignVolume in interface AWSOpsWorks
    
    Parameters:
    assignVolumeRequest - Container for the necessary parameters to execute the AssignVolume service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeServiceErrors
```
public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
```
    Describes AWS OpsWorks service errors.
    
    Specified by:
    
    describeServiceErrors in interface AWSOpsWorks
    
    Parameters:
    describeServiceErrorsRequest - Container for the necessary parameters to execute the DescribeServiceErrors service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeServiceErrors service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - updateLayer
```
public void updateLayer(UpdateLayerRequest updateLayerRequest)
```
    Updates a specified layer.
    
    Specified by:
    
    updateLayer in interface AWSOpsWorks
    
    Parameters:
    updateLayerRequest - Container for the necessary parameters to execute the UpdateLayer service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - updateElasticIp
```
public void updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
```
    Updates a registered Elastic IP address's name. For more information, see .
    
    Specified by:
    
    updateElasticIp in interface AWSOpsWorks
    
    Parameters:
    updateElasticIpRequest - Container for the necessary parameters to execute the UpdateElasticIp service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - startInstance
```
public void startInstance(StartInstanceRequest startInstanceRequest)
```
    Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances .
    
    Specified by:
    
    startInstance in interface AWSOpsWorks
    
    Parameters:
    startInstanceRequest - Container for the necessary parameters to execute the StartInstance service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - createLayer
```
public CreateLayerResult createLayer(CreateLayerRequest createLayerRequest)
```
    Creates a layer. For more information, see How to Create a Layer .
    
    NOTE: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.
    
    Specified by:
    
    createLayer in interface AWSOpsWorks
    
    Parameters:
    createLayerRequest - Container for the necessary parameters to execute the CreateLayer service method on AWSOpsWorks.
    
    Returns:
    The response from the CreateLayer service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - disassociateElasticIp
```
public void disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)
```
    Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see .
    
    Specified by:
    
    disassociateElasticIp in interface AWSOpsWorks
    
    Parameters:
    disassociateElasticIpRequest - Container for the necessary parameters to execute the DisassociateElasticIp service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - deleteStack
```
public void deleteStack(DeleteStackRequest deleteStackRequest)
```
    Deletes a specified stack. You must first delete all instances, layers, and apps. For more information, see Shut Down a Stack .
    
    Specified by:
    
    deleteStack in interface AWSOpsWorks
    
    Parameters:
    deleteStackRequest - Container for the necessary parameters to execute the DeleteStack service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - startStack
```
public void startStack(StartStackRequest startStackRequest)
```
    Starts stack's instances.
    
    Specified by:
    
    startStack in interface AWSOpsWorks
    
    Parameters:
    startStackRequest - Container for the necessary parameters to execute the StartStack service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - registerVolume
```
public 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 .
    
    Specified by:
    
    registerVolume in interface AWSOpsWorks
    
    Parameters:
    registerVolumeRequest - Container for the necessary parameters to execute the RegisterVolume service method on AWSOpsWorks.
    
    Returns:
    The response from the RegisterVolume service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - updateUserProfile
```
public void updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
```
    Updates a specified user profile.
    
    Specified by:
    
    updateUserProfile in interface AWSOpsWorks
    
    Parameters:
    updateUserProfileRequest - Container for the necessary parameters to execute the UpdateUserProfile service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - createStack
```
public CreateStackResult createStack(CreateStackRequest createStackRequest)
```
    Creates a new stack. For more information, see Create a New Stack .
    
    Specified by:
    
    createStack in interface AWSOpsWorks
    
    Parameters:
    createStackRequest - Container for the necessary parameters to execute the CreateStack service method on AWSOpsWorks.
    
    Returns:
    The response from the CreateStack service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - rebootInstance
```
public void rebootInstance(RebootInstanceRequest rebootInstanceRequest)
```
    Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances .
    
    Specified by:
    
    rebootInstance in interface AWSOpsWorks
    
    Parameters:
    rebootInstanceRequest - Container for the necessary parameters to execute the RebootInstance service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - createInstance
```
public CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest)
```
    Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer .
    
    Specified by:
    
    createInstance in interface AWSOpsWorks
    
    Parameters:
    createInstanceRequest - Container for the necessary parameters to execute the CreateInstance service method on AWSOpsWorks.
    
    Returns:
    The response from the CreateInstance service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - deleteApp
```
public void deleteApp(DeleteAppRequest deleteAppRequest)
```
    Deletes a specified app.
    
    Specified by:
    
    deleteApp in interface AWSOpsWorks
    
    Parameters:
    deleteAppRequest - Container for the necessary parameters to execute the DeleteApp service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - deregisterElasticIp
```
public void deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
```
    Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see .
    
    Specified by:
    
    deregisterElasticIp in interface AWSOpsWorks
    
    Parameters:
    deregisterElasticIpRequest - Container for the necessary parameters to execute the DeregisterElasticIp service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - attachElasticLoadBalancer
```
public void attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
```
    Attaches an Elastic Load Balancing load balancer to a specified layer.
    
    NOTE: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.
    
    Specified by:
    
    attachElasticLoadBalancer in interface AWSOpsWorks
    
    Parameters:
    attachElasticLoadBalancerRequest - Container for the necessary parameters to execute the AttachElasticLoadBalancer service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - updateStack
```
public void updateStack(UpdateStackRequest updateStackRequest)
```
    Updates a specified stack.
    
    Specified by:
    
    updateStack in interface AWSOpsWorks
    
    Parameters:
    updateStackRequest - Container for the necessary parameters to execute the UpdateStack service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - createUserProfile
```
public CreateUserProfileResult createUserProfile(CreateUserProfileRequest createUserProfileRequest)
```
    Creates a new user profile.
    
    Specified by:
    
    createUserProfile in interface AWSOpsWorks
    
    Parameters:
    createUserProfileRequest - Container for the necessary parameters to execute the CreateUserProfile service method on AWSOpsWorks.
    
    Returns:
    The response from the CreateUserProfile service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeLayers
```
public DescribeLayersResult describeLayers(DescribeLayersRequest describeLayersRequest)
```
    Requests a description of one or more layers in a specified stack.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeLayers in interface AWSOpsWorks
    
    Parameters:
    describeLayersRequest - Container for the necessary parameters to execute the DescribeLayers service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeLayers service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeLoadBasedAutoScaling
```
public DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)
```
    Describes load-based auto scaling configurations for specified layers.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeLoadBasedAutoScaling in interface AWSOpsWorks
    
    Parameters:
    describeLoadBasedAutoScalingRequest - Container for the necessary parameters to execute the DescribeLoadBasedAutoScaling service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeLoadBasedAutoScaling service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeElasticLoadBalancers
```
public DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
```
    Describes a stack's Elastic Load Balancing instances.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeElasticLoadBalancers in interface AWSOpsWorks
    
    Parameters:
    describeElasticLoadBalancersRequest - Container for the necessary parameters to execute the DescribeElasticLoadBalancers service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeElasticLoadBalancers service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - deleteLayer
```
public void deleteLayer(DeleteLayerRequest deleteLayerRequest)
```
    Deletes a specified layer. You must first stop and then delete all associated instances. For more information, see How to Delete a Layer .
    
    Specified by:
    
    deleteLayer in interface AWSOpsWorks
    
    Parameters:
    deleteLayerRequest - Container for the necessary parameters to execute the DeleteLayer service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - setTimeBasedAutoScaling
```
public void 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 .
    
    Specified by:
    
    setTimeBasedAutoScaling in interface AWSOpsWorks
    
    Parameters:
    setTimeBasedAutoScalingRequest - Container for the necessary parameters to execute the SetTimeBasedAutoScaling service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - createApp
```
public CreateAppResult createApp(CreateAppRequest createAppRequest)
```
    Creates an app for a specified stack. For more information, see Creating Apps .
    
    Specified by:
    
    createApp in interface AWSOpsWorks
    
    Parameters:
    createAppRequest - Container for the necessary parameters to execute the CreateApp service method on AWSOpsWorks.
    
    Returns:
    The response from the CreateApp service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - deleteUserProfile
```
public void deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
```
    Deletes a user profile.
    
    Specified by:
    
    deleteUserProfile in interface AWSOpsWorks
    
    Parameters:
    deleteUserProfileRequest - Container for the necessary parameters to execute the DeleteUserProfile service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeTimeBasedAutoScaling
```
public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
```
    Describes time-based auto scaling configurations for specified instances.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeTimeBasedAutoScaling in interface AWSOpsWorks
    
    Parameters:
    describeTimeBasedAutoScalingRequest - Container for the necessary parameters to execute the DescribeTimeBasedAutoScaling service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeTimeBasedAutoScaling service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - updateVolume
```
public void updateVolume(UpdateVolumeRequest updateVolumeRequest)
```
    Updates an Amazon EBS volume's name or mount point. For more information, see .
    
    Specified by:
    
    updateVolume in interface AWSOpsWorks
    
    Parameters:
    updateVolumeRequest - Container for the necessary parameters to execute the UpdateVolume service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeUserProfiles
```
public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
```
    Describe specified users.
    
    Specified by:
    
    describeUserProfiles in interface AWSOpsWorks
    
    Parameters:
    describeUserProfilesRequest - Container for the necessary parameters to execute the DescribeUserProfiles service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeUserProfiles service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - updateInstance
```
public void updateInstance(UpdateInstanceRequest updateInstanceRequest)
```
    Updates a specified instance.
    
    Specified by:
    
    updateInstance in interface AWSOpsWorks
    
    Parameters:
    updateInstanceRequest - Container for the necessary parameters to execute the UpdateInstance service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeDeployments
```
public DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
```
    Requests a description of a specified set of deployments.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeDeployments in interface AWSOpsWorks
    
    Parameters:
    describeDeploymentsRequest - Container for the necessary parameters to execute the DescribeDeployments service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeDeployments service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - registerElasticIp
```
public 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 .
    
    Specified by:
    
    registerElasticIp in interface AWSOpsWorks
    
    Parameters:
    registerElasticIpRequest - Container for the necessary parameters to execute the RegisterElasticIp service method on AWSOpsWorks.
    
    Returns:
    The response from the RegisterElasticIp service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeElasticIps
```
public DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
```
    Describes Elastic IP addresses .
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeElasticIps in interface AWSOpsWorks
    
    Parameters:
    describeElasticIpsRequest - Container for the necessary parameters to execute the DescribeElasticIps service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeElasticIps service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeStacks
```
public DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
```
    Requests a description of one or more stacks.
    
    Specified by:
    
    describeStacks in interface AWSOpsWorks
    
    Parameters:
    describeStacksRequest - Container for the necessary parameters to execute the DescribeStacks service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeStacks service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - describeApps
```
public DescribeAppsResult describeApps(DescribeAppsRequest describeAppsRequest)
```
    Requests a description of a specified set of apps.
    
    NOTE:You must specify at least one of the parameters.
    
    Specified by:
    
    describeApps in interface AWSOpsWorks
    
    Parameters:
    describeAppsRequest - Container for the necessary parameters to execute the DescribeApps service method on AWSOpsWorks.
    
    Returns:
    The response from the DescribeApps service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - stopStack
```
public void stopStack(StopStackRequest stopStackRequest)
```
    Stops a specified stack.
    
    Specified by:
    
    stopStack in interface AWSOpsWorks
    
    Parameters:
    stopStackRequest - Container for the necessary parameters to execute the StopStack service method on AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - createDeployment
```
public CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
```
    Deploys a stack or app.
    - App deployment generates a deploy event, which runs the associated recipes and passes them a JSON stack configuration object that includes information about the app.
    - Stack deployment runs the deploy recipes but does not raise an event.
    For more information, see Deploying Apps and Run Stack Commands .
    Specified by:
    
    createDeployment in interface AWSOpsWorks
    
    Parameters:
    createDeploymentRequest - Container for the necessary parameters to execute the CreateDeployment service method on AWSOpsWorks.
    
    Returns:
    The response from the CreateDeployment service method, as returned by AWSOpsWorks.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AWSOpsWorks indicating either a problem with the data in the request, or a server side issue.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from class: AmazonWebServiceClient
    
    Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.
    This method is not threadsafe. Endpoints 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.
    Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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
    
    Specified by:
    
    setEndpoint in interface AWSOpsWorks
    
    Overrides:
    
    setEndpoint in class AmazonWebServiceClient
    
    Parameters:
    endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setEndpoint
```
public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException
```
    Description copied from class: AmazonWebServiceClient
    
    Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
    This method is not threadsafe. Endpoints 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.
    Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.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
    
    Overrides:
    
    setEndpoint in class AmazonWebServiceClient
    
    Parameters:
    endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
    serviceName - The name of the AWS service to use when signing requests.
    regionId - The ID of the region in which this service resides.
    
    Throws:
    
    IllegalArgumentException - If any problems are detected with the specified endpoint.
    See Also:
    AmazonDynamoDB#setRegion(Region)
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSOpsWorks
    
    Parameters:
    request - The originally executed request
    
    Returns:
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AWSOpsWorksClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.opsworks.AWSOpsWorks

Constructor Detail

AWSOpsWorksClient

AWSOpsWorksClient

AWSOpsWorksClient

AWSOpsWorksClient

AWSOpsWorksClient

AWSOpsWorksClient

Method Detail

deregisterVolume

setPermission

describeInstances

describePermissions

deleteInstance

cloneStack

detachElasticLoadBalancer

stopInstance

updateApp

describeCommands

associateElasticIp

unassignVolume

describeRaidArrays

getHostnameSuggestion

setLoadBasedAutoScaling

describeVolumes

assignVolume

describeServiceErrors

updateLayer

updateElasticIp

startInstance

createLayer

disassociateElasticIp

deleteStack

startStack

registerVolume

updateUserProfile

createStack

rebootInstance

createInstance

deleteApp

deregisterElasticIp

attachElasticLoadBalancer

updateStack

createUserProfile

describeLayers

describeLoadBasedAutoScaling

describeElasticLoadBalancers

deleteLayer

setTimeBasedAutoScaling

createApp

deleteUserProfile

describeTimeBasedAutoScaling

updateVolume

describeUserProfiles

updateInstance

describeDeployments

registerElasticIp

describeElasticIps

describeStacks

describeApps

stopStack

createDeployment

setEndpoint

setEndpoint

getCachedResponseMetadata