Skip to content

Purchase Capacity Block

ec2_purchase_capacity_block R Documentation

Purchase the Capacity Block for use with your account

Description

Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing.

Usage

ec2_purchase_capacity_block(DryRun, TagSpecifications,
  CapacityBlockOfferingId, InstancePlatform)

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.

TagSpecifications

The tags to apply to the Capacity Block during launch.

CapacityBlockOfferingId

[required] The ID of the Capacity Block offering.

InstancePlatform

[required] The type of operating system for which to reserve capacity.

Value

A list with the following syntax:

list(
  CapacityReservation = 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"
  )
)

Request syntax

svc$purchase_capacity_block(
  DryRun = TRUE|FALSE,
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"ipam-external-resource-verification-token",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  CapacityBlockOfferingId = "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"
)