@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSOpsWorks
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSOpsWorks
instead.
Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for OpsWorks Stacks actions and data types, including common parameters and error codes.
OpsWorks Stacks is an application management service that provides an integrated experience for managing the complete application lifecycle. For information about OpsWorks, see the OpsWorks information page.
SDKs and CLI
Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:
Endpoints
OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
opsworks.us-east-1.amazonaws.com
opsworks.us-east-2.amazonaws.com
opsworks.us-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-west-3.amazonaws.com
opsworks.eu-central-1.amazonaws.com
opsworks.ap-northeast-1.amazonaws.com
opsworks.ap-northeast-2.amazonaws.com
opsworks.ap-south-1.amazonaws.com
opsworks.ap-southeast-1.amazonaws.com
opsworks.ap-southeast-2.amazonaws.com
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the
ConfigurationManager
parameter to specify the Chef version. The recommended and default value for Linux
stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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 an instance from OpsWorks Stacks.
|
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 OpsWorks Stacks 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.
|
DescribeOperatingSystemsResult |
describeOperatingSystems(DescribeOperatingSystemsRequest describeOperatingSystemsRequest)
Describes the operating systems that are supported by OpsWorks Stacks.
|
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 OpsWorks Stacks 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)
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Returns a list of tags that are applied to the specified stack or layer.
|
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 that were created outside of OpsWorks Stacks with a specified stack.
|
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.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetLoadBasedAutoScalingResult |
setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)
Specify the load-based auto scaling configuration for a specified layer.
|
SetPermissionResult |
setPermission(SetPermissionRequest setPermissionRequest)
Specifies a user's permissions.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
SetTimeBasedAutoScalingResult |
setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)
Specify the time-based auto scaling configuration for a specified instance.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
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.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks.
|
UnassignInstanceResult |
unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
Unassigns a registered instance from all layers that are using the instance.
|
UnassignVolumeResult |
unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
Unassigns an assigned Amazon EBS volume.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a specified stack or layer.
|
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() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://opsworks.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://opsworks.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
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 OpsWorks Stacks.
Required Permissions: To use this action, an Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
assignVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
associateElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.AttachElasticLoadBalancerResult attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see the Elastic Load Balancing Developer Guide.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
attachElasticLoadBalancerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
cloneStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
createAppRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
createDeploymentRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
createInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
createLayerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
createStackRequest
- ValidationException
- Indicates that a request was not valid.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 about user permissions, see Managing User Permissions.
createUserProfileRequest
- ValidationException
- Indicates that a request was not valid.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.
deleteAppRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deleteInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deleteLayerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deleteStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
deleteUserProfileRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsClusterRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DeregisterElasticIpResult deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
Deregisters a specified Elastic IP address. The address can be registered by another stack after it is deregistered. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)
Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deregisterRdsDbInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
deregisterVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeAgentVersionsResult describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest)
Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager.
DescribeAgentVersions
returns a list of available agent versions for the specified stack or
configuration manager.
describeAgentVersionsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeAppsResult describeApps(DescribeAppsRequest describeAppsRequest)
Requests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeAppsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeCommandsResult describeCommands(DescribeCommandsRequest describeCommandsRequest)
Describes the results of specified commands.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeCommandsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
Requests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeDeploymentsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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, OpsWorks Stacks
currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClustersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
Describes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeElasticIpsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
Describes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeElasticLoadBalancersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)
Requests a description of a set of instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeInstancesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeLayersResult describeLayers(DescribeLayersRequest describeLayersRequest)
Requests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeLayersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
describeLoadBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
describeMyUserProfileRequest
- DescribeOperatingSystemsResult describeOperatingSystems(DescribeOperatingSystemsRequest describeOperatingSystemsRequest)
Describes the operating systems that are supported by OpsWorks Stacks.
describeOperatingSystemsRequest
- 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.
describePermissionsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
Describe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeRaidArraysRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeRdsDbInstancesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
Describes OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrorsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
describeStackProvisioningParametersRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
describeStackSummaryRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
describeStacksRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
describeTimeBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
describeUserProfilesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
Describes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
describeVolumesRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
detachElasticLoadBalancerRequest
- ResourceNotFoundException
- Indicates that a resource was not found.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.
disassociateElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
getHostnameSuggestionRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
grantAccessRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.ListTagsResult listTags(ListTagsRequest listTagsRequest)
Returns a list of tags that are applied to the specified stack or layer.
listTagsRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
rebootInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
registerEcsClusterRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
registerElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.RegisterInstanceResult registerInstance(RegisterInstanceRequest registerInstanceRequest)
Registers instances that were created outside of OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two
tasks: installing the OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance
handles only the second step. You should instead use the CLI register
command, which performs the entire registration operation. For more information, see Registering an
Instance with an OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
registerRdsDbInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
registerVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
setLoadBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
setPermissionRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
setTimeBasedAutoScalingRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
startInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
startStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
stopInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
stopStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how tagging works, see Tags in the OpsWorks User Guide.
tagResourceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.UnassignInstanceResult unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
Unassigns a registered instance from all layers that are using the instance. 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 OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
unassignInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
unassignVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a specified stack or layer.
untagResourceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
updateAppRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
updateElasticIpRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
updateInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
updateLayerRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
updateMyUserProfileRequest
- ValidationException
- Indicates that a request was not valid.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.
updateRdsDbInstanceRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
updateStackRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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 about user permissions, see Managing User Permissions.
updateUserProfileRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.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.
updateVolumeRequest
- ValidationException
- Indicates that a request was not valid.ResourceNotFoundException
- Indicates that a resource was not found.void shutdown()
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 a request.
request
- The originally executed request.AWSOpsWorksWaiters waiters()