Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh automation library documentation #1534

Merged
merged 2 commits into from
Jan 15, 2024
Merged

Refresh automation library documentation #1534

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc74626
Refresh automation library documentation
squioc Jan 15, 2024
4abb024
fix(AWS): fix menu
squioc Jan 15, 2024
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
20 changes: 10 additions & 10 deletions _shared_content/automate/library/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,37 +96,37 @@ Get line-oriented Flowlog records from new S3 objects based on notifications
| `intake_key` | `string` | Intake key to use when sending events |


### Fetch new logs on S3
### Fetch new FlowLogs Parquet records on S3

Get line-oriented records from new S3 objects based on notifications
Get FlowLogs records from new S3 Parquet objects based on notifications

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `frequency` | `integer` | Batch frequency in seconds |
| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
| `chunk_size` | `integer` | The size of chunks for the batch processing |
| `separator` | `string` | The separator used between each records (default: the linefeed character '\n') |
| `skip_first` | `integer` | The number of records to skip at the begining of each S3 object (default: 0) |
| `ignore_comments` | `boolean` | Flag to ignore commented lines (starting with the character `#`; default: false) |
| `delete_consumed_messages` | `boolean` | Flag to delete consuming messages (default: false) |
| `chunk_size` | `integer` | The size of chunks for the batch processing |
| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
| `intake_key` | `string` | Intake key to use when sending events |


### Fetch new Parquet records on S3
### Fetch new logs on S3

Get records from new S3 Parquet objects based on notifications
Get line-oriented records from new S3 objects based on notifications

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `frequency` | `integer` | Batch frequency in seconds |
| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
| `delete_consumed_messages` | `boolean` | Flag to delete consuming messages (default: false) |
| `chunk_size` | `integer` | The size of chunks for the batch processing |
| `separator` | `string` | The separator used between each records (default: the linefeed character '\n') |
| `skip_first` | `integer` | The number of records to skip at the begining of each S3 object (default: 0) |
| `ignore_comments` | `boolean` | Flag to ignore commented lines (starting with the character `#`; default: false) |
| `delete_consumed_messages` | `boolean` | Flag to delete consuming messages (default: false) |
| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
| `intake_key` | `string` | Intake key to use when sending events |

Expand Down Expand Up @@ -165,4 +165,4 @@ Get messages from SQS

## Extra

Module **`AWS` v1.29.4**
Module **`AWS` v1.29.6**