Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated the syntax errors
  • Loading branch information
adutta-newrelic committed Nov 21, 2025
commit d2f49768d5e92f5ae508b5df967a827e304e04bd
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,10 @@ This page provides a comprehensive reference for authentication actions availabl
<td>**privateKey**</td>
<td>String</td>
<td>
The private key for signing a JWT.
<p>
1. RS256 supports private key in PKCS#8 & PKCS#1 format. ES256 supports private key in PKCS#8 (.p8) format.
2. Private Key must be provided as a secret expression.
3. PrivateKey must be stored as single line string in Secrets.
</p>
The private key for signing a JWT.
- RS256 supports private key in PKCS#8 & PKCS#1 format. ES256 supports private key in PKCS#8 (.p8) format.
- Private Key must be provided as a secret expression.
- PrivateKey must be stored as single line string in Secrets.
</td>
<td>`${{ :secrets:namespace:privateKey }}`</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1267,6 +1267,194 @@ See [Set up AWS credentials](/docs/workflow-automation/setup-and-configuration/s
</table>
</TabsPageItem>
</TabsPages>
</Tabs>
</Collapser>

<Collapser
id="aws.ec2.stopInstances"
title="Stop an instance"
>

Stops an Amazon EBS-backed instance

<Tabs>
<TabsBar>
<TabsBarItem id="ec2.stopInstances-inputs">
Inputs
</TabsBarItem>

<TabsBarItem id="ec2.stopInstances-outputs">
Outputs
</TabsBarItem>

<TabsBarItem id="ec2.stopInstances-example">
Example
</TabsBarItem>
</TabsBar>

<TabsPages>
<TabsPageItem id="ec2.stopInstances-inputs">
<table>
<thead>
<tr>
<th>Input Field</th>
<th>Optionality</th>
<th>Type</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>**awsRoleArn**</td>
<td>Optional</td>
<td>String</td>
<td>`arn:aws:iam::123456789012:role/my-workflow-role`</td>
</tr>
<tr>
<td>**awsAccessKeyId**</td>
<td>Optional</td>
<td>String</td>
<td>`${{ :secrets:<awsAccessKeyId> }}`</td>
</tr>
<tr>
<td>**awsSecretAccessKey**</td>
<td>Optional</td>
<td>String</td>
<td>`${{ :secrets:<awsSecretAccessKey> }}`</td>
</tr>
<tr>
<td>**awsSessionToken**</td>
<td>Optional</td>
<td>String</td>
<td>`${{ :secrets:<awsSessionToken> }}`</td>
</tr>
<tr>
<td>**region**</td>
<td>Required</td>
<td>String</td>
<td>`region: "us-east-2"`</td>
</tr>
<tr>
<td>**instanceIds**</td>
<td>Required</td>
<td>List</td>
<td>`"[\"i-0123456789abcdef0\", \"i-0fedcba9876543210\"]"`</td>
</tr>
<tr>
<td>**hibernate**</td>
<td>Optional</td>
<td>Boolean</td>
<td>true or false (Default: `false`)</td>
</tr>
<tr>
<td>**force**</td>
<td>Optional</td>
<td>Boolean</td>
<td>true or false (Default: `false`)</td>
</tr>
<tr>
<td>**selectors**</td>
<td>Optional</td>
<td>List</td>
<td>`[{\"name\": \"response\", \"expression\": \".response\"}, {\"name\": \"success\", \"expression\": \".success\"}, {\"name\": \"errorMessage\", \"expression\": \".errorMessage\"}]`</td>
</tr>
</tbody>
</table>

<Callout variant="important">
In the action input, at least one of the AWS credentials (short, long, role) should be provided, where the role takes precedence over the others.
</Callout>
</TabsPageItem>

<TabsPageItem id="ec2.stopInstances-outputs">
<table>
<thead>
<tr>
<th>Output Field</th>
<th>Type</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>**response**</td>
<td>object</td>
<td>
```yaml
{
'StoppingInstances': [
{
'InstanceId': 'string',
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
```
<p>
Response syntax can be referred [stop_instances](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/stop_instances.html)
</p>
</td>
</tr>
<tr>
<td>**success**</td>
<td>Boolean</td>
<td>`success: true | false`</td>
</tr>
<tr>
<td>**errorMessage**</td>
<td>String</td>
<td>`errorMessage: "An error occurred (InvalidInstanceID.Malformed) when calling the StopInstances operation: The instance ID 'i-123456789' is malformed"`</td>
</tr>
</tbody>
</table>
</TabsPageItem>

<TabsPageItem id="ec2.stopInstances-example">
<table>
<thead>
<tr>
<th>Workflow example</th>
</tr>
</thead>
<tbody>
<tr>
<td>
```yaml
name: ec2_stop_instance
description: ''
workflowInputs:
arnRole:
type: String
region:
type: String
defaultValue: us-west-2
instanceIds:
type: list
defaultValue: ["i-123456789abcdef0"]
steps:
- name: aws_stop_instances_1
type: action
action: aws.ec2.stopInstances
version: '1'
inputs:
awsRoleArn: ${{ .workflowInputs.arnRole }}
region: ${{ .workflowInputs.region }}
instanceIds: ${{ .workflowInputs.instanceIds }}
next: end
```
</td>
</tr>
</tbody>
</table>
</TabsPageItem>
</TabsPages>
</Tabs>
</Collapser>
</CollapserGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ See [Set up AWS credentials](/docs/workflow-automation/setup-and-configuration/s
<td>**response**</td>
<td>Object</td>
<td>`{"response":<aws api reponse>`
}} each service and api have different response for example https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/query.html.`</td>
}} each service and api have different response for example https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/query.html.</td>
</tr>
<tr>
<td>**success**</td>
Expand Down Expand Up @@ -347,4 +347,4 @@ See [Set up AWS credentials](/docs/workflow-automation/setup-and-configuration/s
</TabsPageItem>
</TabsPages>
</Tabs>
</Collapser>
</Collapser>
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ See [Set up AWS credentials](/docs/workflow-automation/setup-and-configuration/s
<td>String</td>
<td>
`documentType: "Command"`
<p>Check valid values from [here](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateDocument.html#API_CreateDocument_RequestSyntax:~:text=Required%3A%20No-,DocumentType,-The%20type%20of).</p>
<p>Check valid values from [here](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DocumentDescription.html#systemsmanager-Type-DocumentDescription-Status:text=Required%3A%20No-,Status,-The%20status%20of).</p>
</td>
</tr>
<tr>
Expand All @@ -113,7 +113,7 @@ See [Set up AWS credentials](/docs/workflow-automation/setup-and-configuration/s
<td>String</td>
<td>
`documentFormat: "YAML"`
<p>Check valid values from [here](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateDocument.html#API_CreateDocument_RequestSyntax:~:text=Required%3A%20No-,DocumentFormat,-Specify%20the%20document).</p>
<p>Check valid values from [here](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DocumentDescription.html#systemsmanager-Type-DocumentDescription-Status:text=Required%3A%20No-,Status,-The%20status%20of).</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -175,7 +175,7 @@ See [Set up AWS credentials](/docs/workflow-automation/setup-and-configuration/s
<td>
`documentStatus: "Active"`

<p>The value will be one of the statuses from [here](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DocumentDescription.html#systemsmanager-Type-DocumentDescription-Status:~:text=Required%3A%20No-,Status,-The%20status%20of).</p>
<p>The value will be one of the statuses from [here](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DocumentDescription.html#systemsmanager-Type-DocumentDescription-Status:text=Required%3A%20No-,Status,-The%20status%20of).</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1313,4 +1313,4 @@ See [Set up AWS credentials](/docs/workflow-automation/setup-and-configuration/s
</TabsPages>
</Tabs>
</Collapser>
</CollapserGroup>
</CollapserGroup>
55 changes: 55 additions & 0 deletions src/nav/workflow-automation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,73 @@ pages:
pages:
- title: Actions catalog overview
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/actions-catalog
- title: Auth actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/auth
pages:
- title: JWT Create action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/auth/auth-jwt-create
- title: AWS actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws
pages:
- title: AWS CloudWatch actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-cloudwatch
- title: AWS EC2 actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-ec2
- title: AWS Execute API actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-execute-api
- title: AWS Lambda actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-lambda
- title: AWS S3 actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-s3
- title: AWS SNS actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-sns
- title: AWS SQS actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-sqs
- title: AWS Systems Manager actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/aws/aws-systemsmanager
- title: HTTP actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/http
pages:
- title: HTTP DELETE action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/http/http-delete
- title: HTTP GET action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/http/http-get
- title: HTTP POST action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/http/http-post
- title: HTTP PUT action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/http/http-put
- title: New Relic actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/new-relic
pages:
- title: New Relic Ingest action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/newrelic/newrelic-ingest
- title: New Relic NerdGraph action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/newrelic/newrelic-nerdgraph
- title: New Relic Notification action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/newrelic/newrelic-notification
- title: New Relic NRDB action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/newrelic/newrelic-nrdb
- title: Communication actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/communication
pages:
- title: Slack Chat action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/slack/slack-chat
- title: PagerDuty actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/pagerduty
pages:
- title: PagerDuty Incident action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/pagerduty/pagerduty-incident
- title: Other actions
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/others
pages:
- title: Script Run action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/utils/script-run
- title: DateTime action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/utils/utils-datetime
- title: Transform action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/utils/utils-transform
- title: UUID action
path: /docs/workflow-automation/setup-and-configuration/actions-catalog/utils/utils-uuid
- title: Create a workflow automation
path: /docs/workflow-automation/create-a-workflow-automation
pages:
Expand Down
Loading