Data Types

AmazonDisableUnusedIamAccessKeysParameters Object

Description

Parameters for the Amazon Disable Unused IAM Access Keys action.

Properties

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.

Type: Array of string

Required: Yes

isTest

Indicates whether test mode is enabled.

Type: array of boolean

Required: No

Default: false

reportFormat

Format of the final report. Required when targetType is email.

Type: string

Valid Values:

  • email

  • email-html-attachment

  • email-csv-attachment

Required: Conditional

targetEmails

The target email addresses to send the final report.

Type: array of string

Required: No

targetType

Indicates whether a report should be generated with the execution results.

Type: string

Valid Values:

  • none

  • email

Required: No

Default: none

unusedDays

Number of days the access keys should be unused before being disabled.

Type: integer

Required: Yes

userIdentificationMethod

Method in which users will be selected.

Type: string

Valid Values:

  • all-users

  • by-user-name

Required: Yes

userNameComparison

Comparison to use when matching users by their user name. Required when userIdentificationMethod is by-user-name.

Type: IamUserNameComparison object

Required: Conditional

Sample JSON

{
"credentialIds": [
"cred-00000001"
],
"targetType": "email",
"targetEmails": [
"foo@example.com"
],
"ReportFormat": "email"
}