Skip to content

Latest commit

 

History

History
549 lines (509 loc) · 24.5 KB

community.missing_collection.aws_sesv2_info_module.rst

File metadata and controls

549 lines (509 loc) · 24.5 KB
Raw

community.missing_collection.aws_sesv2_info

Get Information about Amazon Simple Email Service (SES V2).

Version added: 0.0.9

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
list_configuration_sets
boolean
    Choices:
  • no
  • yes
do you want to get list of configuration_sets?
list_contact_lists
boolean
    Choices:
  • no
  • yes
do you want to get contact_lists?
list_contacts
boolean
    Choices:
  • no
  • yes
do you want to get list of contacts for given name
list_custom_verification_email_templates
boolean
    Choices:
  • no
  • yes
do you want to get custom_verification_email_templates?
list_dedicated_ip_pools
boolean
    Choices:
  • no
  • yes
do you want to get dedicated_ip_pools?
list_deliverability_test_reports
boolean
    Choices:
  • no
  • yes
do you want to get deliverability_test_reports?
list_email_identities
boolean
    Choices:
  • no
  • yes
do you want to get email_identities?
name
string
name of the contact list.

aliases: contact_list_name
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: "get list of configuration_sets"
  aws_sesv2_info:
    list_configuration_sets: true

- name: "get contact_lists"
  aws_sesv2_info:
    list_contact_lists: true

- name: "get list of contacts"
  aws_sesv2_info:
    list_contacts: true
    name: 'contact_list_name'

- name: "get custom_verification_email_templates"
  aws_sesv2_info:
    list_custom_verification_email_templates: true

- name: "get dedicated_ip_pools"
  aws_sesv2_info:
    list_dedicated_ip_pools: true

- name: "get deliverability_test_reports"
  aws_sesv2_info:
    list_deliverability_test_reports: true

- name: "get email_identities"
  aws_sesv2_info:
    list_email_identities: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
configuration_sets
list
when `list_configuration_sets` is defined and success.
list of configuration_sets.
contact_lists
list
when `list_contact_lists` is defined and success.
list of contact_lists.
contacts
list
when `list_contacts` is defined and success.
list of contacts.
custom_verification_email_templates
list
when `list_custom_verification_email_templates` is defined and success.
list of custom_verification_email_templates.
dedicated_ip_pools
list
when `list_dedicated_ip_pools` is defined and success.
list of dedicated_ip_pools.
deliverability_test_reports
list
when `list_deliverability_test_reports` is defined and success.
list of deliverability_test_reports.
email_identities
list
when `list_email_identities` is defined and success.
list of email_identities.


Status

Authors