Describe Stacks

opsworks_describe_stacks

R Documentation

Requests a description of one or more stacks

Description

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.

Usage

opsworks_describe_stacks(StackIds)

Arguments

StackIds

An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information about all stacks, describe_stacks returns a description of every stack. If the IAM policy that is attached to an IAM user limits the describe_stacks action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. Otherwise, describe_stacks returns an AccessDenied error.

Value

A list with the following syntax:

list(
  Stacks = list(
    list(
      StackId = "string",
      Name = "string",
      Arn = "string",
      Region = "string",
      VpcId = "string",
      Attributes = list(
        "string"
      ),
      ServiceRoleArn = "string",
      DefaultInstanceProfileArn = "string",
      DefaultOs = "string",
      HostnameTheme = "string",
      DefaultAvailabilityZone = "string",
      DefaultSubnetId = "string",
      CustomJson = "string",
      ConfigurationManager = list(
        Name = "string",
        Version = "string"
      ),
      ChefConfiguration = list(
        ManageBerkshelf = TRUE|FALSE,
        BerkshelfVersion = "string"
      ),
      UseCustomCookbooks = TRUE|FALSE,
      UseOpsworksSecurityGroups = TRUE|FALSE,
      CustomCookbooksSource = list(
        Type = "git"|"svn"|"archive"|"s3",
        Url = "string",
        Username = "string",
        Password = "string",
        SshKey = "string",
        Revision = "string"
      ),
      DefaultSshKeyName = "string",
      CreatedAt = "string",
      DefaultRootDeviceType = "ebs"|"instance-store",
      AgentVersion = "string"
    )
  )
)

Request syntax

svc$describe_stacks(
  StackIds = list(
    "string"
  )
)