community / community.aws / 4.3.0 / module / sns_topic_info sns_topic_info module | "added in version" 3.2.0 of community.aws" Authors: Alina Buzachis (@alinabuzachis)community.aws.sns_topic_info (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
The M(community.aws.sns_topic_info) module allows to get all AWS SNS topics or properties of a specific AWS SNS topic.
- 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
region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str topic_arn: description: The ARN of the AWS SNS topic for which you wish to find subscriptions or list attributes. required: false type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - 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.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - 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 I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - 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 I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. type: bool debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
result: contains: sns_arn: description: The ARN of the topic. returned: always sample: arn:aws:sns:us-east-2:111111111111:my_topic_name type: str sns_topic: contains: delivery_policy: description: Delivery policy for the SNS topic. returned: when topic is owned by this AWS account sample: '{"http":{"defaultHealthyRetryPolicy":{"minDelayTarget":20,"maxDelayTarget":20,"numRetries":3,"numMaxDelayRetries":0, "numNoDelayRetries":0,"numMinDelayRetries":0,"backoffFunction":"linear"},"disableSubscriptionOverrides":false}} ' type: str display_name: description: Display name for SNS topic. returned: when topic is owned by this AWS account sample: My topic name type: str owner: description: AWS account that owns the topic. returned: when topic is owned by this AWS account sample: '111111111111' type: str policy: description: Policy for the SNS topic. returned: when topic is owned by this AWS account sample: '{"Version":"2012-10-17","Id":"SomePolicyId","Statement":[{"Sid":"ANewSid","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::111111111111:root"}, "Action":"sns:Subscribe","Resource":"arn:aws:sns:us-east-2:111111111111:ansible-test-dummy-topic","Condition":{"StringEquals":{"sns:Protocol":"email"}}}]} ' type: str subscriptions: description: List of subscribers to the topic in this AWS account. returned: always sample: [] type: list subscriptions_added: description: List of subscribers added in this run. returned: always sample: [] type: list subscriptions_confirmed: description: Count of confirmed subscriptions. returned: when topic is owned by this AWS account sample: '0' type: str subscriptions_deleted: description: Count of deleted subscriptions. returned: when topic is owned by this AWS account sample: '0' type: str subscriptions_existing: description: List of existing subscriptions. returned: always sample: [] type: list subscriptions_new: description: List of new subscriptions. returned: always sample: [] type: list subscriptions_pending: description: Count of pending subscriptions. returned: when topic is owned by this AWS account sample: '0' type: str subscriptions_purge: description: Whether or not purge_subscriptions was set. returned: always sample: true type: bool topic_arn: description: ARN of the SNS topic (equivalent to sns_arn). returned: when topic is owned by this AWS account sample: arn:aws:sns:us-east-2:111111111111:ansible-test-dummy-topic type: str topic_type: description: The type of topic. sample: standard type: str description: Dict of sns topic details. returned: always type: complex description: - The result contaning the details of one or all AWS SNS topics. returned: success type: list