Documentation update for route53_facts (#49525)

Updates details about required parameters.

Fixes: #49450

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2018-12-05 15:51:17 +05:30 committed by John R Barker
parent 7c8b5a407d
commit 2af4761677

View file

@ -15,12 +15,12 @@ DOCUMENTATION = '''
module: route53_facts module: route53_facts
short_description: Retrieves route53 details using AWS methods short_description: Retrieves route53 details using AWS methods
description: description:
- Gets various details related to Route53 zone, record set or health check details - Gets various details related to Route53 zone, record set or health check details.
version_added: "2.0" version_added: "2.0"
options: options:
query: query:
description: description:
- specifies the query action to take - specifies the query action to take.
required: True required: True
choices: [ choices: [
'change', 'change',
@ -33,17 +33,20 @@ options:
change_id: change_id:
description: description:
- The ID of the change batch request. - The ID of the change batch request.
The value that you specify here is the value that - The value that you specify here is the value that
ChangeResourceRecordSets returned in the Id element ChangeResourceRecordSets returned in the Id element
when you submitted the request. when you submitted the request.
- Required if C(query) is set to C(change).
required: false required: false
hosted_zone_id: hosted_zone_id:
description: description:
- The Hosted Zone ID of the DNS zone - The Hosted Zone ID of the DNS zone.
- Required if C(query) is set to C(hosted_zone) and C(hosted_zone_method) is set to C(details).
- Required if C(query) is set to C(record_sets).
required: false required: false
max_items: max_items:
description: description:
- Maximum number of items to return for various get/list requests - Maximum number of items to return for various get/list requests.
required: false required: false
next_marker: next_marker:
description: description:
@ -51,16 +54,16 @@ options:
number of entries - EG 100 or the number specified by max_items. number of entries - EG 100 or the number specified by max_items.
If the number of entries exceeds this maximum another request can be sent If the number of entries exceeds this maximum another request can be sent
using the NextMarker entry from the first response to get the next page using the NextMarker entry from the first response to get the next page
of results" of results."
required: false required: false
delegation_set_id: delegation_set_id:
description: description:
- The DNS Zone delegation set ID - The DNS Zone delegation set ID.
required: false required: false
start_record_name: start_record_name:
description: description:
- "The first name in the lexicographic ordering of domain names that you want - "The first name in the lexicographic ordering of domain names that you want
the list_command: record_sets to start listing from" the list_command: record_sets to start listing from."
required: false required: false
type: type:
description: description:
@ -70,16 +73,20 @@ options:
dns_name: dns_name:
description: description:
- The first name in the lexicographic ordering of domain names that you want - The first name in the lexicographic ordering of domain names that you want
the list_command to start listing from the list_command to start listing from.
required: false required: false
resource_id: resource_id:
description: description:
- The ID/s of the specified resource/s - The ID/s of the specified resource/s.
- Required if C(query) is set to C(health_check) and C(health_check_method) is to C(tags).
- Required if C(query) is set to C(hosted_zone) and C(hosted_zone_method) is to C(tags).
required: false required: false
aliases: ['resource_ids'] aliases: ['resource_ids']
health_check_id: health_check_id:
description: description:
- The ID of the health check - The ID of the health check.
- Required if C(query) is set to C(health_check) and
C(health_check_method) is set to C(details) or C(status) or C(failure_reason).
required: false required: false
hosted_zone_method: hosted_zone_method:
description: description: