S3 Keys

This is a simple module that supports listing S3Keys.

Example Syntax

name: List s3keys
ionoscloudsdk.ionoscloud.s3key_info:
  user: ''
register: s3key_list_response

Returned object

{
    "changed": false,
    "s3keys": [
        {
            "href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>/s3keys/<ID>",
            "id": "<ID>",
            "metadata": {
                "created_date": "2023-08-03T14:09:10",
                "etag": "f245addf606d4e505be3ce87c622bf75"
            },
            "properties": {
                "active": true,
                "secret_key": "<SECRET_KEY>"
            },
            "type": "s3key"
        },
        {
            "href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>/s3keys/<ID>",
            "id": "<ID>",
            "metadata": {
                "created_date": "2023-08-03T14:09:11",
                "etag": "0c24df8cd19a7e35da34e4f4370f305a"
            },
            "properties": {
                "active": true,
                "secret_key": "<SECRET_KEY>"
            },
            "type": "s3key"
        }
    ],
    "failed": false
}

For more examples please check out the tests here.

Available parameters:

Name	Required	Description
user str	True	The ID or email of the user
depth int	False	The depth used when retrieving the items. Default: 1
filters dict	False	Filter that can be used to list only objects which have a certain set of propeties. Filters should be a dict with a key containing keys and value pair in the following format: 'properties.name': 'server_name'
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.