AWS API Changes

2026/06/02 - Amazon Elastic Compute Cloud - 2 new 15 updated api methods

Changes Amazon EC2 now supports self-service cancellation of future-dated Capacity Reservations. A cancellation charge applies based on remaining commitment. Customers can generate a cancellation quote to review charges before confirming.

CreateCapacityReservationCancellationQuote (new)

Link ¶

Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the CancelCapacityReservation action. Cancellation quotes are valid for 24 hours.

See also: AWS API Documentation

Request Syntax

client.create_capacity_reservation_cancellation_quote(
    CapacityReservationId='string',
    ClientToken='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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

type CapacityReservationId:

string

param CapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation.

type ClientToken:

string

param ClientToken:

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.

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the cancellation quote.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type DryRun:

boolean

param DryRun:

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

rtype:

dict

returns:

Response Syntax

{
    'CapacityReservationCancellationQuote': {
        'CapacityReservationCancellationQuoteId': 'string',
        'CapacityReservationId': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'ExpirationTime': datetime(2015, 1, 1),
        'QuoteState': 'pending'|'active'|'expired',
        'CurrentConfiguration': {
            'InstanceCount': 123,
            'ReservationState': 'string'
        },
        'CancellationTerms': [
            {
                'CancellationType': 'commitment-wind-down',
                'ReservationState': 'string',
                'CommittedInstanceCount': 123,
                'ChargeCommitmentDurationHours': 123,
                'ChargeEndDate': datetime(2015, 1, 1)
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- CapacityReservationCancellationQuote (dict) --
  
  Information about the Capacity Reservation cancellation quote.
  - CapacityReservationCancellationQuoteId (string) --
    
    The ID of the cancellation quote.
  - CapacityReservationId (string) --
    
    The ID of the Capacity Reservation associated with the cancellation quote.
  - CreateTime (datetime) --
    
    The date and time at which the cancellation quote was created.
  - ExpirationTime (datetime) --
    
    The date and time at which the cancellation quote expires.
  - QuoteState (string) --
    
    The state of the cancellation quote. Possible values include pending, active, and expired.
  - CurrentConfiguration (dict) --
    
    The current configuration of the Capacity Reservation.
    - InstanceCount (integer) --
      
      The number of instances in the Capacity Reservation.
    - ReservationState (string) --
      
      The current state of the Capacity Reservation.
  - CancellationTerms (list) --
    
    The cancellation terms associated with the quote, including the fee type and charge details.
    - (dict) --
      
      Describes the cancellation terms for cancelling a future-dated Capacity Reservation during its commitment duration.
      - CancellationType (string) --
        
        The type of cancellation charge. Possible values include commitment-wind-down.
      - ReservationState (string) --
        
        The state that the Capacity Reservation will transition to after cancellation.
      - CommittedInstanceCount (integer) --
        
        The number of instances under commitment after cancellation.
      - ChargeCommitmentDurationHours (integer) --
        
        The number of hours for which cancellation charges will apply.
      - ChargeEndDate (datetime) --
        
        The date and time at which cancellation charges will stop.
  - Tags (list) --
    
    The tags assigned to the cancellation quote.
    - (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.

DescribeCapacityReservationCancellationQuotes (new)

Link ¶

Describes one or more Capacity Reservation cancellation quotes. The results describe only the quotes that you have previously generated by using the CreateCapacityReservationCancellationQuote action.

See also: AWS API Documentation

Request Syntax

client.describe_capacity_reservation_cancellation_quotes(
    CapacityReservationCancellationQuoteIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type CapacityReservationCancellationQuoteIds:

list

param CapacityReservationCancellationQuoteIds:

The IDs of the cancellation quotes to describe.

(string) --

type MaxResults:

integer

param MaxResults:

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.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type DryRun:

boolean

param DryRun:

type Filters:

list

param Filters:

One or more filters. Filter names and values are case-sensitive.

(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) --

rtype:

dict

returns:

Response Syntax

{
    'CapacityReservationCancellationQuotes': [
        {
            'CapacityReservationCancellationQuoteId': 'string',
            'CapacityReservationId': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'ExpirationTime': datetime(2015, 1, 1),
            'QuoteState': 'pending'|'active'|'expired',
            'CurrentConfiguration': {
                'InstanceCount': 123,
                'ReservationState': 'string'
            },
            'CancellationTerms': [
                {
                    'CancellationType': 'commitment-wind-down',
                    'ReservationState': 'string',
                    'CommittedInstanceCount': 123,
                    'ChargeCommitmentDurationHours': 123,
                    'ChargeEndDate': datetime(2015, 1, 1)
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- CapacityReservationCancellationQuotes (list) --
  
  Information about the Capacity Reservation cancellation quotes.
  - (dict) --
    
    Describes a Capacity Reservation cancellation quote, which provides the cancellation terms for cancelling a future-dated Capacity Reservation during its commitment duration.
    - CapacityReservationCancellationQuoteId (string) --
      
      The ID of the cancellation quote.
    - CapacityReservationId (string) --
      
      The ID of the Capacity Reservation associated with the cancellation quote.
    - CreateTime (datetime) --
      
      The date and time at which the cancellation quote was created.
    - ExpirationTime (datetime) --
      
      The date and time at which the cancellation quote expires.
    - QuoteState (string) --
      
      The state of the cancellation quote. Possible values include pending, active, and expired.
    - CurrentConfiguration (dict) --
      
      The current configuration of the Capacity Reservation.
      - InstanceCount (integer) --
        
        The number of instances in the Capacity Reservation.
      - ReservationState (string) --
        
        The current state of the Capacity Reservation.
    - CancellationTerms (list) --
      
      The cancellation terms associated with the quote, including the fee type and charge details.
      - (dict) --
        
        Describes the cancellation terms for cancelling a future-dated Capacity Reservation during its commitment duration.
        
        CancellationType (string) --
        
        The type of cancellation charge. Possible values include commitment-wind-down.
        
        ReservationState (string) --
        
        The state that the Capacity Reservation will transition to after cancellation.
        
        CommittedInstanceCount (integer) --
        
        The number of instances under commitment after cancellation.
        
        ChargeCommitmentDurationHours (integer) --
        
        The number of hours for which cancellation charges will apply.
        
        ChargeEndDate (datetime) --
        
        The date and time at which cancellation charges will stop.
    - Tags (list) --
      
      The tags assigned to the cancellation quote.
      - (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.
- 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.

CancelCapacityReservation (updated)

Link ¶
Changes (request)

{'ApplyCancellationCharges': 'commitment-wind-down', 'QuoteId': 'string'}

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.

You can cancel a Capacity Reservation that is in the following states:

assessing
scheduled
active and there is no commitment duration or the commitment duration has elapsed.
active during the commitment duration, if you provide a cancellation quote ID and accept the cancellation charges. Use CreateCapacityReservationCancellationQuote to generate a quote. The Capacity Reservation transitions to cancelling while charges are applied.

If a future-dated Capacity Reservation enters the delayed state, the commitment duration is waived, and you can cancel it as soon as it enters the active state.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

See also: AWS API Documentation

Request Syntax

client.cancel_capacity_reservation(
    CapacityReservationId='string',
    DryRun=True|False,
    ApplyCancellationCharges='commitment-wind-down',
    QuoteId='string'
)

type CapacityReservationId:

string

param CapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation to be cancelled.

type DryRun:

boolean

param DryRun:

type ApplyCancellationCharges:

string

param ApplyCancellationCharges:

Specifies the cancellation charge type to apply when cancelling a future-dated Capacity Reservation during its commitment duration. Possible values include commitment-wind-down, which continues billing for the remaining commitment duration without delivering capacity.

type QuoteId:

string

param QuoteId:

The ID of the cancellation quote to use for the cancellation. You can generate a cancellation quote by using the CreateCapacityReservationCancellationQuote action. The cancellation quote must be in an active state.

rtype:

dict

returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

(dict) --
- Return (boolean) --
  
  Returns true if the request succeeds; otherwise, it returns an error.

CreateCapacityReservation (updated)

Link ¶
Changes (response)

{'CapacityReservation': {'CapacityAllocations': {'AllocationType': {'cancelling'}},
                         'State': {'cancelling'}}}

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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False,
    OutpostArn='string',
    PlacementGroupArn='string',
    StartDate=datetime(2015, 1, 1),
    CommitmentDuration=123,
    DeliveryPreference='fixed'|'incremental'
)

type ClientToken:

string

param ClientToken:

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

type InstanceType:

string

param InstanceType:

[REQUIRED]

The instance type for which to reserve capacity.

For more information, see Instance types in the Amazon EC2 User Guide.

type InstancePlatform:

string

param InstancePlatform:

[REQUIRED]

The type of operating system for which to reserve capacity.

type AvailabilityZone:

string

param AvailabilityZone:

The Availability Zone in which to create the Capacity Reservation.

type AvailabilityZoneId:

string

param AvailabilityZoneId:

The ID of the Availability Zone in which to create the Capacity Reservation.

type Tenancy:

string

param 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.

type InstanceCount:

integer

param InstanceCount:

[REQUIRED]

The number of instances for which to reserve capacity.

Valid range: 1 - 1000

type EbsOptimized:

boolean

param EbsOptimized:

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.

type EphemeralStorage:

boolean

param EphemeralStorage:

Deprecated.

type EndDate:

datetime

param EndDate:

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.

type EndDateType:

string

param EndDateType:

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.

type InstanceMatchCriteria:

string

param InstanceMatchCriteria:

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

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the Capacity Reservation during launch.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type DryRun:

boolean

param DryRun:

type OutpostArn:

string

param OutpostArn:

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

type PlacementGroupArn:

string

param PlacementGroupArn:

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.

type StartDate:

datetime

param StartDate:

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.

type CommitmentDuration:

integer

param CommitmentDuration:

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.

type DeliveryPreference:

string

param DeliveryPreference:

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.

rtype:

dict

returns:

Response Syntax

{
    'CapacityReservation': {
        'CapacityReservationId': 'string',
        'OwnerId': 'string',
        'CapacityReservationArn': 'string',
        'AvailabilityZoneId': 'string',
        'InstanceType': 'string',
        'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'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'
        },
        'InterruptionInfo': {
            'SourceCapacityReservationId': 'string',
            'InterruptionType': 'adhoc'
        }
    }
}

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.
  - 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.

CreateCapacityReservationBySplitting (updated)

Link ¶
Changes (response)

{'DestinationCapacityReservation': {'CapacityAllocations': {'AllocationType': {'cancelling'}},
                                    'State': {'cancelling'}},
 'SourceCapacityReservation': {'CapacityAllocations': {'AllocationType': {'cancelling'}},
                               'State': {'cancelling'}}}

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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

type DryRun:

boolean

param DryRun:

type ClientToken:

string

param ClientToken:

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.

type SourceCapacityReservationId:

string

param SourceCapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation from which you want to split the capacity.

type InstanceCount:

integer

param InstanceCount:

[REQUIRED]

The number of instances to split from the source Capacity Reservation.

type TagSpecifications:

list

param TagSpecifications:

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.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

rtype:

dict

returns:

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'
        },
        'InterruptionInfo': {
            'SourceCapacityReservationId': 'string',
            'InterruptionType': 'adhoc'
        }
    },
    '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'
        },
        'InterruptionInfo': {
            'SourceCapacityReservationId': 'string',
            'InterruptionType': 'adhoc'
        }
    },
    '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.
  - 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.
- 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.
  - 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.
- 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.

CreateLaunchTemplate (updated)

Link ¶
Changes (request)

{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}}

CreateLaunchTemplateVersion (updated)

Link ¶
Changes (request, response)
Request

{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}}

Response

{'LaunchTemplateVersion': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}}}

DescribeCapacityReservations (updated)

Link ¶
Changes (response)

{'CapacityReservations': {'CapacityAllocations': {'AllocationType': {'cancelling'}},
                          'State': {'cancelling'}}}

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
)

type CapacityReservationIds:

list

param CapacityReservationIds:

The ID of the Capacity Reservation.

(string) --

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

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.

type Filters:

list

param Filters:

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) --

type DryRun:

boolean

param DryRun:

rtype:

dict

returns:

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'
            },
            '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.
