@itentialopensource/adapter-aws_cloudformation/pronghorn.json

This adapter integrates with system described as: Aws_cloudformation.

{
  "id": "@itentialopensource/adapter-aws_cloudformation",
  "type": "Adapter",
  "export": "AwsCloudFormation",
  "title": "AwsCloudFormation",
  "src": "adapter.js",
  "roles": [
    "admin"
  ],
  "methods": [
    {
      "name": "iapUpdateAdapterConfiguration",
      "summary": "Updates the adapter configuration",
      "description": "Updates the adapter configuration file with the provided changes",
      "input": [
        {
          "name": "configFile",
          "type": "string",
          "info": "The name of the file to change",
          "required": true,
          "schema": {
            "title": "configFile",
            "type": "string"
          }
        },
        {
          "name": "changes",
          "type": "object",
          "info": "JSON object containing the configuration changes",
          "required": true,
          "schema": {
            "title": "changes",
            "type": "object"
          }
        },
        {
          "name": "entity",
          "type": "string",
          "info": "The entity in which the changes are being made",
          "required": false,
          "schema": {
            "title": "entity",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "The type of file to change - action, schema, or mock",
          "required": false,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "action",
          "type": "string",
          "info": "The action to be changed",
          "required": false,
          "schema": {
            "title": "action",
            "type": "string"
          }
        },
        {
          "name": "replace",
          "type": "boolean",
          "info": "True to replace entire mock data, false to merge/append",
          "required": false,
          "schema": {
            "title": "replace",
            "type": "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUpdateAdapterConfiguration"
      },
      "task": true
    },
    {
      "name": "iapSuspendAdapter",
      "summary": "Suspends the adapter",
      "description": "Suspends the adapter",
      "input": [
        {
          "name": "mode",
          "type": "enum",
          "enumerals": [
            "pause",
            "error"
          ],
          "info": "How incoming requests are handled. Defaults to 'pause'",
          "description": "How incoming requests are handled. Defaults to 'pause'",
          "schema": {
            "title": "mode",
            "type": "string"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapSuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapUnsuspendAdapter",
      "summary": "Unsuspends the adapter",
      "description": "Unsuspends the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUnsuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterQueue",
      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
      "description": "Return the requests that are waiting in the queue if throttling is enabled",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter queue",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetAdapterQueue"
      },
      "task": true
    },
    {
      "name": "iapFindAdapterPath",
      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
      "description": "Provides the ability to see if a particular API path is supported by the adapter",
      "input": [
        {
          "name": "apiPath",
          "type": "string",
          "info": "The API Path you want to check - make sure to not include base path and version",
          "description": "The API Path you want to check - make sure to not include base path and version",
          "schema": {
            "title": "apiPath",
            "type": "string"
          },
          "required": true
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapFindAdapterPath"
      },
      "task": true
    },
    {
      "name": "iapTroubleshootAdapter",
      "summary": "Runs troubleshoot script for adapter",
      "description": "Runs troubleshoot script for adapter",
      "input": [
        {
          "name": "props",
          "type": "object",
          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
          "required": true,
          "schema": {
            "title": "props",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapTroubleshootAdapter"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterHealthcheck",
      "summary": "Runs healthcheck script for adapter",
      "description": "Runs healthcheck script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "Whether healthcheck passed or failed",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterHealthcheck"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterConnectivity",
      "summary": "Runs connectivity check script for adapter",
      "description": "Runs connectivity check script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterConnectivity"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterBasicGet",
      "summary": "Runs basicGet script for adapter",
      "description": "Runs basicGet script for adapter",
      "input": [
        {
          "name": "maxCalls",
          "required": false,
          "type": "number", 
          "info": "How many GET endpoints to test (defaults to 5)",
          "schema": {
            "title": "maxCalls",
            "type": "number", 
            "default": 5
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterBasicGet"
      },
      "task": true
    },
    {
      "name": "iapMoveAdapterEntitiesToDB",
      "summary": "Moves entities from an adapter into the Itential Platform database",
      "description": "Moves entities from an adapter into the Itential Platform database",
      "input": [],
      "output": {
        "name": "res",
        "type": "object",
        "description": "A JSON Object containing status, code and the response from the mongo transaction",
        "schema": {
          "title": "res",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapMoveAdapterEntitiesToDB"
      },
      "task": true
    },
    {
      "name": "iapDeactivateTasks",
      "summary": "Deactivate the inputted tasks",
      "description": "Deactivate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to deactivate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapDeactivateTasks"
      },
      "task": true
    },
    {
      "name": "iapActivateTasks",
      "summary": "Activate the inputted tasks",
      "description": "activate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to activate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapActivateTasks"
      },
      "task": true
    },
    {
      "name": "iapPopulateEntityCache",
      "summary": "Populate the cache for the given entities",
      "description": "Populate the cache for the given entities",
      "input": [
        {
          "name": "entityTypes",
          "type": "array",
          "info": "the entity type(s) to populate",
          "required": true,
          "schema": {
            "title": "entityTypes",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapPopulateEntityCache"
      },
      "task": true
    },
    {
      "name": "iapRetrieveEntitiesCache",
      "summary": "Retrieves data from cache for specified entity type",
      "description": "Retrieves data from cache for specified entity type",
      "input": [
        {
          "name": "entityType",
          "type": "string",
          "info": "entity of which to retrieve",
          "required": true,
          "schema": {
            "title": "entityType",
            "type": "string"
          }
        },
        {
          "name": "options",
          "type": "object",
          "info": "settings of which data to return and how to return it",
          "required": false,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRetrieveEntitiesCache"
      },
      "task": true
    },
    {
      "name": "getDevice",
      "summary": "Get the Appliance",
      "description": "Get the Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevice"
      },
      "task": false
    },
    {
      "name": "getDevicesFiltered",
      "summary": "Get Appliances that match the filter",
      "description": "Get Appliances that match the filter",
      "input": [
        {
          "name": "options",
          "type": "object",
          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
          "required": true,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "array",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "array"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevicesFiltered"
      },
      "task": false
    },
    {
      "name": "isAlive",
      "summary": "Checks the status for the provided Appliance",
      "description": "Checks the status for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/isAlive"
      },
      "task": false
    },
    {
      "name": "getConfig",
      "summary": "Gets a config for the provided Appliance",
      "description": "Gets a config for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        },
        {
          "name": "format",
          "type": "string",
          "info": "The format to be returned - this is ignored as we always return json",
          "required": false,
          "schema": {
            "title": "format",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getConfig"
      },
      "task": false
    },
    {
      "name": "iapGetDeviceCount",
      "summary": "Gets a device count from the system",
      "description": "Gets a device count from the system",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetDeviceCount"
      },
      "task": false
    },
    {
      "name": "iapExpandedGenericAdapterRequest",
      "summary": "Makes the requested generic call with additional options",
      "description": "Makes the requested generic call with additional options via metadata",
      "input": [
        {
          "name": "metadata",
          "type": "object",
          "info": "metadata for the call (optional)",
          "description": "metadata for the call - allows for many enhancements (optional)",
          "schema": {
            "title": "metadata",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "pathVars",
          "type": "object",
          "info": "the parameters to be put within the url path (optional)",
          "description": "the parameters to be put within the url path (optional)",
          "schema": {
            "title": "pathVars",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapExpandedGenericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequest",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequestNoBasePath",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequestNoBasePath"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterLint",
      "summary": "Run the adapter lint script to return the results",
      "description": "Run the adapter lint script to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "string",
        "description": "A string containing the run results",
        "schema": {
          "title": "result",
          "type": "string"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterLint"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterTests",
      "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
      "description": "Run the adapter test scripts (baseunit and unit) to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterTests"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterInventory",
      "summary": "Provide inventory information abbout the adapter",
      "description": "Provide inventory information abbout the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapGetAdapterInventory"
      },
      "task": true
    },
    {
      "name": "listStacks",
      "summary": "Returns the summary information for stacks whose status matches the specified StackStatusFilter.",
      "description": "Returns the summary information for stacks whose status matches the specified StackStatusFilter.",
      "input": [
        {
          "name": "nextToken",
          "type": "string",
          "info": "A string that identifies the next page of stacks that you want to retrieve.",
          "required": false,
          "schema": {
            "title": "nextToken",
            "type": "string"
          }
        },
        {
          "name": "stackStatusFilter",
          "type": "array",
          "info": "Stack status to use as a filter.",
          "required": false,
          "schema": {
            "title": "stackStatusFilter",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listStacks"
      },
      "task": true
    },
    {
      "name": "describeStacks",
      "summary": "Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.",
      "description": "Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.",
      "input": [
        {
          "name": "stackName",
          "type": "string",
          "info": "The name or unique ID of the stack set whose description you want.",
          "required": false,
          "schema": {
            "title": "stackName",
            "type": "string"
          }
        },
        {
          "name": "nextToken",
          "type": "string",
          "info": "A string that identifies the next page of stacks that you want to retrieve.",
          "required": false,
          "schema": {
            "title": "nextToken",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/describeStacks"
      },
      "task": true
    },
    {
      "name": "createStack",
      "summary": "Creates a stack as specified in the template.",
      "description": "Creates a stack as specified in the template.",
      "input": [
        {
          "name": "stackName",
          "type": "string",
          "info": "The name or the unique stack ID that is associated with the stack.",
          "required": true,
          "schema": {
            "title": "stackName",
            "type": "string"
          }
        },
        {
          "name": "capabilities",
          "type": "array",
          "info": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.",
          "required": false,
          "schema": {
            "title": "capabilities",
            "type": "array"
          }
        },
        {
          "name": "clientRequestToken",
          "type": "string",
          "info": "A unique identifier for this CreateStack request.",
          "required": false,
          "schema": {
            "title": "clientRequestToken",
            "type": "string"
          }
        },
        {
          "name": "disableRollback",
          "type": "boolean",
          "info": "Set to true to disable rollback of the stack if stack creation failed.",
          "required": false,
          "schema": {
            "title": "disableRollback",
            "type": "boolean"
          }
        },
        {
          "name": "enableTerminationProtection",
          "type": "boolean",
          "info": "Set to true to disable rollback of the stack if stack creation failed.",
          "required": false,
          "schema": {
            "title": "enableTerminationProtection",
            "type": "boolean"
          }
        },
        {
          "name": "notificationARNs",
          "type": "array",
          "info": "The Simple Notification Service (SNS) topic ARNs to publish stack related events.",
          "required": false,
          "schema": {
            "title": "notificationARNs",
            "type": "array"
          }
        },
        {
          "name": "onFailure",
          "type": "string",
          "info": "Determines what action will be taken if stack creation fails.",
          "required": false,
          "schema": {
            "title": "onFailure",
            "type": "string"
          }
        },
        {
          "name": "parameters",
          "type": "array",
          "info": "A list of Parameter structures that specify input parameters for the stack.",
          "required": false,
          "schema": {
            "title": "parameters",
            "type": "array"
          }
        },
        {
          "name": "resourceTypes",
          "type": "array",
          "info": "The template resource types that you have permissions to work with for this create stack action.",
          "required": false,
          "schema": {
            "title": "resourceTypes",
            "type": "array"
          }
        },
        {
          "name": "roleARN",
          "type": "string",
          "info": "The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack.",
          "required": false,
          "schema": {
            "title": "roleARN",
            "type": "string"
          }
        },
        {
          "name": "rollbackConfiguration",
          "type": "object",
          "info": "The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.",
          "required": false,
          "schema": {
            "title": "rollbackConfiguration",
            "type": "object"
          }
        },
        {
          "name": "stackPolicyBody",
          "type": "string",
          "info": "Structure containing the stack policy body.",
          "required": false,
          "schema": {
            "title": "stackPolicyBody",
            "type": "string"
          }
        },
        {
          "name": "stackPolicyURL",
          "type": "string",
          "info": "Location of a file containing the stack policy.",
          "required": false,
          "schema": {
            "title": "stackPolicyURL",
            "type": "string"
          }
        },
        {
          "name": "tags",
          "type": "array",
          "info": "Key-value pairs to associate with this stack.",
          "required": false,
          "schema": {
            "title": "tags",
            "type": "array"
          }
        },
        {
          "name": "templateBody",
          "type": "string",
          "info": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.",
          "required": false,
          "schema": {
            "title": "templateBody",
            "type": "string"
          }
        },
        {
          "name": "templateURL",
          "type": "string",
          "info": "Location of file containing the template body.",
          "required": false,
          "schema": {
            "title": "templateURL",
            "type": "string"
          }
        },
        {
          "name": "timeoutInMinutes",
          "type": "number",
          "info": "The amount of time that can pass before the stack status becomes CREATE_FAILED;.",
          "required": false,
          "schema": {
            "title": "timeoutInMinutes",
            "type": "number"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createStack"
      },
      "task": true
    },
    {
      "name": "updateStack",
      "summary": "Updates a stack as specified in the template.",
      "description": "Updates a stack as specified in the template.",
      "input": [
        {
          "name": "stackName",
          "type": "string",
          "info": "The name or unique stack ID of the stack to update.",
          "required": true,
          "schema": {
            "title": "stackName",
            "type": "string"
          }
        },
        {
          "name": "capabilities",
          "type": "array",
          "info": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack.",
          "required": false,
          "schema": {
            "title": "capabilities",
            "type": "array"
          }
        },
        {
          "name": "clientRequestToken",
          "type": "string",
          "info": "A unique identifier for this UpdateStack request.",
          "required": false,
          "schema": {
            "title": "clientRequestToken",
            "type": "string"
          }
        },
        {
          "name": "notificationARNs",
          "type": "array",
          "info": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack.",
          "required": false,
          "schema": {
            "title": "notificationARNs",
            "type": "array"
          }
        },
        {
          "name": "parameters",
          "type": "array",
          "info": "A list of Parameter structures that specify input parameters for the stack.",
          "required": false,
          "schema": {
            "title": "parameters",
            "type": "array"
          }
        },
        {
          "name": "resourceTypes",
          "type": "array",
          "info": "The template resource types that you have permissions to work with for this update stack action.",
          "required": false,
          "schema": {
            "title": "resourceTypes",
            "type": "array"
          }
        },
        {
          "name": "roleARN",
          "type": "string",
          "info": "The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack.",
          "required": false,
          "schema": {
            "title": "roleARN",
            "type": "string"
          }
        },
        {
          "name": "rollbackConfiguration",
          "type": "object",
          "info": "The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.",
          "required": false,
          "schema": {
            "title": "rollbackConfiguration",
            "type": "object"
          }
        },
        {
          "name": "stackPolicyBody",
          "type": "string",
          "info": "Structure containing a new stack policy body.",
          "required": false,
          "schema": {
            "title": "stackPolicyBody",
            "type": "string"
          }
        },
        {
          "name": "stackPolicyDuringUpdateBody",
          "type": "string",
          "info": "Structure containing the temporary overriding stack policy body.",
          "required": false,
          "schema": {
            "title": "stackPolicyDuringUpdateBody",
            "type": "string"
          }
        },
        {
          "name": "stackPolicyDuringUpdateURL",
          "type": "string",
          "info": "Location of a file containing the temporary overriding stack policy.",
          "required": false,
          "schema": {
            "title": "stackPolicyDuringUpdateURL",
            "type": "string"
          }
        },
        {
          "name": "stackPolicyURL",
          "type": "string",
          "info": "Location of a file containing the updated stack policy.",
          "required": false,
          "schema": {
            "title": "stackPolicyURL",
            "type": "string"
          }
        },
        {
          "name": "tags",
          "type": "array",
          "info": "Key-value pairs to associate with this stack.",
          "required": false,
          "schema": {
            "title": "tags",
            "type": "array"
          }
        },
        {
          "name": "templateBody",
          "type": "string",
          "info": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.",
          "required": false,
          "schema": {
            "title": "templateBody",
            "type": "string"
          }
        },
        {
          "name": "templateURL",
          "type": "string",
          "info": "Location of file containing the template body.",
          "required": false,
          "schema": {
            "title": "templateURL",
            "type": "string"
          }
        },
        {
          "name": "usePreviousTemplate",
          "type": "boolean",
          "info": "Reuse the existing template that is associated with the stack that you are updating.",
          "required": false,
          "schema": {
            "title": "usePreviousTemplate",
            "type": "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateStack"
      },
      "task": true
    },
    {
      "name": "updateTerminationProtection",
      "summary": "Updates termination protection for the specified stack.",
      "description": "Updates termination protection for the specified stack.",
      "input": [
        {
          "name": "stackName",
          "type": "string",
          "info": "The name or unique ID of the stack for which you want to set termination protection.",
          "required": true,
          "schema": {
            "title": "stackName",
            "type": "string"
          }
        },
        {
          "name": "enableTerminationProtection",
          "type": "boolean",
          "info": "Whether to enable termination protection on the specified stack.",
          "required": true,
          "schema": {
            "title": "enableTerminationProtection",
            "type": "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateTerminationProtection"
      },
      "task": true
    },
    {
      "name": "deleteStack",
      "summary": "Deletes a specified stack.",
      "description": "Deletes a specified stack.",
      "input": [
        {
          "name": "stackName",
          "type": "string",
          "info": "The name or the unique stack ID that is associated with the stack.",
          "required": true,
          "schema": {
            "title": "stackName",
            "type": "string"
          }
        },
        {
          "name": "clientRequestToken",
          "type": "string",
          "info": "A unique identifier for this DeleteStack request.",
          "required": false,
          "schema": {
            "title": "clientRequestToken",
            "type": "string"
          }
        },
        {
          "name": "retainResources",
          "type": "array",
          "info": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain.",
          "required": false,
          "schema": {
            "title": "retainResources",
            "type": "array"
          }
        },
        {
          "name": "roleARN",
          "type": "string",
          "info": "The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack.",
          "required": false,
          "schema": {
            "title": "roleARN",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteStack"
      },
      "task": true
    },
    {
      "name": "listStackInstances",
      "summary": "Returns summary information about stack instances that are associated with the specified stack set.",
      "description": "Returns summary information about stack instances that are associated with the specified stack set.",
      "input": [
        {
          "name": "stackSetName",
          "type": "string",
          "info": "The name or unique ID of the stack set that you want to list stack instances for",
          "required": true,
          "schema": {
            "title": "stackSetName",
            "type": "string"
          }
        },
        {
          "name": "maxResults",
          "type": "number",
          "info": "The maximum number of results to be returned with a single call.",
          "required": false,
          "schema": {
            "title": "maxResults",
            "type": "number"
          }
        },
        {
          "name": "nextToken",
          "type": "string",
          "info": "If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token.",
          "required": false,
          "schema": {
            "title": "nextToken",
            "type": "string"
          }
        },
        {
          "name": "stackInstanceAccount",
          "type": "string",
          "info": "The name of the AWS account that you want to list stack instances for.",
          "required": false,
          "schema": {
            "title": "stackInstanceAccount",
            "type": "string"
          }
        },
        {
          "name": "stackInstanceRegion",
          "type": "string",
          "info": "The name of the region where you want to list stack instances.",
          "required": false,
          "schema": {
            "title": "stackInstanceRegion",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listStackInstances"
      },
      "task": true
    },
    {
      "name": "describeStackInstance",
      "summary": "Returns the stack instance that's associated with the specified stack set, AWS account, and region.",
      "description": "Returns the stack instance that's associated with the specified stack set, AWS account, and region.",
      "input": [
        {
          "name": "stackSetName",
          "type": "string",
          "info": "The name or the unique stack ID of the stack set that you want to get stack instance information for.",
          "required": true,
          "schema": {
            "title": "stackSetName",
            "type": "string"
          }
        },
        {
          "name": "stackInstanceAccount",
          "type": "string",
          "info": "The ID of an AWS account that's associated with this stack instance.",
          "required": true,
          "schema": {
            "title": "stackInstanceAccount",
            "type": "string"
          }
        },
        {
          "name": "stackInstanceRegion",
          "type": "string",
          "info": "The name of a region that's associated with this stack instance.",
          "required": true,
          "schema": {
            "title": "stackInstanceRegion",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/describeStackInstance"
      },
      "task": true
    },
    {
      "name": "createStackInstances",
      "summary": "Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region.",
      "description": "Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region.",
      "input": [
        {
          "name": "stackSetName",
          "type": "string",
          "info": "The name or unique ID of the stack set that you want to create stack instances from.",
          "required": true,
          "schema": {
            "title": "stackSetName",
            "type": "string"
          }
        },
        {
          "name": "regions",
          "type": "array",
          "info": "The names of one or more regions where you want to create stack instances using the specified AWS account(s).",
          "required": true,
          "schema": {
            "title": "regions",
            "type": "array"
          }
        },
        {
          "name": "accounts",
          "type": "array",
          "info": "The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.",
          "required": false,
          "schema": {
            "title": "accounts",
            "type": "array"
          }
        },
        {
          "name": "deployme