access-key

access-key create

Usage

  usage: symp access-key create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--user-id USER_ID]
                                [--access-key-id ACCESS_KEY_ID]
                                [--secret-access-key SECRET_ACCESS_KEY]
                                [--project-id PROJECT_ID]

Description

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.

Returns

Returns dict: A structure with details about the access key

Optional

optional arguments:
  -h, --help            show this help message and exit
  --user-id USER_ID     The ID of the user that the new key will belong to. If not given, current user is used
  --access-key-id ACCESS_KEY_ID
                        Pre-generated access key. If not given, one will be generated
  --secret-access-key SECRET_ACCESS_KEY
                        Pre-generated secret access key. Must be given if access_key_id is not None.
                        If not given, one will be generated
  --project-id PROJECT_ID
                        The ID of the project in which the access-key will be created in

access-key list

Usage

  usage: symp access-key list
[-f {adaptive_table,csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              [--user-id USER_ID]

Description

Returns information about the access key IDs associated with the specified IAM user. If there are none, the action returns an empty list.

Returns

Returns list: A list of objects containing metadata about the access keys

Optional

optional arguments:
  -h, --help            show this help message and exit
  --user-id USER_ID     The ID of the user

access-key remove

Usage

  usage: symp access-key remove
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--user-id USER_ID]
                                access_key_id

Description

Deletes the access key pair associated with the specified user.

Mandatory

positional arguments:
  access_key_id         The access key ID for the access key ID and secret access key you want to delete

Optional

optional arguments:
  -h, --help            show this help message and exit
  --user-id USER_ID     The ID of the user whose access key pair you want to delete

access-key update

Usage

  usage: symp access-key update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--user-id USER_ID]
                                access_key_id is_active

Description

Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user’s key as part of a key rotation work flow.

Mandatory

positional arguments:
  access_key_id         The access key ID of the secret access key you want to update
  is_active             The status you want to assign to the secret access key.
                        True means active - the key can be used for API calls to AWS,
                        False means Inactive - the key cannot be used

Optional

optional arguments:
  -h, --help            show this help message and exit
  --user-id USER_ID     The ID of the user whose key you want to update