- 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.
    - 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.

DescribeLaunchTemplateVersions (updated)

Link ¶
Changes (response)

{'LaunchTemplateVersions': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}}}

DescribeSpotFleetRequests (updated)

Link ¶
Changes (response)

{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}},
                                                        'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}}}

DescribeTags (updated)

Link ¶
Changes (response)

{'Tags': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}

Describes the specified tags for your EC2 resources.

For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

Request Syntax

client.describe_tags(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun:

boolean

param DryRun:

type Filters:

list

param Filters:

The filters.

key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.

(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) --

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

type NextToken:

string

param NextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Tags': [
        {
            'Key': 'string',
            'ResourceId': 'string',
            '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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  The token to include in another request to get the next page of items. This value is null when there are no more items to return.
- Tags (list) --
  
  The tags.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The tag key.
    - ResourceId (string) --
      
      The ID of the resource.
    - ResourceType (string) --
      
      The resource type.
    - Value (string) --
      
      The tag value.

GetCapacityReservationUsage (updated)

Link ¶
Changes (response)

{'State': {'cancelling'}}

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
)

type CapacityReservationId:

string

param CapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

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.

type DryRun:

boolean

param DryRun:

rtype:

dict

returns:

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'
    },
    '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.
- 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.

GetLaunchTemplateData (updated)

