Skip to content

describe_capacity_block_extension_offerings async

describe_capacity_block_extension_offerings(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    capacity_block_extension_duration_hours: Optional[Integer] = None,
    capacity_reservation_id: Optional[CapacityReservationId] = None,
    next_token: Optional[String] = None,
    max_results: Optional[DescribeCapacityBlockExtensionOfferingsMaxResults] = None,
) -> DescribeCapacityBlockExtensionOfferingsResult

Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.

Parameters:

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

  • capacity_block_extension_duration_hours (Optional[Integer], default: None ) –

    The duration of the Capacity Block extension offering in hours.

  • capacity_reservation_id (Optional[CapacityReservationId], default: None ) –

    The ID of the Capacity reservation to be extended.

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

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

  • max_results (Optional[DescribeCapacityBlockExtensionOfferingsMaxResults], 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.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_capacity_block_extension_offerings(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    capacity_block_extension_duration_hours: Optional[
        "capo_ec2.types.integer.Integer"
    ] = None,
    capacity_reservation_id: Optional[
        "capo_ec2.types.capacity_reservation_id.CapacityReservationId"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_capacity_block_extension_offerings_max_results.DescribeCapacityBlockExtensionOfferingsMaxResults"
    ] = None,
) -> "capo_ec2.types.describe_capacity_block_extension_offerings_result.DescribeCapacityBlockExtensionOfferingsResult":
    """<p>Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.</p>

    Args:
        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>
        capacity_block_extension_duration_hours: <p>The duration of the Capacity Block extension offering in hours.</p>
        capacity_reservation_id: <p>The ID of the Capacity reservation to be extended.</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>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_capacity_block_extension_offerings_request.DescribeCapacityBlockExtensionOfferingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_capacity_block_extension_offerings_result.DescribeCapacityBlockExtensionOfferingsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_capacity_block_extension_offerings

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_capacity_block_extension_offerings.async_describe_capacity_block_extension_offerings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeCapacityBlockExtensionOfferings"),
    )
    input_: capo_ec2.types.describe_capacity_block_extension_offerings_request.DescribeCapacityBlockExtensionOfferingsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if capacity_block_extension_duration_hours is not None:
        input_["capacity_block_extension_duration_hours"] = (
            capacity_block_extension_duration_hours
        )
    if capacity_reservation_id is not None:
        input_["capacity_reservation_id"] = capacity_reservation_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output