2026/09/02 - Amazon Elastic Compute Cloud - 12 updated api methods
Changes This release adds support to retain interruptible Capacity Reservations in an active state when all capacity is reclaimed.
{'CapacityReservation': {'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain '
'| '
'default'},
'ZeroSizePreference': 'retain | default'}}
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.
See also: AWS API Documentation
Request Syntax
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'|'image-usage-report'|'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'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'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-metering-policy'|'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'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
OutpostArn='string',
PlacementGroupArn='string',
StartDate=datetime(2015, 1, 1),
CommitmentDuration=123,
DeliveryPreference='fixed'|'incremental'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
string
[REQUIRED]
The instance type for which to reserve capacity.
For more information, see Instance types in the Amazon EC2 User Guide.
string
[REQUIRED]
The type of operating system for which to reserve capacity.
string
The Availability Zone in which to create the Capacity Reservation.
string
The ID of the Availability Zone in which to create the Capacity Reservation.
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.
integer
[REQUIRED]
The number of instances for which to reserve capacity.
Valid range: 1 - 1000
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.
boolean
Deprecated.
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.
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.
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.
Default: open
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.
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.
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.
string
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
string
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.
datetime
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.
integer
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.
string
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.
dict
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'|'cancelling'|'unavailable',
'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'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1)
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'ZeroSizePreference': 'retain'|'default'
}
}
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 ID of the Availability Zone in which the capacity is reserved.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time 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 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.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
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.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
{'DestinationCapacityReservation': {'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain '
'| '
'default'},
'ZeroSizePreference': 'retain | default'},
'SourceCapacityReservation': {'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain '
'| '
'default'},
'ZeroSizePreference': 'retain | default'}}
Create a new Capacity Reservation by splitting the capacity of the source Capacity Reservation. The new Capacity Reservation will have the same attributes as the source Capacity Reservation except for tags. The source Capacity Reservation must be active and owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.create_capacity_reservation_by_splitting(
DryRun=True|False,
ClientToken='string',
SourceCapacityReservationId='string',
InstanceCount=123,
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'|'image-usage-report'|'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'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'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-metering-policy'|'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'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
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.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Capacity Reservation from which you want to split the capacity.
integer
[REQUIRED]
The number of instances to split from the source Capacity Reservation.
list
The tags to apply to the new Capacity Reservation.
(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.
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.
dict
Response Syntax
{
'SourceCapacityReservation': {
'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'|'cancelling'|'unavailable',
'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'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1)
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'ZeroSizePreference': 'retain'|'default'
},
'DestinationCapacityReservation': {
'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'|'cancelling'|'unavailable',
'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'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1)
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'ZeroSizePreference': 'retain'|'default'
},
'InstanceCount': 123
}
Response Structure
(dict) --
SourceCapacityReservation (dict) --
Information about the source 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 ID of the Availability Zone in which the capacity is reserved.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time 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 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.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
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.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
DestinationCapacityReservation (dict) --
Information about the destination 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 ID of the Availability Zone in which the capacity is reserved.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time 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 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.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
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.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
InstanceCount (integer) --
The number of instances in the new Capacity Reservation. The number of instances in the source Capacity Reservation was reduced by this amount.
{'ZeroSizePreference': 'retain | default'}
Creates an interruptible Capacity Reservation by specifying the number of unused instances you want to allocate from your source reservation. This helps you make unused capacity available for other workloads within your account while maintaining control to reclaim it.
See also: AWS API Documentation
Request Syntax
client.create_interruptible_capacity_reservation_allocation(
CapacityReservationId='string',
InstanceCount=123,
ClientToken='string',
DryRun=True|False,
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'|'image-usage-report'|'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'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'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-metering-policy'|'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'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ZeroSizePreference='retain'|'default'
)
string
[REQUIRED]
The ID of the source Capacity Reservation from which to create the interruptible Capacity Reservation. Your Capacity Reservation must be in active state with no end date set and have available capacity for allocation.
integer
[REQUIRED]
The number of instances to allocate from your source reservation. You can only allocate available instances (also called unused capacity).
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
list
The tags to apply to the interruptible Capacity Reservation during creation.
(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.
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.
string
Specifies the behavior for the interruptible Capacity Reservation when you reduce its allocation to zero instances. Specify retain to keep the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. Specify default to cancel the interruptible Capacity Reservation and return the capacity to your source Capacity Reservation. The default value is default.
dict
Response Syntax
{
'SourceCapacityReservationId': 'string',
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptionType': 'adhoc'
}
Response Structure
(dict) --
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible Capacity Reservation was created.
TargetInstanceCount (integer) --
The number of instances allocated to the interruptible reservation.
Status (string) --
The current status of the allocation request (creating, active, updating).
InterruptionType (string) --
The type of interruption applied to the interruptible reservation.
{'IpamInternetRegistryAssociation': {'StateMessage': 'string'}}
Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
See also: AWS API Documentation
Request Syntax
client.create_ipam_internet_registry_association(
DryRun=True|False,
IpamId='string',
Rir='ripe'|'apnic'|'arin'|'lacnic',
OrganizationHandle='string',
Description='string',
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'|'image-usage-report'|'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'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'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-metering-policy'|'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'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM to associate with the internet registry.
string
[REQUIRED]
The Regional Internet Registry to associate with. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
string
[REQUIRED]
The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID).
string
A description for the internet registry association.
list
The tags to assign to the internet registry association.
(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.
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.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'IpamInternetRegistryAssociation': {'StateMessage': 'string'}}
Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry.
See also: AWS API Documentation
Request Syntax
client.delete_ipam_internet_registry_association(
DryRun=True|False,
IpamInternetRegistryAssociationId='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association to delete.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the deleted internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'CapacityReservations': {'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain '
'| '
'default'},
'ZeroSizePreference': 'retain | default'}}
Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
See also: AWS API Documentation
Request Syntax
client.describe_capacity_reservations(
CapacityReservationIds=[
'string',
],
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
list
The ID of the Capacity Reservation.
(string) --
string
The token to use to retrieve the next page of results.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
list
One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - 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.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - 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.
end-date-type - 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.
instance-match-criteria - 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.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
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.
dict
Response Syntax
{
'NextToken': 'string',
'CapacityReservations': [
{
'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'|'cancelling'|'unavailable',
'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'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1)
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'ZeroSizePreference': 'retain'|'default'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
CapacityReservations (list) --
Information about the Capacity Reservations.
(dict) --
Describes a 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 ID of the Availability Zone in which the capacity is reserved.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time 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 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.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
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.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
{'IpamInternetRegistryAssociations': {'StateMessage': 'string'}}
Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.describe_ipam_internet_registry_associations(
DryRun=True|False,
IpamInternetRegistryAssociationIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
boolean
Checks whether you have the required permissions for the operation, 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.
list
The IDs of the internet registry associations to describe.
(string) --
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
list
One or more filters to apply to the results.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamInternetRegistryAssociations': [
{
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results.
IpamInternetRegistryAssociations (list) --
The internet registry associations.
(dict) --
Contains information about an association between an IPAM and a Regional Internet Registry (RIR) for delegated RPKI management.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'IpamInternetRegistryAssociation': {'StateMessage': 'string'}}
Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
See also: AWS API Documentation
Request Syntax
client.enable_ipam_internet_registry_association(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
RpkiVersion='string',
ServiceUri='string',
ChildHandle='string',
ParentHandle='string',
ParentBpkiTa='string',
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association to enable.
string
[REQUIRED]
The RPKI version to use from the Parent Response XML.
string
[REQUIRED]
The RPKI service URI for the publication point from the Parent Response XML.
string
[REQUIRED]
The child handle for the BPKI certificate hierarchy from the Parent Response XML.
string
[REQUIRED]
The parent handle for the BPKI certificate hierarchy from the Parent Response XML.
string
[REQUIRED]
The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the enabled internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain | default'}}
Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
See also: AWS API Documentation
Request Syntax
client.get_capacity_reservation_usage(
CapacityReservationId='string',
NextToken='string',
MaxResults=123,
DryRun=True|False
)
string
[REQUIRED]
The ID of the Capacity Reservation.
string
The token to use to retrieve the next page of results.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
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.
dict
Response Syntax
{
'NextToken': 'string',
'CapacityReservationId': 'string',
'InstanceType': 'string',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'cancelling'|'unavailable',
'InstanceUsages': [
{
'AccountId': 'string',
'UsedInstanceCount': 123
},
],
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
}
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
InstanceType (string) --
The type of instance for which the Capacity Reservation reserves capacity.
TotalInstanceCount (integer) --
The 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.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
InstanceUsages (list) --
Information about the Capacity Reservation usage.
(dict) --
Information about the Capacity Reservation usage.
AccountId (string) --
The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
UsedInstanceCount (integer) --
The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
Interruptible (boolean) --
Indicates whether the Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Information about the capacity allocated to the interruptible Capacity Reservation, including instance counts and allocation status.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Details about the interruption configuration and source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
{'DestinationCapacityReservation': {'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain '
'| '
'default'},
'ZeroSizePreference': 'retain | default'},
'SourceCapacityReservation': {'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain '
'| '
'default'},
'ZeroSizePreference': 'retain | default'}}
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.
See also: AWS API Documentation
Request Syntax
client.move_capacity_reservation_instances(
DryRun=True|False,
ClientToken='string',
SourceCapacityReservationId='string',
DestinationCapacityReservationId='string',
InstanceCount=123
)
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.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Capacity Reservation from which you want to move capacity.
string
[REQUIRED]
The ID of the Capacity Reservation that you want to move capacity into.
integer
[REQUIRED]
The number of instances that you want to move from the source Capacity Reservation.
dict
Response Syntax
{
'SourceCapacityReservation': {
'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'|'cancelling'|'unavailable',
'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'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1)
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'ZeroSizePreference': 'retain'|'default'
},
'DestinationCapacityReservation': {
'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'|'cancelling'|'unavailable',
'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'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1)
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'ZeroSizePreference': 'retain'|'default'
},
'InstanceCount': 123
}
Response Structure
(dict) --
SourceCapacityReservation (dict) --
Information about the source 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 ID of the Availability Zone in which the capacity is reserved.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time 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 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.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
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.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
DestinationCapacityReservation (dict) --
Information about the destination 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 ID of the Availability Zone in which the capacity is reserved.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time 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 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.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
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.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
InstanceCount (integer) --
The number of instances that were moved from the source Capacity Reservation to the destination Capacity Reservation.
{'CapacityReservation': {'InterruptibleCapacityAllocation': {'ZeroSizePreference': 'retain '
'| '
'default'},
'ZeroSizePreference': 'retain | default'}}
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.
See also: AWS API Documentation
Request Syntax
client.purchase_capacity_block(
DryRun=True|False,
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'|'image-usage-report'|'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'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'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-metering-policy'|'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'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'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'
)
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.
list
The tags to apply to the Capacity Block 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.
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.
string
[REQUIRED]
The ID of the Capacity Block offering.
string
[REQUIRED]
The type of operating system for which to reserve capacity.
dict
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'|'cancelling'|'unavailable',
'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'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1)
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'ZeroSizePreference': 'retain'|'default'
},
'CapacityBlocks': [
{
'CapacityBlockId': 'string',
'UltraserverType': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'CapacityReservationIds': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'CreateDate': datetime(2015, 1, 1),
'State': 'active'|'expired'|'unavailable'|'cancelled'|'failed'|'scheduled'|'payment-pending'|'payment-failed',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
CapacityReservation (dict) --
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 ID of the Availability Zone in which the capacity is reserved.
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) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) 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) 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.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time 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 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.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
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.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
CapacityBlocks (list) --
The Capacity Block.
(dict) --
Reserve powerful GPU instances on a future date to support your short duration machine learning (ML) workloads. Instances that run inside a Capacity Block are automatically placed close together inside Amazon EC2 UltraClusters, for low-latency, petabit-scale, non-blocking networking.
You can also reserve Amazon EC2 UltraServers. UltraServers connect multiple EC2 instances using a low-latency, high-bandwidth accelerator interconnect (NeuronLink). They are built to tackle very large-scale AI/ML workloads that require significant processing power. For more information, see Amazon EC2 UltraServers.
CapacityBlockId (string) --
The ID of the Capacity Block.
UltraserverType (string) --
The EC2 UltraServer type of the Capacity Block.
AvailabilityZone (string) --
The Availability Zone of the Capacity Block.
AvailabilityZoneId (string) --
The Availability Zone ID of the Capacity Block.
CapacityReservationIds (list) --
The ID of the Capacity Reservation.
(string) --
StartDate (datetime) --
The date and time at which the Capacity Block was started.
EndDate (datetime) --
The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.
CreateDate (datetime) --
The date and time at which the Capacity Block was created.
State (string) --
The state of the Capacity Block.
Tags (list) --
The tags assigned to the Capacity Block.
(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.
{'ZeroSizePreference': 'retain | default'}
Modifies the number of instances allocated to an interruptible reservation, allowing you to add more capacity or reclaim capacity to your source Capacity Reservation.
See also: AWS API Documentation
Request Syntax
client.update_interruptible_capacity_reservation_allocation(
CapacityReservationId='string',
TargetInstanceCount=123,
DryRun=True|False,
ZeroSizePreference='retain'|'default'
)
string
[REQUIRED]
The ID of the source Capacity Reservation containing the interruptible allocation to modify.
integer
The new number of instances to allocate. Enter a higher number to add more capacity to share, or a lower number to reclaim capacity to your source Capacity Reservation.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
string
Specifies the updated behavior for the interruptible Capacity Reservation when you reduce its allocation to zero instances. Specify retain to keep the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. Specify default to cancel the interruptible Capacity Reservation and return the capacity to your source Capacity Reservation.
dict
Response Syntax
{
'InterruptibleCapacityReservationId': 'string',
'SourceCapacityReservationId': 'string',
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptionType': 'adhoc'
}
Response Structure
(dict) --
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation that was modified.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation to which capacity was reclaimed or from which capacity was allocated.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
The requested number of instances for the interruptible Capacity Reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptionType (string) --
The interruption type for the interruptible reservation.