Data Types

AmazonDeregisterAmiImagesParameters Object

Description

Parameters for the Amazon Deregister AMI Images action.

Properties

credentialIds

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

Type: Array of string

Required: Yes

deleteScheme

Delete scheme to use to determine the images to delete or preserve.

Type: string

Valid Values:

  • none

  • first-in-first-out

  • grandfather-father-son

Required: Yes

deregisterSharedImages

Indicates whether shared AMI images should be deleted.

Type: string

Valid Values:

  • all

  • deregister-shared-images-only

  • deregister-non-shared-images-only

Required: No

Default: all

firstInFirstOutParameters

Parameters to use when using a first-in-first-out delete scheme. Required when deleteScheme is first-in-first-out.

Type: FirstInFirstOutDeleteSchemeParameters​ object

Required: Conditional

grandfatherFatherSonParameters

Parameters to use when using a grandfather-father-son delete scheme. Required when deleteScheme is grandfather-father-son.

Type: GrandfatherFatherSonDeleteSchemeParameters​ object

Required: Conditional

groupingMethod

Method in which to group images when deleting.

Type: string

Valid Values:

  • none

  • by-resource-tag

Required: Yes

groupingResourceTagName

Name of the resource tag to use to group images. Required when groupingMethod is by-resource-tag.

Type: string

Required: Conditional

imageDescriptionComparison

Comparison to use when matching images by description. Required when imageIdentificationMethod is by-image-description.

Type: AmiImageDescriptionComparison object

Required: Conditional

imageIdentificationMethod

Method to use to identify images to be deleted.

Type: string

Valid Values:

  • all-images

  • by-image-description

  • by-image-name

  • by-image-name-tag

  • by-resource-tag

Required: Yes

imageNameComparison

Comparison to use when matching images by their name. Required when imageIdentificationMethod is by-image-name.

Type: AmiImageNameComparison object

Required: Conditional

isDeleteFromS3

Indicates whether S3 data associated with the AMI images are to be deleted. Only applies to instance-backed AMI images.

Type: boolean

Default: true

Required: No

isDeleteSnapshots

Indicates whether EBS snapshots associated with the AMI images are to be deleted. Only applies to EBS-backed AMI images.

Type: boolean

Default: true

Required: No

isTest

Determines if "Test Mode" is enabled on the action. Images will not be deleted when "Test Mode" is enabled.

Type: boolean

Required: No

Default Value: false

nameTagComparison

Comparison to use when matching image by their Name tag. Required when imageIdentificationMethod is by-image-name-tag.

Type: NameTagComparison object

Required: Conditional

regionNames

Regions to use with the action. Omit (or specify null) to include "all regions".

Type: Array of string

Required: No

reportFormat

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

Type: string

Valid Values:

  • email

  • email-html-attachment

  • email-csv-attachment

Required: Conditional

resourceTagComparison

Comparison to use when identifying images by resource tag. Required when imageIdentificationMethod is by-resource-tag.

Type: ResourceTagComparison object.

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

Sample JSON

{
"credentialIds": [
"cred-00000001"
],
"regionNames": [
"us-east-1",
"us-east-2"
],
"imageIdentificationMethod": "by-resource-tag",
"resourceTagComparison": {
"tagName": "skeddly:retention",
"compareType": "equals",
"tagValue": "7"
},
"deregisterSharedImages": "all",
"deleteScheme": "first-in-first-out",
"firstInFirstOutParameters": {
"olderThanDays": 30,
"minimumToKeep": 2
},
"groupingMethod": "by-resource-tag",
"groupingResourceTagName": "skeddly:image-id",
"isDeleteSnapshots": true,
"isDeleteFromS3": false,
"targetType": "email",
"targetEmails": [
"foo@example.com"
],
"ReportFormat": "email",
"isTest": false
}