EC2 / Client / create_capacity_reservation_cancellation_quote

create_capacity_reservation_cancellation_quote¶

EC2.Client.create_capacity_reservation_cancellation_quote(**kwargs)¶

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.

Request Syntax

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

Parameters:

CapacityReservationId (string) –
[REQUIRED]

The ID of the Capacity Reservation.
ClientToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

This field is autopopulated if not provided.
TagSpecifications (list) –
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.
DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

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.