> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m3ter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Aws Functions

## Invoke Lambda

**Function name:** `InvokeLambdaFunction`
**Category:** Write
**Destination:** Aws

Invokes an AWS lambda function

### Parameters

| Name                       | Label          | Required | Description                                                                 |
| -------------------------- | -------------- | :------: | --------------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials    |    Yes   | The AWS credentials to use.                                                 |
| `functionName`             | Function Name  |    Yes   | The name of the function to invoke.                                         |
| `region`                   | Region         |    Yes   | The AWS region where the function has been deployed.                        |
| `payload`                  | Payload        |    No    | The name of the object to pass as the payload when the function is invoked. |
| `resultPayload`            | Result Payload |    No    | The name of the object to store the result payload in.                      |
| `resultStatus`             | Result Status  |    No    | The name of the object to store the result status in.                       |
| `resultError`              | Result Error   |    No    | The name of the object to store the result error in.                        |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Read from S3

**Function name:** `ReadFromS3Function`
**Category:** Read
**Destination:** Aws

Reads AWS S3 object into state

### Parameters

| Name                       | Label       | Required | Description                                                        |
| -------------------------- | ----------- | :------: | ------------------------------------------------------------------ |
| `integrationCredentialsId` | Credentials |    Yes   | The AWS credentials to use.                                        |
| `region`                   | Region      |    Yes   | The AWS region where the bucket is located                         |
| `bucket`                   | Bucket      |    Yes   | The name of the S3 bucket                                          |
| `source`                   | Source      |    Yes   | The path to the S3 Object                                          |
| `stateVariable`            | State name  |    Yes   | The variable name by which this can be referred to in the workflow |
| `csv`                      | CSV         |    Yes   | If the file is a CSV file                                          |
| `hasHeaders`               | Has headers |    No    | If the csv file has headers                                        |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Send Email

**Function name:** `SendEmailFunction`
**Category:** Write
**Destination:** Aws

Sends email via AWS SES

### Parameters

| Name                       | Label           | Required | Description                                                                |
| -------------------------- | --------------- | :------: | -------------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials     |    Yes   | The AWS credentials to use.                                                |
| `region`                   | Region          |    Yes   | The name of the AWS region where the domain is registered.                 |
| `from`                     | From            |    Yes   | The email address to send the email from.                                  |
| `to`                       | To              |    Yes   | The name of the object to pass as the recipient email address.             |
| `emailSubject`             | Email Subject   |    No    | The name of the object to pass as the Subject for the email.               |
| `payload`                  | Payload         |    No    | The name of the object to pass as the payload for the email/emailTemplate. |
| `emailTemplate`            | Email Template  |    No    | The name of the aws email template.                                        |
| `attachmentData`           | Attachment Data |    No    | State variable holding the data to attach as a file.                       |
| `attachmentType`           | Attachment Type |    No    | The type of the attachment eg csv or json                                  |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Send to SNS

**Function name:** `SendToSNSFunction`
**Category:** Write
**Destination:** Aws

Write a state value to an AWS SNS Topic

### Parameters

| Name                       | Label       | Required | Description                                   |
| -------------------------- | ----------- | :------: | --------------------------------------------- |
| `integrationCredentialsId` | Credentials |    Yes   | The AWS credentials to use.                   |
| `region`                   | Region      |    Yes   | The AWS region where the SQS queue is located |
| `source`                   | Source      |    Yes   | The name of the state object to write to SNS  |
| `topic`                    | Queue       |    Yes   | The name of the SNS topic name                |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Send to SQS

**Function name:** `SendToSQSFunction`
**Category:** Write
**Destination:** Aws

Write a state value to an AWS SQS Queue

### Parameters

| Name                       | Label       | Required | Description                                   |
| -------------------------- | ----------- | :------: | --------------------------------------------- |
| `integrationCredentialsId` | Credentials |    Yes   | The AWS credentials to use.                   |
| `region`                   | Region      |    Yes   | The AWS region where the SQS queue is located |
| `source`                   | Source      |    Yes   | The name of the state object to write to SQS  |
| `queue`                    | Queue       |    Yes   | The name of the SQS queue name                |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Write to S3

**Function name:** `WriteToS3Function`
**Category:** Write
**Destination:** Aws

Write a state value to AWS S3

### Parameters

| Name                       | Label          | Required | Description                                                    |
| -------------------------- | -------------- | :------: | -------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials    |    Yes   | The AWS credentials to use.                                    |
| `region`                   | Region         |    Yes   | The AWS region where the bucket is located                     |
| `stateVariable`            | State variable |    Yes   | The variable name by which this output can be referenced using |
| `bucket`                   | Bucket         |    Yes   | The name of the S3 Bucket                                      |
| `destinationS3Key`         | Destination    |    Yes   | The path to the S3 object                                      |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |