Skip to content

Commit

Permalink
Add missing RETURN data in docs (#571)
Browse files Browse the repository at this point in the history
Docs s3_bucket

SUMMARY

Add RETURN docs s3_bucket.

ISSUE TYPE


Docs Pull Request

COMPONENT NAME

s3_bucket

Reviewed-by: Mark Chappell <None>
Reviewed-by: None <None>
  • Loading branch information
alinabuzachis authored Nov 22, 2021
1 parent 498b122 commit 2fded7e
Showing 1 changed file with 59 additions and 2 deletions.
61 changes: 59 additions & 2 deletions plugins/modules/s3_bucket.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
__metaclass__ = type


DOCUMENTATION = '''
DOCUMENTATION = r'''
---
module: s3_bucket
version_added: 1.0.0
Expand Down Expand Up @@ -153,7 +153,7 @@
I(requester_pays) is C(False), I(policy), I(tags), and I(versioning) are C(None).
'''

EXAMPLES = '''
EXAMPLES = r'''
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create a simple S3 bucket
Expand Down Expand Up @@ -243,6 +243,63 @@
policy: "null"
'''

RETURN = r'''
encryption:
description:
- Server-side encryption of the objects in the S3 bucket.
type: str
returned: I(state=present)
sample: ''
name:
description: Name of the S3 bucket.
type: str
returned: I(state=present)
sample: "2d3ce10a8210d36d6b4d23b822892074complex"
object_ownership:
description: S3 bucket's ownership controls.
type: str
returned: I(state=present)
sample: "BucketOwnerPreferred"
policy:
description: S3 bucket's policy.
type: dict
returned: I(state=present)
sample: {
"Statement": [
{
"Action": "s3:GetObject",
"Effect": "Allow",
"Principal": "*",
"Resource": "arn:aws:s3:::2d3ce10a8210d36d6b4d23b822892074complex/*",
"Sid": "AddPerm"
}
],
"Version": "2012-10-17"
}
requester_pays:
description:
- Indicates that the requester was successfully charged for the request.
type: str
returned: I(state=present)
sample: ''
tags:
description: S3 bucket's tags.
type: dict
returned: I(state=present)
sample: {
"Tag1": "tag1",
"Tag2": "tag2"
}
versioning:
description: S3 bucket's versioning configuration.
type: dict
returned: I(state=present)
sample: {
"MfaDelete": "Disabled",
"Versioning": "Enabled"
}
'''

import json
import os
import time
Expand Down

0 comments on commit 2fded7e

Please sign in to comment.