AWSOpsWorks (AWS SDK for Java 1.7.15 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.opsworks
Interface AWSOpsWorks

All Known Subinterfaces:: AWSOpsWorksAsync

All Known Implementing Classes:: AWSOpsWorksAsyncClient, AWSOpsWorksClient

public interface AWSOpsWorks

Interface for accessing AWSOpsWorks. 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.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks 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, 11.4, or 11.10. The default value is currently 11.4. For more information, see Chef Versions .

Method Summary
`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`	`deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)` Deregisters an Amazon RDS instance.
`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.
`DescribeMyUserProfileResult`	`describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)` Describes a user's SSH information.
`DescribePermissionsResult`	`describePermissions(DescribePermissionsRequest describePermissionsRequest)` Describes the permissions for a specified stack.
`DescribeRaidArraysResult`	`describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)` Describe an instance's RAID arrays.
`DescribeRdsDbInstancesResult`	`describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)` Describes Amazon RDS instances.
`DescribeServiceErrorsResult`	`describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)` Describes AWS OpsWorks service errors.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest describeStacksRequest)` Requests a description of one or more stacks.
`DescribeStackSummaryResult`	`describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)` Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as `running_setup` or `online` .
`DescribeTimeBasedAutoScalingResult`	`describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)` Describes time-based auto scaling configurations for specified instances.
`DescribeUserProfilesResult`	`describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)` Describe specified users.
`DescribeVolumesResult`	`describeVolumes(DescribeVolumesRequest describeVolumesRequest)` Describes an instance's Amazon EBS volumes.
`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.
`void`	`registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)` Registers an Amazon RDS instance with a stack.
`RegisterVolumeResult`	`registerVolume(RegisterVolumeRequest registerVolumeRequest)` Registers an Amazon EBS volume with a specified stack.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://opsworks.us-east-1.amazonaws.com").
`void`	`setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)` Specify the load-based auto scaling configuration for a specified layer.
`void`	`setPermission(SetPermissionRequest setPermissionRequest)` Specifies a user's permissions.
`void`	`setRegion(Region region)` An alternative to `setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)` Specify the time-based auto scaling configuration for a specified instance.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`void`	`startInstance(StartInstanceRequest startInstanceRequest)` Starts a specified instance.
`void`	`startStack(StartStackRequest startStackRequest)` Starts a 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`	`updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)` Updates a user's SSH public key.
`void`	`updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)` Updates an Amazon RDS instance.
`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.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://opsworks.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://opsworks.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:: endpoint - The endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://opsworks.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
Throws:: IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:: region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.
Throws:: IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)
See Also:: Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deregisterRdsDbInstance

void deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Deregisters an Amazon RDS instance.

Parameters:: deregisterRdsDbInstanceRequest - Container for the necessary parameters to execute the DeregisterRdsDbInstance 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.

registerRdsDbInstance

void registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

Registers an Amazon RDS instance with a stack.

Parameters:: registerRdsDbInstanceRequest - Container for the necessary parameters to execute the RegisterRdsDbInstance 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.

updateMyUserProfile

void updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)
                         throws AmazonServiceException,
                                AmazonClientException

Updates a user's SSH public key.

Required Permissions : To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: updateMyUserProfileRequest - Container for the necessary parameters to execute the UpdateMyUserProfile service method on 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.

deregisterVolume

void deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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

Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: deregisterVolumeRequest - 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

void setPermission(SetPermissionRequest setPermissionRequest)
                   throws AmazonServiceException,
                          AmazonClientException

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

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

DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Requests a description of a set of instances.

NOTE: You must specify at least one of the parameters.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: 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

DescribePermissionsResult describePermissions(DescribePermissionsRequest describePermissionsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Describes the permissions for a specified stack.

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

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 .

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

CloneStackResult cloneStack(CloneStackRequest cloneStackRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a clone of a specified stack. For more information, see Clone a Stack .

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: cloneStackRequest - 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

void detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Detaches a specified Elastic Load Balancing instance from its layer.

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

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 .

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

void updateApp(UpdateAppRequest updateAppRequest)
               throws AmazonServiceException,
                      AmazonClientException

Updates a specified app.

Required Permissions : To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: updateAppRequest - 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.

describeRdsDbInstances

DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Describes Amazon RDS instances.

Parameters:: describeRdsDbInstancesRequest - Container for the necessary parameters to execute the DescribeRdsDbInstances service method on AWSOpsWorks.
Returns:: The response from the DescribeRdsDbInstances 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.

describeCommands

DescribeCommandsResult describeCommands(DescribeCommandsRequest describeCommandsRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Describes the results of specified commands.

NOTE: You must specify at least one of the parameters.

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

void associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management .

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

void unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
                    throws AmazonServiceException,
                           AmazonClientException

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

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

DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Describe an instance's RAID arrays.

NOTE: You must specify at least one of the parameters.

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

GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Gets a generated host name for the specified layer, based on the current host name theme.

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

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.

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

DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Describes an instance's Amazon EBS volumes.

NOTE: You must specify at least one of the parameters.

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

void assignVolume(AssignVolumeRequest assignVolumeRequest)
                  throws AmazonServiceException,
                         AmazonClientException

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

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

DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Describes AWS OpsWorks service errors.

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

void updateLayer(UpdateLayerRequest updateLayerRequest)
                 throws AmazonServiceException,
                        AmazonClientException

Updates a specified layer.

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

void updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
                     throws AmazonServiceException,
                            AmazonClientException

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

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

void startInstance(StartInstanceRequest startInstanceRequest)
                   throws AmazonServiceException,
                          AmazonClientException

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

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

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

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

void disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management .

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

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 .

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

void startStack(StartStackRequest startStackRequest)
                throws AmazonServiceException,
                       AmazonClientException

Starts a stack's instances.

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

RegisterVolumeResult registerVolume(RegisterVolumeRequest registerVolumeRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management .

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.

updateRdsDbInstance

void updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)
                         throws AmazonServiceException,
                                AmazonClientException

Updates an Amazon RDS instance.

Parameters:: updateRdsDbInstanceRequest - Container for the necessary parameters to execute the UpdateRdsDbInstance 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.

updateUserProfile

void updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Updates a specified user profile.

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: updateUserProfileRequest - 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.

rebootInstance

void rebootInstance(RebootInstanceRequest rebootInstanceRequest)
                    throws AmazonServiceException,
                           AmazonClientException

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

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.

createStack

CreateStackResult createStack(CreateStackRequest createStackRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: createStackRequest - 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.

createInstance

CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

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

void deleteApp(DeleteAppRequest deleteAppRequest)
               throws AmazonServiceException,
                      AmazonClientException

Deletes a specified app.

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

void deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
                         throws AmazonServiceException,
                                AmazonClientException

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

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

void attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing .

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.

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

void updateStack(UpdateStackRequest updateStackRequest)
                 throws AmazonServiceException,
                        AmazonClientException

Updates a specified stack.

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

CreateUserProfileResult createUserProfile(CreateUserProfileRequest createUserProfileRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Creates a new user profile.

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: createUserProfileRequest - 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

DescribeLayersResult describeLayers(DescribeLayersRequest describeLayersRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

NOTE: You must specify at least one of the parameters.

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

DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Describes load-based auto scaling configurations for specified layers.

NOTE: You must specify at least one of the parameters.

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

DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Describes a stack's Elastic Load Balancing instances.

NOTE: You must specify at least one of the parameters.

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

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 .

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.

describeMyUserProfile

DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Describes a user's SSH information.

Parameters:: describeMyUserProfileRequest - Container for the necessary parameters to execute the DescribeMyUserProfile service method on AWSOpsWorks.
Returns:: The response from the DescribeMyUserProfile service method, as returned by AWSOpsWorks.
Throws:: 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

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 .

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

CreateAppResult createApp(CreateAppRequest createAppRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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

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.

updateVolume

void updateVolume(UpdateVolumeRequest updateVolumeRequest)
                  throws AmazonServiceException,
                         AmazonClientException

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

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.

deleteUserProfile

void deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Deletes a user profile.

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: deleteUserProfileRequest - 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

DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Describes time-based auto scaling configurations for specified instances.

NOTE: You must specify at least one of the parameters.

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.

describeUserProfiles

DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Describe specified users.

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Parameters:: describeUserProfilesRequest - 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

void updateInstance(UpdateInstanceRequest updateInstanceRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Updates a specified instance.

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

DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Requests a description of a specified set of deployments.

NOTE: You must specify at least one of the parameters.

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

RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management .

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

DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Describes Elastic IP addresses .

NOTE: You must specify at least one of the parameters.

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

DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Requests a description of one or more stacks.

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

DescribeAppsResult describeApps(DescribeAppsRequest describeAppsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Requests a description of a specified set of apps.

NOTE: You must specify at least one of the parameters.

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.

describeStackSummary

DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online .

Parameters:: describeStackSummaryRequest - Container for the necessary parameters to execute the DescribeStackSummary service method on AWSOpsWorks.
Returns:: The response from the DescribeStackSummary 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

void stopStack(StopStackRequest stopStackRequest)
               throws AmazonServiceException,
                      AmazonClientException

Stops a specified stack.

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

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 .

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:: request - The originally executed request.
Returns:: The response metadata for the specified request, or null if none is available.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.opsworks Interface AWSOpsWorks

setEndpoint

setRegion

deregisterRdsDbInstance

registerRdsDbInstance

updateMyUserProfile

deregisterVolume

setPermission

describeInstances

describePermissions

deleteInstance

cloneStack

detachElasticLoadBalancer

stopInstance

updateApp

describeRdsDbInstances

describeCommands

associateElasticIp

unassignVolume

describeRaidArrays

getHostnameSuggestion

setLoadBasedAutoScaling

describeVolumes

assignVolume

describeServiceErrors

updateLayer

updateElasticIp

startInstance

createLayer

disassociateElasticIp

deleteStack

startStack

registerVolume

updateRdsDbInstance

updateUserProfile

rebootInstance

createStack

createInstance

deleteApp

deregisterElasticIp

attachElasticLoadBalancer

updateStack

createUserProfile

describeLayers

describeLoadBasedAutoScaling

describeElasticLoadBalancers

deleteLayer

describeMyUserProfile

setTimeBasedAutoScaling

createApp

updateVolume

deleteUserProfile

describeTimeBasedAutoScaling

describeUserProfiles

updateInstance

describeDeployments

registerElasticIp

describeElasticIps

describeStacks

describeApps

describeStackSummary

stopStack

createDeployment

shutdown

getCachedResponseMetadata

com.amazonaws.services.opsworks
Interface AWSOpsWorks