AWS SDK Version 3 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.

Implementation for accessing OpsWorks AWS OpsWorks

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

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

SDKs and CLI

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

Endpoints

AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

Inheritance Hierarchy

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

Namespace: Amazon.OpsWorks
Assembly: AWSSDK.OpsWorks.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonOpsWorksClient : AmazonServiceClient
         IAmazonOpsWorks, IAmazonService, 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.



    
        
    

             

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.



    
        
    

             

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.



    
        
    

             

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.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

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 Stacks.

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

Public Method AssignInstanceAsync(AssignInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the AssignInstance operation.

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 AssignVolumeAsync(AssignVolumeRequest, CancellationToken)

Initiates the asynchronous execution of the AssignVolume operation.

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 AssociateElasticIpAsync(AssociateElasticIpRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateElasticIp operation.

Public Method AttachElasticLoadBalancer(AttachElasticLoadBalancerRequest)

Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.

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

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

Public Method AttachElasticLoadBalancerAsync(AttachElasticLoadBalancerRequest, CancellationToken)

Initiates the asynchronous execution of the AttachElasticLoadBalancer 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 CloneStackAsync(CloneStackRequest, CancellationToken)

Initiates the asynchronous execution of the CloneStack operation.

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 CreateAppAsync(CreateAppRequest, CancellationToken)

Initiates the asynchronous execution of the CreateApp operation.

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 CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDeployment operation.

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 CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateInstance operation.

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 CreateLayerAsync(CreateLayerRequest, CancellationToken)

Initiates the asynchronous execution of the CreateLayer operation.

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 CreateStackAsync(CreateStackRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStack operation.

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 CreateUserProfileAsync(CreateUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUserProfile operation.

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 DeleteAppAsync(DeleteAppRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApp operation.

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 DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteInstance operation.

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 DeleteLayerAsync(DeleteLayerRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteLayer operation.

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 DeleteStackAsync(DeleteStackRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteStack operation.

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 DeleteUserProfileAsync(DeleteUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUserProfile operation.

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 http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

Public Method DeregisterEcsClusterAsync(DeregisterEcsClusterRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterEcsCluster operation.

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 DeregisterElasticIpAsync(DeregisterElasticIpRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterElasticIp operation.

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 Stacks.

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

Public Method DeregisterInstanceAsync(DeregisterInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterInstance operation.

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 DeregisterRdsDbInstanceAsync(DeregisterRdsDbInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterRdsDbInstance operation.

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 DeregisterVolumeAsync(DeregisterVolumeRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterVolume operation.

Public Method DescribeAgentVersions(DescribeAgentVersionsRequest)

Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

Public Method DescribeAgentVersionsAsync(DescribeAgentVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAgentVersions operation.

Public Method DescribeApps(DescribeAppsRequest)

Requests a description of a specified set of apps.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeAppsAsync(DescribeAppsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeApps operation.

Public Method DescribeCommands(DescribeCommandsRequest)

Describes the results of specified commands.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeCommandsAsync(DescribeCommandsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCommands operation.

Public Method DescribeDeployments(DescribeDeploymentsRequest)

Requests a description of a specified set of deployments.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeDeploymentsAsync(DescribeDeploymentsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDeployments operation.

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 Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

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

This call accepts only one resource-identifying parameter.

Public Method DescribeEcsClustersAsync(DescribeEcsClustersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEcsClusters operation.

Public Method DescribeElasticIps(DescribeElasticIpsRequest)

Describes Elastic IP addresses.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeElasticIpsAsync(DescribeElasticIpsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeElasticIps operation.

Public Method DescribeElasticLoadBalancers()

Describes a stack's Elastic Load Balancing instances.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeElasticLoadBalancers(DescribeElasticLoadBalancersRequest)

Describes a stack's Elastic Load Balancing instances.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeElasticLoadBalancersAsync(CancellationToken)

Describes a stack's Elastic Load Balancing instances.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeElasticLoadBalancersAsync(DescribeElasticLoadBalancersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeElasticLoadBalancers operation.

Public Method DescribeInstances(DescribeInstancesRequest)

Requests a description of a set of instances.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeInstancesAsync(DescribeInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeInstances operation.

Public Method DescribeLayers(DescribeLayersRequest)

Requests a description of one or more layers in a specified stack.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeLayersAsync(DescribeLayersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLayers operation.

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 DescribeLoadBasedAutoScalingAsync(DescribeLoadBasedAutoScalingRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLoadBasedAutoScaling operation.

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 DescribeMyUserProfileAsync(CancellationToken)

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 DescribeMyUserProfileAsync(DescribeMyUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMyUserProfile operation.

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 DescribePermissionsAsync(DescribePermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePermissions operation.

Public Method DescribeRaidArrays(DescribeRaidArraysRequest)

Describe an instance's RAID arrays.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeRaidArraysAsync(DescribeRaidArraysRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRaidArrays operation.

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.

This call accepts only one resource-identifying parameter.

Public Method DescribeRdsDbInstancesAsync(DescribeRdsDbInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRdsDbInstances operation.

Public Method DescribeServiceErrors()

Describes AWS OpsWorks Stacks service errors.

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

This call accepts only one resource-identifying parameter.

Public Method DescribeServiceErrors(DescribeServiceErrorsRequest)

Describes AWS OpsWorks Stacks service errors.

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

This call accepts only one resource-identifying parameter.

Public Method DescribeServiceErrorsAsync(CancellationToken)

Describes AWS OpsWorks Stacks service errors.

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

This call accepts only one resource-identifying parameter.

Public Method DescribeServiceErrorsAsync(DescribeServiceErrorsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeServiceErrors operation.

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 DescribeStackProvisioningParametersAsync(DescribeStackProvisioningParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStackProvisioningParameters operation.

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 DescribeStacksAsync(CancellationToken)

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 DescribeStacksAsync(DescribeStacksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStacks operation.

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 DescribeStackSummaryAsync(DescribeStackSummaryRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStackSummary operation.

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 DescribeTimeBasedAutoScalingAsync(DescribeTimeBasedAutoScalingRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTimeBasedAutoScaling operation.

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 DescribeUserProfilesAsync(CancellationToken)

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 DescribeUserProfilesAsync(DescribeUserProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserProfiles operation.

Public Method DescribeVolumes(DescribeVolumesRequest)

Describes an instance's Amazon EBS volumes.

This call accepts only one resource-identifying parameter.

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

Public Method DescribeVolumesAsync(DescribeVolumesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeVolumes operation.

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 DetachElasticLoadBalancerAsync(DetachElasticLoadBalancerRequest, CancellationToken)

Initiates the asynchronous execution of the DetachElasticLoadBalancer operation.

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 DisassociateElasticIpAsync(DisassociateElasticIpRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateElasticIp operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
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 GetHostnameSuggestionAsync(GetHostnameSuggestionRequest, CancellationToken)

Initiates the asynchronous execution of the GetHostnameSuggestion operation.

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 GrantAccessAsync(GrantAccessRequest, CancellationToken)

Initiates the asynchronous execution of the GrantAccess operation.

Public Method ListTags(ListTagsRequest)

Returns a list of tags that are applied to the specified stack or layer.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTags operation.

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 RebootInstanceAsync(RebootInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the RebootInstance operation.

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 RegisterEcsClusterAsync(RegisterEcsClusterRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterEcsCluster operation.

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 RegisterElasticIpAsync(RegisterElasticIpRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterElasticIp operation.

Public Method RegisterInstance(RegisterInstanceRequest)

Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.

We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack.

Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.

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

Public Method RegisterInstanceAsync(RegisterInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterInstance operation.

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 RegisterRdsDbInstanceAsync(RegisterRdsDbInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterRdsDbInstance operation.

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 RegisterVolumeAsync(RegisterVolumeRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterVolume operation.

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 SetLoadBasedAutoScalingAsync(SetLoadBasedAutoScalingRequest, CancellationToken)

Initiates the asynchronous execution of the SetLoadBasedAutoScaling operation.

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 SetPermissionAsync(SetPermissionRequest, CancellationToken)

Initiates the asynchronous execution of the SetPermission operation.

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 SetTimeBasedAutoScalingAsync(SetTimeBasedAutoScalingRequest, CancellationToken)

Initiates the asynchronous execution of the SetTimeBasedAutoScaling operation.

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 StartInstanceAsync(StartInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the StartInstance operation.

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 StartStackAsync(StartStackRequest, CancellationToken)

Initiates the asynchronous execution of the StartStack operation.

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 StopInstanceAsync(StopInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the StopInstance operation.

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 StopStackAsync(StopStackRequest, CancellationToken)

Initiates the asynchronous execution of the StopStack operation.

Public Method TagResource(TagResourceRequest)

Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the TagResource operation.

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 Stacks.

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

Public Method UnassignInstanceAsync(UnassignInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the UnassignInstance operation.

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 UnassignVolumeAsync(UnassignVolumeRequest, CancellationToken)

Initiates the asynchronous execution of the UnassignVolume operation.

Public Method UntagResource(UntagResourceRequest)

Removes tags from a specified stack or layer.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UntagResource operation.

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 UpdateAppAsync(UpdateAppRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApp operation.

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 UpdateElasticIpAsync(UpdateElasticIpRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateElasticIp operation.

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 UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateInstance operation.

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 UpdateLayerAsync(UpdateLayerRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateLayer operation.

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 UpdateMyUserProfileAsync(CancellationToken)

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 UpdateMyUserProfileAsync(UpdateMyUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateMyUserProfile operation.

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 UpdateRdsDbInstanceAsync(UpdateRdsDbInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRdsDbInstance operation.

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 UpdateStackAsync(UpdateStackRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateStack operation.

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 UpdateUserProfileAsync(UpdateUserProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserProfile operation.

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.

Public Method UpdateVolumeAsync(UpdateVolumeRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateVolume operation.

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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms