aws-policy

aws-policy assignments-list

Usage

  usage: symp aws-policy assignments-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 ...]]]

Description

Lists the assignments of aws-policies to users, groups and IAM roles.

Returns

Returns list: List of assignments - The entities and their policies

Optional

optional arguments:
  -h, --help            show this help message and exit

aws-policy create

Usage

  usage: symp aws-policy create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--description DESCRIPTION]
                                [--scope-id SCOPE_ID]
                                name policy_document scope_type

Description

Creates a new AWS policy.

Returns

Returns dict: A structure containing details about the new policy

Mandatory

positional arguments:
  name                  The friendly name of the policy
  policy_document       The JSON policy document for the new policy
                        Should be of the following format: '{"Statement": [{"Action": [<actions>], "Effect": "Allow", "Resource": ["*"]}]}'
  scope_type            The scope in which the policy will be available, can be one of: public, domain, project

Optional

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        A friendly description of the policy
  --scope-id SCOPE_ID   If scope_type is project or domain: scope_id should be the project-id or the domain-id, with the logged in scope as default
                        If scope_type is public- scope_id will be ignored

aws-policy get

Usage

  usage: symp aws-policy get
[-f {adaptive_table,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                             policy_id

Description

Retrieves information about the specified AWS policy.

Returns

Returns dict: A structure containing details about the policy

Mandatory

positional arguments:
  policy_id             The ID of the policy

Optional

optional arguments:
  -h, --help            show this help message and exit

aws-policy get-entities

Usage

  usage: symp aws-policy get-entities
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      policy_id

Description

Lists all users, groups, and roles that the specified AWS policy is attached to.

Returns

Returns dict: Entities that the policy is attached to

Mandatory

positional arguments:
  policy_id             The ID of the policy

Optional

optional arguments:
  -h, --help            show this help message and exit

aws-policy list

Usage

  usage: symp aws-policy 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 ...]]] [--name NAME]
                              [--with-document]

Description

Lists all the AWS policies that are available.

Returns

Returns list: List of policies

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           Show only the policy with the given name
  --with-document       Whether to include the policy document or not

aws-policy remove

Usage

  usage: symp aws-policy remove
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                policy_id

Description

Deletes the specified AWS policy. Before you can delete an AWS policy, you must first detach the policy from all users, groups, and roles that it is attached to.

Mandatory

positional arguments:
  policy_id             The ID of the policy to delete

Optional

optional arguments:
  -h, --help            show this help message and exit

aws-policy update

Usage

  usage: symp aws-policy update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]] [--name NAME]
                                [--policy-document POLICY_DOCUMENT]
                                [--description DESCRIPTION]
                                policy_id

Description

Updates the specified AWS policy.

Mandatory

positional arguments:
  policy_id             The ID of the policy to delete

Optional

optional arguments:
  -h, --help            show this help message and exit
  --name NAME           The name of the policy
  --policy-document POLICY_DOCUMENT
                        The JSON policy document for the new policy
                        Should be of the following format: '{"Statement": [{"Action": [<actions>], "Effect": "Allow", "Resource": ["*"]}]}'
  --description DESCRIPTION
                        A friendly description of the policy

aws-policy validate

Usage

  usage: symp aws-policy validate
[-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  policy_document

Description

Validate a policy document without creating a policy.

Returns

Returns dict: Whether the validation was successful, and the errors if there are any

Mandatory

positional arguments:
  policy_document       A policy document to be validated

Optional

optional arguments:
  -h, --help            show this help message and exit