com.amazonaws.services.opsworks.AWSOpsWorks Maven / Gradle / Ivy
Show all versions of aws-java-sdk-opsworks Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.opsworks;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.opsworks.model.*;
/**
* Interface for accessing AWS OpsWorks.
*
* AWS OpsWorks
*
* 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:
*
*
* -
*
* AWS
* CLI
*
*
* -
*
* AWS SDK for Java
*
*
* -
*
* AWS SDK for .NET
*
*
* -
*
*
* -
*
* AWS SDK for Ruby
*
*
* -
*
*
* -
*
*
*
*
* Endpoints
*
*
* AWS OpsWorks supports two endpoints, opsworks.us-east-1.amazonaws.com and
* opsworks.ap-south-1.amazonaws.com (both HTTPS). You must connect to one of
* those two endpoints. You can then use the API to direct AWS OpsWorks to
* create stacks in any AWS region. Stacks created in all regions except
* ap-south-1 are connected to the us-east-1 regional endpoint; stacks created
* in ap-south-1 are associated with the ap-south-1 regional endpoint, and can
* only be accessed or managed within that endpoint.
*
*
* 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.
*
*
*/
public interface AWSOpsWorks {
/**
* The region metadata service name for computing region endpoints. You can
* use this value to retrieve metadata (such as supported regions) of the
* service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "opsworks";
/**
* Overrides the default endpoint for this client
* ("https://opsworks.us-east-1.amazonaws.com"). Callers can use this method
* to control which AWS region they want to work with.
*
* 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
* {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and
* a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=
* 3912
*
* 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.
*
* @param 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.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link AWSOpsWorks#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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link 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.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* 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.
*
*
* @param assignInstanceRequest
* @return Result of the AssignInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.AssignInstance
*/
AssignInstanceResult assignInstance(
AssignInstanceRequest assignInstanceRequest);
/**
*
* 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.
*
*
* @param assignVolumeRequest
* @return Result of the AssignVolume operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.AssignVolume
*/
AssignVolumeResult assignVolume(AssignVolumeRequest assignVolumeRequest);
/**
*
* 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.
*
*
* @param associateElasticIpRequest
* @return Result of the AssociateElasticIp operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.AssociateElasticIp
*/
AssociateElasticIpResult associateElasticIp(
AssociateElasticIpRequest associateElasticIpRequest);
/**
*
* 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.
*
*
* @param attachElasticLoadBalancerRequest
* @return Result of the AttachElasticLoadBalancer operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.AttachElasticLoadBalancer
*/
AttachElasticLoadBalancerResult attachElasticLoadBalancer(
AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest);
/**
*
* 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.
*
*
* @param cloneStackRequest
* @return Result of the CloneStack operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.CloneStack
*/
CloneStackResult cloneStack(CloneStackRequest cloneStackRequest);
/**
*
* 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.
*
*
* @param createAppRequest
* @return Result of the CreateApp operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.CreateApp
*/
CreateAppResult createApp(CreateAppRequest createAppRequest);
/**
*
* 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.
*
*
* @param createDeploymentRequest
* @return Result of the CreateDeployment operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.CreateDeployment
*/
CreateDeploymentResult createDeployment(
CreateDeploymentRequest createDeploymentRequest);
/**
*
* 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.
*
*
* @param createInstanceRequest
* @return Result of the CreateInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.CreateInstance
*/
CreateInstanceResult createInstance(
CreateInstanceRequest createInstanceRequest);
/**
*
* 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.
*
*
* @param createLayerRequest
* @return Result of the CreateLayer operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.CreateLayer
*/
CreateLayerResult createLayer(CreateLayerRequest createLayerRequest);
/**
*
* 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.
*
*
* @param createStackRequest
* @return Result of the CreateStack operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @sample AWSOpsWorks.CreateStack
*/
CreateStackResult createStack(CreateStackRequest createStackRequest);
/**
*
* 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.
*
*
* @param createUserProfileRequest
* @return Result of the CreateUserProfile operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @sample AWSOpsWorks.CreateUserProfile
*/
CreateUserProfileResult createUserProfile(
CreateUserProfileRequest createUserProfileRequest);
/**
*
* 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.
*
*
* @param deleteAppRequest
* @return Result of the DeleteApp operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeleteApp
*/
DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest);
/**
*
* 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.
*
*
* @param deleteInstanceRequest
* @return Result of the DeleteInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeleteInstance
*/
DeleteInstanceResult deleteInstance(
DeleteInstanceRequest deleteInstanceRequest);
/**
*
* 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.
*
*
* @param deleteLayerRequest
* @return Result of the DeleteLayer operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeleteLayer
*/
DeleteLayerResult deleteLayer(DeleteLayerRequest deleteLayerRequest);
/**
*
* 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.
*
*
* @param deleteStackRequest
* @return Result of the DeleteStack operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeleteStack
*/
DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest);
/**
*
* 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.
*
*
* @param deleteUserProfileRequest
* @return Result of the DeleteUserProfile operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeleteUserProfile
*/
DeleteUserProfileResult deleteUserProfile(
DeleteUserProfileRequest deleteUserProfileRequest);
/**
*
* 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.
*
*
* @param deregisterEcsClusterRequest
* @return Result of the DeregisterEcsCluster operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeregisterEcsCluster
*/
DeregisterEcsClusterResult deregisterEcsCluster(
DeregisterEcsClusterRequest deregisterEcsClusterRequest);
/**
*
* 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.
*
*
* @param deregisterElasticIpRequest
* @return Result of the DeregisterElasticIp operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeregisterElasticIp
*/
DeregisterElasticIpResult deregisterElasticIp(
DeregisterElasticIpRequest deregisterElasticIpRequest);
/**
*
* 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.
*
*
* @param deregisterInstanceRequest
* @return Result of the DeregisterInstance operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeregisterInstance
*/
DeregisterInstanceResult deregisterInstance(
DeregisterInstanceRequest deregisterInstanceRequest);
/**
*
* 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.
*
*
* @param deregisterRdsDbInstanceRequest
* @return Result of the DeregisterRdsDbInstance operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeregisterRdsDbInstance
*/
DeregisterRdsDbInstanceResult deregisterRdsDbInstance(
DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest);
/**
*
* 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.
*
*
* @param deregisterVolumeRequest
* @return Result of the DeregisterVolume operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DeregisterVolume
*/
DeregisterVolumeResult deregisterVolume(
DeregisterVolumeRequest deregisterVolumeRequest);
/**
*
* 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.
*
*
* @param describeAgentVersionsRequest
* @return Result of the DescribeAgentVersions operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeAgentVersions
*/
DescribeAgentVersionsResult describeAgentVersions(
DescribeAgentVersionsRequest describeAgentVersionsRequest);
/**
*
* 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.
*
*
* @param describeAppsRequest
* @return Result of the DescribeApps operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeApps
*/
DescribeAppsResult describeApps(DescribeAppsRequest describeAppsRequest);
/**
*
* 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.
*
*
* @param describeCommandsRequest
* @return Result of the DescribeCommands operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeCommands
*/
DescribeCommandsResult describeCommands(
DescribeCommandsRequest describeCommandsRequest);
/**
*
* 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.
*
*
* @param describeDeploymentsRequest
* @return Result of the DescribeDeployments operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeDeployments
*/
DescribeDeploymentsResult describeDeployments(
DescribeDeploymentsRequest describeDeploymentsRequest);
/**
*
* 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.
*
*
* @param describeEcsClustersRequest
* @return Result of the DescribeEcsClusters operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeEcsClusters
*/
DescribeEcsClustersResult describeEcsClusters(
DescribeEcsClustersRequest describeEcsClustersRequest);
/**
*
* 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.
*
*
* @param describeElasticIpsRequest
* @return Result of the DescribeElasticIps operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeElasticIps
*/
DescribeElasticIpsResult describeElasticIps(
DescribeElasticIpsRequest describeElasticIpsRequest);
/**
*
* 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.
*
*
* @param describeElasticLoadBalancersRequest
* @return Result of the DescribeElasticLoadBalancers operation returned by
* the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeElasticLoadBalancers
*/
DescribeElasticLoadBalancersResult describeElasticLoadBalancers(
DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest);
/**
*
* 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.
*
*
* @param describeInstancesRequest
* @return Result of the DescribeInstances operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeInstances
*/
DescribeInstancesResult describeInstances(
DescribeInstancesRequest describeInstancesRequest);
/**
*
* 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.
*
*
* @param describeLayersRequest
* @return Result of the DescribeLayers operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeLayers
*/
DescribeLayersResult describeLayers(
DescribeLayersRequest describeLayersRequest);
/**
*
* 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.
*
*
* @param describeLoadBasedAutoScalingRequest
* @return Result of the DescribeLoadBasedAutoScaling operation returned by
* the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeLoadBasedAutoScaling
*/
DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(
DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest);
/**
*
* 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.
*
*
* @param describeMyUserProfileRequest
* @return Result of the DescribeMyUserProfile operation returned by the
* service.
* @sample AWSOpsWorks.DescribeMyUserProfile
*/
DescribeMyUserProfileResult describeMyUserProfile(
DescribeMyUserProfileRequest describeMyUserProfileRequest);
/**
*
* 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.
*
*
* @param describePermissionsRequest
* @return Result of the DescribePermissions operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribePermissions
*/
DescribePermissionsResult describePermissions(
DescribePermissionsRequest describePermissionsRequest);
/**
*
* 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.
*
*
* @param describeRaidArraysRequest
* @return Result of the DescribeRaidArrays operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeRaidArrays
*/
DescribeRaidArraysResult describeRaidArrays(
DescribeRaidArraysRequest describeRaidArraysRequest);
/**
*
* 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.
*
*
* @param describeRdsDbInstancesRequest
* @return Result of the DescribeRdsDbInstances operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeRdsDbInstances
*/
DescribeRdsDbInstancesResult describeRdsDbInstances(
DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest);
/**
*
* 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.
*
*
* @param describeServiceErrorsRequest
* @return Result of the DescribeServiceErrors operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeServiceErrors
*/
DescribeServiceErrorsResult describeServiceErrors(
DescribeServiceErrorsRequest describeServiceErrorsRequest);
/**
*
* 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.
*
*
* @param describeStackProvisioningParametersRequest
* @return Result of the DescribeStackProvisioningParameters operation
* returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeStackProvisioningParameters
*/
DescribeStackProvisioningParametersResult describeStackProvisioningParameters(
DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest);
/**
*
* 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.
*
*
* @param describeStackSummaryRequest
* @return Result of the DescribeStackSummary operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeStackSummary
*/
DescribeStackSummaryResult describeStackSummary(
DescribeStackSummaryRequest describeStackSummaryRequest);
/**
*
* 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.
*
*
* @param describeStacksRequest
* @return Result of the DescribeStacks operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeStacks
*/
DescribeStacksResult describeStacks(
DescribeStacksRequest describeStacksRequest);
/**
*
* 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.
*
*
* @param describeTimeBasedAutoScalingRequest
* @return Result of the DescribeTimeBasedAutoScaling operation returned by
* the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeTimeBasedAutoScaling
*/
DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(
DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest);
/**
*
* 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.
*
*
* @param describeUserProfilesRequest
* @return Result of the DescribeUserProfiles operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeUserProfiles
*/
DescribeUserProfilesResult describeUserProfiles(
DescribeUserProfilesRequest describeUserProfilesRequest);
/**
*
* 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.
*
*
* @param describeVolumesRequest
* @return Result of the DescribeVolumes operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DescribeVolumes
*/
DescribeVolumesResult describeVolumes(
DescribeVolumesRequest describeVolumesRequest);
/**
*
* 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.
*
*
* @param detachElasticLoadBalancerRequest
* @return Result of the DetachElasticLoadBalancer operation returned by the
* service.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DetachElasticLoadBalancer
*/
DetachElasticLoadBalancerResult detachElasticLoadBalancer(
DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest);
/**
*
* 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.
*
*
* @param disassociateElasticIpRequest
* @return Result of the DisassociateElasticIp operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.DisassociateElasticIp
*/
DisassociateElasticIpResult disassociateElasticIp(
DisassociateElasticIpRequest disassociateElasticIpRequest);
/**
*
* 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.
*
*
* @param getHostnameSuggestionRequest
* @return Result of the GetHostnameSuggestion operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.GetHostnameSuggestion
*/
GetHostnameSuggestionResult getHostnameSuggestion(
GetHostnameSuggestionRequest getHostnameSuggestionRequest);
/**
*
*
* This action can be used only with Windows stacks.
*
*
*
* Grants RDP access to a Windows instance for a specified time period.
*
*
* @param grantAccessRequest
* @return Result of the GrantAccess operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.GrantAccess
*/
GrantAccessResult grantAccess(GrantAccessRequest grantAccessRequest);
/**
*
* 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.
*
*
* @param rebootInstanceRequest
* @return Result of the RebootInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.RebootInstance
*/
RebootInstanceResult rebootInstance(
RebootInstanceRequest rebootInstanceRequest);
/**
*
* 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.
*
*
* @param registerEcsClusterRequest
* @return Result of the RegisterEcsCluster operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.RegisterEcsCluster
*/
RegisterEcsClusterResult registerEcsCluster(
RegisterEcsClusterRequest registerEcsClusterRequest);
/**
*
* 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.
*
*
* @param registerElasticIpRequest
* @return Result of the RegisterElasticIp operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.RegisterElasticIp
*/
RegisterElasticIpResult registerElasticIp(
RegisterElasticIpRequest registerElasticIpRequest);
/**
*
* 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.
*
*
* @param registerInstanceRequest
* @return Result of the RegisterInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.RegisterInstance
*/
RegisterInstanceResult registerInstance(
RegisterInstanceRequest registerInstanceRequest);
/**
*
* 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.
*
*
* @param registerRdsDbInstanceRequest
* @return Result of the RegisterRdsDbInstance operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.RegisterRdsDbInstance
*/
RegisterRdsDbInstanceResult registerRdsDbInstance(
RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest);
/**
*
* 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.
*
*
* @param registerVolumeRequest
* @return Result of the RegisterVolume operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.RegisterVolume
*/
RegisterVolumeResult registerVolume(
RegisterVolumeRequest registerVolumeRequest);
/**
*
* 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.
*
*
* @param setLoadBasedAutoScalingRequest
* @return Result of the SetLoadBasedAutoScaling operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.SetLoadBasedAutoScaling
*/
SetLoadBasedAutoScalingResult setLoadBasedAutoScaling(
SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest);
/**
*
* 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.
*
*
* @param setPermissionRequest
* @return Result of the SetPermission operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.SetPermission
*/
SetPermissionResult setPermission(SetPermissionRequest setPermissionRequest);
/**
*
* 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.
*
*
* @param setTimeBasedAutoScalingRequest
* @return Result of the SetTimeBasedAutoScaling operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.SetTimeBasedAutoScaling
*/
SetTimeBasedAutoScalingResult setTimeBasedAutoScaling(
SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest);
/**
*
* 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.
*
*
* @param startInstanceRequest
* @return Result of the StartInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.StartInstance
*/
StartInstanceResult startInstance(StartInstanceRequest startInstanceRequest);
/**
*
* 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.
*
*
* @param startStackRequest
* @return Result of the StartStack operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.StartStack
*/
StartStackResult startStack(StartStackRequest startStackRequest);
/**
*
* 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.
*
*
* @param stopInstanceRequest
* @return Result of the StopInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.StopInstance
*/
StopInstanceResult stopInstance(StopInstanceRequest stopInstanceRequest);
/**
*
* 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.
*
*
* @param stopStackRequest
* @return Result of the StopStack operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.StopStack
*/
StopStackResult stopStack(StopStackRequest stopStackRequest);
/**
*
* 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.
*
*
* @param unassignInstanceRequest
* @return Result of the UnassignInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UnassignInstance
*/
UnassignInstanceResult unassignInstance(
UnassignInstanceRequest unassignInstanceRequest);
/**
*
* 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.
*
*
* @param unassignVolumeRequest
* @return Result of the UnassignVolume operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UnassignVolume
*/
UnassignVolumeResult unassignVolume(
UnassignVolumeRequest unassignVolumeRequest);
/**
*
* 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.
*
*
* @param updateAppRequest
* @return Result of the UpdateApp operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateApp
*/
UpdateAppResult updateApp(UpdateAppRequest updateAppRequest);
/**
*
* 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.
*
*
* @param updateElasticIpRequest
* @return Result of the UpdateElasticIp operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateElasticIp
*/
UpdateElasticIpResult updateElasticIp(
UpdateElasticIpRequest updateElasticIpRequest);
/**
*
* 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.
*
*
* @param updateInstanceRequest
* @return Result of the UpdateInstance operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateInstance
*/
UpdateInstanceResult updateInstance(
UpdateInstanceRequest updateInstanceRequest);
/**
*
* 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.
*
*
* @param updateLayerRequest
* @return Result of the UpdateLayer operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateLayer
*/
UpdateLayerResult updateLayer(UpdateLayerRequest updateLayerRequest);
/**
*
* 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.
*
*
* @param updateMyUserProfileRequest
* @return Result of the UpdateMyUserProfile operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @sample AWSOpsWorks.UpdateMyUserProfile
*/
UpdateMyUserProfileResult updateMyUserProfile(
UpdateMyUserProfileRequest updateMyUserProfileRequest);
/**
*
* 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.
*
*
* @param updateRdsDbInstanceRequest
* @return Result of the UpdateRdsDbInstance operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateRdsDbInstance
*/
UpdateRdsDbInstanceResult updateRdsDbInstance(
UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest);
/**
*
* 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.
*
*
* @param updateStackRequest
* @return Result of the UpdateStack operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateStack
*/
UpdateStackResult updateStack(UpdateStackRequest updateStackRequest);
/**
*
* 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.
*
*
* @param updateUserProfileRequest
* @return Result of the UpdateUserProfile operation returned by the
* service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateUserProfile
*/
UpdateUserProfileResult updateUserProfile(
UpdateUserProfileRequest updateUserProfileRequest);
/**
*
* 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.
*
*
* @param updateVolumeRequest
* @return Result of the UpdateVolume operation returned by the service.
* @throws ValidationException
* Indicates that a request was not valid.
* @throws ResourceNotFoundException
* Indicates that a resource was not found.
* @sample AWSOpsWorks.UpdateVolume
*/
UpdateVolumeResult updateVolume(UpdateVolumeRequest updateVolumeRequest);
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request,
* typically used for debugging issues where a service isn't acting as
* expected. This data isn't considered part of the result data returned by
* an operation, so it's available through this separate, diagnostic
* interface.
*
* Response metadata is only cached for a limited period of time, so if you
* need to access this extra diagnostic information for an executed request,
* you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}