Skip to content
AWS for Query.Farm

aws.opsworks.describe_commands

Example SQL Queries

SELECT * FROM
aws.opsworks.describe_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.

Table Definition

Column NameColumn Data Type
command_ids Input Column

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

VARCHAR[]
Show child fields
command_ids[]
deployment_id Input Column

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

VARCHAR
instance_id Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
commands

An array of Command objects that describe each of the specified commands.

STRUCT(
    "command_id" VARCHAR,
    "instance_id" VARCHAR,
    "deployment_id" VARCHAR,
    "created_at" VARCHAR,
    "acknowledged_at" VARCHAR,
    "completed_at" VARCHAR,
    "status" VARCHAR,
    "exit_code" BIGINT,
    "log_url" VARCHAR,
    "type" VARCHAR
)[]
Show child fields
commands[]
Show child fields
commands[].acknowledged_at

Date and time when the command was acknowledged.

commands[].command_id

The command ID.

commands[].completed_at

Date when the command completed.

commands[].created_at

Date and time when the command was run.

commands[].deployment_id

The command deployment ID.

commands[].exit_code

The command exit code.

commands[].instance_id

The ID of the instance where the command was executed.

commands[].log_url

The URL of the command log.

commands[].status

The command status:

  • failed

  • successful

  • skipped

  • pending

commands[].type

The command type:

  • configure

  • deploy

  • execute_recipes

  • install_dependencies

  • restart

  • rollback

  • setup

  • start

  • stop

  • undeploy

  • update_custom_cookbooks

  • update_dependencies