AWS - IAM

Amazon Web Services Identity and Access Management (IAM).

IT Services · AWS - IAM

Details

ID	`AWS - IAM`
Provider	Amazon
Category	IT Services
From Version	5.0.0
Docker Image	`demisto/boto3py3:1.0.0.10221838`
Supported Modules	Agentix Cloud Runtime Security Cloud Posture Security XSIAM EDR Cortex Cloud

README

Amazon Web Services Identity and Access Management (IAM)

For detailed instructions about setting up authentication, see: AWS Integrations - Authentication.

Configure AWS - IAM in Cortex

Parameter	Description	Required
roleArn	Role Arn	False
roleSessionName	Role Session Name	False
defaultRegion	AWS Default Region	False
sessionDuration	Role Session Duration	False
access_key	Access Key	False
secret_key	Secret Key	False
timeout	The time in seconds till a timeout exception is reached. You can specify just the read timeout (for example 60) or also the connect timeout followed after a comma (for example 60,10). If a connect timeout is not specified, a default of 10 second will be used.	False
retries	The maximum number of retry attempts when connection or throttling errors are encountered. Set to 0 to disable retries. The default value is 5 and the limit is 10. Note: Increasing the number of retries will increase the execution time.	False
insecure	Trust any certificate (not secure)	False
proxy	Use system proxy settings	False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

aws-iam-create-user

Creates a new IAM user for your AWS account.

Base Command

aws-iam-create-user

Input

Argument Name	Description	Required
userName	The name of the user to create.	Required
path	The path for the user name. This parameter is optional. If it is not included, it defaults to a slash (/).	Optional
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

Path	Type	Description
AWS.IAM.Users.UserName	string	The friendly name identifying the user.
AWS.IAM.Users.UserId	string	The stable and unique string identifying the user.
AWS.IAM.Users.Arn	string	The Amazon Resource Name (ARN) that identifies the user.
AWS.IAM.Users.CreateDate	date	The date and time, when the user was created.
AWS.IAM.Users.Path	string	The path to the user.

Command Example

!aws-iam-create-user userName=Test path=/testusers/

aws-iam-get-user

Retrieves information about the specified IAM user, including the user’s creation date, path, unique ID, and ARN.

Base Command

aws-iam-get-user

Input

Argument Name	Description	Required
userName	The name of the user to get information about.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

Path	Type	Description
AWS.IAM.Users.UserName	string	The friendly name identifying the user.
AWS.IAM.Users.UserId	string	The stable and unique string identifying the user.
AWS.IAM.Users.Arn	string	The Amazon Resource Name (ARN) that identifies the user.
AWS.IAM.Users.CreateDate	date	The date and time when the user was created.
AWS.IAM.Users.Path	string	The path to the user.
AWS.IAM.Users.PasswordLastUsed	date	The date and time, when the user’s password was last used to sign in to an AWS website.

Command Example

!aws-iam-get-user userName=test

aws-iam-list-users

Lists the IAM users, returns all users in the AWS account.

Base Command

aws-iam-list-users

Input

Argument Name	Description	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

Path	Type	Description
AWS.IAM.Users.UserName	string	The friendly name identifying the user.
AWS.IAM.Users.UserId	string	The stable and unique string identifying the user.
AWS.IAM.Users.Arn	string	The Amazon Resource Name (ARN) that identifies the user.
AWS.IAM.Users.CreateDate	date	The date and time when the user was created.
AWS.IAM.Users.Path	string	The path to the user.
AWS.IAM.Users.PasswordLastUsed	date	The date and time when the password was last used.

Command Example


### aws-iam-update-user

***
Updates the name and/or the path of the specified IAM user.

#### Base Command

`aws-iam-update-user`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| oldUserName | Name of the user to update. | Required |
| newUserName | New name for the user. Include this parameter only if you're changing the user's name. | Optional |
| newPath | New path for the IAM user. Include this parameter only if you're changing the user's path. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-update-user oldUserName=test newUserName=NewUserName34 newPath=/iamtest/```

### aws-iam-delete-user

***
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.

#### Base Command

`aws-iam-delete-user`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user to delete. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-delete-user userName=userName34```

### aws-iam-update-login-profile

***
Changes the password for the specified IAM user.

#### Base Command

`aws-iam-update-login-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user whose password you want to update. | Required |
| newPassword | The new password for the specified IAM user. | Required |
| passwordResetRequired | Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in. Possible values are: True, False. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-update-login-profile userName=userName34 newPassword=ArdVaEC@1#$F%g% passwordResetRequired=True raw-response=true```

### aws-iam-create-group

***
Creates a new iam group.

#### Base Command

`aws-iam-create-group`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| groupName | The name of the group to create. Do not include the path in this value. | Optional |
| path | The path to the group. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Groups.GroupName | string | The friendly name that identifies the group. |
| AWS.IAM.Groups.GroupId | string | The stable and unique string identifying the group. |
| AWS.IAM.Groups.Arn | string | The Amazon Resource Name \(ARN\) specifying the group. |
| AWS.IAM.Groups.CreateDate | date | The date and time when the group was created. |
| AWS.IAM.Groups.Path | string | The path to the group. |

#### Command Example

```!aws-iam-create-group groupName=test path=/testgroups/```

### aws-iam-list-groups

***
Lists all the IAM groups in the AWS account

#### Base Command

`aws-iam-list-groups`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Groups.GroupName | string | The friendly name that identifies the group. |
| AWS.IAM.Groups.GroupId | string | The stable and unique string identifying the group. |
| AWS.IAM.Groups.Arn | string | The Amazon Resource Name \(ARN\) specifying the group. |
| AWS.IAM.Groups.CreateDate | date | The date and time when the group was created. |
| AWS.IAM.Groups.Path | string | The path to the group. |

#### Command Example

```!aws-iam-list-groups```

### aws-iam-list-groups-for-user

***
Lists the IAM groups that the specified IAM user belongs to.

#### Base Command

`aws-iam-list-groups-for-user`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user to list groups for. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Users.Groups.GroupName | string | The friendly name that identifies the group. |
| AWS.IAM.Users.Groups.GroupId | string | The stable and unique string identifying the group |
| AWS.IAM.Users.Groups.Arn | string | The Amazon Resource Name \(ARN\) specifying the group. |
| AWS.IAM.Users.Groups.CreateDate | date | The date and time when the group was created. |
| AWS.IAM.Users.Groups.Path | string | The path to the group. |

#### Command Example

```aws-iam-list-groups-for-user userName=test```

### aws-iam-add-user-to-group

***
Adds the specified user to the specified group.

#### Base Command

`aws-iam-add-user-to-group`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user to add. | Required |
| groupName | The name of the group to update. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-add-user-to-group userName=userName34 groupName=test```

### aws-iam-create-access-key

***
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 .

#### Base Command

`aws-iam-create-access-key`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the IAM user that the new key will belong to. If username is not provided, the account name configured in your integration will be used. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Users.AccessKeys.AccessKeyId | string | The ID for this access key. |
| AWS.IAM.Users.AccessKeys.SecretAccessKey | string | The secret key used to sign requests. |
| AWS.IAM.Users.AccessKeys.Status | string | The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not. |
| AWS.IAM.Users.AccessKeys.CreateDate | date | The date when the access key was created. |

#### Command Example

```!aws-iam-create-access-key userName=userName34```

### aws-iam-update-access-key

***
Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.

#### Base Command

`aws-iam-update-access-key`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user whose key you want to update. If username is not provided, the account name configured in your integration . | Optional |
| accessKeyId | The access key ID of the secret access key you want to update. | Required |
| status | The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used. Possible values are: Active, Inactive. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-update-access-key userName=test accessKeyId=AKIAJSFAUQ7EDFPN7Y2D2A status=Inactive```

### aws-iam-list-access-keys-for-user

***
Returns information about the access key IDs associated with the specified IAM user.

#### Base Command

`aws-iam-list-access-keys-for-user`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Users.AccessKeys.AccessKeyId | string | The ID for this access key. |
| AWS.IAM.Users.AccessKeys.Status | string | The status of the access key. Active means the key is valid for API calls; Inactive means it is not. |
| AWS.IAM.Users.AccessKeys.CreateDate | date | The date when the access key was created. |
| AWS.IAM.Users.AccessKeys.UserName | string | The name of the IAM user that the key is associated with. |

#### Command Example

```!aws-iam-list-access-keys-for-user userName=userName34```

### aws-iam-list-policies

***
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.

#### Base Command

`aws-iam-list-policies`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| scope | The scope to use for filtering the results. To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS account, set Scope to Local. Possible values are: All, AWS, Local. Default is All. | Optional |
| onlyAttached | A flag to filter the results to only the attached policies.  When OnlyAttached is true , the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false , or when the parameter is not included, all policies are returned. Possible values are: True, False. Default is False. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Policies.PolicyName | string | The friendly name \(not ARN\) identifying the policy. |
| AWS.IAM.Policies.PolicyId | string | The stable and unique string identifying the policy. |
| AWS.IAM.Policies.Arn | string | The Amazon Resource Name \(ARN\). |
| AWS.IAM.Policies.Path | string | The path to the policy. |
| AWS.IAM.Policies.DefaultVersionId | string | The identifier for the version of the policy that is set as the default version. |
| AWS.IAM.Policies.IsAttachable | string | Specifies whether the policy can be attached to an IAM user, group, or role. |
| AWS.IAM.Policies.CreateDate | date | when the policy was created. |
| AWS.IAM.Policies.UpdateDate | date | when the policy was last updated. |
| AWS.IAM.Policies.AttachmentCount | number | The number of entities \(users, groups, and roles\) that the policy is attached to. |

#### Command Example

```!aws-iam-list-policies scope=AWS onlyAttached=True```

### aws-iam-list-roles

***
Lists all IAM roles

#### Base Command

`aws-iam-list-roles`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.Roles.CreateDate | date | The date and time when the role was created. |
| AWS.IAM.Roles.Path | string | The path to the role. |
| AWS.IAM.Roles.AssumeRolePolicyDocument | string | The policy that grants an entity permission to assume the role. |
| AWS.IAM.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.Roles.MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. Anyone who uses the AWS CLI or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter. |

#### Command Example

```!aws-iam-list-roles```

### aws-iam-attach-policy

***
Attaches the specified managed policy to the specified IAM Entity.

#### Base Command

`aws-iam-attach-policy`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| type | The Type of IAM Entity. Possible values are: User, Group, Role. | Required |
| entityName | The name (friendly name, not ARN) of the IAM Entity to attach the policy to. | Optional |
| policyArn | The Amazon Resource Name (ARN) of the IAM policy you want to attach. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-attach-policy type=User entityName=userName34 policyArn=arn:aws:iam::aws:policy/AmazonSQSFullAccess```

### aws-iam-detach-policy

***
Removes the specified managed policy from the specified IAM Entity.

#### Base Command

`aws-iam-detach-policy`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| type | IAM Entity Type. Possible values are: User, Group, Role. | Required |
| entityName | The name (friendly name, not ARN) of the IAM Entity to detach the policy from. | Optional |
| policyArn | The Amazon Resource Name (ARN) of the IAM policy you want to detach. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-detach-policy type=User entityName=userName34 policyArn=arn:aws:iam::aws:policy/AmazonSQSFullAccess```

### aws-iam-delete-login-profile

***
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.

#### Base Command

`aws-iam-delete-login-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user whose password you want to delete. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-delete-login-profile userName=userName34```

### aws-iam-delete-group

***
Deletes the specified IAM group. The group must not contain any users or have any attached policies.

#### Base Command

`aws-iam-delete-group`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| groupName | The name of the IAM group to delete. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-delete-group groupName=Group123```

### aws-iam-remove-user-from-group

***
Removes the specified user from the specified group.

#### Base Command

`aws-iam-remove-user-from-group`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the user to remove. | Required |
| groupName | The name of the group to update. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-remove-user-from-group userName=userName34 groupName=Group123```

### aws-iam-create-login-profile

***
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console.

#### Base Command

`aws-iam-create-login-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | The name of the IAM user to create a password for. The user must already exist. | Required |
| password | The new password for the user. | Required |
| passwordResetRequired | Specifies whether the user is required to set a new password on next sign-in. Possible values are: True, False. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-create-login-profile userName=userName34 password=Avd#sdf$12VB6*cvg passwordResetRequired=True```

### aws-iam-delete-access-key

***
Deletes the access key pair associated with the specified IAM user.

#### Base Command

`aws-iam-delete-access-key`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| userName | he name of the user whose access key pair you want to delete. If username is not provided, the account name configured in your integration will be used. | Optional |
| AccessKeyId | The access key ID for the access key ID and secret access key you want to delete. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-delete-access-key userName=userName34 AccessKeyId=ABCDEFGGHDJQ7E7X5PADN7Y2D2A```

### aws-iam-create-instance-profile

***
Creates a new instance profile.

#### Base Command

`aws-iam-create-instance-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| instanceProfileName | The name of the instance profile to create. | Required |
| path | The path to the instance profile. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.InstanceProfiles.Path | string | The path to the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileName | string | The name identifying the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileId | string | The stable and unique string identifying the instance profile. |
| AWS.IAM.InstanceProfiles.Arn | string | The Amazon Resource Name \(ARN\) specifying the instance profile. |
| AWS.IAM.InstanceProfiles.CreateDate | date | The date when the instance profile was created. |

#### Command Example

```!aws-iam-create-instance-profile instanceProfileName=testprofile path=/test/```

### aws-iam-delete-instance-profile

***
Deletes the specified instance profile. The instance profile must not have an associated role.

#### Base Command

`aws-iam-delete-instance-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| instanceProfileName | The name of the instance profile to delete. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-delete-instance-profile instanceProfileName=testprofile```

### aws-iam-list-instance-profiles

***
Lists all the instance profiles tin your AWS account.

#### Base Command

`aws-iam-list-instance-profiles`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.InstanceProfiles.Path | string | The path to the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileName | string | The name identifying the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileId | string | The stable and unique string identifying the instance profile. |
| AWS.IAM.InstanceProfiles.Arn | string | The Amazon Resource Name \(ARN\) specifying the instance profile. |
| AWS.IAM.InstanceProfiles.CreateDate | date | The date when the instance profile was created. |
| AWS.IAM.InstanceProfiles.Roles.Path | string | The path to the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.InstanceProfiles.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.InstanceProfiles.Roles.CreateDate | date | The date and time, when the role was created. |
| AWS.IAM.InstanceProfiles.Roles.AssumeRolePolicyDocument | string | The policy that grants an entity permission to assume the role. |
| AWS.IAM.InstanceProfiles.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.InstanceProfiles.Roles.MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. |

#### Command Example

```!aws-iam-list-instance-profiles```

### aws-iam-add-role-to-instance-profile

***
Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile.

#### Base Command

`aws-iam-add-role-to-instance-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| instanceProfileName | The name of the instance profile to update. | Required |
| roleName | The name of the role to add. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.InstanceProfiles.Path | string | The path to the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileName | string | The name identifying the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileId | string | The stable and unique string identifying the instance profile. |
| AWS.IAM.InstanceProfiles.Arn | string | The Amazon Resource Name \(ARN\) specifying the instance profile. |
| AWS.IAM.InstanceProfiles.CreateDate | date | The date when the instance profile was created. |
| AWS.IAM.InstanceProfiles.Roles.Path | string | The path to the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.InstanceProfiles.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.InstanceProfiles.Roles.CreateDate | date | The date and time, when the role was created. |
| AWS.IAM.InstanceProfiles.Roles.AssumeRolePolicyDocument | string | The policy that grants an entity permission to assume the role. |
| AWS.IAM.InstanceProfiles.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.InstanceProfiles.Roles.MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. |

#### Command Example

```!aws-iam-add-role-to-instance-profile instanceProfileName=testprofile roleName=EC2ReadOnly```

### aws-iam-remove-role-from-instance-profile

***
Removes the specified IAM role from the specified EC2 instance profile.

#### Base Command

`aws-iam-remove-role-from-instance-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| instanceProfileName | The name of the instance profile to update. | Required |
| roleName | The name of the role to remove. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.InstanceProfiles.Path | string | The path to the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileName | string | The name identifying the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileId | string | The stable and unique string identifying the instance profile. |
| AWS.IAM.InstanceProfiles.Arn | string | The Amazon Resource Name \(ARN\) specifying the instance profile. |
| AWS.IAM.InstanceProfiles.CreateDate | date | The date when the instance profile was created. |
| AWS.IAM.InstanceProfiles.Roles.Path | string | The path to the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.InstanceProfiles.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.InstanceProfiles.Roles.CreateDate | date | The date and time, when the role was created. |
| AWS.IAM.InstanceProfiles.Roles.AssumeRolePolicyDocument | string | The policy that grants an entity permission to assume the role. |
| AWS.IAM.InstanceProfiles.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.InstanceProfiles.Roles.MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. |

#### Command Example

```!aws-iam-remove-role-from-instance-profile instanceProfileName=testprofile roleName=EC2ReadOnly```

### aws-iam-list-instance-profiles-for-role

***
Lists the instance profiles that have the specified associated IAM role.

#### Base Command

`aws-iam-list-instance-profiles-for-role`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| roleName | The name of the role to list instance profiles for. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.InstanceProfiles.Path | string | The path to the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileName | string | The name identifying the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileId | string | The stable and unique string identifying the instance profile. |
| AWS.IAM.InstanceProfiles.Arn | string | The Amazon Resource Name \(ARN\) specifying the instance profile. |
| AWS.IAM.InstanceProfiles.CreateDate | date | The date when the instance profile was created. |
| AWS.IAM.InstanceProfiles.Roles.Path | string | The path to the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.InstanceProfiles.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.InstanceProfiles.Roles.CreateDate | date | The date and time, when the role was created. |
| AWS.IAM.InstanceProfiles.Roles.AssumeRolePolicyDocument | string | The policy that grants an entity permission to assume the role. |
| AWS.IAM.InstanceProfiles.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.InstanceProfiles.Roles.MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. |

#### Command Example

```!aws-iam-list-instance-profiles-for-role roleName=EC2ReadOnly```

### aws-iam-get-instance-profile

***
Retrieves information about the specified instance profile.

#### Base Command

`aws-iam-get-instance-profile`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| instanceProfileName | The name of the instance profile to get information about. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.InstanceProfiles.Path | string | The path to the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileName | string | The name identifying the instance profile. |
| AWS.IAM.InstanceProfiles.InstanceProfileId | string | The stable and unique string identifying the instance profile. |
| AWS.IAM.InstanceProfiles.Arn | string | The Amazon Resource Name \(ARN\) specifying the instance profile. |
| AWS.IAM.InstanceProfiles.CreateDate | date | The date when the instance profile was created. |
| AWS.IAM.InstanceProfiles.Roles.Path | string | The path to the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.InstanceProfiles.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.InstanceProfiles.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.InstanceProfiles.Roles.CreateDate | date | The date and time, when the role was created. |
| AWS.IAM.InstanceProfiles.Roles.AssumeRolePolicyDocument | string | The policy that grants an entity permission to assume the role. |
| AWS.IAM.InstanceProfiles.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.InstanceProfiles.Roles. MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. |

#### Command Example

```!aws-iam-get-instance-profile instanceProfileName=testprofile```

### aws-iam-get-role

***
Retrieves information about the specified role.

#### Base Command

`aws-iam-get-role`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| roleName | The name of the IAM role to get information about. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Roles.Path | string | The path to the role. |
| AWS.IAM.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.Roles.CreateDate | date | The date and time, when the role was created. |
| AWS.IAM.Roles.AssumeRolePolicyDocument | string | The policy that grants an entity permission to assume the role. |
| AWS.IAM.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.Roles.MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. |
| AWS.IAM.Roles.Tags.Key | string | The tag key. |
| AWS.IAM.Roles.Tags.Value | string | The tag value. |

#### Command Example

```!aws-iam-get-role roleName=ec2readonly```

### aws-iam-delete-role

***
Deletes the specified role. The role must not have any policies attached.

#### Base Command

`aws-iam-delete-role`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| roleName | The name of the role to delete. | Required |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

There is no context output for this command.

#### Command Example

```!aws-iam-delete-role roleName=test-role```

### aws-iam-create-role

***
Creates a new role for your AWS account.

#### Base Command

`aws-iam-create-role`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| roleName | The name of the role to create. | Required |
| assumeRolePolicyDocument | The trust relationship policy document that grants an entity permission to assume the role. | Required |
| path | The path to the role. | Optional |
| description | A description of the role. | Optional |
| maxSessionDuration | The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. | Optional |
| roleArn | The Amazon Resource Name (ARN) of the role to assume. | Optional |
| roleSessionName | An identifier for the assumed role session. | Optional |
| roleSessionDuration | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. | Optional |

#### Context Output

| **Path** | **Type** | **Description** |
| --- | --- | --- |
| AWS.IAM.Roles.RoleName | string | The friendly name that identifies the role. |
| AWS.IAM.Roles.RoleId | string | The stable and unique string identifying the role. |
| AWS.IAM.Roles.Arn | string | The Amazon Resource Name \(ARN\) specifying the role. |
| AWS.IAM.Roles.CreateDate | date | The date and time, when the role was created. |
| AWS.IAM.Roles.Path | string | The path to the role. |
| AWS.IAM.Roles.AssumeRolePolicyDocument | string | he policy that grants an entity permission to assume the role. |
| AWS.IAM.Roles.Description | string | A description of the role that you provide. |
| AWS.IAM.Roles.MaxSessionDuration | number | The maximum session duration \(in seconds\) for the specified role. |

#### Command Example

!aws-iam-create-role roleName=testrole assumeRolePolicyDocument="{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "ec2.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}" description="a test role"   ```

aws-iam-create-policy

Creates a new managed policy for your AWS account. This operation creates a policy version with a version identifier of v1 and sets v1 as the policy’s default version.

Base Command

aws-iam-create-policy

Input

Argument Name	Description	Required
policyName	The friendly name of the policy.	Required
policyDocument	The JSON policy document that you want to use as the content for the new policy.	Required
path	The path for the policy.	Optional
description	A friendly description of the policy.	Optional
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

Path	Type	Description
AWS.IAM.Policies.PolicyName	string	The friendly name (not ARN) identifying the policy.
AWS.IAM.Policies.PolicyId	string	The stable and unique string identifying the policy.
AWS.IAM.Policies.Arn	string	The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
AWS.IAM.Policies.Path	string	The path to the policy.
AWS.IAM.Policies.DefaultVersionId	string	The identifier for the version of the policy that is set as the default version.
AWS.IAM.Policies.AttachmentCount	number	The number of entities (users, groups, and roles) that the policy is attached to.
AWS.IAM.Policies.PermissionsBoundaryUsageCount	number	The number of entities (users and roles) for which the policy is used to set the permissions boundary.
AWS.IAM.Policies.IsAttachable	boolean	Specifies whether the policy can be attached to an IAM user, group, or role.
AWS.IAM.Policies.Description	string	A friendly description of the policy.
AWS.IAM.Policies.CreateDate	date	The date and time, in ISO 8601 date-time format , when the policy was created.
AWS.IAM.Policies.UpdateDate	date	The date and time, in ISO 8601 date-time format , when the policy was last updated.

Command Example

!aws-iam-create-policy policyName=test-policy policyDocument="{  
"Version": "2012-10-17",  
"Statement": \[  
{  
"Sid": "VisualEditor0",  
"Effect": "Allow",  
"Action": "guardduty:CreateIPSet",  
"Resource": "arn:aws:guardduty:_:_:detector/_"  
},  
{  
"Sid": "VisualEditor1",  
"Effect": "Allow",  
"Action": "guardduty:CreateDetector",  
"Resource": "_"  
}  
\]  
}"

aws-iam-delete-policy

Deletes the specified managed policy. Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition you must delete all the policy’s versions.

Base Command

aws-iam-delete-policy

Input

Argument Name	Description	Required
policyArn	The Amazon Resource Name (ARN) of the IAM policy you want to delete.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

There is no context output for this command.

Command Example

!aws-iam-delete-policy policyArn=arn:aws:iam::123456789:policy/test-policy

aws-iam-create-policy-version

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version. Optionally, you can set the new version as the policy’s default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

Base Command

aws-iam-create-policy-version

Input

Argument Name	Description	Required
policyArn	The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.	Required
policyDocument	The JSON policy document that you want to use as the content for this new version of the policy.	Required
setAsDefault	Specifies whether to set this version as the policy’s default version. Possible values are: True, False.	Optional
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

Path	Type	Description
AWS.IAM.Policies.Versions.Document	string	The policy document.
AWS.IAM.Policies.Versions.VersionId	string	The identifier for the policy version.
AWS.IAM.Policies.Versions.IsDefaultVersion	string	The identifier for the policy version.
AWS.IAM.Policies.Versions.CreateDate	string	The date and time, in ISO 8601 date-time format , when the policy version was created.

Command Example

