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:
- AWS CLI
- AWS SDK for Java
- AWS SDK for .NET
- AWS SDK for PHP 2
- AWS SDK for Ruby
- AWS SDK for Node.js
- AWS SDK for Python(Boto)
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.
Inheritance Hierarchy
Namespace: Amazon.OpsWorks
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class AmazonOpsWorksClient : AmazonServiceClient IAmazonOpsWorks, IDisposable
The AmazonOpsWorksClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
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>
|
|
|
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>
|
|
|
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>
|
|
|
AmazonOpsWorksClient(AWSCredentials) | Constructs AmazonOpsWorksClient with AWS Credentials |
|
|
AmazonOpsWorksClient(AWSCredentials, RegionEndpoint) | Constructs AmazonOpsWorksClient with AWS Credentials |
|
|
AmazonOpsWorksClient(AWSCredentials, AmazonOpsWorksConfig) | Constructs AmazonOpsWorksClient with AWS Credentials and an AmazonOpsWorksClient Configuration object. |
|
|
AmazonOpsWorksClient(string, string) | Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonOpsWorksClient(string, string, RegionEndpoint) | Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonOpsWorksClient(string, string, AmazonOpsWorksConfig) | Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object. |
|
|
AmazonOpsWorksClient(string, string, string) | Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonOpsWorksClient(string, string, string, RegionEndpoint) | Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonOpsWorksClient(string, string, string, AmazonOpsWorksConfig) | Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object. |
Methods
| Name | Description | |
|---|---|---|
|
|
AssignInstance(AssignInstanceRequest) |
Assign a registered instance to a layer.
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. |
|
|
AssignInstanceAsync(AssignInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the AssignInstance operation. |
|
|
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. |
|
|
AssignVolumeAsync(AssignVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the AssignVolume operation. |
|
|
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. |
|
|
AssociateElasticIpAsync(AssociateElasticIpRequest, CancellationToken) | Initiates the asynchronous execution of the AssociateElasticIp operation. |
|
|
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. |
|
|
AttachElasticLoadBalancerAsync(AttachElasticLoadBalancerRequest, CancellationToken) | Initiates the asynchronous execution of the AttachElasticLoadBalancer operation. |
|
|
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. |
|
|
CloneStackAsync(CloneStackRequest, CancellationToken) | Initiates the asynchronous execution of the CloneStack operation. |
|
|
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. |
|
|
CreateAppAsync(CreateAppRequest, CancellationToken) | Initiates the asynchronous execution of the CreateApp operation. |
|
|
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. |
|
|
CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken) | Initiates the asynchronous execution of the CreateDeployment operation. |
|
|
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. |
|
|
CreateInstanceAsync(CreateInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the CreateInstance operation. |
|
|
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. |
|
|
CreateLayerAsync(CreateLayerRequest, CancellationToken) | Initiates the asynchronous execution of the CreateLayer operation. |
|
|
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. |
|
|
CreateStackAsync(CreateStackRequest, CancellationToken) | Initiates the asynchronous execution of the CreateStack operation. |
|
|
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. |
|
|
CreateUserProfileAsync(CreateUserProfileRequest, CancellationToken) | Initiates the asynchronous execution of the CreateUserProfile operation. |
|
|
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. |
|
|
DeleteAppAsync(DeleteAppRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteApp operation. |
|
|
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. |
|
|
DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteInstance operation. |
|
|
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. |
|
|
DeleteLayerAsync(DeleteLayerRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteLayer operation. |
|
|
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. |
|
|
DeleteStackAsync(DeleteStackRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteStack operation. |
|
|
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. |
|
|
DeleteUserProfileAsync(DeleteUserProfileRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteUserProfile operation. |
|
|
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 . |
|
|
DeregisterEcsClusterAsync(DeregisterEcsClusterRequest, CancellationToken) | Initiates the asynchronous execution of the DeregisterEcsCluster operation. |
|
|
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. |
|
|
DeregisterElasticIpAsync(DeregisterElasticIpRequest, CancellationToken) | Initiates the asynchronous execution of the DeregisterElasticIp operation. |
|
|
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. |
|
|
DeregisterInstanceAsync(DeregisterInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the DeregisterInstance operation. |
|
|
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. |
|
|
DeregisterRdsDbInstanceAsync(DeregisterRdsDbInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the DeregisterRdsDbInstance operation. |
|
|
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. |
|
|
DeregisterVolumeAsync(DeregisterVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the DeregisterVolume operation. |
|
|
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.
|
|
|
DescribeAgentVersionsAsync(DescribeAgentVersionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeAgentVersions operation. |
|
|
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. |
|
|
DescribeAppsAsync(DescribeAppsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeApps operation. |
|
|
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. |
|
|
DescribeCommandsAsync(DescribeCommandsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCommands operation. |
|
|
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. |
|
|
DescribeDeploymentsAsync(DescribeDeploymentsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDeployments operation. |
|
|
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. |
|
|
DescribeEcsClustersAsync(DescribeEcsClustersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEcsClusters operation. |
|
|
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. |
|
|
DescribeElasticIpsAsync(DescribeElasticIpsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeElasticIps operation. |
|
|
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. |
|
|
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. |
|
|
DescribeElasticLoadBalancersAsync(DescribeElasticLoadBalancersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeElasticLoadBalancers operation. |
|
|
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. |
|
|
DescribeInstancesAsync(DescribeInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeInstances operation. |
|
|
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. |
|
|
DescribeLayersAsync(DescribeLayersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeLayers operation. |
|
|
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. |
|
|
DescribeLoadBasedAutoScalingAsync(DescribeLoadBasedAutoScalingRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeLoadBasedAutoScaling operation. |
|
|
DescribeMyUserProfile() |
Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeMyUserProfile(DescribeMyUserProfileRequest) |
Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeMyUserProfileAsync(DescribeMyUserProfileRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeMyUserProfile operation. |
|
|
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. |
|
|
DescribePermissionsAsync(DescribePermissionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribePermissions operation. |
|
|
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. |
|
|
DescribeRaidArraysAsync(DescribeRaidArraysRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeRaidArrays operation. |
|
|
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. |
|
|
DescribeRdsDbInstancesAsync(DescribeRdsDbInstancesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeRdsDbInstances operation. |
|
|
DescribeServiceErrors() |
Describes AWS OpsWorks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeServiceErrors(DescribeServiceErrorsRequest) |
Describes AWS OpsWorks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeServiceErrorsAsync(DescribeServiceErrorsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeServiceErrors operation. |
|
|
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. |
|
|
DescribeStackProvisioningParametersAsync(DescribeStackProvisioningParametersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeStackProvisioningParameters operation. |
|
|
DescribeStacks() |
Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeStacks(DescribeStacksRequest) |
Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeStacksAsync(DescribeStacksRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeStacks operation. |
|
|
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. |
|
|
DescribeStackSummaryAsync(DescribeStackSummaryRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeStackSummary operation. |
|
|
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. |
|
|
DescribeTimeBasedAutoScalingAsync(DescribeTimeBasedAutoScalingRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeTimeBasedAutoScaling operation. |
|
|
DescribeUserProfiles() |
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeUserProfiles(DescribeUserProfilesRequest) |
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
DescribeUserProfilesAsync(DescribeUserProfilesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeUserProfiles operation. |
|
|
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. |
|
|
DescribeVolumesAsync(DescribeVolumesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeVolumes operation. |
|
|
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. |
|
|
DetachElasticLoadBalancerAsync(DetachElasticLoadBalancerRequest, CancellationToken) | Initiates the asynchronous execution of the DetachElasticLoadBalancer operation. |
|
|
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. |
|
|
DisassociateElasticIpAsync(DisassociateElasticIpRequest, CancellationToken) | Initiates the asynchronous execution of the DisassociateElasticIp operation. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
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. |
|
|
GetHostnameSuggestionAsync(GetHostnameSuggestionRequest, CancellationToken) | Initiates the asynchronous execution of the GetHostnameSuggestion operation. |
|
|
GrantAccess(GrantAccessRequest) |
Grants RDP access to a Windows instance for a specified time period. |
|
|
GrantAccessAsync(GrantAccessRequest, CancellationToken) | Initiates the asynchronous execution of the GrantAccess operation. |
|
|
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. |
|
|
RebootInstanceAsync(RebootInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the RebootInstance operation. |
|
|
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. |
|
|
RegisterEcsClusterAsync(RegisterEcsClusterRequest, CancellationToken) | Initiates the asynchronous execution of the RegisterEcsCluster operation. |
|
|
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. |
|
|
RegisterElasticIpAsync(RegisterElasticIpRequest, CancellationToken) | Initiates the asynchronous execution of the RegisterElasticIp operation. |
|
|
RegisterInstance(RegisterInstanceRequest) |
Registers instances with a specified stack that were created outside of AWS OpsWorks.
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. |
|
|
RegisterInstanceAsync(RegisterInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the RegisterInstance operation. |
|
|
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. |
|
|
RegisterRdsDbInstanceAsync(RegisterRdsDbInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the RegisterRdsDbInstance operation. |
|
|
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. |
|
|
RegisterVolumeAsync(RegisterVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the RegisterVolume operation. |
|
|
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. |
|
|
SetLoadBasedAutoScalingAsync(SetLoadBasedAutoScalingRequest, CancellationToken) | Initiates the asynchronous execution of the SetLoadBasedAutoScaling operation. |
|
|
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. |
|
|
SetPermissionAsync(SetPermissionRequest, CancellationToken) | Initiates the asynchronous execution of the SetPermission operation. |
|
|
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. |
|
|
SetTimeBasedAutoScalingAsync(SetTimeBasedAutoScalingRequest, CancellationToken) | Initiates the asynchronous execution of the SetTimeBasedAutoScaling operation. |
|
|
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. |
|
|
StartInstanceAsync(StartInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the StartInstance operation. |
|
|
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. |
|
|
StartStackAsync(StartStackRequest, CancellationToken) | Initiates the asynchronous execution of the StartStack operation. |
|
|
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. |
|
|
StopInstanceAsync(StopInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the StopInstance operation. |
|
|
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. |
|
|
StopStackAsync(StopStackRequest, CancellationToken) | Initiates the asynchronous execution of the StopStack operation. |
|
|
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. |
|
|
UnassignInstanceAsync(UnassignInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the UnassignInstance operation. |
|
|
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. |
|
|
UnassignVolumeAsync(UnassignVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the UnassignVolume operation. |
|
|
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. |
|
|
UpdateAppAsync(UpdateAppRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateApp operation. |
|
|
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. |
|
|
UpdateElasticIpAsync(UpdateElasticIpRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateElasticIp operation. |
|
|
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. |
|
|
UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateInstance operation. |
|
|
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. |
|
|
UpdateLayerAsync(UpdateLayerRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateLayer operation. |
|
|
UpdateMyUserProfile() |
Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
UpdateMyUserProfile(UpdateMyUserProfileRequest) |
Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. |
|
|
UpdateMyUserProfileAsync(UpdateMyUserProfileRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateMyUserProfile operation. |
|
|
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. |
|
|
UpdateRdsDbInstanceAsync(UpdateRdsDbInstanceRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateRdsDbInstance operation. |
|
|
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. |
|
|
UpdateStackAsync(UpdateStackRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateStack operation. |
|
|
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. |
|
|
UpdateUserProfileAsync(UpdateUserProfileRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateUserProfile operation. |
|
|
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. |
|
|
UpdateVolumeAsync(UpdateVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateVolume operation. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
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