Skip to content

Commit da55da8

Browse files
KeltonKarboviakKeltonKarboviak
authored
docs(parameters): fix typos and inconsistencies (#1966)
* Update parameters.md Signed-off-by: Kelton Karboviak <kelton.karboviak@gmail.com> * Update parameters.md --------- Signed-off-by: Kelton Karboviak <kelton.karboviak@gmail.com>
1 parent 22bda37 commit da55da8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

‎docs/utilities/parameters.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This utility requires additional permissions to work as expected.
3333
| SSM | **`get_parameters`**, **`SSMProvider.get_multiple`** | **`ssm:GetParametersByPath`** |
3434
| SSM | **`get_parameters_by_name`**, **`SSMProvider.get_parameters_by_name`** | **`ssm:GetParameter`** and **`ssm:GetParameters`** |
3535
| SSM | If using **`decrypt=True`** | You must add an additional permission **`kms:Decrypt`** |
36-
| Secrets | **`get_secret`**, **`SecretsManager.get`** | **`secretsmanager:GetSecretValue`** |
36+
| Secrets | **`get_secret`**, **`SecretsProvider.get`** | **`secretsmanager:GetSecretValue`** |
3737
| DynamoDB | **`DynamoDBProvider.get`** | **`dynamodb:GetItem`** |
3838
| DynamoDB | **`DynamoDBProvider.get_multiple`** | **`dynamodb:Query`** |
3939
| AppConfig | **`get_app_config`**, **`AppConfigProvider.get_app_config`** | **`appconfig:GetLatestConfiguration`** and **`appconfig:StartConfigurationSession`** |
@@ -212,7 +212,7 @@ For single parameters, you must use `id` as the [partition key](https://docs.aws
212212
| ------------ | -------- |
213213
| my-parameter | my-value |
214214

215-
With this table, `dynamodb_provider.get("my-param")` will return `my-value`.
215+
With this table, `dynamodb_provider.get("my-parameter")` will return `my-value`.
216216

217217
=== "builtin_provider_dynamodb_single_parameter.py"
218218
```python hl_lines="5 8 15"
@@ -237,7 +237,7 @@ You can retrieve multiple parameters sharing the same `id` by having a sort key
237237

238238
???+ example
239239

240-
DynamoDB table with `id` primary key, `sk` as sort key` and `value` as attribute
240+
DynamoDB table with `id` primary key, `sk` as sort key and `value` as attribute
241241

242242
| id | sk | value |
243243
| ------ | ----------------- | ------------------------------------------------ |
@@ -390,7 +390,7 @@ Here is the mapping between this utility's functions and methods and the underly
390390
| SSM Parameter Store | `SSMProvider.get` | `ssm` | [get_parameter](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM.Client.get_parameter) |
391391
| SSM Parameter Store | `SSMProvider.get_multiple` | `ssm` | [get_parameters_by_path](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM.Client.get_parameters_by_path) |
392392
| Secrets Manager | `get_secret` | `secretsmanager` | [get_secret_value](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/secretsmanager.html#SecretsManager.Client.get_secret_value) |
393-
| Secrets Manager | `SecretsManager.get` | `secretsmanager` | [get_secret_value](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/secretsmanager.html#SecretsManager.Client.get_secret_value) |
393+
| Secrets Manager | `SecretsProvider.get` | `secretsmanager` | [get_secret_value](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/secretsmanager.html#SecretsManager.Client.get_secret_value) |
394394
| DynamoDB | `DynamoDBProvider.get` | `dynamodb` | ([Table resource](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#table)) | [get_item](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.get_item) |
395395
| DynamoDB | `DynamoDBProvider.get_multiple` | `dynamodb` | ([Table resource](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#table)) | [query](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#DynamoDB.Table.query) |
396396
| App Config | `get_app_config` | `appconfigdata` | [start_configuration_session](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/appconfigdata.html#AppConfigData.Client.start_configuration_session) and [get_latest_configuration](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/appconfigdata.html#AppConfigData.Client.get_latest_configuration) |

0 commit comments

Comments
 (0)