AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
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 Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended value for Linux stacks is currently 12 (the default is 11.4). 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.OpsWorks.AmazonOpsWorksClient

Namespace: Amazon.OpsWorks
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class AmazonOpsWorksClient : AmazonServiceClient
         IAmazonOpsWorks, IDisposable

The AmazonOpsWorksClient type exposes the following members

Constructors

NameDescription
Public Method 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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method 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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method 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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonOpsWorksClient(AWSCredentials) Constructs AmazonOpsWorksClient with AWS Credentials
Public Method AmazonOpsWorksClient(AWSCredentials, RegionEndpoint) Constructs AmazonOpsWorksClient with AWS Credentials
Public Method AmazonOpsWorksClient(AWSCredentials, AmazonOpsWorksConfig) Constructs AmazonOpsWorksClient with AWS Credentials and an AmazonOpsWorksClient Configuration object.
Public Method AmazonOpsWorksClient(string, string) Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonOpsWorksClient(string, string, RegionEndpoint) Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonOpsWorksClient(string, string, AmazonOpsWorksConfig) Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object.
Public Method AmazonOpsWorksClient(string, string, string) Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonOpsWorksClient(string, string, string, RegionEndpoint) Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonOpsWorksClient(string, string, string, AmazonOpsWorksConfig) Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object.

Methods

NameDescription
Public Method AssignInstance(AssignInstanceRequest) Assign a registered instance to a layer.
  • You can assign registered on-premises instances to any layer type.
  • You can assign registered Amazon EC2 instances only to custom layers.
  • You cannot use this action with instances that were created with AWS OpsWorks.

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

Public Method 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. 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.

Public Method 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.

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

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

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

