Skip to content

EC2  >  Operations  >  describe_reserved_instances_modifications

describe_reserved_instances_modifications

Operation

describe_reserved_instances_modifications async

describe_reserved_instances_modifications(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedInstancesModificationsInputDict]) -> DescribeReservedInstancesModificationsOutput

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.

Note

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:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeReservedInstancesModificationsOutput

An instance of DescribeReservedInstancesModificationsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeReservedInstancesModificationsInput dataclass

Bases: _SerdeShape

Contains the parameters for DescribeReservedInstancesModifications.

Attributes
filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to retrieve the next page of results.

reserved_instances_modification_ids class-attribute instance-attribute
reserved_instances_modification_ids: list[str] | None = ...

IDs for the submitted modification request.

Dictionaries

DescribeReservedInstancesModificationsInputDict

Bases: TypedDict

Dictionary form of DescribeReservedInstancesModificationsInput.

Attributes
filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

next_token instance-attribute
next_token: str | None

The token to retrieve the next page of results.

reserved_instances_modification_ids instance-attribute
reserved_instances_modification_ids: Sequence[str] | None

IDs for the submitted modification request.

Output

DescribeReservedInstancesModificationsOutput dataclass

Bases: _SerdeShape

Contains the output of DescribeReservedInstancesModifications.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

reserved_instances_modifications class-attribute instance-attribute
reserved_instances_modifications: list[ReservedInstancesModification] | None = ...

The Reserved Instance modification information.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.