Execute Runbook with Airplane API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for Airplane, AWS and 2,400+ other apps remarkably fast.

Trigger workflow on

New SNS Messages from the AWS API

Next, do this

Execute Runbook with the Airplane API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a AWS trigger and Airplane action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New SNS Messages trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Select a SNS Topic
4. Optional- Configure SNS Topic Name
Configure the Execute Runbook action
1. Connect your Airplane account
2. Optional- Configure Runbook ID
3. Optional- Configure Slug
4. Optional- Configure Parameter Values
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New SNS Messages on AWS

Description:Creates an SNS topic in your AWS account. Messages published to this topic are emitted from the Pipedream source.

Version:0.4.2

Key:aws-new-sns-messages

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/sns.mjs";
import { toSingleLineString } from "../../common/utils.mjs";
import commonSNS from "../../common/common-sns.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...base,
  key: "aws-new-sns-messages",
  name: "New SNS Messages",
  description: toSingleLineString(`
    Creates an SNS topic in your AWS account.
    Messages published to this topic are emitted from the Pipedream source.
  `),
  version: "0.4.2",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  props: {
    ...base.props,
    topicArn: {
      ...commonSNS.props.topic,
      optional: true,
    },
    topic: {
      label: "SNS Topic Name",
      description: toSingleLineString(`
        **Pipedream will create an SNS topic with this name in your account**,
        converting it to a [valid SNS topic
        name](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html).
      `),
      type: "string",
      optional: true,
    },
  },
  methods: {
    ...base.methods,
    getTopicName() {
      return this.convertNameToValidSNSTopicName(this.topic);
    },
  },
  async run(event) {
    if (!this.topicArn && !this.topic) {
      throw new ConfigurationError("Must specify either an existing topic or a new topic name");
    }

    if (this._isSubscriptionConfirmationEvent(event)) {
      const { body } = event;
      const subscriptionArn = await this._confirmSubscription(body);
      this._setSubscriptionArn(subscriptionArn);
      return;
    }

    await this.processEvent(event);
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
AWS Region	`region`	`string`	Select a value from the drop down menu.
SNS Topic	`topicArn`	`string`	Select a value from the drop down menu.
SNS Topic Name	`topic`	`string`	Pipedream will create an SNS topic with this name in your account, converting it to a valid SNS topic name.

Trigger Authentication#

AWS uses API keys for authentication. When you connect your AWS account, Pipedream securely stores the keys so you can easily authenticate to AWS APIs in both code and no-code steps.

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Execute Runbook on Airplane

Description:Execute a runbook and receive a session ID to track the runbook's execution. [See the documentation](https://docs.airplane.dev/reference/api#runbooks-execute)

Version:0.0.1

Key:airplane-execute-runbook

View on GitHub

Airplane Overview#

The Airplane API facilitates the creation and management of tasks and runs within the Airplane toolkit, which is geared towards automating developer operations and internal tools. In Pipedream, you can leverage this API to automate workflows, integrate with various services, and handle background tasks. By connecting Airplane to other apps on Pipedream, you can streamline processes like deploying code, managing feature flags, or orchestrating complex workflows that interact with other APIs and services.

Action Code#

import airplane from "../../airplane.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "airplane-execute-runbook",
  name: "Execute Runbook",
  description: "Execute a runbook and receive a session ID to track the runbook's execution. [See the documentation](https://docs.airplane.dev/reference/api#runbooks-execute)",
  version: "0.0.1",
  type: "action",
  props: {
    airplane,
    id: {
      type: "string",
      label: "Runbook ID",
      description: "Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane. The runbook ID is located at the end of the url. e.g. the runbook ID for `https://app.airplane.dev/runbooks/rbk20220120z15kl79` is `rbk20220120z15kl79`",
      optional: true,
    },
    slug: {
      type: "string",
      label: "Slug",
      description: "Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the runbook editor on Airplane. Either an ID or a slug must be provided.`",
      optional: true,
    },
    paramValues: {
      type: "object",
      label: "Parameter Values",
      description: "Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the runbook editor on Airplane.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.id && !this.slug) {
      throw new ConfigurationError("Either an ID or a slug must be provided.");
    }

    const response = await this.airplane.executeRunbook({
      data: {
        id: this.id,
        slug: this.slug,
        paramValues: this.paramValues,
      },
      $,
    });

    if (response) {
      $.export("$summary", "Successfully executed runbook.");
    }

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Airplane	`airplane`	`app`	This component uses the Airplane app.
Runbook ID	`id`	`string`	Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane. The runbook ID is located at the end of the url. e.g. the runbook ID for `https://app.airplane.dev/runbooks/rbk20220120z15kl79` is `rbk20220120z15kl79`
Slug	`slug`	`string`	Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the runbook editor on Airplane. Either an ID or a slug must be provided.`
Parameter Values	`paramValues`	`object`	Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the runbook editor on Airplane.

Action Authentication#

Airplane uses API keys for authentication. When you connect your Airplane account, Pipedream securely stores the keys so you can easily authenticate to Airplane APIs in both code and no-code steps.

Generate and copy your API Key using Airplane CLI.

About Airplane#

Code to internal apps in minutes. Turn APIs, SQL queries, and scripts into apps for the entire team.

More Ways to Connect Airplane + AWS#

Other Popular Integrations#

Execute Runbook with Airplane API on New Records Returned by CloudWatch Logs Insights Query from AWS API

AWS + Airplane

Execute Runbook with Airplane API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for Airplane, AWS and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular