![]() |
![]()
| ![]() |
![]()
NAMEPaws::OpsWorks - Perl Interface to AWS AWS OpsWorks SYNOPSISuse Paws; my $obj = Paws->service('OpsWorks'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], ); DESCRIPTIONAWS OpsWorks Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes. AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks (http://aws.amazon.com/opsworks/) details page. SDKs and CLI The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
Chef Versions When you call CreateStack, CloneStack, or UpdateStack we recommend you use the "ConfigurationManager" parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html). You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18> METHODSAssignInstanceEach argument is described in detail in: Paws::OpsWorks::AssignInstance Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). AssignVolume
Each argument is described in detail in: Paws::OpsWorks::AssignVolume Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). AssociateElasticIp
Each argument is described in detail in: Paws::OpsWorks::AssociateElasticIp Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). AttachElasticLoadBalancerEach argument is described in detail in: Paws::OpsWorks::AttachElasticLoadBalancer Returns: nothing Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing (https://docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html). 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 (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). CloneStack
Each argument is described in detail in: Paws::OpsWorks::CloneStack Returns: a Paws::OpsWorks::CloneStackResult instance Creates a clone of a specified stack. For more information, see Clone a Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html). 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). CreateApp
Each argument is described in detail in: Paws::OpsWorks::CreateApp Returns: a Paws::OpsWorks::CreateAppResult instance Creates an app for a specified stack. For more information, see Creating Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). CreateDeployment
Each argument is described in detail in: Paws::OpsWorks::CreateDeployment Returns: a Paws::OpsWorks::CreateDeploymentResult instance Runs deployment or stack commands. For more information, see Deploying Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html) and Run Stack Commands (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). CreateInstance
Each argument is described in detail in: Paws::OpsWorks::CreateInstance Returns: a Paws::OpsWorks::CreateInstanceResult instance Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). CreateLayer
Each argument is described in detail in: Paws::OpsWorks::CreateLayer Returns: a Paws::OpsWorks::CreateLayerResult instance Creates a layer. For more information, see How to Create a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). CreateStack
Each argument is described in detail in: Paws::OpsWorks::CreateStack Returns: a Paws::OpsWorks::CreateStackResult instance Creates a new stack. For more information, see Create a New Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html). Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). CreateUserProfile
Each argument is described in detail in: Paws::OpsWorks::CreateUserProfile Returns: a Paws::OpsWorks::CreateUserProfileResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeleteAppEach argument is described in detail in: Paws::OpsWorks::DeleteApp Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeleteInstance
Each argument is described in detail in: Paws::OpsWorks::DeleteInstance Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeleteLayerEach argument is described in detail in: Paws::OpsWorks::DeleteLayer Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeleteStackEach argument is described in detail in: Paws::OpsWorks::DeleteStack Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeleteUserProfileEach argument is described in detail in: Paws::OpsWorks::DeleteUserProfile Returns: nothing 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeregisterEcsClusterEach argument is described in detail in: Paws::OpsWorks::DeregisterEcsCluster Returns: nothing Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete). 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 https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeregisterElasticIpEach argument is described in detail in: Paws::OpsWorks::DeregisterElasticIp Returns: nothing Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeregisterInstanceEach argument is described in detail in: Paws::OpsWorks::DeregisterInstance Returns: nothing 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 cannot be used with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeregisterRdsDbInstanceEach argument is described in detail in: Paws::OpsWorks::DeregisterRdsDbInstance Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DeregisterVolumeEach argument is described in detail in: Paws::OpsWorks::DeregisterVolume Returns: nothing Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeAgentVersions
Each argument is described in detail in: Paws::OpsWorks::DescribeAgentVersions Returns: a Paws::OpsWorks::DescribeAgentVersionsResult instance Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. "DescribeAgentVersions" returns a list of available agent versions for the specified stack or configuration manager. DescribeApps
Each argument is described in detail in: Paws::OpsWorks::DescribeApps Returns: a Paws::OpsWorks::DescribeAppsResult instance Requests a description of a specified set of apps. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeCommands
Each argument is described in detail in: Paws::OpsWorks::DescribeCommands Returns: a Paws::OpsWorks::DescribeCommandsResult instance Describes the results of specified commands. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeDeployments
Each argument is described in detail in: Paws::OpsWorks::DescribeDeployments Returns: a Paws::OpsWorks::DescribeDeploymentsResult instance Requests a description of a specified set of deployments. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeEcsClusters
Each argument is described in detail in: Paws::OpsWorks::DescribeEcsClusters Returns: a Paws::OpsWorks::DescribeEcsClustersResult instance Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the "MaxResults" and "NextToken" parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). This call accepts only one resource-identifying parameter. DescribeElasticIps
Each argument is described in detail in: Paws::OpsWorks::DescribeElasticIps Returns: a Paws::OpsWorks::DescribeElasticIpsResult instance Describes Elastic IP addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html). This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeElasticLoadBalancers
Each argument is described in detail in: Paws::OpsWorks::DescribeElasticLoadBalancers Returns: a Paws::OpsWorks::DescribeElasticLoadBalancersResult instance Describes a stack's Elastic Load Balancing instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeInstances
Each argument is described in detail in: Paws::OpsWorks::DescribeInstances Returns: a Paws::OpsWorks::DescribeInstancesResult instance Requests a description of a set of instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeLayers
Each argument is described in detail in: Paws::OpsWorks::DescribeLayers Returns: a Paws::OpsWorks::DescribeLayersResult instance Requests a description of one or more layers in a specified stack. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeLoadBasedAutoScalingEach argument is described in detail in: Paws::OpsWorks::DescribeLoadBasedAutoScaling Returns: a Paws::OpsWorks::DescribeLoadBasedAutoScalingResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeMyUserProfile
Each argument is described in detail in: Paws::OpsWorks::DescribeMyUserProfile Returns: a Paws::OpsWorks::DescribeMyUserProfileResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeOperatingSystems
Each argument is described in detail in: Paws::OpsWorks::DescribeOperatingSystems Returns: a Paws::OpsWorks::DescribeOperatingSystemsResponse instance Describes the operating systems that are supported by AWS OpsWorks Stacks. DescribePermissions
Each argument is described in detail in: Paws::OpsWorks::DescribePermissions Returns: a Paws::OpsWorks::DescribePermissionsResult instance 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeRaidArrays
Each argument is described in detail in: Paws::OpsWorks::DescribeRaidArrays Returns: a Paws::OpsWorks::DescribeRaidArraysResult instance Describe an instance's RAID arrays. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeRdsDbInstances
Each argument is described in detail in: Paws::OpsWorks::DescribeRdsDbInstances Returns: a Paws::OpsWorks::DescribeRdsDbInstancesResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). This call accepts only one resource-identifying parameter. DescribeServiceErrors
Each argument is described in detail in: Paws::OpsWorks::DescribeServiceErrors Returns: a Paws::OpsWorks::DescribeServiceErrorsResult instance Describes AWS OpsWorks Stacks service errors. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). This call accepts only one resource-identifying parameter. DescribeStackProvisioningParametersEach argument is described in detail in: Paws::OpsWorks::DescribeStackProvisioningParameters Returns: a Paws::OpsWorks::DescribeStackProvisioningParametersResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeStacks
Each argument is described in detail in: Paws::OpsWorks::DescribeStacks Returns: a Paws::OpsWorks::DescribeStacksResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeStackSummaryEach argument is described in detail in: Paws::OpsWorks::DescribeStackSummary Returns: a Paws::OpsWorks::DescribeStackSummaryResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeTimeBasedAutoScalingEach argument is described in detail in: Paws::OpsWorks::DescribeTimeBasedAutoScaling Returns: a Paws::OpsWorks::DescribeTimeBasedAutoScalingResult instance 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeUserProfiles
Each argument is described in detail in: Paws::OpsWorks::DescribeUserProfiles Returns: a Paws::OpsWorks::DescribeUserProfilesResult instance Describe specified users. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DescribeVolumes
Each argument is described in detail in: Paws::OpsWorks::DescribeVolumes Returns: a Paws::OpsWorks::DescribeVolumesResult instance Describes an instance's Amazon EBS volumes. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DetachElasticLoadBalancerEach argument is described in detail in: Paws::OpsWorks::DetachElasticLoadBalancer Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). DisassociateElasticIpEach argument is described in detail in: Paws::OpsWorks::DisassociateElasticIp Returns: nothing Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). GetHostnameSuggestionEach argument is described in detail in: Paws::OpsWorks::GetHostnameSuggestion Returns: a Paws::OpsWorks::GetHostnameSuggestionResult instance 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). GrantAccess
Each argument is described in detail in: Paws::OpsWorks::GrantAccess Returns: a Paws::OpsWorks::GrantAccessResult instance This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period. ListTags
Each argument is described in detail in: Paws::OpsWorks::ListTags Returns: a Paws::OpsWorks::ListTagsResult instance Returns a list of tags that are applied to the specified stack or layer. RebootInstanceEach argument is described in detail in: Paws::OpsWorks::RebootInstance Returns: nothing Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). RegisterEcsClusterEach argument is described in detail in: Paws::OpsWorks::RegisterEcsCluster Returns: a Paws::OpsWorks::RegisterEcsClusterResult instance 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). RegisterElasticIpEach argument is described in detail in: Paws::OpsWorks::RegisterElasticIp Returns: a Paws::OpsWorks::RegisterElasticIpResult instance 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). RegisterInstance
Each argument is described in detail in: Paws::OpsWorks::RegisterInstance Returns: a Paws::OpsWorks::RegisterInstanceResult instance Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack. We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. "RegisterInstance" handles only the second step. You should instead use the AWS CLI "register" command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html). Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance (https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). RegisterRdsDbInstanceEach argument is described in detail in: Paws::OpsWorks::RegisterRdsDbInstance Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). RegisterVolume
Each argument is described in detail in: Paws::OpsWorks::RegisterVolume Returns: a Paws::OpsWorks::RegisterVolumeResult instance 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). SetLoadBasedAutoScaling
Each argument is described in detail in: Paws::OpsWorks::SetLoadBasedAutoScaling Returns: nothing Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). SetPermission
Each argument is described in detail in: Paws::OpsWorks::SetPermission Returns: nothing Specifies a user's permissions. For more information, see Security and Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). SetTimeBasedAutoScaling
Each argument is described in detail in: Paws::OpsWorks::SetTimeBasedAutoScaling Returns: nothing Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). StartInstanceEach argument is described in detail in: Paws::OpsWorks::StartInstance Returns: nothing Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). StartStackEach argument is described in detail in: Paws::OpsWorks::StartStack Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). StopInstance
Each argument is described in detail in: Paws::OpsWorks::StopInstance Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). StopStackEach argument is described in detail in: Paws::OpsWorks::StopStack Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). TagResourceEach argument is described in detail in: Paws::OpsWorks::TagResource Returns: nothing Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags (https://docs.aws.amazon.com/opsworks/latest/userguide/tagging.html) in the AWS OpsWorks User Guide. UnassignInstanceEach argument is described in detail in: Paws::OpsWorks::UnassignInstance Returns: nothing Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UnassignVolumeEach argument is described in detail in: Paws::OpsWorks::UnassignVolume Returns: nothing Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UntagResourceEach argument is described in detail in: Paws::OpsWorks::UntagResource Returns: nothing Removes tags from a specified stack or layer. UpdateApp
Each argument is described in detail in: Paws::OpsWorks::UpdateApp Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateElasticIp
Each argument is described in detail in: Paws::OpsWorks::UpdateElasticIp Returns: nothing Updates a registered Elastic IP address's name. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateInstance
Each argument is described in detail in: Paws::OpsWorks::UpdateInstance Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateLayer
Each argument is described in detail in: Paws::OpsWorks::UpdateLayer Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateMyUserProfile
Each argument is described in detail in: Paws::OpsWorks::UpdateMyUserProfile Returns: nothing 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateRdsDbInstance
Each argument is described in detail in: Paws::OpsWorks::UpdateRdsDbInstance Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateStack
Each argument is described in detail in: Paws::OpsWorks::UpdateStack Returns: nothing 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateUserProfile
Each argument is described in detail in: Paws::OpsWorks::UpdateUserProfile Returns: nothing 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 about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). UpdateVolume
Each argument is described in detail in: Paws::OpsWorks::UpdateVolume Returns: nothing Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). PAGINATORSPaginator methods are helpers that repetively call methods that return partial results DescribeAllEcsClusters(sub { },[EcsClusterArns => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, StackId => Str])DescribeAllEcsClusters([EcsClusterArns => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, StackId => Str])If passed a sub as first parameter, it will call the sub for each element found in : - EcsClusters, passing the object as the first parameter, and the string 'EcsClusters' as the second parameter If not, it will return a a Paws::OpsWorks::DescribeEcsClustersResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. SEE ALSOThis service class forms part of Paws BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|