mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -44,48 +44,42 @@ options:
|
|||
- The name of the function to be invoked. This can only be used for
|
||||
invocations within the calling account. To invoke a function in another
|
||||
account, use I(function_arn) to specify the full ARN.
|
||||
required: false
|
||||
default: None
|
||||
function_arn:
|
||||
description:
|
||||
- The name of the function to be invoked
|
||||
required: false
|
||||
default: None
|
||||
tail_log:
|
||||
description:
|
||||
- If C(tail_log=true), the result of the task will include the last 4 KB
|
||||
- If C(tail_log=yes), the result of the task will include the last 4 KB
|
||||
of the CloudWatch log for the function execution. Log tailing only
|
||||
works if you use synchronous invocation C(wait=true). This is usually
|
||||
works if you use synchronous invocation C(wait=yes). This is usually
|
||||
used for development or testing Lambdas.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
wait:
|
||||
description:
|
||||
- Whether to wait for the function results or not. If I(wait) is false,
|
||||
- Whether to wait for the function results or not. If I(wait) is C(no),
|
||||
the task will not return any results. To wait for the Lambda function
|
||||
to complete, set C(wait=true) and the result will be available in the
|
||||
to complete, set C(wait=yes) and the result will be available in the
|
||||
I(output) key.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
dry_run:
|
||||
description:
|
||||
- Do not *actually* invoke the function. A C(DryRun) call will check that
|
||||
the caller has permissions to call the function, especially for
|
||||
checking cross-account permissions.
|
||||
required: false
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_qualifier:
|
||||
description:
|
||||
- Which version/alias of the function to run. This defaults to the
|
||||
C(LATEST) revision, but can be set to any existing version or alias.
|
||||
See https;//docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html
|
||||
for details.
|
||||
required: false
|
||||
default: LATEST
|
||||
payload:
|
||||
description:
|
||||
- A dictionary in any form to be provided as input to the Lambda function.
|
||||
required: false
|
||||
default: {}
|
||||
'''
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue