Describe Commands

opsworks_describe_commands

R Documentation

Describes the results of specified commands

Description

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.

Usage

opsworks_describe_commands(DeploymentId, InstanceId, CommandIds)

Arguments

DeploymentId

The deployment ID. If you include this parameter, describe_commands returns a description of the commands associated with the specified deployment.

InstanceId

The instance ID. If you include this parameter, describe_commands returns a description of the commands associated with the specified instance.

CommandIds

An array of command IDs. If you include this parameter, describe_commands returns a description of the specified commands. Otherwise, it returns a description of every command.

Value

A list with the following syntax:

list(
  Commands = list(
    list(
      CommandId = "string",
      InstanceId = "string",
      DeploymentId = "string",
      CreatedAt = "string",
      AcknowledgedAt = "string",
      CompletedAt = "string",
      Status = "string",
      ExitCode = 123,
      LogUrl = "string",
      Type = "string"
    )
  )
)

Request syntax

svc$describe_commands(
  DeploymentId = "string",
  InstanceId = "string",
  CommandIds = list(
    "string"
  )
)