From 0c64bbcd6f88dd1e71267bab411af05f35fc9684 Mon Sep 17 00:00:00 2001 From: Prasad Katti Date: Mon, 9 Oct 2017 16:26:42 -0700 Subject: [PATCH] Document return values for aws_s3 (#31158) * Document return values for aws_s3 --- lib/ansible/modules/cloud/amazon/aws_s3.py | 31 ++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/lib/ansible/modules/cloud/amazon/aws_s3.py b/lib/ansible/modules/cloud/amazon/aws_s3.py index a61273ed218..8cc48e9f1dc 100644 --- a/lib/ansible/modules/cloud/amazon/aws_s3.py +++ b/lib/ansible/modules/cloud/amazon/aws_s3.py @@ -236,6 +236,37 @@ EXAMPLES = ''' mode: delobj ''' +RETURN = ''' +msg: + description: msg indicating the status of the operation + returned: always + type: string + sample: PUT operation complete +url: + description: url of the object + returned: (for put and geturl operations) + type: string + sample: https://my-bucket.s3.amazonaws.com/my-key.txt?AWSAccessKeyId=&Expires=1506888865&Signature= +expiry: + description: number of seconds the presigned url is valid for + returned: (for geturl operation) + type: int + sample: 600 +contents: + description: contents of the object as string + returned: (for getstr operation) + type: string + sample: "Hello, world!" +s3_keys: + description: list of object keys + returned: (for list operation) + type: list + sample: + - prefix1/ + - prefix1/key1 + - prefix1/key2 +''' + import os import traceback from ansible.module_utils.six.moves.urllib.parse import urlparse