AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface OpsWorksClient extends AutoCloseable
builder() method.
Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
opsworks.us-east-1.amazonaws.com
opsworks.us-east-2.amazonaws.com
opsworks.us-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-central-1.amazonaws.com
opsworks.ap-northeast-1.amazonaws.com
opsworks.ap-northeast-2.amazonaws.com
opsworks.ap-south-1.amazonaws.com
opsworks.ap-southeast-1.amazonaws.com
opsworks.ap-southeast-2.amazonaws.com
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the
ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux
stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AssignInstanceResponse |
assignInstance(AssignInstanceRequest assignInstanceRequest) |
Assign a registered instance to a layer.
|
default AssignVolumeResponse |
assignVolume(AssignVolumeRequest assignVolumeRequest) |
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
|
default AssociateElasticIpResponse |
associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest) |
Associates one of the stack's registered Elastic IP addresses with a specified instance.
|
default AttachElasticLoadBalancerResponse |
attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) |
Attaches an Elastic Load Balancing load balancer to a specified layer.
|
static OpsWorksClientBuilder |
builder() |
Create a builder that can be used to configure and create a
OpsWorksClient. |
default CloneStackResponse |
cloneStack(CloneStackRequest cloneStackRequest) |
Creates a clone of a specified stack.
|
static OpsWorksClient |
create() |
Create a
OpsWorksClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAppResponse |
createApp(CreateAppRequest createAppRequest) |
Creates an app for a specified stack.
|
default CreateDeploymentResponse |
createDeployment(CreateDeploymentRequest createDeploymentRequest) |
Runs deployment or stack commands.
|
default CreateInstanceResponse |
createInstance(CreateInstanceRequest createInstanceRequest) |
Creates an instance in a specified stack.
|
default CreateLayerResponse |
createLayer(CreateLayerRequest createLayerRequest) |
Creates a layer.
|
default CreateStackResponse |
createStack(CreateStackRequest createStackRequest) |
Creates a new stack.
|
default CreateUserProfileResponse |
createUserProfile(CreateUserProfileRequest createUserProfileRequest) |
Creates a new user profile.
|
default DeleteAppResponse |
deleteApp(DeleteAppRequest deleteAppRequest) |
Deletes a specified app.
|
default DeleteInstanceResponse |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest) |
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
|
default DeleteLayerResponse |
deleteLayer(DeleteLayerRequest deleteLayerRequest) |
Deletes a specified layer.
|
default DeleteStackResponse |
deleteStack(DeleteStackRequest deleteStackRequest) |
Deletes a specified stack.
|
default DeleteUserProfileResponse |
deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest) |
Deletes a user profile.
|
default DeregisterEcsClusterResponse |
deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest) |
Deregisters a specified Amazon ECS cluster from a stack.
|
default DeregisterElasticIpResponse |
deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest) |
Deregisters a specified Elastic IP address.
|
default DeregisterInstanceResponse |
deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) |
Deregister a registered Amazon EC2 or on-premises instance.
|
default DeregisterRdsDbInstanceResponse |
deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) |
Deregisters an Amazon RDS instance.
|
default DeregisterVolumeResponse |
deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest) |
Deregisters an Amazon EBS volume.
|
default DescribeAgentVersionsResponse |
describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest) |
Describes the available AWS OpsWorks Stacks agent versions.
|
default DescribeAppsResponse |
describeApps(DescribeAppsRequest describeAppsRequest) |
Requests a description of a specified set of apps.
|
default DescribeCommandsResponse |
describeCommands(DescribeCommandsRequest describeCommandsRequest) |
Describes the results of specified commands.
|
default DescribeDeploymentsResponse |
describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest) |
Requests a description of a specified set of deployments.
|
default DescribeEcsClustersResponse |
describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest) |
Describes Amazon ECS clusters that are registered with a stack.
|
default DescribeElasticIpsResponse |
describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest) |
Describes Elastic IP
addresses.
|
default DescribeElasticLoadBalancersResponse |
describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) |
Describes a stack's Elastic Load Balancing instances.
|
default DescribeInstancesResponse |
describeInstances(DescribeInstancesRequest describeInstancesRequest) |
Requests a description of a set of instances.
|
default DescribeLayersResponse |
describeLayers(DescribeLayersRequest describeLayersRequest) |
Requests a description of one or more layers in a specified stack.
|
default DescribeLoadBasedAutoScalingResponse |
describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) |
Describes load-based auto scaling configurations for specified layers.
|
default DescribeMyUserProfileResponse |
describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest) |
Describes a user's SSH information.
|
default DescribePermissionsResponse |
describePermissions(DescribePermissionsRequest describePermissionsRequest) |
Describes the permissions for a specified stack.
|
default DescribeRaidArraysResponse |
describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest) |
Describe an instance's RAID arrays.
|
default DescribeRdsDbInstancesResponse |
describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) |
Describes Amazon RDS instances.
|
default DescribeServiceErrorsResponse |
describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest) |
Describes AWS OpsWorks Stacks service errors.
|
default DescribeStackProvisioningParametersResponse |
describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) |
Requests a description of a stack's provisioning parameters.
|
default DescribeStacksResponse |
describeStacks(DescribeStacksRequest describeStacksRequest) |
Requests a description of one or more stacks.
|
default DescribeStackSummaryResponse |
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. |
default DescribeTimeBasedAutoScalingResponse |
describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) |
Describes time-based auto scaling configurations for specified instances.
|
default DescribeUserProfilesResponse |
describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest) |
Describe specified users.
|
default DescribeVolumesResponse |
describeVolumes(DescribeVolumesRequest describeVolumesRequest) |
Describes an instance's Amazon EBS volumes.
|
default DetachElasticLoadBalancerResponse |
detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) |
Detaches a specified Elastic Load Balancing instance from its layer.
|
default DisassociateElasticIpResponse |
disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest) |
Disassociates an Elastic IP address from its instance.
|
default GetHostnameSuggestionResponse |
getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest) |
Gets a generated host name for the specified layer, based on the current host name theme.
|
default GrantAccessResponse |
grantAccess(GrantAccessRequest grantAccessRequest) |
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest) |
Returns a list of tags that are applied to the specified stack or layer.
|
default RebootInstanceResponse |
rebootInstance(RebootInstanceRequest rebootInstanceRequest) |
Reboots a specified instance.
|
default RegisterEcsClusterResponse |
registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest) |
Registers a specified Amazon ECS cluster with a stack.
|
default RegisterElasticIpResponse |
registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest) |
Registers an Elastic IP address with a specified stack.
|
default RegisterInstanceResponse |
registerInstance(RegisterInstanceRequest registerInstanceRequest) |
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
|
default RegisterRdsDbInstanceResponse |
registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) |
Registers an Amazon RDS instance with a stack.
|
default RegisterVolumeResponse |
registerVolume(RegisterVolumeRequest registerVolumeRequest) |
Registers an Amazon EBS volume with a specified stack.
|
static ServiceMetadata |
serviceMetadata() |
|
default SetLoadBasedAutoScalingResponse |
setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) |
Specify the load-based auto scaling configuration for a specified layer.
|
default SetPermissionResponse |
setPermission(SetPermissionRequest setPermissionRequest) |
Specifies a user's permissions.
|
default SetTimeBasedAutoScalingResponse |
setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) |
Specify the time-based auto scaling configuration for a specified instance.
|
default StartInstanceResponse |
startInstance(StartInstanceRequest startInstanceRequest) |
Starts a specified instance.
|
default StartStackResponse |
startStack(StartStackRequest startStackRequest) |
Starts a stack's instances.
|
default StopInstanceResponse |
stopInstance(StopInstanceRequest stopInstanceRequest) |
Stops a specified instance.
|
default StopStackResponse |
stopStack(StopStackRequest stopStackRequest) |
Stops a specified stack.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest) |
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
|
default UnassignInstanceResponse |
unassignInstance(UnassignInstanceRequest unassignInstanceRequest) |
Unassigns a registered instance from all of it's layers.
|
default UnassignVolumeResponse |
unassignVolume(UnassignVolumeRequest unassignVolumeRequest) |
Unassigns an assigned Amazon EBS volume.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest) |
Removes tags from a specified stack or layer.
|
default UpdateAppResponse |
updateApp(UpdateAppRequest updateAppRequest) |
Updates a specified app.
|
default UpdateElasticIpResponse |
updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest) |
Updates a registered Elastic IP address's name.
|
default UpdateInstanceResponse |
updateInstance(UpdateInstanceRequest updateInstanceRequest) |
Updates a specified instance.
|
default UpdateLayerResponse |
updateLayer(UpdateLayerRequest updateLayerRequest) |
Updates a specified layer.
|
default UpdateMyUserProfileResponse |
updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest) |
Updates a user's SSH public key.
|
default UpdateRdsDbInstanceResponse |
updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) |
Updates an Amazon RDS instance.
|
default UpdateStackResponse |
updateStack(UpdateStackRequest updateStackRequest) |
Updates a specified stack.
|
default UpdateUserProfileResponse |
updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest) |
Updates a specified user profile.
|
default UpdateVolumeResponse |
updateVolume(UpdateVolumeRequest updateVolumeRequest) |
Updates an Amazon EBS volume's name or mount point.
|
OpsWorksClientWaiters |
waiters() |
closestatic final String SERVICE_NAME
static OpsWorksClient create()
OpsWorksClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OpsWorksClientBuilder builder()
OpsWorksClient.default AssignInstanceResponse assignInstance(AssignInstanceRequest assignInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Assign a registered instance to a layer.
You can assign registered on-premises instances to any layer type.
You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AssignVolumeResponse assignVolume(AssignVolumeRequest assignVolumeRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be
registered with the stack by calling RegisterVolume. After you register the volume, you must call
UpdateVolume to specify a mount point before calling AssignVolume. For more information, see
Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AssociateElasticIpResponse associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
associateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AttachElasticLoadBalancerResponse attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
attachElasticLoadBalancerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CloneStackResponse cloneStack(CloneStackRequest cloneStackRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
cloneStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateAppResponse createApp(CreateAppRequest createAppRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
createAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createDeploymentRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateInstanceResponse createInstance(CreateInstanceRequest createInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
createInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateLayerResponse createLayer(CreateLayerRequest createLayerRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Creates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateStackResponse createStack(CreateStackRequest createStackRequest) throws ValidationException, SdkBaseException, SdkClientException, OpsWorksException
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.
createStackRequest - ValidationException - Indicates that a request was not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateUserProfileResponse createUserProfile(CreateUserProfileRequest createUserProfileRequest) throws ValidationException, SdkBaseException, SdkClientException, OpsWorksException
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.
createUserProfileRequest - ValidationException - Indicates that a request was not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
deleteAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteLayerResponse deleteLayer(DeleteLayerRequest deleteLayerRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteUserProfileResponse deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
deleteUserProfileRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterEcsClusterResponse deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsClusterRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterElasticIpResponse deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
deregisterElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterInstanceResponse deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterRdsDbInstanceResponse deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Deregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterVolumeResponse deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
deregisterVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAgentVersionsResponse describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration
manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or
configuration manager.
describeAgentVersionsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAppsResponse describeApps(DescribeAppsRequest describeAppsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Requests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeAppsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCommandsResponse describeCommands(DescribeCommandsRequest describeCommandsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes the results of specified commands.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeCommandsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDeploymentsResponse describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Requests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeDeploymentsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEcsClustersResponse describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the
MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks
Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClustersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeElasticIpsResponse describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeElasticIpsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeElasticLoadBalancersResponse describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeElasticLoadBalancersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeInstancesResponse describeInstances(DescribeInstancesRequest describeInstancesRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Requests a description of a set of instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeInstancesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeLayersResponse describeLayers(DescribeLayersRequest describeLayersRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Requests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeLayersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeLoadBasedAutoScalingResponse describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeLoadBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMyUserProfileResponse describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest) throws SdkBaseException, SdkClientException, OpsWorksException
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.
describeMyUserProfileRequest - SdkBaseExceptionSdkClientExceptionOpsWorksExceptiondefault DescribePermissionsResponse describePermissions(DescribePermissionsRequest describePermissionsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
describePermissionsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeRaidArraysResponse describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeRaidArraysRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeRdsDbInstancesResponse describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeRdsDbInstancesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeServiceErrorsResponse describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes AWS OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrorsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeStackProvisioningParametersResponse describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeStackProvisioningParametersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeStackSummaryResponse describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
describeStackSummaryRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
describeStacksRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTimeBasedAutoScalingResponse describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeTimeBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeUserProfilesResponse describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
describeUserProfilesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeVolumesResponse describeVolumes(DescribeVolumesRequest describeVolumesRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Describes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeVolumesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DetachElasticLoadBalancerResponse detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
detachElasticLoadBalancerRequest - ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisassociateElasticIpResponse disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
disassociateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetHostnameSuggestionResponse getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
getHostnameSuggestionRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GrantAccessResponse grantAccess(GrantAccessRequest grantAccessRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
grantAccessRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Returns a list of tags that are applied to the specified stack or layer.
listTagsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
rebootInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterEcsClusterResponse registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerEcsClusterRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterElasticIpResponse registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
registerElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterInstanceResponse registerInstance(RegisterInstanceRequest registerInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two
tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance handles only the second step. You should instead use the AWS CLI
register command, which performs the entire registration operation. For more information, see Registering an
Instance with an AWS OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterRdsDbInstanceResponse registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterVolumeResponse registerVolume(RegisterVolumeRequest registerVolumeRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
registerVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetLoadBasedAutoScalingResponse setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setLoadBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetPermissionResponse setPermission(SetPermissionRequest setPermissionRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
setPermissionRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetTimeBasedAutoScalingResponse setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
setTimeBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartInstanceResponse startInstance(StartInstanceRequest startInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
startInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartStackResponse startStack(StartStackRequest startStackRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
startStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopInstanceResponse stopInstance(StopInstanceRequest stopInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
stopInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopStackResponse stopStack(StopStackRequest stopStackRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
stopStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
tagResourceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UnassignInstanceResponse unassignInstance(UnassignInstanceRequest unassignInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
unassignInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UnassignVolumeResponse unassignVolume(UnassignVolumeRequest unassignVolumeRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
unassignVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Removes tags from a specified stack or layer.
untagResourceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateAppResponse updateApp(UpdateAppRequest updateAppRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateElasticIpResponse updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateInstanceResponse updateInstance(UpdateInstanceRequest updateInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateLayerResponse updateLayer(UpdateLayerRequest updateLayerRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateMyUserProfileResponse updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest) throws ValidationException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateMyUserProfileRequest - ValidationException - Indicates that a request was not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateRdsDbInstanceResponse updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateUserProfileResponse updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateUserProfileRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateVolumeResponse updateVolume(UpdateVolumeRequest updateVolumeRequest) throws ValidationException, ResourceNotFoundException, SdkBaseException, SdkClientException, OpsWorksException
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.
updateVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)OpsWorksException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
OpsWorksClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.