Skip to content

Commit

Permalink
AWS documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Nidheesh-Panchal committed Jun 1, 2024
1 parent d606173 commit f31509b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/source/deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Deploy resources using the Cloud Formation template
Give a name to the stack in ``Stack name``.


Values that are required to be added:
Fill in the following parameter values as they require user input:

**BucketName:**\ The name of S3 bucket that you want to create.
(required to change as the current value populated may not be
Expand All @@ -53,9 +53,9 @@ Deploy resources using the Cloud Formation template
**FlowModelARN:**\ The ARN of the subscribed model package for MITRE
flow detector

The recommended value for parameter:
Recommended value for parameter:

ChunkSize: The size of a single chunk that will be processed at a
**ChunkSize:**\ The size of a single chunk that will be processed at a
time for an input file uploaded to S3. Recommended chunk_size is
below ``50000``.

Expand Down
6 changes: 3 additions & 3 deletions docs/source/end_to_end_test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ How to test end-to-end
2. Sample input json file:

.. code-block:: JSON
{
"input": [
{
Expand Down Expand Up @@ -73,7 +73,7 @@ How to test end-to-end
All fields are required unless mentioned otherwise.

3. Upload input json file to the s3 bucket in path (eg: s3://{bucket-name}/input/). The name of the input file does not matter to the end-to-end flow. Note that if you upload a file with the same name, it will be overwritten in S3 bucket.
3. Upload input json file to the s3 bucket in path: ``s3://{bucket-name}/input/``. The name of the input file does not matter to the end-to-end flow. Note that if you upload a file with the same name, it will be overwritten in S3 bucket.

1. Once you upload the input file. Lets say ``input.json``. Then the control flow will be as follows:

Expand Down Expand Up @@ -103,4 +103,4 @@ How to test end-to-end

3. You can monitor the progress on CloudWatch logs for each lambda function and transform job created.

4. Wait for a complete output to show up on the S3 bucket. (s3://alert-detector/output/flow/{unique-id}/)
4. Wait for a complete output to show up on the S3 bucket. ``s3://alert-detector/output/flow/{unique-id}/``
6 changes: 3 additions & 3 deletions docs/source/subscription.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ATTACK Technique Detector
:align: center

.. note::
Note: Do not click on ``Continue to configuration`` at the top of the page. You can move to the next step.
Note: Do not click on ``Continue to configuration`` at the top of the page. You can move to the next step.

3. Make note of the technique detector model package ARN by going to the Sagemaker console. On the left-hand side panel, navigate to Inference → Marketplace model packages. Select ``AWS Marketplace subscriptions`` tab. Click on the desired product title and copy the ``Model package ARN``.

Expand All @@ -46,7 +46,7 @@ Temporal Clustering
:align: center

.. note::
Note: Do not click on ``Continue to configuration`` at the top of the page. You can move to the next step.
Note: Do not click on ``Continue to configuration`` at the top of the page. You can move to the next step.

3. Make note of the temporal clustering model package ARN by going to the Sagemaker console. On the left hand side panel, navigate to Inference → Marketplace model packages. Select ``AWS Marketplace subscriptions`` tab. Click on the desired product title and copy the ``Model package ARN``.

Expand All @@ -73,7 +73,7 @@ MITRE ATTACK Flow Detector
:align: center

.. note::
Note: Do not click on ``Continue to configuration`` at the top of the page. You can move to the next step.
Note: Do not click on ``Continue to configuration`` at the top of the page. You can move to the next step.

3. Make note of the flow detector model package ARN by going to the Sagemaker console. On the left hand side panel, navigate to Inference → Marketplace model packages. Select ``AWS Marketplace subscriptions`` tab. Click on the desired product title and copy the ``Model package ARN``.

Expand Down

0 comments on commit f31509b

Please sign in to comment.