EC2 / Client / create_capacity_reservation_date_change_quote

create_capacity_reservation_date_change_quote¶

EC2.Client.create_capacity_reservation_date_change_quote(**kwargs)¶

Generates a quote for changing the start date of a future-dated Capacity Reservation that has not yet been delivered. The quote includes the new start date, the resulting commitment end date, and a quote ID. Pass the quote ID to ModifyCapacityReservation to apply the change.

The cumulative pushout across all changes is limited to 30 days from the Capacity Reservation’s original start date. Quotes are valid for 24 hours, and always expire at least one hour before the start date.

Request Syntax

response = client.create_capacity_reservation_date_change_quote(
    CapacityReservationId='string',
    NewStartDate=datetime(2015, 1, 1),
    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'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

CapacityReservationId (string) –
[REQUIRED]

The ID of the Capacity Reservation.
NewStartDate (datetime) –
[REQUIRED]

The requested new start date for the Capacity Reservation, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). The new start date must be later than the current start date and within the cumulative 30-day pushout limit.
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 date change 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

{
    'CapacityReservationModificationQuote': {
        'CapacityReservationModificationQuoteId': 'string',
        'CapacityReservationId': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'ExpirationTime': datetime(2015, 1, 1),
        'QuoteState': 'active'|'expired',
        'CurrentConfiguration': {
            'InstanceCount': 123,
            'ReservationState': 'string',
            'StartDate': datetime(2015, 1, 1),
            'OriginalStartDate': datetime(2015, 1, 1)
        },
        'ModificationTerms': {
            'ReservationUpdate': {
                'NewCommitmentEndDate': datetime(2015, 1, 1),
                'NewStartDate': datetime(2015, 1, 1),
                'NewCommitmentDuration': 123
            }
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- CapacityReservationModificationQuote (dict) –
  
  Information about the Capacity Reservation date change quote.
  - CapacityReservationModificationQuoteId (string) –
    
    The ID of the modification quote.
  - CapacityReservationId (string) –
    
    The ID of the Capacity Reservation associated with the modification quote.
  - CreateTime (datetime) –
    
    The date and time at which the modification quote was created.
  - ExpirationTime (datetime) –
    
    The date and time at which the modification quote expires.
  - QuoteState (string) –
    
    The state of the modification quote itself. Possible values are:
    - active - The quote can still be used.
    - expired - The quote can no longer be used. A quote becomes expired at its expirationTime.
  - CurrentConfiguration (dict) –
    
    The configuration that the Capacity Reservation has at the time the quote was generated.
    - InstanceCount (integer) –
      
      The number of instances in the Capacity Reservation.
    - ReservationState (string) –
      
      The current state of the Capacity Reservation.
    - StartDate (datetime) –
      
      The start date that the Capacity Reservation has before the quoted modification is applied.
    - OriginalStartDate (datetime) –
      
      The start date that the Capacity Reservation was originally requested with. This value does not change when you push out the start date.
  - ModificationTerms (dict) –
    
    The terms of the modification, including the configuration that the Capacity Reservation will have if you accept them by using ModifyCapacityReservation.
    - ReservationUpdate (dict) –
      
      The changes that will be applied to the Capacity Reservation if you accept the modification terms.
      - NewCommitmentEndDate (datetime) –
        
        The date and time at which the commitment duration will expire after the modification, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).
      - NewStartDate (datetime) –
        
        The start date that the Capacity Reservation will have after the modification, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).
      - NewCommitmentDuration (integer) –
        
        The commitment duration, in seconds, that the Capacity Reservation will have after the modification.
  - Tags (list) –
    
    The tags assigned to the modification 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.