Link ¶
Changes (response)

{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}}

MoveCapacityReservationInstances (updated)

Link ¶
Changes (response)

{'DestinationCapacityReservation': {'CapacityAllocations': {'AllocationType': {'cancelling'}},
                                    'State': {'cancelling'}},
 'SourceCapacityReservation': {'CapacityAllocations': {'AllocationType': {'cancelling'}},
                               'State': {'cancelling'}}}

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
)

type DryRun:

boolean

param DryRun:

type ClientToken:

string

param ClientToken:

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.

type SourceCapacityReservationId:

string

param SourceCapacityReservationId:

[REQUIRED]

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

type DestinationCapacityReservationId:

string

param DestinationCapacityReservationId:

[REQUIRED]

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

type InstanceCount:

integer

param InstanceCount:

[REQUIRED]

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

rtype:

dict

returns:

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'
        },
        'InterruptionInfo': {
            'SourceCapacityReservationId': 'string',
            'InterruptionType': 'adhoc'
        }
    },
    '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'
        },
        'InterruptionInfo': {
            'SourceCapacityReservationId': 'string',
            'InterruptionType': 'adhoc'
        }
    },
    '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.
  - 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.
- 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.
  - 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.
- InstanceCount (integer) --
  
  The number of instances that were moved from the source Capacity Reservation to the destination Capacity Reservation.

