From 31f062868c31a125714d6b8e33e127e1e2fe7bd9 Mon Sep 17 00:00:00 2001 From: Ryan Johnston Date: Tue, 18 Feb 2020 13:45:58 -0500 Subject: [PATCH] Update README.md The documentation should contain some information about what is returned from the getParameter method. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ff7010c..7608fe1 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,17 @@ awsParamStore.getParameter( '/project1/my-parameter', { region: 'us-east-1' } ) }); ``` +The `parameter` info object will have properties similiar to the following: + +`{ + Name: '/project1/my-parameter', + Type: 'String', + Value: 'your value', + Version: 1, + LastModifiedDate: 2020-02-18T18:17:08.229Z, + ARN: 'arn:aws:ssm:us-east-1:000000000000:parameter/project1/my-parameter' +}` + ### `getParameterSync( name [, options] )` Gets a parameter by name. This method will block until the operation completes. @@ -212,7 +223,6 @@ that resolves the parameter results. Executes the query based on path or name(s) that were selected. This operation will block until complete. - ## Feedback We'd love to get feedback on how to make this tool better. Feel free to contact