OpsWorksClient Class

(QtAws::OpsWorks::OpsWorksClient)

The OpsWorksClient class provides access to the AWS OpsWorks service. More...

Header: #include <OpsWorksClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

OpsWorksClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
OpsWorksClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

AssignInstanceResponse *assignInstance(const AssignInstanceRequest &request)
AssignVolumeResponse *assignVolume(const AssignVolumeRequest &request)
AssociateElasticIpResponse *associateElasticIp(const AssociateElasticIpRequest &request)
AttachElasticLoadBalancerResponse *attachElasticLoadBalancer(const AttachElasticLoadBalancerRequest &request)
CloneStackResponse *cloneStack(const CloneStackRequest &request)
CreateAppResponse *createApp(const CreateAppRequest &request)
CreateDeploymentResponse *createDeployment(const CreateDeploymentRequest &request)
CreateInstanceResponse *createInstance(const CreateInstanceRequest &request)
CreateLayerResponse *createLayer(const CreateLayerRequest &request)
CreateStackResponse *createStack(const CreateStackRequest &request)
CreateUserProfileResponse *createUserProfile(const CreateUserProfileRequest &request)
DeleteAppResponse *deleteApp(const DeleteAppRequest &request)
DeleteInstanceResponse *deleteInstance(const DeleteInstanceRequest &request)
DeleteLayerResponse *deleteLayer(const DeleteLayerRequest &request)
DeleteStackResponse *deleteStack(const DeleteStackRequest &request)
DeleteUserProfileResponse *deleteUserProfile(const DeleteUserProfileRequest &request)
DeregisterEcsClusterResponse *deregisterEcsCluster(const DeregisterEcsClusterRequest &request)
DeregisterElasticIpResponse *deregisterElasticIp(const DeregisterElasticIpRequest &request)
DeregisterInstanceResponse *deregisterInstance(const DeregisterInstanceRequest &request)
DeregisterRdsDbInstanceResponse *deregisterRdsDbInstance(const DeregisterRdsDbInstanceRequest &request)
DeregisterVolumeResponse *deregisterVolume(const DeregisterVolumeRequest &request)
DescribeAgentVersionsResponse *describeAgentVersions(const DescribeAgentVersionsRequest &request)
DescribeAppsResponse *describeApps(const DescribeAppsRequest &request)
DescribeCommandsResponse *describeCommands(const DescribeCommandsRequest &request)
DescribeDeploymentsResponse *describeDeployments(const DescribeDeploymentsRequest &request)
DescribeEcsClustersResponse *describeEcsClusters(const DescribeEcsClustersRequest &request)
DescribeElasticIpsResponse *describeElasticIps(const DescribeElasticIpsRequest &request)
DescribeElasticLoadBalancersResponse *describeElasticLoadBalancers(const DescribeElasticLoadBalancersRequest &request)
DescribeInstancesResponse *describeInstances(const DescribeInstancesRequest &request)
DescribeLayersResponse *describeLayers(const DescribeLayersRequest &request)
DescribeLoadBasedAutoScalingResponse *describeLoadBasedAutoScaling(const DescribeLoadBasedAutoScalingRequest &request)
DescribeMyUserProfileResponse *describeMyUserProfile()
DescribeOperatingSystemsResponse *describeOperatingSystems()
DescribePermissionsResponse *describePermissions(const DescribePermissionsRequest &request)
DescribeRaidArraysResponse *describeRaidArrays(const DescribeRaidArraysRequest &request)
DescribeRdsDbInstancesResponse *describeRdsDbInstances(const DescribeRdsDbInstancesRequest &request)
DescribeServiceErrorsResponse *describeServiceErrors(const DescribeServiceErrorsRequest &request)
DescribeStackProvisioningParametersResponse *describeStackProvisioningParameters(const DescribeStackProvisioningParametersRequest &request)
DescribeStackSummaryResponse *describeStackSummary(const DescribeStackSummaryRequest &request)
DescribeStacksResponse *describeStacks(const DescribeStacksRequest &request)
DescribeTimeBasedAutoScalingResponse *describeTimeBasedAutoScaling(const DescribeTimeBasedAutoScalingRequest &request)
DescribeUserProfilesResponse *describeUserProfiles(const DescribeUserProfilesRequest &request)
DescribeVolumesResponse *describeVolumes(const DescribeVolumesRequest &request)
DetachElasticLoadBalancerResponse *detachElasticLoadBalancer(const DetachElasticLoadBalancerRequest &request)
DisassociateElasticIpResponse *disassociateElasticIp(const DisassociateElasticIpRequest &request)
GetHostnameSuggestionResponse *getHostnameSuggestion(const GetHostnameSuggestionRequest &request)
GrantAccessResponse *grantAccess(const GrantAccessRequest &request)
ListTagsResponse *listTags(const ListTagsRequest &request)
RebootInstanceResponse *rebootInstance(const RebootInstanceRequest &request)
RegisterEcsClusterResponse *registerEcsCluster(const RegisterEcsClusterRequest &request)
RegisterElasticIpResponse *registerElasticIp(const RegisterElasticIpRequest &request)
RegisterInstanceResponse *registerInstance(const RegisterInstanceRequest &request)
RegisterRdsDbInstanceResponse *registerRdsDbInstance(const RegisterRdsDbInstanceRequest &request)
RegisterVolumeResponse *registerVolume(const RegisterVolumeRequest &request)
SetLoadBasedAutoScalingResponse *setLoadBasedAutoScaling(const SetLoadBasedAutoScalingRequest &request)
SetPermissionResponse *setPermission(const SetPermissionRequest &request)
SetTimeBasedAutoScalingResponse *setTimeBasedAutoScaling(const SetTimeBasedAutoScalingRequest &request)
StartInstanceResponse *startInstance(const StartInstanceRequest &request)
StartStackResponse *startStack(const StartStackRequest &request)
StopInstanceResponse *stopInstance(const StopInstanceRequest &request)
StopStackResponse *stopStack(const StopStackRequest &request)
TagResourceResponse *tagResource(const TagResourceRequest &request)
UnassignInstanceResponse *unassignInstance(const UnassignInstanceRequest &request)
UnassignVolumeResponse *unassignVolume(const UnassignVolumeRequest &request)
UntagResourceResponse *untagResource(const UntagResourceRequest &request)
UpdateAppResponse *updateApp(const UpdateAppRequest &request)
UpdateElasticIpResponse *updateElasticIp(const UpdateElasticIpRequest &request)
UpdateInstanceResponse *updateInstance(const UpdateInstanceRequest &request)
UpdateLayerResponse *updateLayer(const UpdateLayerRequest &request)
UpdateMyUserProfileResponse *updateMyUserProfile(const UpdateMyUserProfileRequest &request)
UpdateRdsDbInstanceResponse *updateRdsDbInstance(const UpdateRdsDbInstanceRequest &request)
UpdateStackResponse *updateStack(const UpdateStackRequest &request)
UpdateUserProfileResponse *updateUserProfile(const UpdateUserProfileRequest &request)
UpdateVolumeResponse *updateVolume(const UpdateVolumeRequest &request)

