com.amazonaws.services.opsworks
Class AWSOpsWorksClient

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

Constructor Summary

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

void	attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) Attaches an Elastic Load Balancing instance 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.
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 an instance's 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 associated with a specified ID or IDs.
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 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 it's layer.
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 hostname for the specified layer, based on the current hostname theme.
void	rebootInstance(RebootInstanceRequest rebootInstanceRequest) Reboots a specified instance.
void	setEndpoint(String endpoint, String serviceName, String regionId) Overrides the default endpoint for this client ("https://opsworks.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	updateApp(UpdateAppRequest updateAppRequest) Updates a specified app.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, 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

setEndpoint, 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:

DefaultAWSCredentialsProvider

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:

DefaultAWSCredentialsProvider

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

updateUserProfile

public void updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
                       throws AmazonServiceException,
                              AmazonClientException

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)
                              throws AmazonServiceException,
                                     AmazonClientException

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)
                    throws AmazonServiceException,
                           AmazonClientException

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.

setPermission

public void setPermission(SetPermissionRequest setPermissionRequest)
                   throws AmazonServiceException,
                          AmazonClientException

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)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Requests a description of a set of instances associated with a specified ID or IDs.

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)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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)
                    throws AmazonServiceException,
                           AmazonClientException

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)
                            throws AmazonServiceException,
                                   AmazonClientException

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.

createInstance

public CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

stopInstance

public void stopInstance(StopInstanceRequest stopInstanceRequest)
                  throws AmazonServiceException,
                         AmazonClientException

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.

detachElasticLoadBalancer

public void detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Detaches a specified Elastic Load Balancing instance from it's 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.

updateApp

public void updateApp(UpdateAppRequest updateAppRequest)
               throws AmazonServiceException,
                      AmazonClientException

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.

deleteApp

public void deleteApp(DeleteAppRequest deleteAppRequest)
               throws AmazonServiceException,
                      AmazonClientException

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.

attachElasticLoadBalancer

public void attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Attaches an Elastic Load Balancing instance 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.

describeCommands

public DescribeCommandsResult describeCommands(DescribeCommandsRequest describeCommandsRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Describes the results of specified commands.

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.

updateStack

public void updateStack(UpdateStackRequest updateStackRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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)
                                          throws AmazonServiceException,
                                                 AmazonClientException

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.

getHostnameSuggestion

public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Gets a generated hostname for the specified layer, based on the current hostname 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.

describeRaidArrays

public DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Describe an instance's RAID arrays.

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.

describeLayers

public DescribeLayersResult describeLayers(DescribeLayersRequest describeLayersRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

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)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Describes load-based auto scaling configurations for specified layers.

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.

setLoadBasedAutoScaling

public void setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

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.

describeElasticLoadBalancers

public DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Describes a stack's Elastic Load Balancing instances.

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)
                 throws AmazonServiceException,
                        AmazonClientException

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)
                             throws AmazonServiceException,
                                    AmazonClientException

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.

describeVolumes

public DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Describes an instance's Amazon EBS volumes.

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.

createApp

public CreateAppResult createApp(CreateAppRequest createAppRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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.

describeTimeBasedAutoScaling

public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Describes time-based auto scaling configurations for specified instances.

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.

deleteUserProfile

public void deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
                       throws AmazonServiceException,
                              AmazonClientException

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.

describeUserProfiles

public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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)
                    throws AmazonServiceException,
                           AmazonClientException

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.

describeServiceErrors

public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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

describeDeployments

public DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Requests a description of a specified set of deployments.

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.

updateLayer

public void updateLayer(UpdateLayerRequest updateLayerRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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.

startInstance

public void startInstance(StartInstanceRequest startInstanceRequest)
                   throws AmazonServiceException,
                          AmazonClientException

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.

describeElasticIps

public DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Describes an instance's Elastic IP addresses .

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)
                                    throws AmazonServiceException,
                                           AmazonClientException

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)
                                throws AmazonServiceException,
                                       AmazonClientException

Requests a description of a specified set of apps.

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.

createLayer

public CreateLayerResult createLayer(CreateLayerRequest createLayerRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

NOTE:You should use CreateLayer for non-custom 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 non-custom 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.

deleteStack

public void deleteStack(DeleteStackRequest deleteStackRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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)
                throws AmazonServiceException,
                       AmazonClientException

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.

stopStack

public void stopStack(StopStackRequest stopStackRequest)
               throws AmazonServiceException,
                      AmazonClientException

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)
                                        throws AmazonServiceException,
                                               AmazonClientException

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,
                        String serviceName,
                        String regionId)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://opsworks.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: "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

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.

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.