community.missing_collection.aws_cognito_idp_info_module.rst

community.missing_collection.aws_cognito_idp_info

Get Information about Amazon Cognito Identity Provider.

Version added: 0.0.4

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Get Information about Amazon Cognito Identity Provider.
• https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_Operations.html

Requirements

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

• boto
• boto3
• botocore
• python >= 2.6

Parameters

Parameter	Choices/Defaults	Comments
access_token string		access token for cognito devices.
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. 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.
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
group_name string		cognito group name.
list_devices boolean	Choices: no yes	do you want to get list of devices for given access token access_token?
list_groups boolean	Choices: no yes	do you want to get list of cognito groups for given user_pool_id?
list_identity_providers boolean	Choices: no yes	do you want to get list of cognito identity providers for given user_pool_id?
list_resource_servers boolean	Choices: no yes	do you want to get list of cognito resource servers for given user_pool_id?
list_user_import_jobs boolean	Choices: no yes	do you want to get list of cognito user import jobs for given user_pool_id?
list_user_pool_clients boolean	Choices: no yes	do you want to get list of cognito user pool clients for given user_pool_id?
list_users boolean	Choices: no yes	do you want to get list of cognito users for given user_pool_id?
list_users_in_group boolean	Choices: no yes	do you want to get list of cognito groups for given user_pool_id and group_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
user_pool_id string		cognito user pool id.
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 cognito user pools"
  aws_cognito_idp_info:

- name: "get list of cognito devices"
  aws_cognito_idp_info:
    list_devices: true
    access_token: 'test'

- name: "get list of cognito user groups"
  aws_cognito_idp_info:
    list_groups: true
    user_pool_id: 'test'

- name: "get list of cognito providers"
  aws_cognito_idp_info:
    list_identity_providers: true
    user_pool_id: 'test'

- name: "get list of cognito resource servers"
  aws_cognito_idp_info:
    list_resource_servers: true
    user_pool_id: 'test'

- name: "get list of cognito import jobs"
  aws_cognito_idp_info:
    list_user_import_jobs: true
    user_pool_id: 'test'

- name: "get list of cognito user pool clients"
  aws_cognito_idp_info:
    list_user_pool_clients: true
    user_pool_id: 'test'

- name: "get list of cognito users in a pool"
  aws_cognito_idp_info:
    list_users: true
    user_pool_id: 'test'

- name: "get list of cognito users in group"
  aws_cognito_idp_info:
    list_users_in_group: true
    user_pool_id: 'test'
    group_name: 'test-group'

Return Values

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

Key	Returned	Description
devices list	when `list_devices` and `access_token` are defined and success	get list of devices. Sample: [{'device_key': 'string', 'device_attributes': [], 'device_create_date': 'datetime(2016', 6: None, '6)': None, 'device_last_modified_date': 'datetime(2017', 7: None, '7)': None, 'device_last_authenticated_date': 'datetime(2015', 1: None, '1)': None}]
groups list	when `list_groups` and `user_pool_id` are defined and success	get list of groups. Sample: [{'group_name': 'string', 'user_pool_id': 'string', 'description': 'string', 'role_arn': 'string', 'precedence': 123, 'last_modified_date': 'datetime(2015', 1: None, '1)': None, 'creation_date': 'datetime(2016', 6: None, '6)': None}]
providers list	when `list_identity_providers` and `user_pool_id` are defined and success	get list of providers. Sample: [{'provider_name': 'string', 'provider_type': 'SAML', 'last_modified_date': 'datetime(2015', 1: None, '1)': None, 'creation_date': 'datetime(2016', 6: None, '6)': None}]
resource_servers list	when `list_resource_servers` and `user_pool_id` are defined and success	get list of resource servers. Sample: [{'user_pool_id': 'string', 'identifier': 'string', 'name': 'string', 'scopes': [{'scope_name': 'string', 'scope_description': 'string'}]}]
user_import_jobs list	when `list_user_import_jobs` and `user_pool_id` are defined and success	get list of user import jobs. Sample: [{'job_name': 'string', 'job_id': 'string', 'user_pool_id': 'string', 'pre_signed_url': 'string', 'creation_date': 'datetime(2016', 6: None, '6)': None, 'startDate': 'datetime(2017', 7: None, '7)': None, 'completion_date': 'datetime(2015', 1: None, '1)': None, 'status': 'Created', 'cloud_watch_logs_role_arn': 'string', 'imported_users': 1234, 'skipped_users': 12345, 'failed_users': 123, 'completion_message': 'string'}]
user_pool_clients list	when `list_user_pool_clients` and `user_pool_id` are defined and success	get list of user pool clients. Sample: [{'client_id': 'string', 'user_pool_id': 'string', 'client_name': 'string'}]
user_pools list	when no argument and success	get list of cognito user pools. Sample: [{'id': 'string', 'name': 'string', 'lambda_config': {}, 'status': 'Enabled', 'last_modified_date': 'datetime(2015', 1: None, '1)': None, 'creation_date': 'datetime(2016', 6: None, '6)': None}]
users list	when `list_users` or `list_users_in_group` with `user_pool_id` and `group_name` are defined and success	get list of users. Sample: [{'username': 'string', 'attributes': [], 'user_create_date': 'datetime(2016', 6: None, '6)': None, 'user_last_modified_date': 'datetime(2015', 1: None, '1)': None, 'enabled': True, 'user_status': 'UNCONFIRMED', 'mfs_options': []}]

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>