Public Method BeginAssignInstance(AssignInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the AssignInstance operation.
Public Method BeginAssignVolume(AssignVolumeRequest, AsyncCallback, object) Initiates the asynchronous execution of the AssignVolume operation.
Public Method BeginAssociateElasticIp(AssociateElasticIpRequest, AsyncCallback, object) Initiates the asynchronous execution of the AssociateElasticIp operation.
Public Method BeginAttachElasticLoadBalancer(AttachElasticLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the AttachElasticLoadBalancer operation.
Public Method BeginCloneStack(CloneStackRequest, AsyncCallback, object) Initiates the asynchronous execution of the CloneStack operation.
Public Method BeginCreateApp(CreateAppRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateApp operation.
Public Method BeginCreateDeployment(CreateDeploymentRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateDeployment operation.
Public Method BeginCreateInstance(CreateInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateInstance operation.
Public Method BeginCreateLayer(CreateLayerRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateLayer operation.
Public Method BeginCreateStack(CreateStackRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateStack operation.
Public Method BeginCreateUserProfile(CreateUserProfileRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateUserProfile operation.
Public Method BeginDeleteApp(DeleteAppRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteApp operation.
Public Method BeginDeleteInstance(DeleteInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteInstance operation.
Public Method BeginDeleteLayer(DeleteLayerRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteLayer operation.
Public Method BeginDeleteStack(DeleteStackRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteStack operation.
Public Method BeginDeleteUserProfile(DeleteUserProfileRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteUserProfile operation.
Public Method BeginDeregisterEcsCluster(DeregisterEcsClusterRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeregisterEcsCluster operation.
Public Method BeginDeregisterElasticIp(DeregisterElasticIpRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeregisterElasticIp operation.
Public Method BeginDeregisterInstance(DeregisterInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeregisterInstance operation.
Public Method BeginDeregisterRdsDbInstance(DeregisterRdsDbInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeregisterRdsDbInstance operation.
Public Method BeginDeregisterVolume(DeregisterVolumeRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeregisterVolume operation.
Public Method BeginDescribeAgentVersions(DescribeAgentVersionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAgentVersions operation.
Public Method BeginDescribeApps(DescribeAppsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeApps operation.
Public Method BeginDescribeCommands(DescribeCommandsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeCommands operation.
Public Method BeginDescribeDeployments(DescribeDeploymentsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeDeployments operation.
Public Method BeginDescribeEcsClusters(DescribeEcsClustersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeEcsClusters operation.
Public Method BeginDescribeElasticIps(DescribeElasticIpsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeElasticIps operation.
Public Method BeginDescribeElasticLoadBalancers(DescribeElasticLoadBalancersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeElasticLoadBalancers operation.
Public Method BeginDescribeInstances(DescribeInstancesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeInstances operation.
Public Method BeginDescribeLayers(DescribeLayersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLayers operation.
Public Method BeginDescribeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLoadBasedAutoScaling operation.
Public Method BeginDescribeMyUserProfile(DescribeMyUserProfileRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeMyUserProfile operation.
Public Method BeginDescribePermissions(DescribePermissionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribePermissions operation.
Public Method BeginDescribeRaidArrays(DescribeRaidArraysRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeRaidArrays operation.
Public Method BeginDescribeRdsDbInstances(DescribeRdsDbInstancesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeRdsDbInstances operation.
Public Method BeginDescribeServiceErrors(DescribeServiceErrorsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeServiceErrors operation.
Public Method BeginDescribeStackProvisioningParameters(DescribeStackProvisioningParametersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeStackProvisioningParameters operation.
Public Method BeginDescribeStacks(DescribeStacksRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeStacks operation.
Public Method BeginDescribeStackSummary(DescribeStackSummaryRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeStackSummary operation.
Public Method BeginDescribeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeTimeBasedAutoScaling operation.
Public Method BeginDescribeUserProfiles(DescribeUserProfilesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeUserProfiles operation.
Public Method BeginDescribeVolumes(DescribeVolumesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeVolumes operation.
Public Method BeginDetachElasticLoadBalancer(DetachElasticLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the DetachElasticLoadBalancer operation.
Public Method BeginDisassociateElasticIp(DisassociateElasticIpRequest, AsyncCallback, object) Initiates the asynchronous execution of the DisassociateElasticIp operation.
Public Method BeginGetHostnameSuggestion(GetHostnameSuggestionRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetHostnameSuggestion operation.
Public Method BeginGrantAccess(GrantAccessRequest, AsyncCallback, object) Initiates the asynchronous execution of the GrantAccess operation.
Public Method BeginRebootInstance(RebootInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the RebootInstance operation.
Public Method BeginRegisterEcsCluster(RegisterEcsClusterRequest, AsyncCallback, object) Initiates the asynchronous execution of the RegisterEcsCluster operation.
Public Method BeginRegisterElasticIp(RegisterElasticIpRequest, AsyncCallback, object) Initiates the asynchronous execution of the RegisterElasticIp operation.
Public Method BeginRegisterInstance(RegisterInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the RegisterInstance operation.
Public Method BeginRegisterRdsDbInstance(RegisterRdsDbInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the RegisterRdsDbInstance operation.
Public Method BeginRegisterVolume(RegisterVolumeRequest, AsyncCallback, object) Initiates the asynchronous execution of the RegisterVolume operation.
Public Method BeginSetLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetLoadBasedAutoScaling operation.
Public Method BeginSetPermission(SetPermissionRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetPermission operation.
Public Method BeginSetTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetTimeBasedAutoScaling operation.
Public Method BeginStartInstance(StartInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the StartInstance operation.
Public Method BeginStartStack(StartStackRequest, AsyncCallback, object) Initiates the asynchronous execution of the StartStack operation.
Public Method BeginStopInstance(StopInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the StopInstance operation.
Public Method BeginStopStack(StopStackRequest, AsyncCallback, object) Initiates the asynchronous execution of the StopStack operation.
Public Method BeginUnassignInstance(UnassignInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the UnassignInstance operation.
Public Method BeginUnassignVolume(UnassignVolumeRequest, AsyncCallback, object) Initiates the asynchronous execution of the UnassignVolume operation.
Public Method BeginUpdateApp(UpdateAppRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateApp operation.
Public Method BeginUpdateElasticIp(UpdateElasticIpRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateElasticIp operation.
Public Method BeginUpdateInstance(UpdateInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateInstance operation.
Public Method BeginUpdateLayer(UpdateLayerRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateLayer operation.
Public Method BeginUpdateMyUserProfile(UpdateMyUserProfileRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateMyUserProfile operation.
Public Method BeginUpdateRdsDbInstance(UpdateRdsDbInstanceRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateRdsDbInstance operation.
Public Method BeginUpdateStack(UpdateStackRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateStack operation.
Public Method BeginUpdateUserProfile(UpdateUserProfileRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateUserProfile operation.
Public Method BeginUpdateVolume(UpdateVolumeRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateVolume operation.
Public Method CloneStack(CloneStackRequest) Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.

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

Public Method 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.

Public Method CreateDeployment(CreateDeploymentRequest) Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

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

Public Method 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.

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

You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

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

Public Method 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.

Public Method 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.

Public Method 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.

Public Method DeleteInstance(DeleteInstanceRequest) Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.

For more information, see Deleting Instances.

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

Public Method DeleteLayer(DeleteLayerRequest) Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.

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

Public Method DeleteStack(DeleteStackRequest) Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.

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

Public Method 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.

Public Method DeregisterEcsCluster(DeregisterEcsClusterRequest) Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

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

Public Method 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.

Public Method DeregisterInstance(DeregisterInstanceRequest) Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks.

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

Public Method DeregisterRdsDbInstance(DeregisterRdsDbInstanceRequest) Deregisters an Amazon RDS instance.

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

Public Method 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.

Public Method DescribeAgentVersions(DescribeAgentVersionsRequest) Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.
Public Method DescribeApps(DescribeAppsRequest) Requests a description of a specified set of apps.

You must specify at least one of the parameters.

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

Public Method DescribeCommands(DescribeCommandsRequest) Describes the results of specified commands.

You must specify at least one of the parameters.

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

Public Method DescribeDeployments(DescribeDeploymentsRequest) Requests a description of a specified set of deployments.

You must specify at least one of the parameters.

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

Public Method DescribeEcsClusters(DescribeEcsClustersRequest) Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element.

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

Public Method DescribeElasticIps(DescribeElasticIpsRequest) Describes Elastic IP addresses.

You must specify at least one of the parameters.

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

Public Method DescribeElasticLoadBalancers() Describes a stack's Elastic Load Balancing instances.

You must specify at least one of the parameters.

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

Public Method DescribeElasticLoadBalancers(DescribeElasticLoadBalancersRequest) Describes a stack's Elastic Load Balancing instances.

You must specify at least one of the parameters.

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

Public Method DescribeInstances(DescribeInstancesRequest) Requests a description of a set of instances.

You must specify at least one of the parameters.

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

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

You must specify at least one of the parameters.

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

Public Method DescribeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest) Describes load-based auto scaling configurations for specified layers.

You must specify at least one of the parameters.

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

Public Method 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.

Public Method 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.

Public Method 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.

Public Method DescribeRaidArrays(DescribeRaidArraysRequest) Describe an instance's RAID arrays.

You must specify at least one of the parameters.

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

Public Method DescribeRdsDbInstances(DescribeRdsDbInstancesRequest) Describes Amazon RDS instances.

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

Public Method 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.

Public Method 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.

Public Method DescribeStackProvisioningParameters(DescribeStackProvisioningParametersRequest) Requests a description of a stack's provisioning parameters.

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

Public Method 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.

Public Method 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.

Public Method DescribeStackSummary(DescribeStackSummaryRequest) Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.

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

Public Method DescribeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest) Describes time-based auto scaling configurations for specified instances.

You must specify at least one of the parameters.

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

Public Method 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.

Public Method 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.

Public Method DescribeVolumes(DescribeVolumesRequest) Describes an instance's Amazon EBS volumes.

You must specify at least one of the parameters.

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

Public Method 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.

Public Method 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.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EndAssignInstance(IAsyncResult) Finishes the asynchronous execution of the AssignInstance operation.
Public Method EndAssignVolume(IAsyncResult) Finishes the asynchronous execution of the AssignVolume operation.
Public Method EndAssociateElasticIp(IAsyncResult) Finishes the asynchronous execution of the AssociateElasticIp operation.
Public Method EndAttachElasticLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the AttachElasticLoadBalancer operation.
Public Method EndCloneStack(IAsyncResult) Finishes the asynchronous execution of the CloneStack operation.
Public Method EndCreateApp(IAsyncResult) Finishes the asynchronous execution of the CreateApp operation.
Public Method EndCreateDeployment(IAsyncResult) Finishes the asynchronous execution of the CreateDeployment operation.
Public Method EndCreateInstance(IAsyncResult) Finishes the asynchronous execution of the CreateInstance operation.
Public Method EndCreateLayer(IAsyncResult) Finishes the asynchronous execution of the CreateLayer operation.
Public Method EndCreateStack(IAsyncResult) Finishes the asynchronous execution of the CreateStack operation.
Public Method EndCreateUserProfile(IAsyncResult) Finishes the asynchronous execution of the CreateUserProfile operation.
Public Method EndDeleteApp(IAsyncResult) Finishes the asynchronous execution of the DeleteApp operation.
Public Method EndDeleteInstance(IAsyncResult) Finishes the asynchronous execution of the DeleteInstance operation.
Public Method EndDeleteLayer(IAsyncResult) Finishes the asynchronous execution of the DeleteLayer operation.
Public Method EndDeleteStack(IAsyncResult) Finishes the asynchronous execution of the DeleteStack operation.
Public Method EndDeleteUserProfile(IAsyncResult) Finishes the asynchronous execution of the DeleteUserProfile operation.
Public Method EndDeregisterEcsCluster(IAsyncResult) Finishes the asynchronous execution of the DeregisterEcsCluster operation.
Public Method EndDeregisterElasticIp(IAsyncResult) Finishes the asynchronous execution of the DeregisterElasticIp operation.
Public Method EndDeregisterInstance(IAsyncResult) Finishes the asynchronous execution of the DeregisterInstance operation.
Public Method EndDeregisterRdsDbInstance(IAsyncResult) Finishes the asynchronous execution of the DeregisterRdsDbInstance operation.
Public Method EndDeregisterVolume(IAsyncResult) Finishes the asynchronous execution of the DeregisterVolume operation.
Public Method EndDescribeAgentVersions(IAsyncResult) Finishes the asynchronous execution of the DescribeAgentVersions operation.
Public Method EndDescribeApps(IAsyncResult) Finishes the asynchronous execution of the DescribeApps operation.
Public Method EndDescribeCommands(IAsyncResult) Finishes the asynchronous execution of the DescribeCommands operation.
Public Method EndDescribeDeployments(IAsyncResult) Finishes the asynchronous execution of the DescribeDeployments operation.
Public Method EndDescribeEcsClusters(IAsyncResult) Finishes the asynchronous execution of the DescribeEcsClusters operation.
Public Method EndDescribeElasticIps(IAsyncResult) Finishes the asynchronous execution of the DescribeElasticIps operation.
Public Method EndDescribeElasticLoadBalancers(IAsyncResult) Finishes the asynchronous execution of the DescribeElasticLoadBalancers operation.
Public Method EndDescribeInstances(IAsyncResult) Finishes the asynchronous execution of the DescribeInstances operation.
Public Method EndDescribeLayers(IAsyncResult) Finishes the asynchronous execution of the DescribeLayers operation.
Public Method EndDescribeLoadBasedAutoScaling(IAsyncResult) Finishes the asynchronous execution of the DescribeLoadBasedAutoScaling operation.
Public Method EndDescribeMyUserProfile(IAsyncResult) Finishes the asynchronous execution of the DescribeMyUserProfile operation.
Public Method EndDescribePermissions(IAsyncResult) Finishes the asynchronous execution of the DescribePermissions operation.
Public Method EndDescribeRaidArrays(IAsyncResult) Finishes the asynchronous execution of the DescribeRaidArrays operation.
Public Method EndDescribeRdsDbInstances(IAsyncResult) Finishes the asynchronous execution of the DescribeRdsDbInstances operation.
Public Method EndDescribeServiceErrors(IAsyncResult) Finishes the asynchronous execution of the DescribeServiceErrors operation.
Public Method EndDescribeStackProvisioningParameters(IAsyncResult) Finishes the asynchronous execution of the DescribeStackProvisioningParameters operation.
Public Method EndDescribeStacks(IAsyncResult) Finishes the asynchronous execution of the DescribeStacks operation.
Public Method EndDescribeStackSummary(IAsyncResult) Finishes the asynchronous execution of the DescribeStackSummary operation.
Public Method EndDescribeTimeBasedAutoScaling(IAsyncResult) Finishes the asynchronous execution of the DescribeTimeBasedAutoScaling operation.
Public Method EndDescribeUserProfiles(IAsyncResult) Finishes the asynchronous execution of the DescribeUserProfiles operation.
Public Method EndDescribeVolumes(IAsyncResult) Finishes the asynchronous execution of the DescribeVolumes operation.
Public Method EndDetachElasticLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the DetachElasticLoadBalancer operation.
Public Method EndDisassociateElasticIp(IAsyncResult) Finishes the asynchronous execution of the DisassociateElasticIp operation.
Public Method EndGetHostnameSuggestion(IAsyncResult) Finishes the asynchronous execution of the GetHostnameSuggestion operation.
Public Method EndGrantAccess(IAsyncResult) Finishes the asynchronous execution of the GrantAccess operation.
Public Method EndRebootInstance(IAsyncResult) Finishes the asynchronous execution of the RebootInstance operation.
Public Method EndRegisterEcsCluster(IAsyncResult) Finishes the asynchronous execution of the RegisterEcsCluster operation.
Public Method EndRegisterElasticIp(IAsyncResult) Finishes the asynchronous execution of the RegisterElasticIp operation.
Public Method EndRegisterInstance(IAsyncResult) Finishes the asynchronous execution of the RegisterInstance operation.
Public Method EndRegisterRdsDbInstance(IAsyncResult) Finishes the asynchronous execution of the RegisterRdsDbInstance operation.
Public Method EndRegisterVolume(IAsyncResult) Finishes the asynchronous execution of the RegisterVolume operation.
Public Method EndSetLoadBasedAutoScaling(IAsyncResult) Finishes the asynchronous execution of the SetLoadBasedAutoScaling operation.
Public Method EndSetPermission(IAsyncResult) Finishes the asynchronous execution of the SetPermission operation.
Public Method EndSetTimeBasedAutoScaling(IAsyncResult) Finishes the asynchronous execution of the SetTimeBasedAutoScaling operation.
Public Method EndStartInstance(IAsyncResult) Finishes the asynchronous execution of the StartInstance operation.
Public Method EndStartStack(IAsyncResult) Finishes the asynchronous execution of the StartStack operation.
Public Method EndStopInstance(IAsyncResult) Finishes the asynchronous execution of the StopInstance operation.
Public Method EndStopStack(IAsyncResult) Finishes the asynchronous execution of the StopStack operation.
Public Method EndUnassignInstance(IAsyncResult) Finishes the asynchronous execution of the UnassignInstance operation.
Public Method EndUnassignVolume(IAsyncResult) Finishes the asynchronous execution of the UnassignVolume operation.
Public Method EndUpdateApp(IAsyncResult) Finishes the asynchronous execution of the UpdateApp operation.
Public Method EndUpdateElasticIp(IAsyncResult) Finishes the asynchronous execution of the UpdateElasticIp operation.
Public Method EndUpdateInstance(IAsyncResult) Finishes the asynchronous execution of the UpdateInstance operation.
Public Method EndUpdateLayer(IAsyncResult) Finishes the asynchronous execution of the UpdateLayer operation.
Public Method EndUpdateMyUserProfile(IAsyncResult) Finishes the asynchronous execution of the UpdateMyUserProfile operation.
Public Method EndUpdateRdsDbInstance(IAsyncResult) Finishes the asynchronous execution of the UpdateRdsDbInstance operation.
Public Method EndUpdateStack(IAsyncResult) Finishes the asynchronous execution of the UpdateStack operation.
Public Method EndUpdateUserProfile(IAsyncResult) Finishes the asynchronous execution of the UpdateUserProfile operation.
Public Method EndUpdateVolume(IAsyncResult) Finishes the asynchronous execution of the UpdateVolume operation.
Public Method 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.

Public Method GrantAccess(GrantAccessRequest) This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

Public Method 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.

Public Method RegisterEcsCluster(RegisterEcsClusterRequest) Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.

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

Public Method 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.

Public Method RegisterInstance(RegisterInstanceRequest) Registers instances with a specified stack that were created outside of AWS OpsWorks. We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stack.

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

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

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

Public Method 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.

Public Method 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.

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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method UnassignInstance(UnassignInstanceRequest) Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks.

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

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method UpdateRdsDbInstance(UpdateRdsDbInstanceRequest) Updates an Amazon RDS instance.

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

Public Method 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.

Public Method 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.

Public Method 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.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8