| Column Name | Column Data Type |
|---|
app_id Input Column
The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app. | VARCHAR |
deployment_ids Input Column
An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment. | VARCHAR[] |
Show child fields- deployment_ids[]
|
stack_id Input Column
The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack. | 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 |
deployments
An array of Deployment objects that describe the deployments. | STRUCT(
"deployment_id" VARCHAR,
"stack_id" VARCHAR,
"app_id" VARCHAR,
"created_at" VARCHAR,
"completed_at" VARCHAR,
"duration" BIGINT,
"iam_user_arn" VARCHAR,
"comment" VARCHAR,
"command" STRUCT(
"name" VARCHAR,
"args" MAP(VARCHAR, VARCHAR[])
),
"status" VARCHAR,
"custom_json" VARCHAR,
"instance_ids" VARCHAR[]
)[] |
Show child fields- deployments[]
Show child fields- deployments[].app_id
The app ID. - deployments[].command
Used to specify a stack or deployment command. Show child fields- deployments[].command.args
The arguments of those commands that take arguments. It should be set to a JSON object with the following format: {"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...} The update_dependencies command takes two arguments: -
upgrade_os_to - Specifies the Amazon Linux version that you want instances to run, such as Amazon Linux 2. You must also set the allow_reboot argument to true. -
allow_reboot - Specifies whether to allow OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false. For example, to upgrade an instance to Amazon Linux 2018.03, set Args to the following. { "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] } - deployments[].command.name
Specifies the operation. You can specify only one command. For stacks, the following commands are available: -
execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}. -
install_dependencies: Install the stack's dependencies. -
update_custom_cookbooks: Update the stack's custom cookbooks. -
update_dependencies: Update the stack's dependencies. The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing. For apps, the following commands are available: -
deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. Set Args to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. -
rollback Roll the app back to the previous version. When you update an app, OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions. -
start: Start the app's web or application server. -
stop: Stop the app's web or application server. -
restart: Restart the app's web or application server. -
undeploy: Undeploy the app.
- deployments[].comment
A user-defined comment. - deployments[].completed_at
Date when the deployment completed. - deployments[].created_at
Date when the deployment was created. - deployments[].custom_json
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. - deployments[].deployment_id
The deployment ID. - deployments[].duration
The deployment duration. - deployments[].iam_user_arn
The user's IAM ARN. - deployments[].instance_ids[]
- deployments[].stack_id
The stack ID. - deployments[].status
The deployment status: -
running -
successful -
failed
|