diff --git a/docs/mint.json b/docs/mint.json index 1ee51f5c0..27720e6bb 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -113,6 +113,7 @@ "providers/documentation/aks-provider", "providers/documentation/amazonsqs-provider", "providers/documentation/appdynamics-provider", + "providers/documentation/s3-provider", "providers/documentation/argocd-provider", "providers/documentation/auth0-provider", "providers/documentation/axiom-provider", diff --git a/docs/providers/documentation/keep-provider.mdx b/docs/providers/documentation/keep-provider.mdx index 059bdd0a0..ea1677f2f 100644 --- a/docs/providers/documentation/keep-provider.mdx +++ b/docs/providers/documentation/keep-provider.mdx @@ -9,6 +9,10 @@ description: "Keep provider allows you to query and manage alerts in Keep." - `query`: str : The query to retrieve alerts based on specific criteria. - `filter`: dict : Optional filters to narrow down the query results. +### Optional + +- `workflow_to_update_yaml`: str : The YAML of a workflow to update in Keep. You may find [functions -> raw_render_without_execution](/workflows/syntax/functions#raw-render-without-execution) useful. + ## Outputs - `alerts`: list : A list of alerts that match the query criteria. diff --git a/docs/providers/documentation/s3-provider.mdx b/docs/providers/documentation/s3-provider.mdx new file mode 100644 index 000000000..2ec3e3713 --- /dev/null +++ b/docs/providers/documentation/s3-provider.mdx @@ -0,0 +1,57 @@ +--- +title: "AWS S3" +sidebarTitle: "AWS S3 Provider" +description: "AWS S3 provider to query S3 buckets" +--- + +## Inputs + +- `bucket`: str : The bucket to read the files from. + +## Limitations + +Querying only yaml, yml, json, xml and csv files. + +## Outputs + +Files's content as a dict. + +## Authentication Parameters + +- access_key +- secret_access_key + +Please note that during the installation, the provider is performing `list_buckets` to validate the config. Here is an example IAM policy: +``` +{ + "Version": "2025-01-15", + "Statement": [ + { + "Sid": "VisualEditor0", + "Effect": "Allow", + "Action": [ + "s3:ListBucket", + "s3:GetObject", + "s3:GetBucketLocation", + "s3:ListAllMyBuckets" + ], + "Resource": "*" + } + ] +} +``` + +## Example of usage + + +``` +steps: + - name: s3-dump + provider: + config: '{{ providers.s3 }}' + type: s3 + with: + bucket: "keep-workflows" +``` + +- [Example workflow](https://github.com/keephq/keep/blob/main/examples/workflows/update_workflows_from_s3.yml) diff --git a/docs/providers/overview.mdx b/docs/providers/overview.mdx index 8d8b0d7de..8bc929f88 100644 --- a/docs/providers/overview.mdx +++ b/docs/providers/overview.mdx @@ -15,737 +15,559 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t - } + icon={ } > - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - - } -/> - - } + icon={ } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } +> + + } +> + + } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } -> - - - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } +> + + } +> + + } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } +> + + } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + title="SMTP" + href="/providers/documentation/smtp-provider" + icon={ } > - } + title="Snowflake" + href="/providers/documentation/snowflake-provider" + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } >