1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Document return values for aws_s3 (#31158)

* Document return values for aws_s3
This commit is contained in:
Prasad Katti 2017-10-09 16:26:42 -07:00 committed by Will Thames
parent 91a36faddb
commit 0c64bbcd6f

View file

@ -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=<access-key>&Expires=1506888865&Signature=<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