community.aws.sns_topic_info module – sns_topic_info module
Note
This module is part of the community.aws collection (version 3.6.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.sns_topic_info.
New in community.aws 3.2.0
Synopsis
The community.aws.sns_topic_info module allows to get all AWS SNS topics or properties of a specific AWS SNS topic.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
|---|---|
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. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. 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. |
|
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. |
|
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. Choices:
|
|
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. |
|
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. |
|
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 |
|
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_session_token and session_token have been added in version 3.2.0. |
|
The ARN of the AWS SNS topic for which you wish to find subscriptions or list attributes. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLEWhen no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
- name: list all the topics
community.aws.sns_topic_info:
register: sns_topic_list
- name: get info on specific topic
community.aws.sns_topic_info:
topic_arn: "{{ sns_arn }}"
register: sns_topic_info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result contaning the details of one or all AWS SNS topics. Returned: success |
|
The ARN of the topic. Returned: always Sample: |
|
Dict of sns topic details. Returned: always |
|
Delivery policy for the SNS topic. Returned: when topic is owned by this AWS account Sample: |
|
Display name for SNS topic. Returned: when topic is owned by this AWS account Sample: |
|
AWS account that owns the topic. Returned: when topic is owned by this AWS account Sample: |
|
Policy for the SNS topic. Returned: when topic is owned by this AWS account Sample: |
|
List of subscribers to the topic in this AWS account. Returned: always Sample: |
|
List of subscribers added in this run. Returned: always Sample: |
|
Count of confirmed subscriptions. Returned: when topic is owned by this AWS account Sample: |
|
Count of deleted subscriptions. Returned: when topic is owned by this AWS account Sample: |
|
List of existing subscriptions. Returned: always Sample: |
|
List of new subscriptions. Returned: always Sample: |
|
Count of pending subscriptions. Returned: when topic is owned by this AWS account Sample: |
|
Whether or not purge_subscriptions was set. Returned: always Sample: |
|
ARN of the SNS topic (equivalent to sns_arn). Returned: when topic is owned by this AWS account Sample: |
|
The type of topic. Returned: success Sample: |