@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSOpsWorksClient extends AmazonWebServiceClient implements AWSOpsWorks
Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
opsworks.us-east-1.amazonaws.com
opsworks.us-east-2.amazonaws.com
opsworks.us-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-central-1.amazonaws.com
opsworks.ap-northeast-1.amazonaws.com
opsworks.ap-northeast-2.amazonaws.com
opsworks.ap-south-1.amazonaws.com
opsworks.ap-southeast-1.amazonaws.com
opsworks.ap-southeast-2.amazonaws.com
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the
ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux
stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSOpsWorksClient()
Deprecated.
|
AWSOpsWorksClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSOpsWorksClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSOpsWorksClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSOpsWorksClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSOpsWorksClient()
AWSOpsWorksClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSOpsWorksClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSOpsWorksClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSOpsWorksClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSOpsWorksClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSOpsWorksClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSOpsWorksClientBuilder builder()
public AssignInstanceResult assignInstance(AssignInstanceRequest request)
Assign a registered instance to a layer.
You can assign registered on-premises instances to any layer type.
You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignInstance in interface AWSOpsWorksassignInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public AssignVolumeResult assignVolume(AssignVolumeRequest request)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be
registered with the stack by calling RegisterVolume. After you register the volume, you must call
UpdateVolume to specify a mount point before calling AssignVolume. For more information, see
Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
assignVolume in interface AWSOpsWorksassignVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public AssociateElasticIpResult associateElasticIp(AssociateElasticIpRequest request)
Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
associateElasticIp in interface AWSOpsWorksassociateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public AttachElasticLoadBalancerResult attachElasticLoadBalancer(AttachElasticLoadBalancerRequest request)
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
attachElasticLoadBalancer in interface AWSOpsWorksattachElasticLoadBalancerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public CloneStackResult cloneStack(CloneStackRequest request)
Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
cloneStack in interface AWSOpsWorkscloneStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public CreateAppResult createApp(CreateAppRequest request)
Creates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createApp in interface AWSOpsWorkscreateAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createDeployment in interface AWSOpsWorkscreateDeploymentRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public CreateInstanceResult createInstance(CreateInstanceRequest request)
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createInstance in interface AWSOpsWorkscreateInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public CreateLayerResult createLayer(CreateLayerRequest request)
Creates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createLayer in interface AWSOpsWorkscreateLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public CreateStackResult createStack(CreateStackRequest request)
Creates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createStack in interface AWSOpsWorkscreateStackRequest - ValidationException - Indicates that a request was not valid.public CreateUserProfileResult createUserProfile(CreateUserProfileRequest request)
Creates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
createUserProfile in interface AWSOpsWorkscreateUserProfileRequest - ValidationException - Indicates that a request was not valid.public DeleteAppResult deleteApp(DeleteAppRequest request)
Deletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteApp in interface AWSOpsWorksdeleteAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteInstance in interface AWSOpsWorksdeleteInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeleteLayerResult deleteLayer(DeleteLayerRequest request)
Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteLayer in interface AWSOpsWorksdeleteLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeleteStackResult deleteStack(DeleteStackRequest request)
Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteStack in interface AWSOpsWorksdeleteStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest request)
Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deleteUserProfile in interface AWSOpsWorksdeleteUserProfileRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeregisterEcsClusterResult deregisterEcsCluster(DeregisterEcsClusterRequest request)
Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsCluster in interface AWSOpsWorksderegisterEcsClusterRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeregisterElasticIpResult deregisterElasticIp(DeregisterElasticIpRequest request)
Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterElasticIp in interface AWSOpsWorksderegisterElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterInstance in interface AWSOpsWorksderegisterInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeregisterRdsDbInstanceResult deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest request)
Deregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterRdsDbInstance in interface AWSOpsWorksderegisterRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DeregisterVolumeResult deregisterVolume(DeregisterVolumeRequest request)
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterVolume in interface AWSOpsWorksderegisterVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeAgentVersionsResult describeAgentVersions(DescribeAgentVersionsRequest request)
Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration
manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or
configuration manager.
describeAgentVersions in interface AWSOpsWorksdescribeAgentVersionsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeAppsResult describeApps(DescribeAppsRequest request)
Requests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeApps in interface AWSOpsWorksdescribeAppsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeCommandsResult describeCommands(DescribeCommandsRequest request)
Describes the results of specified commands.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeCommands in interface AWSOpsWorksdescribeCommandsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest request)
Requests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeDeployments in interface AWSOpsWorksdescribeDeploymentsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeEcsClustersResult describeEcsClusters(DescribeEcsClustersRequest request)
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the
MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks
Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClusters in interface AWSOpsWorksdescribeEcsClustersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest request)
Describes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeElasticIps in interface AWSOpsWorksdescribeElasticIpsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest request)
Describes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeElasticLoadBalancers in interface AWSOpsWorksdescribeElasticLoadBalancersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeInstancesResult describeInstances(DescribeInstancesRequest request)
Requests a description of a set of instances.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeInstances in interface AWSOpsWorksdescribeInstancesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeLayersResult describeLayers(DescribeLayersRequest request)
Requests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeLayers in interface AWSOpsWorksdescribeLayersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest request)
Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeLoadBasedAutoScaling in interface AWSOpsWorksdescribeLoadBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest request)
Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeMyUserProfile in interface AWSOpsWorksdescribeMyUserProfileRequest - public DescribePermissionsResult describePermissions(DescribePermissionsRequest request)
Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describePermissions in interface AWSOpsWorksdescribePermissionsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest request)
Describe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeRaidArrays in interface AWSOpsWorksdescribeRaidArraysRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest request)
Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeRdsDbInstances in interface AWSOpsWorksdescribeRdsDbInstancesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest request)
Describes AWS OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrors in interface AWSOpsWorksdescribeServiceErrorsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeStackProvisioningParametersResult describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest request)
Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeStackProvisioningParameters in interface AWSOpsWorksdescribeStackProvisioningParametersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest request)
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup or online.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeStackSummary in interface AWSOpsWorksdescribeStackSummaryRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeStacksResult describeStacks(DescribeStacksRequest request)
Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeStacks in interface AWSOpsWorksdescribeStacksRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest request)
Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeTimeBasedAutoScaling in interface AWSOpsWorksdescribeTimeBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest request)
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeUserProfiles in interface AWSOpsWorksdescribeUserProfilesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
Describes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeVolumes in interface AWSOpsWorksdescribeVolumesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public DetachElasticLoadBalancerResult detachElasticLoadBalancer(DetachElasticLoadBalancerRequest request)
Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
detachElasticLoadBalancer in interface AWSOpsWorksdetachElasticLoadBalancerRequest - ResourceNotFoundException - Indicates that a resource was not found.public DisassociateElasticIpResult disassociateElasticIp(DisassociateElasticIpRequest request)
Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
disassociateElasticIp in interface AWSOpsWorksdisassociateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest request)
Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
getHostnameSuggestion in interface AWSOpsWorksgetHostnameSuggestionRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public GrantAccessResult grantAccess(GrantAccessRequest request)
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
grantAccess in interface AWSOpsWorksgrantAccessRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public ListTagsResult listTags(ListTagsRequest request)
Returns a list of tags that are applied to the specified stack or layer.
listTags in interface AWSOpsWorkslistTagsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public RebootInstanceResult rebootInstance(RebootInstanceRequest request)
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
rebootInstance in interface AWSOpsWorksrebootInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public RegisterEcsClusterResult registerEcsCluster(RegisterEcsClusterRequest request)
Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerEcsCluster in interface AWSOpsWorksregisterEcsClusterRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest request)
Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerElasticIp in interface AWSOpsWorksregisterElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two
tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance handles only the second step. You should instead use the AWS CLI
register command, which performs the entire registration operation. For more information, see Registering an
Instance with an AWS OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerInstance in interface AWSOpsWorksregisterInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public RegisterRdsDbInstanceResult registerRdsDbInstance(RegisterRdsDbInstanceRequest request)
Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerRdsDbInstance in interface AWSOpsWorksregisterRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public RegisterVolumeResult registerVolume(RegisterVolumeRequest request)
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerVolume in interface AWSOpsWorksregisterVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public SetLoadBasedAutoScalingResult setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest request)
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setLoadBasedAutoScaling in interface AWSOpsWorkssetLoadBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public SetPermissionResult setPermission(SetPermissionRequest request)
Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setPermission in interface AWSOpsWorkssetPermissionRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public SetTimeBasedAutoScalingResult setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest request)
Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
setTimeBasedAutoScaling in interface AWSOpsWorkssetTimeBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public StartInstanceResult startInstance(StartInstanceRequest request)
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startInstance in interface AWSOpsWorksstartInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public StartStackResult startStack(StartStackRequest request)
Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
startStack in interface AWSOpsWorksstartStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public StopInstanceResult stopInstance(StopInstanceRequest request)
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopInstance in interface AWSOpsWorksstopInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public StopStackResult stopStack(StopStackRequest request)
Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
stopStack in interface AWSOpsWorksstopStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public TagResourceResult tagResource(TagResourceRequest request)
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
tagResource in interface AWSOpsWorkstagResourceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UnassignInstanceResult unassignInstance(UnassignInstanceRequest request)
Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
unassignInstance in interface AWSOpsWorksunassignInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UnassignVolumeResult unassignVolume(UnassignVolumeRequest request)
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
unassignVolume in interface AWSOpsWorksunassignVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a specified stack or layer.
untagResource in interface AWSOpsWorksuntagResourceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateAppResult updateApp(UpdateAppRequest request)
Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateApp in interface AWSOpsWorksupdateAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateElasticIpResult updateElasticIp(UpdateElasticIpRequest request)
Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateElasticIp in interface AWSOpsWorksupdateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateInstanceResult updateInstance(UpdateInstanceRequest request)
Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateInstance in interface AWSOpsWorksupdateInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateLayerResult updateLayer(UpdateLayerRequest request)
Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateLayer in interface AWSOpsWorksupdateLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateMyUserProfileResult updateMyUserProfile(UpdateMyUserProfileRequest request)
Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateMyUserProfile in interface AWSOpsWorksupdateMyUserProfileRequest - ValidationException - Indicates that a request was not valid.public UpdateRdsDbInstanceResult updateRdsDbInstance(UpdateRdsDbInstanceRequest request)
Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateRdsDbInstance in interface AWSOpsWorksupdateRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateStackResult updateStack(UpdateStackRequest request)
Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateStack in interface AWSOpsWorksupdateStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest request)
Updates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateUserProfile in interface AWSOpsWorksupdateUserProfileRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public UpdateVolumeResult updateVolume(UpdateVolumeRequest request)
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
updateVolume in interface AWSOpsWorksupdateVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSOpsWorksrequest - The originally executed requestpublic AWSOpsWorksWaiters waiters()
waiters in interface AWSOpsWorkspublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSOpsWorksshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.