Additional Inherited Members

Detailed Description

The OpsWorksClient class provides access to the AWS OpsWorks service.

<fullname>AWS OpsWorks</fullname>

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

</p

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 <a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page.

</p

<b>SDKs and CLI</b>

</p

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> <ul> <li>

<a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a>

</p </li> <li>

<a href="http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a>

</p </li> <li>

<a href="http://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for .NET</a>

</p </li> <li>

<a href="http://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS SDK for PHP 2</a>

</p </li> <li>

<a href="http://docs.aws.amazon.com/sdkforruby/api/">AWS SDK for Ruby</a>

</p </li> <li>

<a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a>

</p </li> <li>

<a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for Python(Boto)</a>

</p </li> </ul>

<b>Endpoints</b>

</p

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> <ul> <li>

opsworks.us-east-1.amazonaws.co> </li> <li>

opsworks.us-east-2.amazonaws.co> </li> <li>

opsworks.us-west-1.amazonaws.co> </li> <li>

opsworks.us-west-2.amazonaws.co> </li> <li>

opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS

console> </li> <li>

opsworks.eu-west-1.amazonaws.co> </li> <li>

opsworks.eu-west-2.amazonaws.co> </li> <li>

opsworks.eu-west-3.amazonaws.co> </li> <li>

opsworks.eu-central-1.amazonaws.co> </li> <li>

opsworks.ap-northeast-1.amazonaws.co> </li> <li>

opsworks.ap-northeast-2.amazonaws.co> </li> <li>

opsworks.ap-south-1.amazonaws.co> </li> <li>

opsworks.ap-southeast-1.amazonaws.co> </li> <li>

opsworks.ap-southeast-2.amazonaws.co> </li> <li>

opsworks.sa-east-1.amazonaws.co> </li> </ul>

<b>Chef Versions</b>

</p

When you call <a>CreateStack</a>, <a>CloneStack</a>, or <a>UpdateStack</a> we recommend you use the <code>ConfigurationManager</code> 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef

