community.general.scaleway_function_namespace_info module – Retrieve information on Scaleway Function namespace

Note

This module is part of the community.general collection (version 12.6.1).

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.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.scaleway_function_namespace_info.

New in community.general 6.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module return information about a function namespace on Scaleway account.

Requirements

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

PyYAML (when profile is used)

Parameters

Parameter	Comments
api_timeout aliases: timeout integer	HTTP timeout to Scaleway API in seconds. Default: `30`
api_token aliases: oauth_token string	Scaleway OAuth token. This is required if `profile` is not specified.
api_url aliases: base_url string	Scaleway API URL. Default: `"https://api.scaleway.com"`
name string / required	Name of the function namespace.
profile aliases: scw_profile string added in community.general 12.2.0	The config profile in config file to load the Scaleway OAuth token from, use instead of `api_token`. It is also possible to set `SCW_PROFILE` to use a SCW CLI config profile.
project_id string / required	Project identifier.
query_parameters dictionary	List of parameters passed to the query string. Default: `{}`
region string / required	Scaleway region to use (for example `fr-par`). Choices: `"fr-par"` `"nl-ams"` `"pl-waw"`
validate_certs boolean	Validate SSL certs of the Scaleway API. Choices: `false` `true` ← (default)

Attributes

Attribute	Support	Description
action_group	Action group: community.general.scaleway added in community.general 11.3.0	Use `group/community.general.scaleway` in `module_defaults` to set defaults for this module.
check_mode	Support: full This action does not modify state.	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: N/A This action does not modify state.	Returns details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Notes

Note

Also see the API documentation on https://developer.scaleway.com/.
If api_token is not set within the module, the following environment variables can be used in decreasing order of precedence SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN or SCW_API_TOKEN.
If one wants to use a different api_url one can also set the SCW_API_URL environment variable.

Examples

- name: Get a function namespace info
  community.general.scaleway_function_namespace_info:
    project_id: '{{ scw_project }}'
    region: fr-par
    name: my-awesome-function-namespace
  register: function_namespace_info_task

Return Values

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

Key	Description
function_namespace dictionary	The function namespace information. Returned: always Sample: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-function-namespace", "organization_id": "e04e3bdc-015c-4514-afde-9389e9be24b0", "project_id": "d44cea58-dcb7-4c95-bff1-1105acb60a98", "region": "fr-par", "registry_endpoint": "", "registry_namespace_id": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "pending"}

Key

Description

function_namespace

dictionary

The function namespace information.

Returned: always

Sample: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-function-namespace", "organization_id": "e04e3bdc-015c-4514-afde-9389e9be24b0", "project_id": "d44cea58-dcb7-4c95-bff1-1105acb60a98", "region": "fr-par", "registry_endpoint": "", "registry_namespace_id": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "pending"}

Authors

Guillaume MARTINEZ (@Lunik)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/scaleway_function_namespace_info_module.html