Skip to content

Move Capacity Reservation Instances

ec2_move_capacity_reservation_instances R Documentation

Move available capacity from a source Capacity Reservation to a destination Capacity Reservation

Description

Move available capacity from a source Capacity Reservation to a destination Capacity Reservation. The source Capacity Reservation and the destination Capacity Reservation must be active, owned by your Amazon Web Services account, and share the following:

  • Instance type

  • Platform

  • Availability Zone

  • Tenancy

  • Placement group

  • Capacity Reservation end time - ⁠At specific time⁠ or Manually.

Usage

ec2_move_capacity_reservation_instances(DryRun, ClientToken,
  SourceCapacityReservationId, DestinationCapacityReservationId,
  InstanceCount)

Arguments

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

SourceCapacityReservationId

[required] The ID of the Capacity Reservation from which you want to move capacity.

DestinationCapacityReservationId

[required] The ID of the Capacity Reservation that you want to move capacity into.

InstanceCount

[required] The number of instances that you want to move from the source Capacity Reservation.

Value

A list with the following syntax: 

list(
  SourceCapacityReservation = list(
    CapacityReservationId = "string",
    OwnerId = "string",
    CapacityReservationArn = "string",
    AvailabilityZoneId = "string",
    InstanceType = "string",
    InstancePlatform = "Linux/UNIX"|"Red Hat Enterprise Linux"|"SUSE Linux"|"Windows"|"Windows with SQL Server"|"Windows with SQL Server Enterprise"|"Windows with SQL Server Standard"|"Windows with SQL Server Web"|"Linux with SQL Server Standard"|"Linux with SQL Server Web"|"Linux with SQL Server Enterprise"|"RHEL with SQL Server Standard"|"RHEL with SQL Server Enterprise"|"RHEL with SQL Server Web"|"RHEL with HA"|"RHEL with HA and SQL Server Standard"|"RHEL with HA and SQL Server Enterprise"|"Ubuntu Pro",
    AvailabilityZone = "string",
    Tenancy = "default"|"dedicated",
    TotalInstanceCount = 123,
    AvailableInstanceCount = 123,
    EbsOptimized = TRUE|FALSE,
    EphemeralStorage = TRUE|FALSE,
    State = "active"|"expired"|"cancelled"|"pending"|"failed"|"scheduled"|"payment-pending"|"payment-failed",
    StartDate = as.POSIXct(
      "2015-01-01"
    ),
    EndDate = as.POSIXct(
      "2015-01-01"
    ),
    EndDateType = "unlimited"|"limited",
    InstanceMatchCriteria = "open"|"targeted",
    CreateDate = as.POSIXct(
      "2015-01-01"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    OutpostArn = "string",
    CapacityReservationFleetId = "string",
    PlacementGroupArn = "string",
    CapacityAllocations = list(
      list(
        AllocationType = "used",
        Count = 123
      )
    ),
    ReservationType = "default"|"capacity-block"
  ),
  DestinationCapacityReservation = list(
    CapacityReservationId = "string",
    OwnerId = "string",
    CapacityReservationArn = "string",
    AvailabilityZoneId = "string",
    InstanceType = "string",
    InstancePlatform = "Linux/UNIX"|"Red Hat Enterprise Linux"|"SUSE Linux"|"Windows"|"Windows with SQL Server"|"Windows with SQL Server Enterprise"|"Windows with SQL Server Standard"|"Windows with SQL Server Web"|"Linux with SQL Server Standard"|"Linux with SQL Server Web"|"Linux with SQL Server Enterprise"|"RHEL with SQL Server Standard"|"RHEL with SQL Server Enterprise"|"RHEL with SQL Server Web"|"RHEL with HA"|"RHEL with HA and SQL Server Standard"|"RHEL with HA and SQL Server Enterprise"|"Ubuntu Pro",
    AvailabilityZone = "string",
    Tenancy = "default"|"dedicated",
    TotalInstanceCount = 123,
    AvailableInstanceCount = 123,
    EbsOptimized = TRUE|FALSE,
    EphemeralStorage = TRUE|FALSE,
    State = "active"|"expired"|"cancelled"|"pending"|"failed"|"scheduled"|"payment-pending"|"payment-failed",
    StartDate = as.POSIXct(
      "2015-01-01"
    ),
    EndDate = as.POSIXct(
      "2015-01-01"
    ),
    EndDateType = "unlimited"|"limited",
    InstanceMatchCriteria = "open"|"targeted",
    CreateDate = as.POSIXct(
      "2015-01-01"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    OutpostArn = "string",
    CapacityReservationFleetId = "string",
    PlacementGroupArn = "string",
    CapacityAllocations = list(
      list(
        AllocationType = "used",
        Count = 123
      )
    ),
    ReservationType = "default"|"capacity-block"
  ),
  InstanceCount = 123
)

Request syntax

svc$move_capacity_reservation_instances(
  DryRun = TRUE|FALSE,
  ClientToken = "string",
  SourceCapacityReservationId = "string",
  DestinationCapacityReservationId = "string",
  InstanceCount = 123
)