Skip to content

describe_capacity_block_extension_history

describe_capacity_block_extension_history(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_reservation_ids: Optional[CapacityReservationIdSet] = None,
    next_token: Optional[String] = None,
    max_results: Optional[DescribeFutureCapacityMaxResults] = None,
    filters: Optional[FilterList] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeCapacityBlockExtensionHistoryResult

Describes the events for the specified Capacity Block extension during the specified time.

Parameters:

  • capacity_reservation_ids (Optional[CapacityReservationIdSet], default: None ) –

    The IDs of Capacity Block reservations that you want to display the history for.

  • next_token (Optional[String], default: None ) –

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

  • max_results (Optional[DescribeFutureCapacityMaxResults], default: None ) –

    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.

  • filters (Optional[FilterList], default: None ) –

    One or more filters

    • availability-zone - The Availability Zone of the extension.

    • availability-zone-id - The Availability Zone ID of the extension.

    • capacity-block-extension-offering-id - The ID of the extension offering.

    • capacity-block-extension-status - The status of the extension (payment-pending | payment-failed | payment-succeeded).

    • capacity-reservation-id - The reservation ID of the extension.

    • instance-type - The instance type of the extension.

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_capacity_block_extension_history(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_reservation_ids: Optional[
        "capo_ec2.types.capacity_reservation_id_set.CapacityReservationIdSet"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_future_capacity_max_results.DescribeFutureCapacityMaxResults"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_capacity_block_extension_history_result.DescribeCapacityBlockExtensionHistoryResult":
    """<p>Describes the events for the specified Capacity Block extension during the specified time.</p>

    Args:
        capacity_reservation_ids: <p>The IDs of Capacity Block reservations that you want to display the history for.</p>
        next_token: <p>The token to use to retrieve the next page of results.</p>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        filters: <p>One or more filters</p> <ul> <li> <p> <code>availability-zone</code> - The Availability Zone of the extension.</p> </li> <li> <p> <code>availability-zone-id</code> - The Availability Zone ID of the extension.</p> </li> <li> <p> <code>capacity-block-extension-offering-id</code> - The ID of the extension offering.</p> </li> <li> <p> <code>capacity-block-extension-status</code> - The status of the extension (<code>payment-pending</code> | <code>payment-failed</code> | <code>payment-succeeded</code>).</p> </li> <li> <p> <code>capacity-reservation-id</code> - The reservation ID of the extension.</p> </li> <li> <p> <code>instance-type</code> - The instance type of the extension.</p> </li> </ul>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_capacity_block_extension_history_request.DescribeCapacityBlockExtensionHistoryRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_capacity_block_extension_history_result.DescribeCapacityBlockExtensionHistoryResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_capacity_block_extension_history

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_capacity_block_extension_history.describe_capacity_block_extension_history(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCapacityBlockExtensionHistory")
    )
    input_: capo_ec2.types.describe_capacity_block_extension_history_request.DescribeCapacityBlockExtensionHistoryRequest = {}
    if capacity_reservation_ids is not None:
        input_["capacity_reservation_ids"] = capacity_reservation_ids
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output