public class AWSOpsWorksClient extends AmazonWebServiceClient implements 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
.
| Modifier and Type | Field and Description |
|---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AWSOpsWorks exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AWSOpsWorksClient()
Constructs a new client to invoke service methods on
AWSOpsWorks.
|
AWSOpsWorksClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AWSOpsWorks using the specified AWS account credentials.
|
AWSOpsWorksClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AWSOpsWorks using the specified AWS account credentials
and client configuration options.
|
AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AWSOpsWorks using the specified AWS account credentials provider.
|
AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AWSOpsWorks using the specified AWS account credentials
provider and client configuration options.
|
AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AWSOpsWorks using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AWSOpsWorksClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AWSOpsWorks.
|
| Modifier and Type | Method and Description |
|---|---|
void |
assignVolume(AssignVolumeRequest assignVolumeRequest)
Assigns one of the stack's registered Amazon EBS volumes to a
specified instance.
|
void |
associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)
Associates one of the stack's registered Elastic IP addresses with a
specified instance.
|
void |
attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
Attaches an Elastic Load Balancing load balancer to a specified
layer.
|
CloneStackResult |
cloneStack(CloneStackRequest cloneStackRequest)
Creates a clone of a specified stack.
|
CreateAppResult |
createApp(CreateAppRequest createAppRequest)
Creates an app for a specified stack.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Deploys a stack or app.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest createInstanceRequest)
Creates an instance in a specified stack.
|
CreateLayerResult |
createLayer(CreateLayerRequest createLayerRequest)
Creates a layer.
|
CreateStackResult |
createStack(CreateStackRequest createStackRequest)
Creates a new stack.
|
CreateUserProfileResult |
createUserProfile(CreateUserProfileRequest createUserProfileRequest)
Creates a new user profile.
|
void |
deleteApp(DeleteAppRequest deleteAppRequest)
Deletes a specified app.
|
void |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes a specified instance.
|
void |
deleteLayer(DeleteLayerRequest deleteLayerRequest)
Deletes a specified layer.
|
void |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
void |
deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
Deletes a user profile.
|
void |
deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
Deregisters a specified Elastic IP address.
|
void |
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.
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId)
An internal method that is not expected to be normally
called except for AWS internal development purposes.
|
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 |
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 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.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetRegion, shutdownprotected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AWSOpsWorksClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AWSOpsWorksClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to AWSOpsWorks
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AWSOpsWorksClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AWSOpsWorksClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).requestMetricCollector - optional request metric collectorpublic void deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)
Deregisters an Amazon RDS instance.
deregisterRdsDbInstance in interface AWSOpsWorksderegisterRdsDbInstanceRequest - Container for the necessary
parameters to execute the DeregisterRdsDbInstance service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)
Registers an Amazon RDS instance with a stack.
registerRdsDbInstance in interface AWSOpsWorksregisterRdsDbInstanceRequest - Container for the necessary
parameters to execute the RegisterRdsDbInstance service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)
Updates a user's SSH public key.
Required Permissions : To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateMyUserProfile in interface AWSOpsWorksupdateMyUserProfileRequest - Container for the necessary
parameters to execute the UpdateMyUserProfile service method on
AWSOpsWorks.ValidationExceptionAmazonClientException - 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.public void deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
deregisterVolume in interface AWSOpsWorksderegisterVolumeRequest - Container for the necessary parameters
to execute the DeregisterVolume service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void setPermission(SetPermissionRequest setPermissionRequest)
Specifies a user's permissions. For more information, see Security and Permissions .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
setPermission in interface AWSOpsWorkssetPermissionRequest - Container for the necessary parameters to
execute the SetPermission service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)
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 .
describeInstances in interface AWSOpsWorksdescribeInstancesRequest - Container for the necessary parameters
to execute the DescribeInstances service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribePermissionsResult describePermissions(DescribePermissionsRequest describePermissionsRequest)
Describes the permissions for a specified stack.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
describePermissions in interface AWSOpsWorksdescribePermissionsRequest - Container for the necessary
parameters to execute the DescribePermissions service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes a specified instance. You must stop an instance before you can delete it. For more information, see Deleting Instances .
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 .
deleteInstance in interface AWSOpsWorksdeleteInstanceRequest - Container for the necessary parameters to
execute the DeleteInstance service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public CloneStackResult cloneStack(CloneStackRequest cloneStackRequest)
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 .
cloneStack in interface AWSOpsWorkscloneStackRequest - Container for the necessary parameters to
execute the CloneStack service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
detachElasticLoadBalancer in interface AWSOpsWorksdetachElasticLoadBalancerRequest - Container for the necessary
parameters to execute the DetachElasticLoadBalancer service method on
AWSOpsWorks.ResourceNotFoundExceptionAmazonClientException - 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.public void stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances .
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 .
stopInstance in interface AWSOpsWorksstopInstanceRequest - Container for the necessary parameters to
execute the StopInstance service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateApp(UpdateAppRequest updateAppRequest)
Updates a specified app.
Required Permissions : To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateApp in interface AWSOpsWorksupdateAppRequest - Container for the necessary parameters to
execute the UpdateApp service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)
Describes Amazon RDS instances.
describeRdsDbInstances in interface AWSOpsWorksdescribeRdsDbInstancesRequest - Container for the necessary
parameters to execute the DescribeRdsDbInstances service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeCommandsResult describeCommands(DescribeCommandsRequest describeCommandsRequest)
Describes the results of specified commands.
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 .
describeCommands in interface AWSOpsWorksdescribeCommandsRequest - Container for the necessary parameters
to execute the DescribeCommands service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)
Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see 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 .
associateElasticIp in interface AWSOpsWorksassociateElasticIpRequest - Container for the necessary
parameters to execute the AssociateElasticIp service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
unassignVolume in interface AWSOpsWorksunassignVolumeRequest - Container for the necessary parameters to
execute the UnassignVolume service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
Describe an instance's RAID arrays.
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 .
describeRaidArrays in interface AWSOpsWorksdescribeRaidArraysRequest - Container for the necessary
parameters to execute the DescribeRaidArrays service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
getHostnameSuggestion in interface AWSOpsWorksgetHostnameSuggestionRequest - Container for the necessary
parameters to execute the GetHostnameSuggestion service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances .
NOTE: To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
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 .
setLoadBasedAutoScaling in interface AWSOpsWorkssetLoadBasedAutoScalingRequest - Container for the necessary
parameters to execute the SetLoadBasedAutoScaling service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
Describes an instance's Amazon EBS volumes.
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 .
describeVolumes in interface AWSOpsWorksdescribeVolumesRequest - Container for the necessary parameters
to execute the DescribeVolumes service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void assignVolume(AssignVolumeRequest assignVolumeRequest)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. For more information, see 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 .
assignVolume in interface AWSOpsWorksassignVolumeRequest - Container for the necessary parameters to
execute the AssignVolume service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
Describes AWS OpsWorks service errors.
Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
describeServiceErrors in interface AWSOpsWorksdescribeServiceErrorsRequest - Container for the necessary
parameters to execute the DescribeServiceErrors service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateLayer(UpdateLayerRequest updateLayerRequest)
Updates a specified layer.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateLayer in interface AWSOpsWorksupdateLayerRequest - Container for the necessary parameters to
execute the UpdateLayer service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
Updates a registered Elastic IP address's name. For more information, see Resource Management .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateElasticIp in interface AWSOpsWorksupdateElasticIpRequest - Container for the necessary parameters
to execute the UpdateElasticIp service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void startInstance(StartInstanceRequest startInstanceRequest)
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
startInstance in interface AWSOpsWorksstartInstanceRequest - Container for the necessary parameters to
execute the StartInstance service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public CreateLayerResult createLayer(CreateLayerRequest createLayerRequest)
Creates a layer. For more information, see How to Create a Layer .
NOTE: You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
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 .
createLayer in interface AWSOpsWorkscreateLayerRequest - Container for the necessary parameters to
execute the CreateLayer service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)
Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
disassociateElasticIp in interface AWSOpsWorksdisassociateElasticIpRequest - Container for the necessary
parameters to execute the DisassociateElasticIp service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack. You must first delete all instances, layers, and apps. For more information, see Shut Down a Stack .
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 .
deleteStack in interface AWSOpsWorksdeleteStackRequest - Container for the necessary parameters to
execute the DeleteStack service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void startStack(StartStackRequest startStackRequest)
Starts a stack's instances.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
startStack in interface AWSOpsWorksstartStackRequest - Container for the necessary parameters to
execute the StartStack service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public RegisterVolumeResult registerVolume(RegisterVolumeRequest registerVolumeRequest)
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see 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 .
registerVolume in interface AWSOpsWorksregisterVolumeRequest - Container for the necessary parameters to
execute the RegisterVolume service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)
Updates an Amazon RDS instance.
updateRdsDbInstance in interface AWSOpsWorksupdateRdsDbInstanceRequest - Container for the necessary
parameters to execute the UpdateRdsDbInstance service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
Updates a specified user profile.
Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateUserProfile in interface AWSOpsWorksupdateUserProfileRequest - Container for the necessary parameters
to execute the UpdateUserProfile service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
rebootInstance in interface AWSOpsWorksrebootInstanceRequest - Container for the necessary parameters to
execute the RebootInstance service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public CreateStackResult createStack(CreateStackRequest createStackRequest)
Creates a new stack. For more information, see Create a New Stack .
Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
createStack in interface AWSOpsWorkscreateStackRequest - Container for the necessary parameters to
execute the CreateStack service method on AWSOpsWorks.ValidationExceptionAmazonClientException - 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.public CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest)
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
createInstance in interface AWSOpsWorkscreateInstanceRequest - Container for the necessary parameters to
execute the CreateInstance service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void deleteApp(DeleteAppRequest deleteAppRequest)
Deletes a specified app.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
deleteApp in interface AWSOpsWorksdeleteAppRequest - Container for the necessary parameters to
execute the DeleteApp service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
deregisterElasticIp in interface AWSOpsWorksderegisterElasticIpRequest - Container for the necessary
parameters to execute the DeregisterElasticIp service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
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.
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 .
attachElasticLoadBalancer in interface AWSOpsWorksattachElasticLoadBalancerRequest - Container for the necessary
parameters to execute the AttachElasticLoadBalancer service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateStack(UpdateStackRequest updateStackRequest)
Updates a specified stack.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateStack in interface AWSOpsWorksupdateStackRequest - Container for the necessary parameters to
execute the UpdateStack service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public CreateUserProfileResult createUserProfile(CreateUserProfileRequest createUserProfileRequest)
Creates a new user profile.
Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
createUserProfile in interface AWSOpsWorkscreateUserProfileRequest - Container for the necessary parameters
to execute the CreateUserProfile service method on AWSOpsWorks.ValidationExceptionAmazonClientException - 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.public DescribeLayersResult describeLayers(DescribeLayersRequest describeLayersRequest)
Requests a description of one or more layers in a specified stack.
NOTE: You must specify at least one of the parameters.
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 .
describeLayers in interface AWSOpsWorksdescribeLayersRequest - Container for the necessary parameters to
execute the DescribeLayers service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)
Describes load-based auto scaling configurations for specified layers.
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 .
describeLoadBasedAutoScaling in interface AWSOpsWorksdescribeLoadBasedAutoScalingRequest - Container for the necessary
parameters to execute the DescribeLoadBasedAutoScaling service method
on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
Describes a stack's Elastic Load Balancing 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 .
describeElasticLoadBalancers in interface AWSOpsWorksdescribeElasticLoadBalancersRequest - Container for the necessary
parameters to execute the DescribeElasticLoadBalancers service method
on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void deleteLayer(DeleteLayerRequest deleteLayerRequest)
Deletes a specified layer. You must first stop and then delete all associated instances. For more information, see How to Delete a Layer .
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 .
deleteLayer in interface AWSOpsWorksdeleteLayerRequest - Container for the necessary parameters to
execute the DeleteLayer service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)
Describes a user's SSH information.
Required Permissions : To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
describeMyUserProfile in interface AWSOpsWorksdescribeMyUserProfileRequest - Container for the necessary
parameters to execute the DescribeMyUserProfile service method on
AWSOpsWorks.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.public void setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)
Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances .
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 .
setTimeBasedAutoScaling in interface AWSOpsWorkssetTimeBasedAutoScalingRequest - Container for the necessary
parameters to execute the SetTimeBasedAutoScaling service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public CreateAppResult createApp(CreateAppRequest createAppRequest)
Creates an app for a specified stack. For more information, see Creating Apps .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
createApp in interface AWSOpsWorkscreateAppRequest - Container for the necessary parameters to
execute the CreateApp service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateVolume(UpdateVolumeRequest updateVolumeRequest)
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateVolume in interface AWSOpsWorksupdateVolumeRequest - Container for the necessary parameters to
execute the UpdateVolume service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
Deletes a user profile.
Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
deleteUserProfile in interface AWSOpsWorksdeleteUserProfileRequest - Container for the necessary parameters
to execute the DeleteUserProfile service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
Describes time-based auto scaling configurations for specified 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 .
describeTimeBasedAutoScaling in interface AWSOpsWorksdescribeTimeBasedAutoScalingRequest - Container for the necessary
parameters to execute the DescribeTimeBasedAutoScaling service method
on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
Describe specified users.
Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
describeUserProfiles in interface AWSOpsWorksdescribeUserProfilesRequest - Container for the necessary
parameters to execute the DescribeUserProfiles service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void updateInstance(UpdateInstanceRequest updateInstanceRequest)
Updates a specified instance.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
updateInstance in interface AWSOpsWorksupdateInstanceRequest - Container for the necessary parameters to
execute the UpdateInstance service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
Requests a description of a specified set of deployments.
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 .
describeDeployments in interface AWSOpsWorksdescribeDeploymentsRequest - Container for the necessary
parameters to execute the DescribeDeployments service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)
Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see 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 .
registerElasticIp in interface AWSOpsWorksregisterElasticIpRequest - Container for the necessary parameters
to execute the RegisterElasticIp service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
Describes Elastic IP addresses .
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 .
describeElasticIps in interface AWSOpsWorksdescribeElasticIpsRequest - Container for the necessary
parameters to execute the DescribeElasticIps service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
Requests a description of one or more stacks.
Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
describeStacks in interface AWSOpsWorksdescribeStacksRequest - Container for the necessary parameters to
execute the DescribeStacks service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeAppsResult describeApps(DescribeAppsRequest describeAppsRequest)
Requests a description of a specified set of apps.
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 .
describeApps in interface AWSOpsWorksdescribeAppsRequest - Container for the necessary parameters to
execute the DescribeApps service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)
Describes the number of layers and apps in a specified stack, and the
number of instances in each state, such as running_setup
or online .
Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
describeStackSummary in interface AWSOpsWorksdescribeStackSummaryRequest - Container for the necessary
parameters to execute the DescribeStackSummary service method on
AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void stopStack(StopStackRequest stopStackRequest)
Stops a specified stack.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
stopStack in interface AWSOpsWorksstopStackRequest - Container for the necessary parameters to
execute the StopStack service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Deploys a stack or app.
deploy event, which runs
the associated recipes and passes them a JSON stack configuration
object that includes information about the app. deploy recipes but does
not raise an event.For more information, see Deploying Apps and Run Stack Commands .
Required Permissions : To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
createDeployment in interface AWSOpsWorkscreateDeploymentRequest - Container for the necessary parameters
to execute the CreateDeployment service method on AWSOpsWorks.ResourceNotFoundExceptionValidationExceptionAmazonClientException - 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.public void setEndpoint(String endpoint)
AmazonWebServiceClientThis method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full
URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
setEndpoint in interface AWSOpsWorkssetEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL,
including the protocol (ex: "https://ec2.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
AmazonWebServiceClientOverrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
Callers can pass in just the endpoint (ex:
"dynamodb.us-east-1.amazonaws.com/") or a full URL, including the
protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
setEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a
full URL, including the protocol (ex:
"http://dynamodb.us-east-1.amazonaws.com/") of the region
specific AWS endpoint this client will communicate with.serviceName - This parameter is ignored.regionId - The ID of the region in which this service resides AND the
overriding region for signing purposes.IllegalArgumentException - If any problems are detected with the specified endpoint.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSOpsWorksrequest - The originally executed requestCopyright © 2014. All rights reserved.