EC2 / Client / create_capacity_reservation

create_capacity_reservation#

EC2.Client.create_capacity_reservation(**kwargs)#

Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration.

You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a Capacity Reservation for immediate use or you can request a Capacity Reservation for a future date.

For more information, see Reserve compute capacity with On-Demand Capacity Reservations in the Amazon EC2 User Guide.

Your request to create a Capacity Reservation could fail if:

Amazon EC2 does not have sufficient capacity. In this case, try again at a later time, try in a different Availability Zone, or request a smaller Capacity Reservation. If your workload is flexible across instance types and sizes, try with different instance attributes.
The requested quantity exceeds your On-Demand Instance quota. In this case, increase your On-Demand Instance quota for the requested instance type and try again. For more information, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.

Request Syntax

response = client.create_capacity_reservation(
    ClientToken='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',
    AvailabilityZoneId='string',
    Tenancy='default'|'dedicated',
    InstanceCount=123,
    EbsOptimized=True|False,
    EphemeralStorage=True|False,
    EndDate=datetime(2015, 1, 1),
    EndDateType='unlimited'|'limited',
    InstanceMatchCriteria='open'|'targeted',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'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'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False,
    OutpostArn='string',
    PlacementGroupArn='string',
    StartDate=datetime(2015, 1, 1),
    CommitmentDuration=123,
    DeliveryPreference='fixed'|'incremental'
)

Parameters:

ClientToken (string) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
InstanceType (string) –
[REQUIRED]

The instance type for which to reserve capacity.

Note
You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

For more information, see Instance types in the Amazon EC2 User Guide.
InstancePlatform (string) –
[REQUIRED]

The type of operating system for which to reserve capacity.
AvailabilityZone (string) – The Availability Zone in which to create the Capacity Reservation.
AvailabilityZoneId (string) – The ID of the Availability Zone in which to create the Capacity Reservation.
Tenancy (string) –
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
- default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
- dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
InstanceCount (integer) –
[REQUIRED]

The number of instances for which to reserve capacity.

Note
You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances (25 * m5.xlarge = 100 vCPUs).

Valid range: 1 - 1000
EbsOptimized (boolean) – Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
EphemeralStorage (boolean) – Deprecated.
EndDate (datetime) –
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation’s state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

If you are requesting a future-dated Capacity Reservation, you can’t specify an end date and time that is within the commitment duration.
EndDateType (string) –
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
- unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
- limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.
InstanceMatchCriteria (string) –
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
- open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
- targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Note
If you are requesting a future-dated Capacity Reservation, you must specify targeted.

Default: open
TagSpecifications (list) –
The tags to apply to the Capacity Reservation during launch.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
DryRun (boolean) – 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.
OutpostArn (string) –

Note
Not supported for future-dated Capacity Reservations.

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
PlacementGroupArn (string) –

Note
Not supported for future-dated Capacity Reservations.

The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
StartDate (datetime) –

Note
Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

You can request a future-dated Capacity Reservation between 5 and 120 days in advance.
CommitmentDuration (integer) –

Note
Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the active state in your account after it has been delivered.

For more information, see Commitment duration.
DeliveryPreference (string) –

Note
Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

The only supported value is incremental.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityReservation': {
        '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'|'assessing'|'delayed'|'unsupported',
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OutpostArn': 'string',
        'CapacityReservationFleetId': 'string',
        'PlacementGroupArn': 'string',
        'CapacityAllocations': [
            {
                'AllocationType': 'used',
                'Count': 123
            },
        ],
        'ReservationType': 'default'|'capacity-block',
        'UnusedReservationBillingOwnerId': 'string',
        'CommitmentInfo': {
            'CommittedInstanceCount': 123,
            'CommitmentEndDate': datetime(2015, 1, 1)
        },
        'DeliveryPreference': 'fixed'|'incremental'
    }
}

Response Structure

(dict) –
- CapacityReservation (dict) –
  
  Information about the Capacity Reservation.
  - CapacityReservationId (string) –
    
    The ID of the Capacity Reservation.
  - OwnerId (string) –
    
    The ID of the Amazon Web Services account that owns the Capacity Reservation.
  - CapacityReservationArn (string) –
    
    The Amazon Resource Name (ARN) of the Capacity Reservation.
  - AvailabilityZoneId (string) –
    
    The Availability Zone ID of the Capacity Reservation.
  - InstanceType (string) –
    
    The type of instance for which the Capacity Reservation reserves capacity.
  - InstancePlatform (string) –
    
    The type of operating system for which the Capacity Reservation reserves capacity.
  - AvailabilityZone (string) –
    
    The Availability Zone in which the capacity is reserved.
  - Tenancy (string) –
    
    Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
    - default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
    - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
  - TotalInstanceCount (integer) –
    
    The total number of instances for which the Capacity Reservation reserves capacity.
  - AvailableInstanceCount (integer) –
    
    The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
  - EbsOptimized (boolean) –
    
    Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
  - EphemeralStorage (boolean) –
    
    Deprecated.
  - State (string) –
    
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    - active - The capacity is available for use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
    - pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    - failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can’t support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
  - StartDate (datetime) –
    
    The date and time at which the Capacity Reservation was started.
  - EndDate (datetime) –
    
    The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation’s state changes to expired when it reaches its end date and time.
  - EndDateType (string) –
    
    Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
    - unlimited - The Capacity Reservation remains active until you explicitly cancel it.
    - limited - The Capacity Reservation expires automatically at a specified date and time.
  - InstanceMatchCriteria (string) –
    
    Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
    - open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
    - targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
  - CreateDate (datetime) –
    
    The date and time at which the Capacity Reservation was created.
  - Tags (list) –
    
    Any tags assigned to the Capacity Reservation.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - OutpostArn (string) –
    
    The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
  - CapacityReservationFleetId (string) –
    
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
  - PlacementGroupArn (string) –
    
    The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
  - CapacityAllocations (list) –
    
    Information about instance capacity usage.
    - (dict) –
      
      Information about instance capacity usage for a Capacity Reservation.
      - AllocationType (string) –
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
      - Count (integer) –
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
  - ReservationType (string) –
    
    The type of Capacity Reservation.
  - UnusedReservationBillingOwnerId (string) –
    
    The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
  - CommitmentInfo (dict) –
    
    Information about your commitment for a future-dated Capacity Reservation.
    - CommittedInstanceCount (integer) –
      
      The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    - CommitmentEndDate (datetime) –
      
      The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can’t decrease the instance count or cancel the Capacity Reservation before this date and time.
  - DeliveryPreference (string) –
    
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.