Versions</a>> <note>

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

Member Function Documentation

OpsWorksClient::OpsWorksClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a OpsWorksClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

OpsWorksClient::OpsWorksClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads OpsWorksClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssignInstanceResponse *OpsWorksClient::assignInstance(const AssignInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an AssignInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Assign a registered instance to a

layer> <ul> <li>

You can assign registered on-premises instances to any layer

type> </li> <li>

You can assign registered Amazon EC2 instances only to custom

layers> </li> <li>

You cannot use this action with instances that were created with AWS OpsWorks

Stacks> </li> </ul>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] AssignVolumeResponse *OpsWorksClient::assignVolume(const AssignVolumeRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an AssignVolumeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>RegisterVolume</a>. After you register the volume, you must call <a>UpdateVolume</a> to specify a mount point before calling <code>AssignVolume</code>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] AssociateElasticIpResponse *OpsWorksClient::associateElasticIp(const AssociateElasticIpRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an AssociateElasticIpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>RegisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] AttachElasticLoadBalancerResponse *OpsWorksClient::attachElasticLoadBalancer(const AttachElasticLoadBalancerRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an AttachElasticLoadBalancerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html">Elastic Load

Balancing</a>> <note>

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html"> Elastic Load Balancing Developer

Guide</a>> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] CloneStackResponse *OpsWorksClient::cloneStack(const CloneStackRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an CloneStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a clone of a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html">Clone a Stack</a>. By default, all parameters are set to the values used by the parent

stack>

<b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] CreateAppResponse *OpsWorksClient::createApp(const CreateAppRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an CreateAppResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an app for a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html">Creating

Apps</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] CreateDeploymentResponse *OpsWorksClient::createDeployment(const CreateDeploymentRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an CreateDeploymentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Runs deployment or stack commands. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html">Deploying Apps</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html">Run Stack

Commands</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] CreateInstanceResponse *OpsWorksClient::createInstance(const CreateInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an CreateInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an instance in a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html">Adding an Instance to a

Layer</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] CreateLayerResponse *OpsWorksClient::createLayer(const CreateLayerRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an CreateLayerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html">How to Create a

Layer</a>> <note>

You should use <b>CreateLayer</b> 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, <b>CreateLayer</b> fails. A stack can have an arbitrary number of custom layers, so you can call <b>CreateLayer</b> as many times as you like for that layer

type> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] CreateStackResponse *OpsWorksClient::createStack(const CreateStackRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an CreateStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html">Create a New

Stack</a>>

<b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] CreateUserProfileResponse *OpsWorksClient::createUserProfile(const CreateUserProfileRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an CreateUserProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new user

profile>

<b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeleteAppResponse *OpsWorksClient::deleteApp(const DeleteAppRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeleteAppResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a specified

app>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeleteInstanceResponse *OpsWorksClient::deleteInstance(const DeleteInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeleteInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html">Deleting

Instances</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeleteLayerResponse *OpsWorksClient::deleteLayer(const DeleteLayerRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeleteLayerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html">How to Delete a

Layer</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeleteStackResponse *OpsWorksClient::deleteStack(const DeleteStackRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeleteStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html">Shut Down a

Stack</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeleteUserProfileResponse *OpsWorksClient::deleteUserProfile(const DeleteUserProfileRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeleteUserProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a user

profile>

<b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeregisterEcsClusterResponse *OpsWorksClient::deregisterEcsCluster(const DeregisterEcsClusterRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeregisterEcsClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deregisters a specified Amazon ECS cluster from a stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete"> Resource

Management</a>>

<b>Required Permissions</b>: 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 <a

[slot] DeregisterElasticIpResponse *OpsWorksClient::deregisterElasticIp(const DeregisterElasticIpRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeregisterElasticIpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeregisterInstanceResponse *OpsWorksClient::deregisterInstance(const DeregisterInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeregisterInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeregisterRdsDbInstanceResponse *OpsWorksClient::deregisterRdsDbInstance(const DeregisterRdsDbInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeregisterRdsDbInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deregisters an Amazon RDS

instance>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DeregisterVolumeResponse *OpsWorksClient::deregisterVolume(const DeregisterVolumeRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DeregisterVolumeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeAgentVersionsResponse *OpsWorksClient::describeAgentVersions(const DescribeAgentVersionsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeAgentVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeAppsResponse *OpsWorksClient::describeApps(const DescribeAppsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeAppsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests a description of a specified set of

apps> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeCommandsResponse *OpsWorksClient::describeCommands(const DescribeCommandsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeCommandsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the results of specified

commands> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeDeploymentsResponse *OpsWorksClient::describeDeployments(const DescribeDeploymentsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeDeploymentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests a description of a specified set of

deployments> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeEcsClustersResponse *OpsWorksClient::describeEcsClusters(const DescribeEcsClustersRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeEcsClustersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> 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>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

Permissions</a>>

This call accepts only one resource-identifying

[slot] DescribeElasticIpsResponse *OpsWorksClient::describeElasticIps(const DescribeElasticIpsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeElasticIpsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP

addresses</a>> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeElasticLoadBalancersResponse *OpsWorksClient::describeElasticLoadBalancers(const DescribeElasticLoadBalancersRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeElasticLoadBalancersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes a stack's Elastic Load Balancing

instances> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeInstancesResponse *OpsWorksClient::describeInstances(const DescribeInstancesRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests a description of a set of

instances> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeLayersResponse *OpsWorksClient::describeLayers(const DescribeLayersRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeLayersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests a description of one or more layers in a specified

stack> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeLoadBasedAutoScalingResponse *OpsWorksClient::describeLoadBasedAutoScaling(const DescribeLoadBasedAutoScalingRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeLoadBasedAutoScalingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes load-based auto scaling configurations for specified

layers> <note>

You must specify at least one of the

parameters> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeMyUserProfileResponse *OpsWorksClient::describeMyUserProfile()

Sends a DescribeMyUserProfile request to the OpsWorksClient service, and returns a pointer to an DescribeMyUserProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes a user's SSH

information>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeOperatingSystemsResponse *OpsWorksClient::describeOperatingSystems()

Sends a DescribeOperatingSystems request to the OpsWorksClient service, and returns a pointer to an DescribeOperatingSystemsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the operating systems that are supported by AWS OpsWorks

[slot] DescribePermissionsResponse *OpsWorksClient::describePermissions(const DescribePermissionsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribePermissionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the permissions for a specified

stack>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeRaidArraysResponse *OpsWorksClient::describeRaidArrays(const DescribeRaidArraysRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeRaidArraysResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describe an instance's RAID

arrays> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeRdsDbInstancesResponse *OpsWorksClient::describeRdsDbInstances(const DescribeRdsDbInstancesRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeRdsDbInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes Amazon RDS

instances>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

Permissions</a>>

This call accepts only one resource-identifying

[slot] DescribeServiceErrorsResponse *OpsWorksClient::describeServiceErrors(const DescribeServiceErrorsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeServiceErrorsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes AWS OpsWorks Stacks service

errors>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

Permissions</a>>

This call accepts only one resource-identifying

[slot] DescribeStackProvisioningParametersResponse *OpsWorksClient::describeStackProvisioningParameters(const DescribeStackProvisioningParametersRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeStackProvisioningParametersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests a description of a stack's provisioning

parameters>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeStackSummaryResponse *OpsWorksClient::describeStackSummary(const DescribeStackSummaryRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeStackSummaryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or

<code>online</code>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeStacksResponse *OpsWorksClient::describeStacks(const DescribeStacksRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeStacksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests a description of one or more

stacks>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeTimeBasedAutoScalingResponse *OpsWorksClient::describeTimeBasedAutoScaling(const DescribeTimeBasedAutoScalingRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeTimeBasedAutoScalingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes time-based auto scaling configurations for specified

instances> <note>

You must specify at least one of the

parameters> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeUserProfilesResponse *OpsWorksClient::describeUserProfiles(const DescribeUserProfilesRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeUserProfilesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describe specified

users>

<b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DescribeVolumesResponse *OpsWorksClient::describeVolumes(const DescribeVolumesRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DescribeVolumesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes an instance's Amazon EBS

volumes> <note>

This call accepts only one resource-identifying

parameter> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DetachElasticLoadBalancerResponse *OpsWorksClient::detachElasticLoadBalancer(const DetachElasticLoadBalancerRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DetachElasticLoadBalancerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Detaches a specified Elastic Load Balancing instance from its

layer>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] DisassociateElasticIpResponse *OpsWorksClient::disassociateElasticIp(const DisassociateElasticIpRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an DisassociateElasticIpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] GetHostnameSuggestionResponse *OpsWorksClient::getHostnameSuggestion(const GetHostnameSuggestionRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an GetHostnameSuggestionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a generated host name for the specified layer, based on the current host name

theme>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] GrantAccessResponse *OpsWorksClient::grantAccess(const GrantAccessRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an GrantAccessResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

<note>

This action can be used only with Windows

stacks> </note>

Grants RDP access to a Windows instance for a specified time

[slot] ListTagsResponse *OpsWorksClient::listTags(const ListTagsRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an ListTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RebootInstanceResponse *OpsWorksClient::rebootInstance(const RebootInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an RebootInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Reboots a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting

Instances</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] RegisterEcsClusterResponse *OpsWorksClient::registerEcsCluster(const RegisterEcsClusterRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an RegisterEcsClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html"> Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"> Managing User

[slot] RegisterElasticIpResponse *OpsWorksClient::registerElasticIp(const RegisterElasticIpRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an RegisterElasticIpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DeregisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] RegisterInstanceResponse *OpsWorksClient::registerInstance(const RegisterInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an RegisterInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

stack> <note>

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. <code>RegisterInstance</code> handles only the second step. You should instead use the AWS CLI <code>register</code> command, which performs the entire registration operation. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html"> Registering an Instance with an AWS OpsWorks Stacks

Stack</a>> </note>

Registered instances have the same requirements as instances that are created by using the <a>CreateInstance</a> 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html"> Preparing the

Instance</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] RegisterRdsDbInstanceResponse *OpsWorksClient::registerRdsDbInstance(const RegisterRdsDbInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an RegisterRdsDbInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers an Amazon RDS instance with a

stack>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] RegisterVolumeResponse *OpsWorksClient::registerVolume(const RegisterVolumeRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an RegisterVolumeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DeregisterVolume</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] SetLoadBasedAutoScalingResponse *OpsWorksClient::setLoadBasedAutoScaling(const SetLoadBasedAutoScalingRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an SetLoadBasedAutoScalingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Specify the load-based auto scaling configuration for a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based

Instances</a>> <note>

To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated

load> </note>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] SetPermissionResponse *OpsWorksClient::setPermission(const SetPermissionRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an SetPermissionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Specifies a user's permissions. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html">Security and

Permissions</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] SetTimeBasedAutoScalingResponse *OpsWorksClient::setTimeBasedAutoScaling(const SetTimeBasedAutoScalingRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an SetTimeBasedAutoScalingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Specify the time-based auto scaling configuration for a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based

Instances</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] StartInstanceResponse *OpsWorksClient::startInstance(const StartInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an StartInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting

Instances</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] StartStackResponse *OpsWorksClient::startStack(const StartStackRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an StartStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts a stack's

instances>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] StopInstanceResponse *OpsWorksClient::stopInstance(const StopInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an StopInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting

Instances</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] StopStackResponse *OpsWorksClient::stopStack(const StopStackRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an StopStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops a specified

stack>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] TagResourceResponse *OpsWorksClient::tagResource(const TagResourceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an TagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/tagging.html">Tags</a> in the AWS OpsWorks User

[slot] UnassignInstanceResponse *OpsWorksClient::unassignInstance(const UnassignInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UnassignInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UnassignVolumeResponse *OpsWorksClient::unassignVolume(const UnassignVolumeRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UnassignVolumeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UntagResourceResponse *OpsWorksClient::untagResource(const UntagResourceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UntagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes tags from a specified stack or

[slot] UpdateAppResponse *OpsWorksClient::updateApp(const UpdateAppRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateAppResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a specified

app>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateElasticIpResponse *OpsWorksClient::updateElasticIp(const UpdateElasticIpRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateElasticIpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a registered Elastic IP address's name. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateInstanceResponse *OpsWorksClient::updateInstance(const UpdateInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a specified

instance>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateLayerResponse *OpsWorksClient::updateLayer(const UpdateLayerRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateLayerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a specified

layer>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateMyUserProfileResponse *OpsWorksClient::updateMyUserProfile(const UpdateMyUserProfileRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateMyUserProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a user's SSH public

key>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateRdsDbInstanceResponse *OpsWorksClient::updateRdsDbInstance(const UpdateRdsDbInstanceRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateRdsDbInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an Amazon RDS

instance>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateStackResponse *OpsWorksClient::updateStack(const UpdateStackRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateStackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a specified

stack>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateUserProfileResponse *OpsWorksClient::updateUserProfile(const UpdateUserProfileRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateUserProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a specified user

profile>

<b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

[slot] UpdateVolumeResponse *OpsWorksClient::updateVolume(const UpdateVolumeRequest &request)

Sends request to the OpsWorksClient service, and returns a pointer to an UpdateVolumeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an Amazon EBS volume's name or mount point. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource

Management</a>>

<b>Required Permissions</b>: 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 <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.