ProvisionByoipCidr (updated)

Link ¶
Changes (request)

{'PoolTagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised.

Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range.

See also: AWS API Documentation

Request Syntax

client.provision_byoip_cidr(
    Cidr='string',
    CidrAuthorizationContext={
        'Message': 'string',
        'Signature': 'string'
    },
    PubliclyAdvertisable=True|False,
    Description='string',
    DryRun=True|False,
    PoolTagSpecifications=[
        {
            '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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    MultiRegion=True|False,
    NetworkBorderGroup='string'
)

type Cidr:

string

param Cidr:

[REQUIRED]

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

type CidrAuthorizationContext:

dict

param CidrAuthorizationContext:

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

Message (string) -- [REQUIRED]

The plain-text authorization message for the prefix and account.
Signature (string) -- [REQUIRED]

The signed authorization message for the prefix and account.

type PubliclyAdvertisable:

boolean

param PubliclyAdvertisable:

(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Default: true

type Description:

string

param Description:

A description for the address range and the address pool.

type DryRun:

boolean

param DryRun:

type PoolTagSpecifications:

list

param PoolTagSpecifications:

The tags to apply to the address pool.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type MultiRegion:

boolean

param MultiRegion:

Reserved.

type NetworkBorderGroup:

string

param NetworkBorderGroup:

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2

rtype:

dict

returns:

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'Description': 'string',
        'AsnAssociations': [
            {
                'Asn': 'string',
                'Cidr': 'string',
                'StatusMessage': 'string',
                'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
            },
        ],
        'StatusMessage': 'string',
        'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
        'NetworkBorderGroup': 'string',
        'AdvertisementType': 'string'
    }
}

Response Structure

(dict) --
- ByoipCidr (dict) --
  
  Information about the address range.
  - Cidr (string) --
    
    The address range, in CIDR notation.
  - Description (string) --
    
    The description of the address range.
  - AsnAssociations (list) --
    
    The BYOIP CIDR associations with ASNs.
    - (dict) --
      
      An Autonomous System Number (ASN) and BYOIP CIDR association.
      - Asn (string) --
        
        The association's ASN.
      - Cidr (string) --
        
        The association's CIDR.
      - StatusMessage (string) --
        
        The association's status message.
      - State (string) --
        
        The association's state.
  - StatusMessage (string) --
    
    Upon success, contains the ID of the address pool. Otherwise, contains an error message.
  - State (string) --
    
    The state of the address range.
    - advertised: The address range is being advertised to the internet by Amazon Web Services.
    - deprovisioned: The address range is deprovisioned.
    - failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    - failed-provision: The request to provision the address range was unsuccessful.
    - pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
    - pending-provision: You’ve submitted a request to provision an address range and it's pending.
    - provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    - provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
  - NetworkBorderGroup (string) --
    
    If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
    
    You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
    - us-east-1-dfw-2
    - us-west-2-lax-1
    - us-west-2-phx-2
    Note
    
    You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
  - AdvertisementType (string) --
    
    Specifies the advertisement method for the BYOIP CIDR. Valid values are:
    - unicast: IP is advertised from a single location (regional services like EC2)
    - anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
    For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.

PurchaseCapacityBlock (updated)

Link ¶
Changes (response)

{'CapacityReservation': {'CapacityAllocations': {'AllocationType': {'cancelling'}},
                         'State': {'cancelling'}}}

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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote',
            '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'
)

type DryRun:

boolean

param DryRun:

type TagSpecifications:

list

param TagSpecifications:

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.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type CapacityBlockOfferingId:

string

param CapacityBlockOfferingId:

[REQUIRED]

The ID of the Capacity Block offering.

type InstancePlatform:

string

param InstancePlatform:

[REQUIRED]

The type of operating system for which to reserve capacity.

rtype:

dict

returns:

Response Syntax

{
    'CapacityReservation': {
        'CapacityReservationId': 'string',
        'OwnerId': 'string',
        'CapacityReservationArn': 'string',
        'AvailabilityZoneId': 'string',
        'InstanceType': 'string',
        'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'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'
        },
        'InterruptionInfo': {
            'SourceCapacityReservationId': 'string',
            'InterruptionType': 'adhoc'
        }
    },
    '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.
  - 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.
- 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.

RequestSpotFleet (updated)

Link ¶
Changes (request)

{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}},
                            'TagSpecifications': {'ResourceType': {'capacity-reservation-cancellation-quote'}}}}