Class AWSOpsWorksClient
- All Implemented Interfaces:
AWSOpsWorks
- Direct Known Subclasses:
AWSOpsWorksAsyncClient
Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.
AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
- AWS CLI
- AWS SDK for Java
- AWS SDK for .NET
- AWS SDK for PHP 2
- AWS SDK for Ruby
- AWS SDK for Node.js
- AWS SDK for Python(Boto)
Endpoints
AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we
recommend you use the ConfigurationManager
parameter to specify
the Chef version. The recommended value for Linux stacks is currently 12 (the
default is 11.4). Windows stacks use Chef 12.2. For more information, see Chef Versions.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new client to invoke service methods on AWS OpsWorks.AWSOpsWorksClient
(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials.AWSOpsWorksClient
(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider.AWSOpsWorksClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider and client configuration options.AWSOpsWorksClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider, client configuration options, and request metric collector.AWSOpsWorksClient
(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials and client configuration options.AWSOpsWorksClient
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS OpsWorks. -
Method Summary
Modifier and TypeMethodDescriptionassignInstance
(AssignInstanceRequest assignInstanceRequest) Assign a registered instance to a layer.assignVolume
(AssignVolumeRequest assignVolumeRequest) Assigns one of the stack's registered Amazon EBS volumes to a specified instance.associateElasticIp
(AssociateElasticIpRequest associateElasticIpRequest) Associates one of the stack's registered Elastic IP addresses with a specified instance.attachElasticLoadBalancer
(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) Attaches an Elastic Load Balancing load balancer to a specified layer.cloneStack
(CloneStackRequest cloneStackRequest) Creates a clone of a specified stack.createApp
(CreateAppRequest createAppRequest) Creates an app for a specified stack.createDeployment
(CreateDeploymentRequest createDeploymentRequest) Runs deployment or stack commands.createInstance
(CreateInstanceRequest createInstanceRequest) Creates an instance in a specified stack.createLayer
(CreateLayerRequest createLayerRequest) Creates a layer.createStack
(CreateStackRequest createStackRequest) Creates a new stack.createUserProfile
(CreateUserProfileRequest createUserProfileRequest) Creates a new user profile.deleteApp
(DeleteAppRequest deleteAppRequest) Deletes a specified app.deleteInstance
(DeleteInstanceRequest deleteInstanceRequest) Deletes a specified instance, which terminates the associated Amazon EC2 instance.deleteLayer
(DeleteLayerRequest deleteLayerRequest) Deletes a specified layer.deleteStack
(DeleteStackRequest deleteStackRequest) Deletes a specified stack.deleteUserProfile
(DeleteUserProfileRequest deleteUserProfileRequest) Deletes a user profile.deregisterEcsCluster
(DeregisterEcsClusterRequest deregisterEcsClusterRequest) Deregisters a specified Amazon ECS cluster from a stack.deregisterElasticIp
(DeregisterElasticIpRequest deregisterElasticIpRequest) Deregisters a specified Elastic IP address.deregisterInstance
(DeregisterInstanceRequest deregisterInstanceRequest) Deregister a registered Amazon EC2 or on-premises instance.deregisterRdsDbInstance
(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) Deregisters an Amazon RDS instance.deregisterVolume
(DeregisterVolumeRequest deregisterVolumeRequest) Deregisters an Amazon EBS volume.describeAgentVersions
(DescribeAgentVersionsRequest describeAgentVersionsRequest) Describes the available AWS OpsWorks agent versions.describeApps
(DescribeAppsRequest describeAppsRequest) Requests a description of a specified set of apps.describeCommands
(DescribeCommandsRequest describeCommandsRequest) Describes the results of specified commands.describeDeployments
(DescribeDeploymentsRequest describeDeploymentsRequest) Requests a description of a specified set of deployments.describeEcsClusters
(DescribeEcsClustersRequest describeEcsClustersRequest) Describes Amazon ECS clusters that are registered with a stack.describeElasticIps
(DescribeElasticIpsRequest describeElasticIpsRequest) Describes Elastic IP addresses.describeElasticLoadBalancers
(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) Describes a stack's Elastic Load Balancing instances.describeInstances
(DescribeInstancesRequest describeInstancesRequest) Requests a description of a set of instances.describeLayers
(DescribeLayersRequest describeLayersRequest) Requests a description of one or more layers in a specified stack.describeLoadBasedAutoScaling
(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) Describes load-based auto scaling configurations for specified layers.describeMyUserProfile
(DescribeMyUserProfileRequest describeMyUserProfileRequest) Describes a user's SSH information.describePermissions
(DescribePermissionsRequest describePermissionsRequest) Describes the permissions for a specified stack.describeRaidArrays
(DescribeRaidArraysRequest describeRaidArraysRequest) Describe an instance's RAID arrays.describeRdsDbInstances
(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) Describes Amazon RDS instances.describeServiceErrors
(DescribeServiceErrorsRequest describeServiceErrorsRequest) Describes AWS OpsWorks service errors.describeStackProvisioningParameters
(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) Requests a description of a stack's provisioning parameters.describeStacks
(DescribeStacksRequest describeStacksRequest) Requests a description of one or more stacks.describeStackSummary
(DescribeStackSummaryRequest describeStackSummaryRequest) Describes the number of layers and apps in a specified stack, and the number of instances in each state, such asrunning_setup
oronline
.describeTimeBasedAutoScaling
(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) Describes time-based auto scaling configurations for specified instances.describeUserProfiles
(DescribeUserProfilesRequest describeUserProfilesRequest) Describe specified users.describeVolumes
(DescribeVolumesRequest describeVolumesRequest) Describes an instance's Amazon EBS volumes.detachElasticLoadBalancer
(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) Detaches a specified Elastic Load Balancing instance from its layer.disassociateElasticIp
(DisassociateElasticIpRequest disassociateElasticIpRequest) Disassociates an Elastic IP address from its instance.Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.getHostnameSuggestion
(GetHostnameSuggestionRequest getHostnameSuggestionRequest) Gets a generated host name for the specified layer, based on the current host name theme.grantAccess
(GrantAccessRequest grantAccessRequest) This action can be used only with Windows stacks. rebootInstance
(RebootInstanceRequest rebootInstanceRequest) Reboots a specified instance.registerEcsCluster
(RegisterEcsClusterRequest registerEcsClusterRequest) Registers a specified Amazon ECS cluster with a stack.registerElasticIp
(RegisterElasticIpRequest registerElasticIpRequest) Registers an Elastic IP address with a specified stack.registerInstance
(RegisterInstanceRequest registerInstanceRequest) Registers instances with a specified stack that were created outside of AWS OpsWorks.registerRdsDbInstance
(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) Registers an Amazon RDS instance with a stack.registerVolume
(RegisterVolumeRequest registerVolumeRequest) Registers an Amazon EBS volume with a specified stack.setLoadBasedAutoScaling
(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) Specify the load-based auto scaling configuration for a specified layer.setPermission
(SetPermissionRequest setPermissionRequest) Specifies a user's permissions.setTimeBasedAutoScaling
(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) Specify the time-based auto scaling configuration for a specified instance.startInstance
(StartInstanceRequest startInstanceRequest) Starts a specified instance.startStack
(StartStackRequest startStackRequest) Starts a stack's instances.stopInstance
(StopInstanceRequest stopInstanceRequest) Stops a specified instance.stopStack
(StopStackRequest stopStackRequest) Stops a specified stack.unassignInstance
(UnassignInstanceRequest unassignInstanceRequest) Unassigns a registered instance from all of it's layers.unassignVolume
(UnassignVolumeRequest unassignVolumeRequest) Unassigns an assigned Amazon EBS volume.updateApp
(UpdateAppRequest updateAppRequest) Updates a specified app.updateElasticIp
(UpdateElasticIpRequest updateElasticIpRequest) Updates a registered Elastic IP address's name.updateInstance
(UpdateInstanceRequest updateInstanceRequest) Updates a specified instance.updateLayer
(UpdateLayerRequest updateLayerRequest) Updates a specified layer.updateMyUserProfile
(UpdateMyUserProfileRequest updateMyUserProfileRequest) Updates a user's SSH public key.updateRdsDbInstance
(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) Updates an Amazon RDS instance.updateStack
(UpdateStackRequest updateStackRequest) Updates a specified stack.updateUserProfile
(UpdateUserProfileRequest updateUserProfileRequest) Updates a specified user profile.updateVolume
(UpdateVolumeRequest updateVolumeRequest) Updates an Amazon EBS volume's name or mount point.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.opsworks.AWSOpsWorks
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Details
-
AWSOpsWorksClient
public AWSOpsWorksClient()Constructs a new client to invoke service methods on AWS OpsWorks. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AWSOpsWorksClient
Constructs a new client to invoke service methods on AWS OpsWorks. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).- See Also:
-
AWSOpsWorksClient
Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AWSOpsWorksClient
Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).
-
AWSOpsWorksClient
Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AWSOpsWorksClient
public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).
-
AWSOpsWorksClient
public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Details
-
assignInstance
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.
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.
- Specified by:
assignInstance
in interfaceAWSOpsWorks
- Parameters:
assignInstanceRequest
-- Returns:
- Result of the AssignInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
assignVolume
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.
- Specified by:
assignVolume
in interfaceAWSOpsWorks
- Parameters:
assignVolumeRequest
-- Returns:
- Result of the AssignVolume operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
associateElasticIp
public AssociateElasticIpResult associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest) Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
associateElasticIp
in interfaceAWSOpsWorks
- Parameters:
associateElasticIpRequest
-- Returns:
- Result of the AssociateElasticIp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
attachElasticLoadBalancer
public AttachElasticLoadBalancerResult attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) Attaches an Elastic Load Balancing load balancer to a specified layer. 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.
- Specified by:
attachElasticLoadBalancer
in interfaceAWSOpsWorks
- Parameters:
attachElasticLoadBalancerRequest
-- Returns:
- Result of the AttachElasticLoadBalancer operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
cloneStack
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.
- Specified by:
cloneStack
in interfaceAWSOpsWorks
- Parameters:
cloneStackRequest
-- Returns:
- Result of the CloneStack operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
createApp
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.
- Specified by:
createApp
in interfaceAWSOpsWorks
- Parameters:
createAppRequest
-- Returns:
- Result of the CreateApp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
createDeployment
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.
- Specified by:
createDeployment
in interfaceAWSOpsWorks
- Parameters:
createDeploymentRequest
-- Returns:
- Result of the CreateDeployment operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
createInstance
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.
- Specified by:
createInstance
in interfaceAWSOpsWorks
- Parameters:
createInstanceRequest
-- Returns:
- Result of the CreateInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
createLayer
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.
- Specified by:
createLayer
in interfaceAWSOpsWorks
- Parameters:
createLayerRequest
-- Returns:
- Result of the CreateLayer operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
createStack
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.
- Specified by:
createStack
in interfaceAWSOpsWorks
- Parameters:
createStackRequest
-- Returns:
- Result of the CreateStack operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.
-
createUserProfile
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.
- Specified by:
createUserProfile
in interfaceAWSOpsWorks
- Parameters:
createUserProfileRequest
-- Returns:
- Result of the CreateUserProfile operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.
-
deleteApp
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.
- Specified by:
deleteApp
in interfaceAWSOpsWorks
- Parameters:
deleteAppRequest
-- Returns:
- Result of the DeleteApp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deleteInstance
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.
- Specified by:
deleteInstance
in interfaceAWSOpsWorks
- Parameters:
deleteInstanceRequest
-- Returns:
- Result of the DeleteInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deleteLayer
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.
- Specified by:
deleteLayer
in interfaceAWSOpsWorks
- Parameters:
deleteLayerRequest
-- Returns:
- Result of the DeleteLayer operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deleteStack
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.
- Specified by:
deleteStack
in interfaceAWSOpsWorks
- Parameters:
deleteStackRequest
-- Returns:
- Result of the DeleteStack operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deleteUserProfile
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.
- Specified by:
deleteUserProfile
in interfaceAWSOpsWorks
- Parameters:
deleteUserProfileRequest
-- Returns:
- Result of the DeleteUserProfile operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deregisterEcsCluster
public DeregisterEcsClusterResult deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest) 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 .
- Specified by:
deregisterEcsCluster
in interfaceAWSOpsWorks
- Parameters:
deregisterEcsClusterRequest
-- Returns:
- Result of the DeregisterEcsCluster operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deregisterElasticIp
public DeregisterElasticIpResult deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest) Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
deregisterElasticIp
in interfaceAWSOpsWorks
- Parameters:
deregisterElasticIpRequest
-- Returns:
- Result of the DeregisterElasticIp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deregisterInstance
public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) 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.
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.
- Specified by:
deregisterInstance
in interfaceAWSOpsWorks
- Parameters:
deregisterInstanceRequest
-- Returns:
- Result of the DeregisterInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deregisterRdsDbInstance
public DeregisterRdsDbInstanceResult deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) 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.
- Specified by:
deregisterRdsDbInstance
in interfaceAWSOpsWorks
- Parameters:
deregisterRdsDbInstanceRequest
-- Returns:
- Result of the DeregisterRdsDbInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
deregisterVolume
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.
- Specified by:
deregisterVolume
in interfaceAWSOpsWorks
- Parameters:
deregisterVolumeRequest
-- Returns:
- Result of the DeregisterVolume operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeAgentVersions
public DescribeAgentVersionsResult describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest) Describes the available AWS OpsWorks 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.- Specified by:
describeAgentVersions
in interfaceAWSOpsWorks
- Parameters:
describeAgentVersionsRequest
-- Returns:
- Result of the DescribeAgentVersions operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeApps
Requests a description of a specified set of apps.
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.
- Specified by:
describeApps
in interfaceAWSOpsWorks
- Parameters:
describeAppsRequest
-- Returns:
- Result of the DescribeApps operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeCommands
Describes the results of specified commands.
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.
- Specified by:
describeCommands
in interfaceAWSOpsWorks
- Parameters:
describeCommandsRequest
-- Returns:
- Result of the DescribeCommands operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeDeployments
public DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest) Requests a description of a specified set of deployments.
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.
- Specified by:
describeDeployments
in interfaceAWSOpsWorks
- Parameters:
describeDeploymentsRequest
-- Returns:
- Result of the DescribeDeployments operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeEcsClusters
public DescribeEcsClustersResult describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest) Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the
MaxResults
andNextToken
parameters to paginate the response. However, AWS OpsWorks 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.
- Specified by:
describeEcsClusters
in interfaceAWSOpsWorks
- Parameters:
describeEcsClustersRequest
-- Returns:
- Result of the DescribeEcsClusters operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeElasticIps
public DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest) Describes Elastic IP addresses.
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.
- Specified by:
describeElasticIps
in interfaceAWSOpsWorks
- Parameters:
describeElasticIpsRequest
-- Returns:
- Result of the DescribeElasticIps operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeElasticLoadBalancers
public DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) Describes a stack's Elastic Load Balancing 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.
- Specified by:
describeElasticLoadBalancers
in interfaceAWSOpsWorks
- Parameters:
describeElasticLoadBalancersRequest
-- Returns:
- Result of the DescribeElasticLoadBalancers operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeInstances
Requests a description of a set of 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.
- Specified by:
describeInstances
in interfaceAWSOpsWorks
- Parameters:
describeInstancesRequest
-- Returns:
- Result of the DescribeInstances operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeLayers
Requests a description of one or more layers in a specified stack.
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.
- Specified by:
describeLayers
in interfaceAWSOpsWorks
- Parameters:
describeLayersRequest
-- Returns:
- Result of the DescribeLayers operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeLoadBasedAutoScaling
public DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) 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.
- Specified by:
describeLoadBasedAutoScaling
in interfaceAWSOpsWorks
- Parameters:
describeLoadBasedAutoScalingRequest
-- Returns:
- Result of the DescribeLoadBasedAutoScaling operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeMyUserProfile
public DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest) Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
describeMyUserProfile
in interfaceAWSOpsWorks
- Parameters:
describeMyUserProfileRequest
-- Returns:
- Result of the DescribeMyUserProfile operation returned by the service.
-
describePermissions
public DescribePermissionsResult describePermissions(DescribePermissionsRequest describePermissionsRequest) Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
describePermissions
in interfaceAWSOpsWorks
- Parameters:
describePermissionsRequest
-- Returns:
- Result of the DescribePermissions operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeRaidArrays
public DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest) Describe an instance's RAID arrays.
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.
- Specified by:
describeRaidArrays
in interfaceAWSOpsWorks
- Parameters:
describeRaidArraysRequest
-- Returns:
- Result of the DescribeRaidArrays operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeRdsDbInstances
public DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) 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.
- Specified by:
describeRdsDbInstances
in interfaceAWSOpsWorks
- Parameters:
describeRdsDbInstancesRequest
-- Returns:
- Result of the DescribeRdsDbInstances operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeServiceErrors
public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest) Describes AWS OpsWorks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
describeServiceErrors
in interfaceAWSOpsWorks
- Parameters:
describeServiceErrorsRequest
-- Returns:
- Result of the DescribeServiceErrors operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeStackProvisioningParameters
public DescribeStackProvisioningParametersResult describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) 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.
- Specified by:
describeStackProvisioningParameters
in interfaceAWSOpsWorks
- Parameters:
describeStackProvisioningParametersRequest
-- Returns:
- Result of the DescribeStackProvisioningParameters operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeStackSummary
public DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest) Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup
oronline
.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.
- Specified by:
describeStackSummary
in interfaceAWSOpsWorks
- Parameters:
describeStackSummaryRequest
-- Returns:
- Result of the DescribeStackSummary operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeStacks
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.
- Specified by:
describeStacks
in interfaceAWSOpsWorks
- Parameters:
describeStacksRequest
-- Returns:
- Result of the DescribeStacks operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeTimeBasedAutoScaling
public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) 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.
- Specified by:
describeTimeBasedAutoScaling
in interfaceAWSOpsWorks
- Parameters:
describeTimeBasedAutoScalingRequest
-- Returns:
- Result of the DescribeTimeBasedAutoScaling operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeUserProfiles
public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest) Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
describeUserProfiles
in interfaceAWSOpsWorks
- Parameters:
describeUserProfilesRequest
-- Returns:
- Result of the DescribeUserProfiles operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
describeVolumes
Describes an instance's Amazon EBS volumes.
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.
- Specified by:
describeVolumes
in interfaceAWSOpsWorks
- Parameters:
describeVolumesRequest
-- Returns:
- Result of the DescribeVolumes operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
detachElasticLoadBalancer
public DetachElasticLoadBalancerResult detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
detachElasticLoadBalancer
in interfaceAWSOpsWorks
- Parameters:
detachElasticLoadBalancerRequest
-- Returns:
- Result of the DetachElasticLoadBalancer operation returned by the service.
- Throws:
ResourceNotFoundException
- Indicates that a resource was not found.
-
disassociateElasticIp
public DisassociateElasticIpResult disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest) Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
disassociateElasticIp
in interfaceAWSOpsWorks
- Parameters:
disassociateElasticIpRequest
-- Returns:
- Result of the DisassociateElasticIp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
getHostnameSuggestion
public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest) Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
getHostnameSuggestion
in interfaceAWSOpsWorks
- Parameters:
getHostnameSuggestionRequest
-- Returns:
- Result of the GetHostnameSuggestion operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
grantAccess
This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period.
- Specified by:
grantAccess
in interfaceAWSOpsWorks
- Parameters:
grantAccessRequest
-- Returns:
- Result of the GrantAccess operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
rebootInstance
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.
- Specified by:
rebootInstance
in interfaceAWSOpsWorks
- Parameters:
rebootInstanceRequest
-- Returns:
- Result of the RebootInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
registerEcsCluster
public RegisterEcsClusterResult registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest) 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.
- Specified by:
registerEcsCluster
in interfaceAWSOpsWorks
- Parameters:
registerEcsClusterRequest
-- Returns:
- Result of the RegisterEcsCluster operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
registerElasticIp
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.
- Specified by:
registerElasticIp
in interfaceAWSOpsWorks
- Parameters:
registerElasticIpRequest
-- Returns:
- Result of the RegisterElasticIp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
registerInstance
Registers instances with a specified stack that were created outside of AWS OpsWorks.
We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance
handles only the second step. You should instead use the AWS CLIregister
command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks 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.
- Specified by:
registerInstance
in interfaceAWSOpsWorks
- Parameters:
registerInstanceRequest
-- Returns:
- Result of the RegisterInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
registerRdsDbInstance
public RegisterRdsDbInstanceResult registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) 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.
- Specified by:
registerRdsDbInstance
in interfaceAWSOpsWorks
- Parameters:
registerRdsDbInstanceRequest
-- Returns:
- Result of the RegisterRdsDbInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
registerVolume
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.
- Specified by:
registerVolume
in interfaceAWSOpsWorks
- Parameters:
registerVolumeRequest
-- Returns:
- Result of the RegisterVolume operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
setLoadBasedAutoScaling
public SetLoadBasedAutoScalingResult setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
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.
- Specified by:
setLoadBasedAutoScaling
in interfaceAWSOpsWorks
- Parameters:
setLoadBasedAutoScalingRequest
-- Returns:
- Result of the SetLoadBasedAutoScaling operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
setPermission
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.
- Specified by:
setPermission
in interfaceAWSOpsWorks
- Parameters:
setPermissionRequest
-- Returns:
- Result of the SetPermission operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
setTimeBasedAutoScaling
public SetTimeBasedAutoScalingResult setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
setTimeBasedAutoScaling
in interfaceAWSOpsWorks
- Parameters:
setTimeBasedAutoScalingRequest
-- Returns:
- Result of the SetTimeBasedAutoScaling operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
startInstance
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.
- Specified by:
startInstance
in interfaceAWSOpsWorks
- Parameters:
startInstanceRequest
-- Returns:
- Result of the StartInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
startStack
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.
- Specified by:
startStack
in interfaceAWSOpsWorks
- Parameters:
startStackRequest
-- Returns:
- Result of the StartStack operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
stopInstance
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.
- Specified by:
stopInstance
in interfaceAWSOpsWorks
- Parameters:
stopInstanceRequest
-- Returns:
- Result of the StopInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
stopStack
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.
- Specified by:
stopStack
in interfaceAWSOpsWorks
- Parameters:
stopStackRequest
-- Returns:
- Result of the StopStack operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
unassignInstance
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.
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.
- Specified by:
unassignInstance
in interfaceAWSOpsWorks
- Parameters:
unassignInstanceRequest
-- Returns:
- Result of the UnassignInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
unassignVolume
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.
- Specified by:
unassignVolume
in interfaceAWSOpsWorks
- Parameters:
unassignVolumeRequest
-- Returns:
- Result of the UnassignVolume operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateApp
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.
- Specified by:
updateApp
in interfaceAWSOpsWorks
- Parameters:
updateAppRequest
-- Returns:
- Result of the UpdateApp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateElasticIp
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.
- Specified by:
updateElasticIp
in interfaceAWSOpsWorks
- Parameters:
updateElasticIpRequest
-- Returns:
- Result of the UpdateElasticIp operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateInstance
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.
- Specified by:
updateInstance
in interfaceAWSOpsWorks
- Parameters:
updateInstanceRequest
-- Returns:
- Result of the UpdateInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateLayer
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.
- Specified by:
updateLayer
in interfaceAWSOpsWorks
- Parameters:
updateLayerRequest
-- Returns:
- Result of the UpdateLayer operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateMyUserProfile
public UpdateMyUserProfileResult updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest) Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
updateMyUserProfile
in interfaceAWSOpsWorks
- Parameters:
updateMyUserProfileRequest
-- Returns:
- Result of the UpdateMyUserProfile operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.
-
updateRdsDbInstance
public UpdateRdsDbInstanceResult updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) 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.
- Specified by:
updateRdsDbInstance
in interfaceAWSOpsWorks
- Parameters:
updateRdsDbInstanceRequest
-- Returns:
- Result of the UpdateRdsDbInstance operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateStack
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.
- Specified by:
updateStack
in interfaceAWSOpsWorks
- Parameters:
updateStackRequest
-- Returns:
- Result of the UpdateStack operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateUserProfile
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.
- Specified by:
updateUserProfile
in interfaceAWSOpsWorks
- Parameters:
updateUserProfileRequest
-- Returns:
- Result of the UpdateUserProfile operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
updateVolume
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.
- Specified by:
updateVolume
in interfaceAWSOpsWorks
- Parameters:
updateVolumeRequest
-- Returns:
- Result of the UpdateVolume operation returned by the service.
- Throws:
ValidationException
- Indicates that a request was invalid.ResourceNotFoundException
- Indicates that a resource was not found.
-
getCachedResponseMetadata
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSOpsWorks
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-