From dc7462620377f5678e7e08ceee3740421db0b123 Mon Sep 17 00:00:00 2001 From: squioc Date: Mon, 15 Jan 2024 14:16:50 +0000 Subject: [PATCH 1/2] Refresh automation library documentation --- _shared_content/automate/library/aws.md | 20 ++++++++++---------- mkdocs.yml | 2 ++ 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/_shared_content/automate/library/aws.md b/_shared_content/automate/library/aws.md index dbf6c7404e..ca1c34add1 100644 --- a/_shared_content/automate/library/aws.md +++ b/_shared_content/automate/library/aws.md @@ -96,9 +96,9 @@ 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** @@ -106,18 +106,15 @@ Get line-oriented records from new S3 objects based on notifications | --------- | ------- | --------------------------- | | `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** @@ -125,8 +122,11 @@ Get records from new S3 Parquet objects based on notifications | --------- | ------- | --------------------------- | | `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 | @@ -165,4 +165,4 @@ Get messages from SQS ## Extra -Module **`AWS` v1.29.4** \ No newline at end of file +Module **`AWS` v1.29.6** \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a2566663fe..3817690867 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -259,6 +259,7 @@ nav: - Operators: xdr/features/automate/operators.md - Actions: xdr/features/automate/actions.md - Actions Library: + - AWS: xdr/features/automate/library/aws.md - AWS: xdr/features/automate/library/aws.md - Atlassian JIRA: xdr/features/automate/library/atlassian-jira.md - BinaryEdge's API: xdr/features/automate/library/binaryedge-s-api.md @@ -444,6 +445,7 @@ nav: - Operators: tip/features/automate/operators.md - Actions: tip/features/automate/actions.md - Actions Library: + - AWS: tip/features/automate/library/aws.md - AWS: tip/features/automate/library/aws.md - Atlassian JIRA: tip/features/automate/library/atlassian-jira.md - BinaryEdge's API: tip/features/automate/library/binaryedge-s-api.md From 4abb0241464d20f67638a64719461bd402a18cc3 Mon Sep 17 00:00:00 2001 From: Sebastien Quioc Date: Mon, 15 Jan 2024 17:03:56 +0100 Subject: [PATCH 2/2] fix(AWS): fix menu --- mkdocs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 3817690867..a2566663fe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -259,7 +259,6 @@ nav: - Operators: xdr/features/automate/operators.md - Actions: xdr/features/automate/actions.md - Actions Library: - - AWS: xdr/features/automate/library/aws.md - AWS: xdr/features/automate/library/aws.md - Atlassian JIRA: xdr/features/automate/library/atlassian-jira.md - BinaryEdge's API: xdr/features/automate/library/binaryedge-s-api.md @@ -445,7 +444,6 @@ nav: - Operators: tip/features/automate/operators.md - Actions: tip/features/automate/actions.md - Actions Library: - - AWS: tip/features/automate/library/aws.md - AWS: tip/features/automate/library/aws.md - Atlassian JIRA: tip/features/automate/library/atlassian-jira.md - BinaryEdge's API: tip/features/automate/library/binaryedge-s-api.md