!aws-iam-create-policy-version policyArn=arn:aws:iam::123456789:policy/test-policy policyDocument="{  
"Version": "2012-10-17",  
"Statement": \[  
{  
"Sid": "VisualEditor0",  
"Effect": "Allow",  
"Action": "guardduty:CreateIPSet",  
"Resource": "arn:aws:guardduty:_:_:detector/_"  
},  
{  
"Sid": "VisualEditor1",  
"Effect": "Allow",  
"Action": "guardduty:CreateDetector",  
"Resource": "_"  
}  
\]  
}" setAsDefault=True

aws-iam-delete-policy-version

Deletes the specified version from the specified managed policy. You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy . To find out which version of a policy is marked as the default version, use ListPolicyVersions .

Base Command

aws-iam-delete-policy-version

Input

Argument Name	Description	Required
policyArn	The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.	Required
versionId	The policy version to delete.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

There is no context output for this command.

Command Example

!aws-iam-delete-policy-version policyArn=arn:aws:iam::123456789:policy/test-policy versionId=v1

aws-iam-list-policy-versions

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy’s default version.

Base Command

aws-iam-list-policy-versions

Input

Argument Name	Description	Required
policyArn	The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.	Required

Context Output

Path	Type	Description
AWS.IAM.Policies.Versions.Document	string	The policy document.
AWS.IAM.Policies.Versions.VersionId	string	The identifier for the policy version.
AWS.IAM.Policies.Versions.IsDefaultVersion	boolean	Specifies whether the policy version is set as the policy’s default version.
AWS.IAM.Policies.Versions.CreateDate	date	The date and time, in ISO 8601 date-time format , when the policy version was created.

Command Example

!aws-iam-list-policy-versions policyArn=arn:aws:iam::123456789:policy/test-policy

aws-iam-get-policy-version

Retrieves information about the specified version of the specified managed policy, including the policy document.

Base Command

aws-iam-get-policy-version

Input

Argument Name	Description	Required
policyArn	The Amazon Resource Name (ARN) of the managed policy that you want information about.	Required
versionId	Identifies the policy version to retrieve.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

Path	Type	Description
AWS.IAM.Policies.Versions.Document	unknown	The policy document.
AWS.IAM.Policies.Versions.VersionId	unknown	The identifier for the policy version.
AWS.IAM.Policies.Versions.IsDefaultVersion	unknown	Specifies whether the policy version is set as the policy’s default version.
AWS.IAM.Policies.Versions.CreateDate	unknown	The date and time, in ISO 8601 date-time format , when the policy version was created.

Command Example

!aws-iam-get-policy-version policyArn=arn:aws:iam::123456789:policy/test-policy versionId=v3

aws-iam-set-default-policy-version

Sets the specified version of the specified policy as the policy’s default (operative) version. This operation affects all users, groups, and roles that the policy is attached to.

Base Command

aws-iam-set-default-policy-version

Input

Argument Name	Description	Required
policyArn	The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.	Required
versionId	The version of the policy to set as the default (operative) version.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

There is no context output for this command.

Command Example

!aws-iam-set-default-policy-version policyArn=arn:aws:iam::123456789:policy/test-policy versionId=v2

aws-iam-create-account-alias

Creates an alias for your AWS account.

Base Command

aws-iam-create-account-alias

Input

Argument Name	Description	Required
accountAlias	The account alias to create.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

There is no context output for this command.

Command Example

!aws-iam-create-account-alias accountAlias=test-alias

aws-iam-delete-account-alias

Deletes the specified AWS account alias.

Base Command

aws-iam-delete-account-alias

Input

Argument Name	Description	Required
accountAlias	The name of the account alias to delete.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

There is no context output for this command.

Command Example

!aws-iam-delete-account-alias accountAlias=demisto-test-alias

aws-iam-get-account-password-policy

Get AWS account’s password policy

Base Command

aws-iam-get-account-password-policy

Input

| Argument Name | Description | Required |
| — | — | — |

Context Output

Path	Type	Description
AWS.IAM.PasswordPolicy	Unknown	Account’s password policy.

aws-iam-update-account-password-policy

Create/update password policy

Base Command

aws-iam-update-account-password-policy

Input

Argument Name	Description	Required
minimumPasswordLength	The minimum number of characters allowed in an IAM user password. Possible values are: .	Optional
requireSymbols	Specifies whether IAM user passwords must contain at least one of the non-alphanumeric characters. Can be “True” or “False”. Possible values are: True, False.	Optional
requireNumbers	Specifies whether IAM user passwords must contain at least one numeric character (0 to 9). Can be “True” or “False”. Possible values are: True, False.	Optional
requireUppercaseCharacters	Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). Can be “True” or “False”. Possible values are: True, False.	Optional
requireLowercaseCharacters	Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). Can be “True” or “False”. Possible values are: True, False.	Optional
allowUsersToChangePassword	Allows all IAM users in your account to use the AWS Management Console to change their own passwords. Can be “True” or “False”. Possible values are: True, False.	Optional
maxPasswordAge	The number of days that an IAM user password is valid. Possible values are: .	Optional
passwordReusePrevention	Specifies the number of previous passwords that IAM users are prevented from reusing. Possible values are: .	Optional
hardExpiry	Prevents IAM users from setting a new password after their password has expired. Can be “True” or “False”. Possible values are: True, False.	Optional

Context Output

There is no context output for this command.

aws-iam-list-role-policies

Lists the names of the inline policies that are embedded in the specified IAM role.

Base Command

aws-iam-list-role-policies

Input

Argument Name	Description	Required
roleName	The name of the role to list policies for.	Required

Context Output

Path	Type	Description
AWS.IAM.Roles.RoleName.Policies	Unknown	A list of policy names.

Command Example

!aws-iam-list-role-policies roleName=test-RoleARN

aws-iam-get-role-policy

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Base Command

aws-iam-get-role-policy

Input

Argument Name	Description	Required
roleName	The name of the role associated with the policy.	Required
policyName	The name of the policy document to get.	Required

Context Output

Path	Type	Description
AWS.IAM.Roles.PolicyDocument	string	The policy document.

Command Example

!aws-iam-get-role-policy roleName=test-RoleARN policyName=testPolicy

aws-iam-get-policy

Retrieves information about the specified managed policy, including the policy’s default version and the total number of
IAM users, groups, and roles to which the policy is attached.

Base Command

aws-iam-get-policy

Input

Argument Name	Description	Required
policyName	The Amazon Resource Name (ARN) of the managed policy that you want information about.	Required

Context Output

Path	Type	Description
AWS.IAM.Policy.PolicyName	string	The friendly name (not ARN) identifying the policy.
AWS.IAM.Policy.PolicyId	string	The stable and unique string identifying the policy.
AWS.IAM.Policy.Arn	string	The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
AWS.IAM.Policy.Path	string	The path to the policy.
AWS.IAM.Policy.Description	string	A friendly description of the policy.

Command Example

!aws-iam-get-policy policyName=testPolicy

aws-iam-list-user-policies

Lists the names of the inline policies embedded in the specified IAM user.

Base Command

aws-iam-list-user-policies

Input

Argument Name	Description	Required
userName	The name (friendly name, not ARN) of the user to list inline policies for.	Required
limit	Number of results to display. Default value is 50.	Optional
page	Page number you would like to view. Each page contains page_size values. Must be used along with page_size.	Optional
page_size	Number of results per page to display.	Optional
marker	Starting item of the next page to view. Can be retrieved from context (AttachedPoliciesMarker).	Optional

Context Output

Path	Type	Description
AWS.IAM.UserPolicies.UserName	string	A list of the user’s inline policy names.
AWS.IAM.UserPolicies.PolicyName	string	The name of the policy.
AWS.IAM.Users.InlinePoliciesMarker	string	First element of next page of items.

Command Example

!aws-iam-list-user-policies userName=testUser

aws-iam-list-attached-user-polices

Lists all managed policies that are attached to the specified IAM user.

Base Command

aws-iam-list-attached-user-policies

Input

Argument Name	Description	Required
userName	The name (friendly name, not ARN) of the user to list attached policies for.	Required
limit	Number of results to display. Default value is 50.	Optional
page	Page number you would like to view. Each page contains page_size values. Must be used along with page_size.	Optional
page_size	Number of results per page to display.	Optional
marker	Starting item of the next page to view. Can be retrieved from context (AttachedPoliciesMarker).	Optional

Context Output

Path	Type	Description
AWS.IAM.AttachedUserPolicies.UserName	string	The name (friendly name, not ARN) of the user to list attached policies for.
AWS.IAM.AttachedUserPolicies.PolicyName	string	Policy Name
AWS.IAM.AttachedUserPolicies.PolicyArn	string	The Amazon Resource Name (ARN) of the attached policy.
AWS.IAM.Users.AttachedPoliciesMarker	string	First element of next page of items.

Command Example

!aws-iam-list-attached-user-policies userName=testUser

aws-iam-list-attached-group-policies

Lists all managed policies that are attached to the specified IAM group.

Base Command

aws-iam-list-attached-group-policies

Input

Argument Name	Description	Required
groupName	The name (friendly name, not ARN) of the group to list attached policies for.	Required
limit	Number of results to display. Default value is 50.	Optional
page	Page number you would like to view. Each page contains page_size values. Must be used along with page_size.	Optional
page_size	Number of results per page to display.	Optional
marker	Starting item of the next page to view. Can be retrieved from context (AttachedPoliciesMarker).	Optional

Context Output

Path	Type	Description
AWS.IAM.AttachedGroupPolicies.GroupName	string	The name (friendly name, not ARN) of the group to list attached policies for.
AWS.IAM.AttachedGroupPolicies.PolicyName	string	Policy Name
AWS.IAM.AttachedGroupPolicies.PolicyArn	string	The Amazon Resource Name (ARN) of the attached policy.
AWS.IAM.Groups.AttachedPoliciesMarker	string	First element of next page of items.

Command Example

!aws-iam-list-attached-group-policies groupName=testGroup

aws-iam-get-user-login-profile

Lists all managed policies that are attached to the specified IAM user.

Base Command

aws-iam-get-user-login-profile

Input

Argument Name	Description	Required
userName	The name (friendly name, not ARN) of the user to retrieve login profile for.	Required

Context Output

Path	Type	Description
AWS.IAM.Users.LoginProfile.CreateDate	date	The date when the password for the user was created.
AWS.IAM.Users.LoginProfile.PasswordResetRequired	boolean	Specifies whether the user is required to set a new password on next sign-in.

Command Example

!aws-iam-get-user-login-profile userName=testUser

aws-iam-put-role-policy

Adds or updates an inline policy document that is embedded in the specified IAM role.

Base Command

aws-iam-put-role-policy

Input

Argument Name	Description	Required
policyDocument	The policy document. You must provide policies in JSON format in IAM.	Required
policyName	The name of the policy document.	Required
roleName	The name of the role to associate the policy with.	Required

Human Readable Output

Policy {policy_name} was added to role {role_name}

Context Output

There is no context output for this command.

aws-iam-put-user-policy

Adds or updates an inline policy document that is embedded in the specified IAM user.

Base Command

aws-iam-put-user-policy

Input

Argument Name	Description	Required
policyDocument	The policy document. You must provide policies in JSON format in IAM.	Required
policyName	The name of the policy document.	Required
userName	The name of the user to associate the policy with.	Required

Context Output

There is no context output for this command.

Human Readable Output

Policy {policy_name} was added to role {user_name}

aws-iam-put-group-policy

Adds or updates an inline policy document that is embedded in the specified IAM group.

Base Command

aws-iam-put-group-policy

Input

Argument Name	Description	Required
policyDocument	The policy document. You must provide policies in JSON format in IAM.	Required
policyName	The name of the policy document.	Required
groupName	The name of the group to associate the policy with.	Required

Context Output

There is no context output for this command.

Human Readable Output

Policy {policy_name} was added to role {group_name}

aws-iam-tag-role

Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.

Base Command

aws-iam-tag-role

Input

Argument Name	Description	Required
roleName	The name of the IAM role to which you want to add tags.	Required
tags	A comma-separated list of Key:Value tag objects.	Required

Context Output

There is no context output for this command.

Human Readable Output

Added the following tags to role {role_name}

Key	Value
Key	Value

aws-iam-tag-user

Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.

Base Command

aws-iam-tag-user

Input

Argument Name	Description	Required
userName	The name of the IAM user to which you want to add tags.	Required
tags	A comma-separated list of Key:Value tag objects.	Required

Context Output

There is no context output for this command.

Human Readable Output

Added the following tags to user {user_name}

Key	Value
Key	Value

aws-iam-untag-user

Removes the specified tags from the user.

Base Command

aws-iam-untag-user

Input

Argument Name	Description	Required
userName	The name of the IAM role to which you want to untag.	Required
tagKeys	A comma-separated list of tag keys.	Required

Context Output

There is no context output for this command.

Human Readable Output

Untagged the following tags from user {user_name}

Removed keys
Key1

aws-iam-untag-role

Removes the specified tags from the role.

Base Command

aws-iam-untag-role

Input

Argument Name	Description	Required
roleName	The name of the IAM role to which you want to untag.	Required
tagKeys	A comma-separated list of tag keys.	Required

Context Output

There is no context output for this command.

Human Readable Output

Untagged the following tags from role {role_name}

Removed keys
Key1

aws-iam-get-access-key-last-used

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.

Base Command

aws-iam-get-access-key-last-used

Input

Argument Name	Description	Required
accessKeyId	The identifier of an access key.	Required

Context Output

Path	Type	Description
AWS.IAM.AccessKey.ID	string	The access key ID.
AWS.IAM.AccessKey.UserName	string	The username owning the given access key.
AWS.IAM.AccessKey.LastUsedServiceName	string	The name of the service that last used the given access key.
AWS.IAM.AccessKey.LastUsedRegion	string	The name of the region where the given access key was last used.
AWS.IAM.AccessKey.LastUsedDate	string	The date when the given access key was last used.

Human Readable Output

Found the following information about access key access_Key_Id

ID	UserName	LastUsedDate	LastUsedServiceName	LastUsedRegion
access_Key_Id	user_name	2023-06-06T14:32:00	test	Here

aws-iam-list-attached-role-policies

List all managed policies that are attached to the specified IAM role.

Base Command

aws-iam-list-attached-role-policies

Input

Argument Name	Description	Required
roleName	The name (friendly name, not ARN) of the role to list attached policies for.	Required
pathPrefix	The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.	Optional
maxItems	The maximum number of items to return in the command’s output.	Optional
marker	Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.	Optional

Context Output

Path	Type	Description
AWS.IAM.Roles.AttachedPolicies.Policies.PolicyName	string	The policy name.
AWS.IAM.Roles.AttachedPolicies.Policies.PolicyArn	string	The policy ARN.
AWS.IAM.Roles.AttachedPolicies.Policies.RoleName	string	The queried role name.
AWS.IAM.Roles.AttachedPolicies.Query.IsTruncated	Boolean	Whether there are more items to return. If the results were truncated, make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. AWS recommends checking IsTruncated after every call to ensure that all results are received.
AWS.IAM.Roles.AttachedPolicies.Query.Marker	string	When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Command example

!aws-iam-list-attached-role-policies roleName=myRoleName

Context Example

{
    "AWS": {
        "IAM": {
            "Roles": {
                "AttachedPolicies": {
                    "Policies": [
                        {
                            "PolicyArn": "arn:aws:iam::000000000000:policy/my-policy",
                            "PolicyName": "my-policy-name",
                            "RoleName": "myRoleName"
                        },
                        {
                            "PolicyArn": "arn:aws:iam::000000000001:policy/my-other-policy",
                            "PolicyName": "my-other-policy-name",
                            "RoleName": "myRoleName"
                        }
                    ],
                    "Query": {
                        "IsTruncated": false
                    }
                }
            }
        }
    }
}

Human Readable Output

Results

Attached Policies for Role myRoleName

PolicyArn	PolicyName	RoleName
arn:aws:iam::000000000000:policy/my-policy	my-policy-name	myRoleName
arn:aws:iam::000000000001:policy/my-other-policy	my-other-policy-name	myRoleName

Listed 2 attached policies for role test-role

aws-iam-list-mfa-devices

Lists the MFA devices for an IAM user.

Base Command

aws-iam-list-mfa-devices

Input

Argument Name	Description	Required
userName	The name of the user whose MFA devices you want to list.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional
marker	Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.	Optional

Context Output

Path	Type	Description
AWS.IAM.MFADevices.Devices.UserName	string	The user with whom the MFA device is associated.
AWS.IAM.MFADevices.Devices.SerialNumber	string	The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
AWS.IAM.MFADevices.Devices.EnableDate	date	The date when the MFA device was enabled for the user.
MFADevices.Devices.Marker	string	First element of next page of items.

aws-iam-delete-mfa-devices

Deletes a virtual MFA device.

Base Command

aws-iam-delete-mfa-devices

Input

Argument Name	Description	Required
serialNumber	The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

There is no context output for this command.

aws-iam-deactivate-mfa-devices

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

Base Command

aws-iam-deactivate-mfa-devices

Input

Argument Name	Description	Required
userName	The name of the user whose MFA devices you want to list.	Required
serialNumber	The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.	Required
roleArn	The Amazon Resource Name (ARN) of the role to assume.	Optional
roleSessionName	An identifier for the assumed role session.	Optional
roleSessionDuration	The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role.	Optional

Context Output

There is no context output for this command.

Configuration parameters

roleArn — Role Arn
roleSessionName — Role Session Name
defaultRegion — AWS Default Region (required)
sessionDuration — Role Session Duration
credentials — Access Key
access_key — Access Key
secret_key — Secret Key
timeout — Timeout
retries — Retries
sts_regional_endpoint — AWS STS Regional Endpoints
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings

Commands (66)

aws-iam-access-key-update-quick-action
Immediately disables a specific IAM access key. This stops all CLI, SDK, and API-based communication for this key ID without deleting it, enabling forensic recovery or re-enabling if the key is found to be safe.
aws-iam-account-password-policy-update-quick-action
Updates the password policy to require a minimum length of 14 characters, at least one lowercase letter, one uppercase letter, one symbol. Allows users to reset password, disallow reuse of the last 24 passwords and set password expiration to 90 days. It runs the aws-iam-update-account-password-policy CLI command in your AWS environment and requires the 'iam:UpdateAccountPasswordPolicy' permission.
aws-iam-add-role-to-instance-profile
Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile.
aws-iam-add-user-to-group
Adds the specified user to the specified group.
aws-iam-attach-policy
Attaches the specified managed policy to the specified IAM Entity.
aws-iam-create-access-key
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 .
aws-iam-create-account-alias
Creates an alias for your AWS account.
aws-iam-create-group
Creates a new iam group.
aws-iam-create-instance-profile
Creates a new instance profile.
aws-iam-create-login-profile
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console.
aws-iam-create-policy
Creates a new managed policy for your AWS account. This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version.
aws-iam-create-policy-version
Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version. Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
aws-iam-create-role
Creates a new role for your AWS account.
aws-iam-create-user
Creates a new IAM user for your AWS account.
aws-iam-deactivate-mfa-devices
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
aws-iam-delete-access-key
Deletes the access key pair associated with the specified IAM user.
aws-iam-delete-account-alias
Deletes the specified AWS account alias.
aws-iam-delete-group
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
aws-iam-delete-instance-profile
Deletes the specified instance profile. The instance profile must not have an associated role.
aws-iam-delete-login-profile
Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.
aws-iam-delete-mfa-devices
Deletes a virtual MFA device.
aws-iam-delete-policy
Deletes the specified managed policy. Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition you must delete all the policy's versions.
aws-iam-delete-policy-version
Deletes the specified version from the specified managed policy. You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy . To find out which version of a policy is marked as the default version, use ListPolicyVersions .
aws-iam-delete-role
Deletes the specified role. The role must not have any policies attached.
aws-iam-delete-user
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
aws-iam-detach-policy
Removes the specified managed policy from the specified IAM Entity.
aws-iam-get-access-key-last-used
Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.
aws-iam-get-account-password-policy
Get AWS account's password policy.
aws-iam-get-instance-profile
Retrieves information about the specified instance profile.
aws-iam-get-policy
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached.
aws-iam-get-policy-version
Retrieves information about the specified version of the specified managed policy, including the policy document.
aws-iam-get-role
Retrieves information about the specified role.
aws-iam-get-role-policy
Retrieves the specified inline policy document that is embedded with the specified IAM role.
aws-iam-get-user
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
aws-iam-get-user-login-profile
Retrieves the user login profile information for AWS management consle.
aws-iam-list-access-keys-for-user
Returns information about the access key IDs associated with the specified IAM user.
aws-iam-list-attached-group-policies
Lists all managed policies that are attached to the specified IAM group.
aws-iam-list-attached-role-policies
List all managed policies that are attached to the specified IAM role.
aws-iam-list-attached-user-policies
Lists all managed policies that are attached to the specified IAM user.
aws-iam-list-groups
Lists all the IAM groups in the AWS account.
aws-iam-list-groups-for-user
Lists the IAM groups that the specified IAM user belongs to.
aws-iam-list-instance-profiles
Lists all the instance profiles tin your AWS account.
aws-iam-list-instance-profiles-for-role
Lists the instance profiles that have the specified associated IAM role.
aws-iam-list-mfa-devices
Lists the MFA devices for an IAM user.
aws-iam-list-policies
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.
aws-iam-list-policy-versions
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
aws-iam-list-role-policies
Lists the names of the inline policies that are embedded in the specified IAM role.
aws-iam-list-roles
Lists all IAM roles.
aws-iam-list-user-policies
Lists the names of the inline policies embedded in the specified IAM user.
aws-iam-list-users
Lists the IAM users, returns all users in the AWS account.
aws-iam-login-profile-delete-quick-action
Permanently deletes the IAM user's password (login profile). This prevents the user from signing into the AWS Management Console but does not deactivate their programmatic access keys or delete the IAM user itself.
aws-iam-put-group-policy
Adds or updates an inline policy document that is embedded in the specified IAM group.
aws-iam-put-role-policy
Adds or updates an inline policy document that is embedded in the specified IAM role.
aws-iam-put-user-policy
Adds or updates an inline policy document that is embedded in the specified IAM user.
aws-iam-remove-role-from-instance-profile
Removes the specified IAM role from the specified EC2 instance profile.
aws-iam-remove-user-from-group
Removes the specified user from the specified group.
aws-iam-set-default-policy-version
Sets the specified version of the specified policy as the policy's default (operative) version. This operation affects all users, groups, and roles that the policy is attached to.
aws-iam-tag-role
Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.
aws-iam-tag-user
Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.
aws-iam-untag-role
Removes the specified tags from the role.
aws-iam-untag-user
Removes the specified tags from the user.
aws-iam-update-access-key
Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.
aws-iam-update-account-password-policy
Create/update password policy.
aws-iam-update-login-profile
Changes the password for the specified IAM user.
aws-iam-update-user
Updates the name and/or the path of the specified IAM user.
aws-iam-user-policy-put-quick-action
Attaches an inline "Deny All" policy for the specified IAM user, effectively blocking the user from performing any actions on all AWS resources.

Source

AWS-IAM.py AWS-IAM_test.py AWS-IAM.yml AWS-IAM_description.md

Download History Raw

import datetime
import importlib

import demistomock as demisto
import pytest
from pytest_mock import MockerFixture

AWS_IAM = importlib.import_module("AWS-IAM")

ATTACHED_POLICIES = [{"PolicyName": "AdministratorAccess", "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess"}]

ATTACHED_RESPONSE = {"AttachedPolicies": ATTACHED_POLICIES, "IsTruncated": True, "Marker": "111"}

PAGINATION_CHECK = [
    ({"userName": "test"}, ["AllAccessPolicy", "KeyPolicy"]),
    ({"userName": "test", "page": 2, "page_size": 1, "marker": "111"}, ["KeyPolicy"]),
]

ARG_LIST = [
    ({"limit": "2", "page_size": "3"}, 2, False, 3),
    ({"page_size": "3", "page": "4"}, 12, True, 3),
    ({}, 50, False, None),
]


class Boto3Client:
    def list_user_policies(self):
        pass

    def list_attached_user_policies(self):
        pass

    def list_attached_group_policies(self):
        pass

    def get_login_profile(self):
        pass

    def put_group_policy(self):
        pass

    def put_user_policy(self):
        pass

    def put_role_policy(self):
        pass

    def tag_role(self):
        pass

    def tag_user(self):
        pass

    def untag_role(self):
        pass

    def untag_user(self):
        pass

    def get_access_key_last_used(self):
        pass

    def get_user(self):
        pass

    def list_attached_role_policies(self):
        pass

    def deactivate_mfa_device(self):
        pass

    def delete_virtual_mfa_device(self):
        pass

    def list_mfa_devices(self):
        pass

    @property
    def exceptions(self):
        raise NoSuchEntityException


class Mock_Exceptions(BaseException):
    def NoSuchEntityException(self, UserName):
        raise NoSuchEntityException


class NoSuchEntityException(BaseException):
    pass


@pytest.mark.parametrize("args, res", PAGINATION_CHECK)
def test_list_user_policies(mocker, args, res):
    """

    Given:
    - user_name - user name to retrieve policies for.
    - pagination args - combination of marker, limit, page and page_size args in order to control pagination.

    When:
    - After running a list_user_policies command

    Then:
    - Ensure that the returned list includes only the policies the user posses.
    """

    response = {"PolicyNames": ["AllAccessPolicy", "KeyPolicy"], "IsTruncated": True, "Marker": "111"}

    policy_data = []
    for policy in res:
        policy_data.append(
            {
                "UserName": "test",
                "PolicyName": policy,
            }
        )

    mocker.patch.object(Boto3Client, "list_user_policies", return_value=response)
    mocker.patch.object(demisto, "results")

    client = Boto3Client()
    AWS_IAM.list_user_policies(args, client)
    contents = demisto.results.call_args[0][0]

    assert "AWS IAM Policies for user test" in contents.get("HumanReadable")
    assert policy_data in contents.get("EntryContext").values()
    assert response.get("Marker") in contents.get("EntryContext").values()


def test_list_attached_user_polices(mocker):
    """

    Given:
    - user_name - user name to retrieve policies for.
    - pagination args - combination of marker, limit, page and page_size args in order to control pagination.

    When:
    - After running a list_user_attached_policies command

    Then:
    - Ensure that the returned list includes only the attached policies the user posses.
    """
    args = {"userName": "test"}

    policy_name = ATTACHED_POLICIES[0].get("PolicyName")
    policy_arn = ATTACHED_POLICIES[0].get("PolicyArn")

    mocker.patch.object(Boto3Client, "list_attached_user_policies", return_value=ATTACHED_RESPONSE)
    mocker.patch.object(demisto, "results")

    client = Boto3Client()
    AWS_IAM.list_attached_user_policies(args, client)
    contents = demisto.results.call_args[0][0]

    assert "AWS IAM Attached Policies for user test" in contents.get("HumanReadable")
    assert [{"UserName": "test", "PolicyName": policy_name, "PolicyArn": policy_arn}] in contents.get("EntryContext").values()
    assert "111" in contents.get("EntryContext").values()


def test_list_attached_group_polices(mocker):
    """

     Given:
    - group_name - group name to retrieve policies for.
    - pagination args - combination of marker, limit, page and page_size args in order to control pagination.

    When:
    - After running a list_group_attached_policies command

    Then:
    - Ensure that the returned list includes only the attached policies the group posses.
    """
    args = {"groupName": "test"}

    policy_name = ATTACHED_POLICIES[0].get("PolicyName")
    policy_arn = ATTACHED_POLICIES[0].get("PolicyArn")

    mocker.patch.object(Boto3Client, "list_attached_group_policies", return_value=ATTACHED_RESPONSE)
    mocker.patch.object(demisto, "results")

    client = Boto3Client()
    AWS_IAM.list_attached_group_policies(args, client)
    contents = demisto.results.call_args[0][0]

    assert "AWS IAM Attached Policies for group test" in contents.get("HumanReadable")
    assert [{"GroupName": "test", "PolicyName": policy_name, "PolicyArn": policy_arn}] in contents.get("EntryContext").values()
    assert "111" in contents.get("EntryContext").values()


def test_get_user_login_profile(mocker):
    """
     Given:
    - user_name - user name to retrieve login profile for.

    When:
    - After running a get_user_login_profile command

    Then:
    - Ensure that the returned profile set correctly.
    """
    res = {
        "LoginProfile": {
            "UserName": "test",
            "CreateDate": datetime.datetime(2021, 11, 7, 15, 55, 3),
            "PasswordResetRequired": False,
        }
    }
    args = {"userName": "test"}

    data = {"UserName": "test", "LoginProfile": {"CreateDate": "2021-11-07 15:55:03", "PasswordResetRequired": False}}

    mocker.patch.object(Boto3Client, "get_login_profile", return_value=res)
    mocker.patch.object(demisto, "results")

    client = Boto3Client()
    AWS_IAM.get_user_login_profile(args, client)
    contents = demisto.results.call_args[0][0]

    assert "AWS IAM Login Profile for user test" in contents.get("HumanReadable")
    assert data in contents.get("EntryContext").values()


@pytest.mark.parametrize("args, limit, is_manual, page_size", ARG_LIST)
def test_get_limit(args, limit, is_manual, page_size):
    res_limit, res_is_manual, res_page_size = AWS_IAM.get_limit(args)

    assert res_limit == limit
    assert res_is_manual == is_manual
    assert res_page_size == page_size


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr",
    [
        (
            {"policyDocument": "policy_doc", "policyName": "policy_name", "roleName": "role_name"},
            {"ResponseMetadata": {"HTTPStatusCode": 200}},
            "Policy policy_name was added to role role_name",
        )
    ],
)
def test_put_role_policy_command(args, mocked_res, expected_hr, mocker):
    """
     Given:
    - args with policyDocument,  policyName, and roleName.

    When:
    - Calling put_role_policy_command.

    Then:
    - Ensure that the right header appears in the human readable results.
    """
    mocker.patch.object(Boto3Client, "put_role_policy", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.put_role_policy_command(args, client)
    assert expected_hr in cr_obj.readable_output


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr",
    [
        (
            {"policyDocument": "policy_doc", "policyName": "policy_name", "userName": "user_name"},
            {"ResponseMetadata": {"HTTPStatusCode": 200}},
            "Policy policy_name was added to user user_name",
        )
    ],
)
def test_put_user_policy_command(args, mocked_res, expected_hr, mocker):
    """
     Given:
    - args with policyDocument,  policyName, and userName.

    When:
    - Calling _put_user_policy_command.

    Then:
    - Ensure that the right header appears in the human readable results.
    """
    mocker.patch.object(Boto3Client, "put_user_policy", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.put_user_policy_command(args, client)
    assert expected_hr in cr_obj.readable_output


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr",
    [
        (
            {"policyDocument": "policy_doc", "policyName": "policy_name", "groupName": "group_name"},
            {"ResponseMetadata": {"HTTPStatusCode": 200}},
            "Policy policy_name was added to group group_name",
        )
    ],
)
def test_put_group_policy_command(args, mocked_res, expected_hr, mocker):
    """
     Given:
    - args with policyDocument,  policyName, and groupName.

    When:
    - Calling put_group_policy_command.

    Then:
    - Ensure that the right header appears in the human readable results.
    """
    mocker.patch.object(Boto3Client, "put_group_policy", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.put_group_policy_command(args, client)
    assert expected_hr in cr_obj.readable_output


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr",
    [
        (
            {"roleName": "role_name", "tags": "Key:Value"},
            {"ResponseMetadata": {"HTTPStatusCode": 200}},
            "### Added the following tags to role role_name\n|Key|Value|\n|---|---|\n| Key | Value |\n",
        )
    ],
)
def test_tag_role_command(args, mocked_res, expected_hr, mocker):
    """
     Given:
    - args with roleName and tags.

    When:
    - Calling tag_role_command.

    Then:
    - Ensure that the results were parsed correctly into a 2 columns table with all the keys and values.
    """
    mocker.patch.object(Boto3Client, "tag_role", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.tag_role_command(args, client)
    assert expected_hr == cr_obj.readable_output


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr",
    [
        (
            {"userName": "user_name", "tags": "Key:Value, Key1:Value1"},
            {"ResponseMetadata": {"HTTPStatusCode": 200}},
            "### Added the following tags to user user_name\n|Key|Value|\n|---|---|\n| Key | Value |\n| Key1 | Value1 |\n",
        )
    ],
)
def test_tag_user_command(args, mocked_res, expected_hr, mocker):
    """
     Given:
    - args with userName and tags.

    When:
    - Calling tag_user_command.

    Then:
    - Ensure that the results were parsed correctly into a 2 columns table with all the keys and values.
    """
    mocker.patch.object(Boto3Client, "tag_user", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.tag_user_command(args, client)
    assert expected_hr == cr_obj.readable_output


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr",
    [
        (
            {"roleName": "role_name", "tagKeys": "Key1"},
            {"ResponseMetadata": {"HTTPStatusCode": 200}},
            "### Untagged the following tags from role role_name\n|Removed keys|\n|---|\n| Key1 |\n",
        )
    ],
)
def test_untag_role_command(args, mocked_res, expected_hr, mocker):
    """
     Given:
    - args with roleName and tagKeys.

    When:
    - Calling untag_role_command.

    Then:
    - Ensure that the results were parsed correctly into a 1 column table with all the keys.
    """
    mocker.patch.object(Boto3Client, "untag_role", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.untag_role_command(args, client)
    assert expected_hr == cr_obj.readable_output


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr",
    [
        (
            {"userName": "user_name", "tagKeys": "Key1,Key2"},
            {"ResponseMetadata": {"HTTPStatusCode": 200}},
            "### Untagged the following tags from user user_name\n|Removed keys|\n|---|\n| Key1 |\n| Key2 |\n",
        )
    ],
)
def test_untag_user_command(args, mocked_res, expected_hr, mocker):
    """
     Given:
    - args with userName and tagKeys.

    When:
    - Calling untag_user_command.

    Then:
    - Ensure that the results were parsed correctly into a 1 column table with all the keys.
    """
    mocker.patch.object(Boto3Client, "untag_user", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.untag_user_command(args, client)
    assert expected_hr == cr_obj.readable_output


@pytest.mark.parametrize(
    "args, mocked_res, expected_hr, expected_ec",
    [
        (
            {"accessKeyId": "access_Key_Id"},
            {
                "UserName": "user_name",
                "AccessKeyLastUsed": {
                    "LastUsedDate": datetime.datetime(2023, 6, 6, 14, 32),
                    "ServiceName": "test",
                    "Region": "Here",
                },
                "ResponseMetadata": {"HTTPStatusCode": 200, "RetryAttempts": 0},
            },
            "### Found the following information about access key access_Key_Id\n|ID|UserName|LastUsedDate|LastUsedServiceName|"
            "LastUsedRegion|\n|---|---|---|---|---|\n| access_Key_Id | user_name | 2023-06-06T14:32:00 | test | Here |\n",
            {
                "ID": "access_Key_Id",
                "UserName": "user_name",
                "LastUsedServiceName": "test",
                "LastUsedRegion": "Here",
                "LastUsedDate": "2023-06-06T14:32:00",
            },
        )
    ],
)
def test_get_access_key_last_used_command(args, mocked_res, expected_hr, expected_ec, mocker):
    """
     Given:
    - args with accessKeyId, and mocked_response with all fields that should be in the outputs.

    When:
    - Calling get_access_key_last_used_command.

    Then:
    - Ensure that the returned CR object contain the right data - all fields are included in the HR and EC,
    and that the LastUsedDate field in the response was converted to str.
    """
    mocker.patch.object(Boto3Client, "get_access_key_last_used", return_value=mocked_res)

    client = Boto3Client()
    cr_obj = AWS_IAM.get_access_key_last_used_command(args, client)
    assert expected_hr == cr_obj.readable_output
    assert expected_ec == cr_obj.outputs
    assert type(cr_obj.raw_response.get("AccessKeyLastUsed", {}).get("LastUsedDate")) is str


@pytest.mark.parametrize(
    "tags_ls, expected_output",
    [(["Key1:Value1", "Key2:Value2"], [{"Key": "Key1", "Value": "Value1"}, {"Key": "Key2", "Value": "Value2"}])],
)
def test_create_tag_dicts_list(tags_ls, expected_output):
    """
     Given:
    - tags_ls - a list of Key:Value tags.

    When:
    - running create_tag_dicts_list.

    Then:
    - Ensure that the list was parsed into a list of dicts,
    where each Key:Value in the input is {"Key": "Key1", "Value": "Value1"}.
    """
    tags_dicts_ls = AWS_IAM.create_tag_dicts_list(tags_ls)
    assert expected_output == tags_dicts_ls


def test_get_user_not_found_user_exception(mocker):
    """
    Given:
    - user_name - user name to retrieve policies for.
    When:
    - After running a get_user command
    Then:
    - Ensure that no exception was raised, and assert the readable output.
    """
    client = Boto3Client()
    args = {"userName": "userName"}
    mocker.patch.object(
        Boto3Client,
        "get_user",
        side_effect=Exception(
            "An error occurred (NoSuchEntity) when calling the "
            "GetUser operation: The user with name yayyyy cannot "
            "be found."
        ),
    )
    mocker.patch.object(demisto, "results")

    AWS_IAM.get_user(args, client)
    contents = demisto.results.call_args[0][0]

    assert "User userName was not found." in contents.get("HumanReadable")


@pytest.mark.parametrize(
    "is_truncated,expeted_second_output,expected_marker",
    (
        pytest.param(
            True,
            (
                "Listed 2 role policies but more are available. "
                "Either increase the `maxItems` argument, or use `marker` argument with the value from context."
            ),
            "some_marker",
            id="truncated",
        ),
        pytest.param(False, "Listed 2 attached policies for role test-role", None, id="not truncated"),
    ),
)
def test_list_attached_role_policies(mocker, is_truncated: bool, expeted_second_output: str, expected_marker: str | None) -> None:
    """
    Given:
        args = {'roleName': 'test-role'}.
    When:
        Calling list_attached_role_policies
    Then:
        Ensure outputs_prefix is 'AWS.IAM.AttachedPolicies'.
        Check readable_output for formatted attached policies.
        Confirm raw_response matches predefined response.
    """
    args = {"roleName": "test-role"}
    response = {
        "AttachedPolicies": [{"PolicyName": "policy1", "PolicyArn": "Arn1"}, {"PolicyName": "policy2", "PolicyArn": "Arn2"}],
        "IsTruncated": is_truncated,
    }
    if is_truncated:
        response["Marker"] = expected_marker

    client = Boto3Client()
    mocker.patch.object(client, "list_attached_role_policies", return_value=response)

    result = AWS_IAM.list_attached_role_policies_command(args, client)

    assert len(result) == 2

    assert result[0].outputs == [
        {"PolicyName": "policy1", "PolicyArn": "Arn1", "RoleName": "test-role"},
        {"PolicyName": "policy2", "PolicyArn": "Arn2", "RoleName": "test-role"},
    ]
    assert result[0].readable_output == (
        "### Attached Policies for Role test-role\n|PolicyArn|PolicyName|RoleName|\n"
        "|---|---|---|\n| Arn1 | policy1 | test-role |\n| Arn2 | policy2 | test-role |\n"
    )
    assert result[0].raw_response == response

    assert result[1].outputs["IsTruncated"] is is_truncated
    assert result[1].outputs.get("Marker") == expected_marker
    assert result[1].raw_response == response
    assert result[1].readable_output == expeted_second_output


def test_deactivate_mfa_device(mocker: MockerFixture):
    """
    Given:
        args - userName, serialNumber.
    When:
        calling deactivate_mfa_device function.
    Then:
        Ensure that the response returns as expected and contains the userName.
    """
    mock_res = {"ResponseMetadata": {"HTTPStatusCode": 200}}

    args = {"userName": "test", "serialNumber": "test1"}
    mocker.patch.object(Boto3Client, "deactivate_mfa_device", return_value=mock_res)
    results = mocker.patch.object(demisto, "results")

    client = Boto3Client()
    AWS_IAM.deactivate_mfa_device(args, client)

    assert results.call_args[0][0] == "The User test mfa device has been deactivated"


def test_delete_virtual_mfa_device(mocker: MockerFixture):
    """
    Given:
        args - serialNumber.
    When:
        calling delete_virtual_mfa_device function.
    Then:
        Ensure that the response returns as expected and contains the userName.
    """
    mock_res = {"ResponseMetadata": {"HTTPStatusCode": 200}}

    args = {"serialNumber": "test1"}
    mocker.patch.object(Boto3Client, "delete_virtual_mfa_device", return_value=mock_res)
    results = mocker.patch.object(demisto, "results")

    client = Boto3Client()
    AWS_IAM.delete_virtual_mfa_device(args, client)

    assert results.call_args[0][0] == "The User test1 mfa device has been deleted"


@pytest.mark.parametrize("page_size", [1, 2])
def test_list_mfa_devices(mocker: MockerFixture, page_size: int):
    """
    Given:
        - page_size argument
    Then:
        - run `list_mfa_devices` function
    When:
        - Ensure that `outputs_prefix` is as expected
        - Ensure that the number of returned devices is as expected
    """
    mock_res = {
        "MFADevices": [
            {"UserName": "test", "SerialNumber": "test", "EnableDate": datetime.datetime(2021, 11, 7, 15, 55, 3)},
            {"UserName": "test2", "SerialNumber": "test2", "EnableDate": datetime.datetime(2022, 11, 7, 15, 55, 3)},
        ],
        "Marker": "test",
    }
    mocker.patch.object(Boto3Client, "list_mfa_devices", return_value=mock_res)

    client = Boto3Client()
    res = AWS_IAM.list_mfa_devices({"page_size": page_size, "page": 1}, client)

    assert len(res.outputs["Devices"]) == page_size
    assert res.outputs_prefix == "AWS.IAM.MFADevices"