create_capacity_reservation_cancellation_quote¶
Operation¶
create_capacity_reservation_cancellation_quote
¶
create_capacity_reservation_cancellation_quote(request: CreateCapacityReservationCancellationQuoteInput | CreateCapacityReservationCancellationQuoteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCapacityReservationCancellationQuoteInputDict]) -> CreateCapacityReservationCancellationQuoteOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateCapacityReservationCancellationQuoteInput | CreateCapacityReservationCancellationQuoteInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateCapacityReservationCancellationQuoteInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateCapacityReservationCancellationQuoteOutput
|
An instance of |
create_capacity_reservation_cancellation_quote
async
¶
create_capacity_reservation_cancellation_quote(request: CreateCapacityReservationCancellationQuoteInput | CreateCapacityReservationCancellationQuoteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCapacityReservationCancellationQuoteInputDict]) -> CreateCapacityReservationCancellationQuoteOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateCapacityReservationCancellationQuoteInput | CreateCapacityReservationCancellationQuoteInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateCapacityReservationCancellationQuoteInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateCapacityReservationCancellationQuoteOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateCapacityReservationCancellationQuoteInputDict
¶
Bases: TypedDict
Dictionary form of CreateCapacityReservationCancellationQuoteInput.
Attributes¶
capacity_reservation_id
instance-attribute
¶
The ID of the Capacity Reservation.
client_token
instance-attribute
¶
client_token: str | None
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.
dry_run
instance-attribute
¶
dry_run: bool | None
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.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply to the cancellation quote.
CreateCapacityReservationCancellationQuoteInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateCapacityReservationCancellationQuoteInput structure.
Attributes¶
capacity_reservation_id
class-attribute
instance-attribute
¶
capacity_reservation_id: str | None = ...
The ID of the Capacity Reservation.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
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.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the cancellation quote.
Output¶
CreateCapacityReservationCancellationQuoteOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateCapacityReservationCancellationQuoteOutput structure.
Attributes¶
capacity_reservation_cancellation_quote
class-attribute
instance-attribute
¶
capacity_reservation_cancellation_quote: CapacityReservationCancellationQuote | None = ...
Information about the Capacity Reservation cancellation quote.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.