reserved_instances_modifications

Creates, updates, deletes, gets or lists a reserved_instances_modifications resource.

Overview

Name	reserved_instances_modifications
Type	Resource
Id	aws.ec2.reserved_instances_modifications

Fields

The following fields are returned by SELECT queries:

describe_reserved_instances_modifications

Name	Datatype	Description
client_token	string	A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
create_date	string	The time when the modification request was created.
effective_date	string	The time for the modification to become effective.
modification_results	string	Contains target configurations along with their corresponding new Reserved Instance IDs.
reserved_instances_ids	string	The IDs of one or more Reserved Instances.
reserved_instances_modification_id	string	A unique ID for the Reserved Instance modification.
status	string	The status of the Reserved Instances modification request.
status_message	string	The reason for the status.
update_date	string	The time when the modification request was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reserved_instances_modifications	select	region	ReservedInstancesModificationId, NextToken, Filter	Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. For more information, see Modify Reserved Instances in the Amazon EC2 User Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
Filter	array	One or more filters. client-token - The idempotency token for the modification request. create-date - The time when the modification request was created. effective-date - The time when the modification becomes effective. modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled. modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances. modification-result.target-configuration.availability-zone-id - The ID of the Availability Zone for the new Reserved Instances. modification-result.target-configuration.instance-count - The number of new Reserved Instances. modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances. reserved-instances-id - The ID of the Reserved Instances modified. reserved-instances-modification-id - The ID of the modification request. status - The status of the Reserved Instances modification request (processing | fulfilled | failed). status-message - The reason for the status. update-date - The time when the modification request was last updated.
NextToken	string	The token to retrieve the next page of results.
ReservedInstancesModificationId	array	IDs for the submitted modification request.

SELECT examples

describe_reserved_instances_modifications

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. For more information, see Modify Reserved Instances in the Amazon EC2 User Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

SELECT
client_token,
create_date,
effective_date,
modification_results,
reserved_instances_ids,
reserved_instances_modification_id,
status,
status_message,
update_date
FROM aws.ec2.reserved_instances_modifications
WHERE region = '{{ region }}' -- required
AND ReservedInstancesModificationId = '{{ ReservedInstancesModificationId }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
;