@ThreadSafe public class AWSOpsWorksClient extends AmazonWebServiceClient implements AWSOpsWorks
Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks actions and data types, including common parameters and error codes.
AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks supports 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-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.eu-west-1.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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSOpsWorksClient()
Constructs 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(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(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(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS OpsWorks.
|
Modifier and Type | Method and Description |
---|---|
AssignInstanceResult |
assignInstance(AssignInstanceRequest assignInstanceRequest)
Assign a registered instance to a layer.
|
AssignVolumeResult |
assignVolume(AssignVolumeRequest assignVolumeRequest)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
|
AssociateElasticIpResult |
associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)
Associates one of the stack's registered Elastic IP addresses with a specified instance.
|
AttachElasticLoadBalancerResult |
attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
Attaches an Elastic Load Balancing load balancer to a specified layer.
|
CloneStackResult |
cloneStack(CloneStackRequest cloneStackRequest)
Creates a clone of a specified stack.
|
CreateAppResult |
createApp(CreateAppRequest createAppRequest)
Creates an app for a specified stack.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Runs deployment or stack commands.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest createInstanceRequest)
Creates an instance in a specified stack.
|
CreateLayerResult |
createLayer(CreateLayerRequest createLayerRequest)
Creates a layer.
|
CreateStackResult |
createStack(CreateStackRequest createStackRequest)
Creates a new stack.
|
CreateUserProfileResult |
createUserProfile(CreateUserProfileRequest createUserProfileRequest)
Creates a new user profile.
|
DeleteAppResult |
deleteApp(DeleteAppRequest deleteAppRequest)
Deletes a specified app.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
|
DeleteLayerResult |
deleteLayer(DeleteLayerRequest deleteLayerRequest)
Deletes a specified layer.
|
DeleteStackResult |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
DeleteUserProfileResult |
deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
Deletes a user profile.
|
DeregisterEcsClusterResult |
deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest)
Deregisters a specified Amazon ECS cluster from a stack.
|
DeregisterElasticIpResult |
deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
Deregisters a specified Elastic IP address.
|
DeregisterInstanceResult |
deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)
Deregister a registered Amazon EC2 or on-premises instance.
|
DeregisterRdsDbInstanceResult |
deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)
Deregisters an Amazon RDS instance.
|
DeregisterVolumeResult |
deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
Deregisters an Amazon EBS volume.
|
DescribeAgentVersionsResult |
describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest)
Describes the available AWS OpsWorks agent versions.
|
DescribeAppsResult |
describeApps(DescribeAppsRequest describeAppsRequest)
Requests a description of a specified set of apps.
|
DescribeCommandsResult |
describeCommands(DescribeCommandsRequest describeCommandsRequest)
Describes the results of specified commands.
|
DescribeDeploymentsResult |
describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
Requests a description of a specified set of deployments.
|
DescribeEcsClustersResult |
describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest)
Describes Amazon ECS clusters that are registered with a stack.
|
DescribeElasticIpsResult |
describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
Describes Elastic IP
addresses.
|
DescribeElasticLoadBalancersResult |
describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
Describes a stack's Elastic Load Balancing instances.
|
DescribeInstancesResult |
describeInstances(DescribeInstancesRequest describeInstancesRequest)
Requests a description of a set of instances.
|
DescribeLayersResult |
describeLayers(DescribeLayersRequest describeLayersRequest)
Requests a description of one or more layers in a specified stack.
|
DescribeLoadBasedAutoScalingResult |
describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)
Describes load-based auto scaling configurations for specified layers.
|
DescribeMyUserProfileResult |
describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)
Describes a user's SSH information.
|
DescribePermissionsResult |
describePermissions(DescribePermissionsRequest describePermissionsRequest)
Describes the permissions for a specified stack.
|
DescribeRaidArraysResult |
describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
Describe an instance's RAID arrays.
|
DescribeRdsDbInstancesResult |
describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)
Describes Amazon RDS instances.
|
DescribeServiceErrorsResult |
describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
Describes AWS OpsWorks service errors.
|
DescribeStackProvisioningParametersResult |
describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest)
Requests a description of a stack's provisioning parameters.
|
DescribeStacksResult |
describeStacks(DescribeStacksRequest describeStacksRequest)
Requests a description of one or more stacks.
|
DescribeStackSummaryResult |
describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup or online . |
DescribeTimeBasedAutoScalingResult |
describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
Describes time-based auto scaling configurations for specified instances.
|
DescribeUserProfilesResult |
describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
Describe specified users.
|
DescribeVolumesResult |
describeVolumes(DescribeVolumesRequest describeVolumesRequest)
Describes an instance's Amazon EBS volumes.
|
DetachElasticLoadBalancerResult |
detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
Detaches a specified Elastic Load Balancing instance from its layer.
|
DisassociateElasticIpResult |
disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)
Disassociates an Elastic IP address from its instance.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetHostnameSuggestionResult |
getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
Gets a generated host name for the specified layer, based on the current host name theme.
|
GrantAccessResult |
grantAccess(GrantAccessRequest grantAccessRequest)
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Reboots a specified instance.
|
RegisterEcsClusterResult |
registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest)
Registers a specified Amazon ECS cluster with a stack.
|
RegisterElasticIpResult |
registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)
Registers an Elastic IP address with a specified stack.
|
RegisterInstanceResult |
registerInstance(RegisterInstanceRequest registerInstanceRequest)
Registers instances with a specified stack that were created outside of AWS OpsWorks.
|
RegisterRdsDbInstanceResult |
registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)
Registers an Amazon RDS instance with a stack.
|
RegisterVolumeResult |
registerVolume(RegisterVolumeRequest registerVolumeRequest)
Registers an Amazon EBS volume with a specified stack.
|
SetLoadBasedAutoScalingResult |
setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)
Specify the load-based auto scaling configuration for a specified layer.
|
SetPermissionResult |
setPermission(SetPermissionRequest setPermissionRequest)
Specifies a user's permissions.
|
SetTimeBasedAutoScalingResult |
setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)
Specify the time-based auto scaling configuration for a specified instance.
|
StartInstanceResult |
startInstance(StartInstanceRequest startInstanceRequest)
Starts a specified instance.
|
StartStackResult |
startStack(StartStackRequest startStackRequest)
Starts a stack's instances.
|
StopInstanceResult |
stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specified instance.
|
StopStackResult |
stopStack(StopStackRequest stopStackRequest)
Stops a specified stack.
|
UnassignInstanceResult |
unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
Unassigns a registered instance from all of it's layers.
|
UnassignVolumeResult |
unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
Unassigns an assigned Amazon EBS volume.
|
UpdateAppResult |
updateApp(UpdateAppRequest updateAppRequest)
Updates a specified app.
|
UpdateElasticIpResult |
updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
Updates a registered Elastic IP address's name.
|
UpdateInstanceResult |
updateInstance(UpdateInstanceRequest updateInstanceRequest)
Updates a specified instance.
|
UpdateLayerResult |
updateLayer(UpdateLayerRequest updateLayerRequest)
Updates a specified layer.
|
UpdateMyUserProfileResult |
updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)
Updates a user's SSH public key.
|
UpdateRdsDbInstanceResult |
updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)
Updates an Amazon RDS instance.
|
UpdateStackResult |
updateStack(UpdateStackRequest updateStackRequest)
Updates a specified stack.
|
UpdateUserProfileResult |
updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
Updates a specified user profile.
|
UpdateVolumeResult |
updateVolume(UpdateVolumeRequest updateVolumeRequest)
Updates an Amazon EBS volume's name or mount point.
|
AWSOpsWorksWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
public AWSOpsWorksClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AWSOpsWorksClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
public AWSOpsWorksClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.public AWSOpsWorksClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic AssignInstanceResult assignInstance(AssignInstanceRequest assignInstanceRequest)
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.
assignInstance
in interface AWSOpsWorks
assignInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public AssignVolumeResult assignVolume(AssignVolumeRequest assignVolumeRequest)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be
registered with the stack by calling RegisterVolume. 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.
assignVolume
in interface AWSOpsWorks
assignVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
associateElasticIp
in interface AWSOpsWorks
associateElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
attachElasticLoadBalancer
in interface AWSOpsWorks
attachElasticLoadBalancerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public CloneStackResult cloneStack(CloneStackRequest cloneStackRequest)
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.
cloneStack
in interface AWSOpsWorks
cloneStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public CreateAppResult createApp(CreateAppRequest createAppRequest)
Creates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createApp
in interface AWSOpsWorks
createAppRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
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.
createDeployment
in interface AWSOpsWorks
createDeploymentRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest)
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createInstance
in interface AWSOpsWorks
createInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public CreateLayerResult createLayer(CreateLayerRequest createLayerRequest)
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.
createLayer
in interface AWSOpsWorks
createLayerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public CreateStackResult createStack(CreateStackRequest createStackRequest)
Creates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createStack
in interface AWSOpsWorks
createStackRequest
- ValidationException
- Indicates that a request was not valid.public CreateUserProfileResult createUserProfile(CreateUserProfileRequest createUserProfileRequest)
Creates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createUserProfile
in interface AWSOpsWorks
createUserProfileRequest
- ValidationException
- Indicates that a request was not valid.public DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
Deletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteApp
in interface AWSOpsWorks
deleteAppRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DeleteInstanceResult deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
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.
deleteInstance
in interface AWSOpsWorks
deleteInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DeleteLayerResult deleteLayer(DeleteLayerRequest deleteLayerRequest)
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.
deleteLayer
in interface AWSOpsWorks
deleteLayerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)
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.
deleteStack
in interface AWSOpsWorks
deleteStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteUserProfile
in interface AWSOpsWorks
deleteUserProfileRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsCluster
in interface AWSOpsWorks
deregisterEcsClusterRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deregisterElasticIp
in interface AWSOpsWorks
deregisterElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deregisterInstance
in interface AWSOpsWorks
deregisterInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deregisterRdsDbInstance
in interface AWSOpsWorks
deregisterRdsDbInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DeregisterVolumeResult deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterVolume
in interface AWSOpsWorks
deregisterVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeAgentVersions
in interface AWSOpsWorks
describeAgentVersionsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeAppsResult describeApps(DescribeAppsRequest describeAppsRequest)
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.
describeApps
in interface AWSOpsWorks
describeAppsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeCommandsResult describeCommands(DescribeCommandsRequest describeCommandsRequest)
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.
describeCommands
in interface AWSOpsWorks
describeCommandsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeDeployments
in interface AWSOpsWorks
describeDeploymentsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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
and NextToken
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.
describeEcsClusters
in interface AWSOpsWorks
describeEcsClustersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeElasticIps
in interface AWSOpsWorks
describeElasticIpsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeElasticLoadBalancers
in interface AWSOpsWorks
describeElasticLoadBalancersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)
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.
describeInstances
in interface AWSOpsWorks
describeInstancesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeLayersResult describeLayers(DescribeLayersRequest describeLayersRequest)
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.
describeLayers
in interface AWSOpsWorks
describeLayersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeLoadBasedAutoScaling
in interface AWSOpsWorks
describeLoadBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)
Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeMyUserProfile
in interface AWSOpsWorks
describeMyUserProfileRequest
- public DescribePermissionsResult describePermissions(DescribePermissionsRequest describePermissionsRequest)
Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describePermissions
in interface AWSOpsWorks
describePermissionsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeRaidArrays
in interface AWSOpsWorks
describeRaidArraysRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeRdsDbInstances
in interface AWSOpsWorks
describeRdsDbInstancesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
Describes AWS OpsWorks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeServiceErrors
in interface AWSOpsWorks
describeServiceErrorsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeStackProvisioningParameters
in interface AWSOpsWorks
describeStackProvisioningParametersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup
or online
.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeStackSummary
in interface AWSOpsWorks
describeStackSummaryRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeStacks
in interface AWSOpsWorks
describeStacksRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
describeTimeBasedAutoScaling
in interface AWSOpsWorks
describeTimeBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeUserProfiles
in interface AWSOpsWorks
describeUserProfilesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
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.
describeVolumes
in interface AWSOpsWorks
describeVolumesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
detachElasticLoadBalancer
in interface AWSOpsWorks
detachElasticLoadBalancerRequest
- ResourceNotFoundException
- Indicates that a resource was not found.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.
disassociateElasticIp
in interface AWSOpsWorks
disassociateElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
getHostnameSuggestion
in interface AWSOpsWorks
getHostnameSuggestionRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public GrantAccessResult grantAccess(GrantAccessRequest grantAccessRequest)
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
grantAccess
in interface AWSOpsWorks
grantAccessRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public RebootInstanceResult rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
rebootInstance
in interface AWSOpsWorks
rebootInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
registerEcsCluster
in interface AWSOpsWorks
registerEcsClusterRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)
Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerElasticIp
in interface AWSOpsWorks
registerElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public RegisterInstanceResult registerInstance(RegisterInstanceRequest registerInstanceRequest)
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 CLI
register
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.
registerInstance
in interface AWSOpsWorks
registerInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
registerRdsDbInstance
in interface AWSOpsWorks
registerRdsDbInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public RegisterVolumeResult registerVolume(RegisterVolumeRequest registerVolumeRequest)
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerVolume
in interface AWSOpsWorks
registerVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
setLoadBasedAutoScaling
in interface AWSOpsWorks
setLoadBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public SetPermissionResult setPermission(SetPermissionRequest setPermissionRequest)
Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setPermission
in interface AWSOpsWorks
setPermissionRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
setTimeBasedAutoScaling
in interface AWSOpsWorks
setTimeBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public StartInstanceResult startInstance(StartInstanceRequest startInstanceRequest)
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startInstance
in interface AWSOpsWorks
startInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public StartStackResult startStack(StartStackRequest startStackRequest)
Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startStack
in interface AWSOpsWorks
startStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public StopInstanceResult stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopInstance
in interface AWSOpsWorks
stopInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public StopStackResult stopStack(StopStackRequest stopStackRequest)
Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopStack
in interface AWSOpsWorks
stopStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UnassignInstanceResult unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
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.
unassignInstance
in interface AWSOpsWorks
unassignInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UnassignVolumeResult unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
unassignVolume
in interface AWSOpsWorks
unassignVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UpdateAppResult updateApp(UpdateAppRequest updateAppRequest)
Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateApp
in interface AWSOpsWorks
updateAppRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UpdateElasticIpResult updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateElasticIp
in interface AWSOpsWorks
updateElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UpdateInstanceResult updateInstance(UpdateInstanceRequest updateInstanceRequest)
Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateInstance
in interface AWSOpsWorks
updateInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UpdateLayerResult updateLayer(UpdateLayerRequest updateLayerRequest)
Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateLayer
in interface AWSOpsWorks
updateLayerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
updateMyUserProfile
in interface AWSOpsWorks
updateMyUserProfileRequest
- ValidationException
- Indicates that a request was not valid.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.
updateRdsDbInstance
in interface AWSOpsWorks
updateRdsDbInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateStack
in interface AWSOpsWorks
updateStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
Updates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateUserProfile
in interface AWSOpsWorks
updateUserProfileRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public UpdateVolumeResult updateVolume(UpdateVolumeRequest updateVolumeRequest)
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateVolume
in interface AWSOpsWorks
updateVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSOpsWorks
request
- The originally executed requestpublic AWSOpsWorksWaiters waiters()
waiters
in interface AWSOpsWorks
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.