AWS SDK for .NET Documentation
AmazonOpsWorksClient Class
AmazonAmazon.OpsWorksAmazonOpsWorksClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing OpsWorks AWS OpsWorks

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

Chef Version

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the

CopyC#
ConfigurationManager
parameter to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4. For more information, see Chef Versions.

Declaration Syntax
C#
public class AmazonOpsWorksClient : AmazonWebServiceClient, 
	AmazonOpsWorks, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
AmazonOpsWorksClient()()()()
Constructs AmazonOpsWorksClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonOpsWorksClient(RegionEndpoint)
Constructs AmazonOpsWorksClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonOpsWorksClient(AmazonOpsWorksConfig)
Constructs AmazonOpsWorksClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonOpsWorksClient(AWSCredentials)
Constructs AmazonOpsWorksClient with AWS Credentials

AmazonOpsWorksClient(AWSCredentials, RegionEndpoint)
Constructs AmazonOpsWorksClient with AWS Credentials

AmazonOpsWorksClient(AWSCredentials, AmazonOpsWorksConfig)
Constructs AmazonOpsWorksClient with AWS Credentials and an AmazonOpsWorksClient Configuration object.

AmazonOpsWorksClient(String, String)
Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key

AmazonOpsWorksClient(String, String, RegionEndpoint)
Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key

AmazonOpsWorksClient(String, String, AmazonOpsWorksConfig)
Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object.

AmazonOpsWorksClient(String, String, String)
Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key

AmazonOpsWorksClient(String, String, String, RegionEndpoint)
Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key

AmazonOpsWorksClient(String, String, String, AmazonOpsWorksConfig)
Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object.

AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
AssignVolume(AssignVolumeRequest)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. 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(AssociateElasticIpRequest)
Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


AttachElasticLoadBalancer(AttachElasticLoadBalancerRequest)
Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.
Note:

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.


BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginAssignVolume(AssignVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AssignVolume operation.

BeginAssociateElasticIp(AssociateElasticIpRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AssociateElasticIp operation.

BeginAttachElasticLoadBalancer(AttachElasticLoadBalancerRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AttachElasticLoadBalancer operation.

BeginCloneStack(CloneStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CloneStack operation.

BeginCreateApp(CreateAppRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateApp operation.

BeginCreateDeployment(CreateDeploymentRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateDeployment operation.

BeginCreateInstance(CreateInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateInstance operation.

BeginCreateLayer(CreateLayerRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateLayer operation.

BeginCreateStack(CreateStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateStack operation.

BeginCreateUserProfile(CreateUserProfileRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateUserProfile operation.

BeginDeleteApp(DeleteAppRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteApp operation.

BeginDeleteInstance(DeleteInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteInstance operation.

BeginDeleteLayer(DeleteLayerRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteLayer operation.

BeginDeleteStack(DeleteStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteStack operation.

BeginDeleteUserProfile(DeleteUserProfileRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteUserProfile operation.

BeginDeregisterElasticIp(DeregisterElasticIpRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeregisterElasticIp operation.

BeginDeregisterRdsDbInstance(DeregisterRdsDbInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeregisterRdsDbInstance operation.

BeginDeregisterVolume(DeregisterVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeregisterVolume operation.

BeginDescribeApps(DescribeAppsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeApps operation.

BeginDescribeCommands(DescribeCommandsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeCommands operation.

BeginDescribeDeployments(DescribeDeploymentsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeDeployments operation.

BeginDescribeElasticIps(DescribeElasticIpsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeElasticIps operation.

BeginDescribeElasticLoadBalancers(DescribeElasticLoadBalancersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeElasticLoadBalancers operation.

BeginDescribeInstances(DescribeInstancesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeInstances operation.

BeginDescribeLayers(DescribeLayersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeLayers operation.

BeginDescribeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeLoadBasedAutoScaling operation.

BeginDescribeMyUserProfile(DescribeMyUserProfileRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeMyUserProfile operation.

BeginDescribePermissions(DescribePermissionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribePermissions operation.

BeginDescribeRaidArrays(DescribeRaidArraysRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeRaidArrays operation.

BeginDescribeRdsDbInstances(DescribeRdsDbInstancesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeRdsDbInstances operation.

BeginDescribeServiceErrors(DescribeServiceErrorsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeServiceErrors operation.

BeginDescribeStacks(DescribeStacksRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStacks operation.

BeginDescribeStackSummary(DescribeStackSummaryRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStackSummary operation.

BeginDescribeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeTimeBasedAutoScaling operation.

BeginDescribeUserProfiles(DescribeUserProfilesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeUserProfiles operation.

BeginDescribeVolumes(DescribeVolumesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeVolumes operation.

BeginDetachElasticLoadBalancer(DetachElasticLoadBalancerRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DetachElasticLoadBalancer operation.

BeginDisassociateElasticIp(DisassociateElasticIpRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DisassociateElasticIp operation.

BeginGetHostnameSuggestion(GetHostnameSuggestionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetHostnameSuggestion operation.

BeginRebootInstance(RebootInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RebootInstance operation.

BeginRegisterElasticIp(RegisterElasticIpRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RegisterElasticIp operation.

BeginRegisterRdsDbInstance(RegisterRdsDbInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RegisterRdsDbInstance operation.

BeginRegisterVolume(RegisterVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RegisterVolume operation.

BeginSetLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetLoadBasedAutoScaling operation.

BeginSetPermission(SetPermissionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetPermission operation.

BeginSetTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetTimeBasedAutoScaling operation.

BeginStartInstance(StartInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the StartInstance operation.

BeginStartStack(StartStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the StartStack operation.

BeginStopInstance(StopInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the StopInstance operation.

BeginStopStack(StopStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the StopStack operation.

BeginUnassignVolume(UnassignVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UnassignVolume operation.

BeginUpdateApp(UpdateAppRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateApp operation.

BeginUpdateElasticIp(UpdateElasticIpRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateElasticIp operation.

BeginUpdateInstance(UpdateInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateInstance operation.

BeginUpdateLayer(UpdateLayerRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateLayer operation.

BeginUpdateMyUserProfile(UpdateMyUserProfileRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateMyUserProfile operation.

BeginUpdateRdsDbInstance(UpdateRdsDbInstanceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateRdsDbInstance operation.

BeginUpdateStack(UpdateStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateStack operation.

BeginUpdateUserProfile(UpdateUserProfileRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateUserProfile operation.

BeginUpdateVolume(UpdateVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateVolume operation.

CloneStack(CloneStackRequest)
Creates a clone of a specified stack. For more information, see Clone a 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.


CreateApp(CreateAppRequest)
Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


CreateDeployment(CreateDeploymentRequest)
Deploys a stack or app.
  • App deployment generates a
    CopyC#
    deploy
    event, which runs the associated recipes and passes them a JSON stack configuration object that includes information about the app.
  • Stack deployment runs the
    CopyC#
    deploy
    recipes but does not raise an event.

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.


CreateInstance(CreateInstanceRequest)
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


CreateLayer(CreateLayerRequest)
Creates a layer. For more information, see How to Create a Layer.
Note:

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.


CreateStack(CreateStackRequest)
Creates a new stack. For more information, see Create a New Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


CreateUserProfile(CreateUserProfileRequest)
Creates a new user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DeleteApp(DeleteAppRequest)
Deletes a specified app.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DeleteInstance(DeleteInstanceRequest)
Deletes a specified 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.


DeleteLayer(DeleteLayerRequest)
Deletes a specified layer. You must first stop and then delete all associated 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.


DeleteStack(DeleteStackRequest)
Deletes a specified stack. You must first delete all instances, layers, and apps. 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.


DeleteUserProfile(DeleteUserProfileRequest)
Deletes a user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DeregisterElasticIp(DeregisterElasticIpRequest)
Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DeregisterRdsDbInstance(DeregisterRdsDbInstanceRequest)
Deregisters an Amazon RDS instance.

DeregisterVolume(DeregisterVolumeRequest)
Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeApps(DescribeAppsRequest)
Requests a description of a specified set of apps.
Note:

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeCommands(DescribeCommandsRequest)
Describes the results of specified commands.
Note:

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeDeployments(DescribeDeploymentsRequest)
Requests a description of a specified set of deployments.
Note:

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeElasticIps(DescribeElasticIpsRequest)
Describes Elastic IP addresses.
Note:

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeElasticLoadBalancers()()()()
Describes a stack's Elastic Load Balancing instances.
Note:

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeElasticLoadBalancers(DescribeElasticLoadBalancersRequest)
Describes a stack's Elastic Load Balancing instances.
Note:

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeInstances(DescribeInstancesRequest)
Requests a description of a set of instances.
Note:

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeLayers(DescribeLayersRequest)
Requests a description of one or more layers in a specified stack.
Note:

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(DescribeLoadBasedAutoScalingRequest)
Describes load-based auto scaling configurations for specified layers.
Note:

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.


DescribeMyUserProfile()()()()
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(DescribeMyUserProfileRequest)
Describes a user's SSH information.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribePermissions(DescribePermissionsRequest)
Describes the permissions for a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeRaidArrays(DescribeRaidArraysRequest)
Describe an instance's RAID arrays.
Note:

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.


DescribeRdsDbInstances(DescribeRdsDbInstancesRequest)
Describes Amazon RDS instances.

DescribeServiceErrors()()()()
Describes AWS OpsWorks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeServiceErrors(DescribeServiceErrorsRequest)
Describes AWS OpsWorks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeStacks()()()()
Requests a description of one or more stacks.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeStacks(DescribeStacksRequest)
Requests a description of one or more stacks.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeStackSummary(DescribeStackSummaryRequest)
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
CopyC#
running_setup
or
CopyC#
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.


DescribeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest)
Describes time-based auto scaling configurations for specified instances.
Note:

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.


DescribeUserProfiles()()()()
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(DescribeUserProfilesRequest)
Describe specified users.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DescribeVolumes(DescribeVolumesRequest)
Describes an instance's Amazon EBS volumes.
Note:

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.


DetachElasticLoadBalancer(DetachElasticLoadBalancerRequest)
Detaches a specified Elastic Load Balancing instance from its layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


DisassociateElasticIp(DisassociateElasticIpRequest)
Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndAssignVolume(IAsyncResult)
Finishes the asynchronous execution of the AssignVolume operation.

EndAssociateElasticIp(IAsyncResult)
Finishes the asynchronous execution of the AssociateElasticIp operation.

EndAttachElasticLoadBalancer(IAsyncResult)
Finishes the asynchronous execution of the AttachElasticLoadBalancer operation.

EndCloneStack(IAsyncResult)
Finishes the asynchronous execution of the CloneStack operation.

EndCreateApp(IAsyncResult)
Finishes the asynchronous execution of the CreateApp operation.

EndCreateDeployment(IAsyncResult)
Finishes the asynchronous execution of the CreateDeployment operation.

EndCreateInstance(IAsyncResult)
Finishes the asynchronous execution of the CreateInstance operation.

EndCreateLayer(IAsyncResult)
Finishes the asynchronous execution of the CreateLayer operation.

EndCreateStack(IAsyncResult)
Finishes the asynchronous execution of the CreateStack operation.

EndCreateUserProfile(IAsyncResult)
Finishes the asynchronous execution of the CreateUserProfile operation.

EndDeleteApp(IAsyncResult)
Finishes the asynchronous execution of the DeleteApp operation.

EndDeleteInstance(IAsyncResult)
Finishes the asynchronous execution of the DeleteInstance operation.

EndDeleteLayer(IAsyncResult)
Finishes the asynchronous execution of the DeleteLayer operation.

EndDeleteStack(IAsyncResult)
Finishes the asynchronous execution of the DeleteStack operation.

EndDeleteUserProfile(IAsyncResult)
Finishes the asynchronous execution of the DeleteUserProfile operation.

EndDeregisterElasticIp(IAsyncResult)
Finishes the asynchronous execution of the DeregisterElasticIp operation.

EndDeregisterRdsDbInstance(IAsyncResult)
Finishes the asynchronous execution of the DeregisterRdsDbInstance operation.

EndDeregisterVolume(IAsyncResult)
Finishes the asynchronous execution of the DeregisterVolume operation.

EndDescribeApps(IAsyncResult)
Finishes the asynchronous execution of the DescribeApps operation.

EndDescribeCommands(IAsyncResult)
Finishes the asynchronous execution of the DescribeCommands operation.

EndDescribeDeployments(IAsyncResult)
Finishes the asynchronous execution of the DescribeDeployments operation.

EndDescribeElasticIps(IAsyncResult)
Finishes the asynchronous execution of the DescribeElasticIps operation.

EndDescribeElasticLoadBalancers(IAsyncResult)
Finishes the asynchronous execution of the DescribeElasticLoadBalancers operation.

EndDescribeInstances(IAsyncResult)
Finishes the asynchronous execution of the DescribeInstances operation.

EndDescribeLayers(IAsyncResult)
Finishes the asynchronous execution of the DescribeLayers operation.

EndDescribeLoadBasedAutoScaling(IAsyncResult)
Finishes the asynchronous execution of the DescribeLoadBasedAutoScaling operation.

EndDescribeMyUserProfile(IAsyncResult)
Finishes the asynchronous execution of the DescribeMyUserProfile operation.

EndDescribePermissions(IAsyncResult)
Finishes the asynchronous execution of the DescribePermissions operation.

EndDescribeRaidArrays(IAsyncResult)
Finishes the asynchronous execution of the DescribeRaidArrays operation.

EndDescribeRdsDbInstances(IAsyncResult)
Finishes the asynchronous execution of the DescribeRdsDbInstances operation.

EndDescribeServiceErrors(IAsyncResult)
Finishes the asynchronous execution of the DescribeServiceErrors operation.

EndDescribeStacks(IAsyncResult)
Finishes the asynchronous execution of the DescribeStacks operation.

EndDescribeStackSummary(IAsyncResult)
Finishes the asynchronous execution of the DescribeStackSummary operation.

EndDescribeTimeBasedAutoScaling(IAsyncResult)
Finishes the asynchronous execution of the DescribeTimeBasedAutoScaling operation.

EndDescribeUserProfiles(IAsyncResult)
Finishes the asynchronous execution of the DescribeUserProfiles operation.

EndDescribeVolumes(IAsyncResult)
Finishes the asynchronous execution of the DescribeVolumes operation.

EndDetachElasticLoadBalancer(IAsyncResult)
Finishes the asynchronous execution of the DetachElasticLoadBalancer operation.

EndDisassociateElasticIp(IAsyncResult)
Finishes the asynchronous execution of the DisassociateElasticIp operation.

EndGetHostnameSuggestion(IAsyncResult)
Finishes the asynchronous execution of the GetHostnameSuggestion operation.

EndRebootInstance(IAsyncResult)
Finishes the asynchronous execution of the RebootInstance operation.

EndRegisterElasticIp(IAsyncResult)
Finishes the asynchronous execution of the RegisterElasticIp operation.

EndRegisterRdsDbInstance(IAsyncResult)
Finishes the asynchronous execution of the RegisterRdsDbInstance operation.

EndRegisterVolume(IAsyncResult)
Finishes the asynchronous execution of the RegisterVolume operation.

EndSetLoadBasedAutoScaling(IAsyncResult)
Finishes the asynchronous execution of the SetLoadBasedAutoScaling operation.

EndSetPermission(IAsyncResult)
Finishes the asynchronous execution of the SetPermission operation.

EndSetTimeBasedAutoScaling(IAsyncResult)
Finishes the asynchronous execution of the SetTimeBasedAutoScaling operation.

EndStartInstance(IAsyncResult)
Finishes the asynchronous execution of the StartInstance operation.

EndStartStack(IAsyncResult)
Finishes the asynchronous execution of the StartStack operation.

EndStopInstance(IAsyncResult)
Finishes the asynchronous execution of the StopInstance operation.

EndStopStack(IAsyncResult)
Finishes the asynchronous execution of the StopStack operation.

EndUnassignVolume(IAsyncResult)
Finishes the asynchronous execution of the UnassignVolume operation.

EndUpdateApp(IAsyncResult)
Finishes the asynchronous execution of the UpdateApp operation.

EndUpdateElasticIp(IAsyncResult)
Finishes the asynchronous execution of the UpdateElasticIp operation.

EndUpdateInstance(IAsyncResult)
Finishes the asynchronous execution of the UpdateInstance operation.

EndUpdateLayer(IAsyncResult)
Finishes the asynchronous execution of the UpdateLayer operation.

EndUpdateMyUserProfile(IAsyncResult)
Finishes the asynchronous execution of the UpdateMyUserProfile operation.

EndUpdateRdsDbInstance(IAsyncResult)
Finishes the asynchronous execution of the UpdateRdsDbInstance operation.

EndUpdateStack(IAsyncResult)
Finishes the asynchronous execution of the UpdateStack operation.

EndUpdateUserProfile(IAsyncResult)
Finishes the asynchronous execution of the UpdateUserProfile operation.

EndUpdateVolume(IAsyncResult)
Finishes the asynchronous execution of the UpdateVolume operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetHostnameSuggestion(GetHostnameSuggestionRequest)
Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
RebootInstance(RebootInstanceRequest)
Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


RegisterElasticIp(RegisterElasticIpRequest)
Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


RegisterRdsDbInstance(RegisterRdsDbInstanceRequest)
Registers an Amazon RDS instance with a stack.

RegisterVolume(RegisterVolumeRequest)
Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


SetLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest)
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
Note:

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.


SetPermission(SetPermissionRequest)
Specifies a user's permissions. For more information, see Security and Permissions.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


SetTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest)
Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


StartInstance(StartInstanceRequest)
Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


StartStack(StartStackRequest)
Starts a stack's instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


StopInstance(StopInstanceRequest)
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


StopStack(StopStackRequest)
Stops a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UnassignVolume(UnassignVolumeRequest)
Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateApp(UpdateAppRequest)
Updates a specified app.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateElasticIp(UpdateElasticIpRequest)
Updates a registered Elastic IP address's name. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateInstance(UpdateInstanceRequest)
Updates a specified instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateLayer(UpdateLayerRequest)
Updates a specified layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateMyUserProfile()()()()
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(UpdateMyUserProfileRequest)
Updates a user's SSH public key.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateRdsDbInstance(UpdateRdsDbInstanceRequest)
Updates an Amazon RDS instance.

UpdateStack(UpdateStackRequest)
Updates a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateUserProfile(UpdateUserProfileRequest)
Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


UpdateVolume(UpdateVolumeRequest)
Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonOpsWorksClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)