describe_capacity_block_status ¶

def describe_capacity_block_status(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_block_ids: Optional[
        "capo_ec2.types.capacity_block_ids.CapacityBlockIds"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_capacity_block_status_max_results.DescribeCapacityBlockStatusMaxResults"
    ] = 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_status_result.DescribeCapacityBlockStatusResult":
    """<p>Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.</p>

    Args:
        capacity_block_ids: <p>The ID of the Capacity Block.</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>interconnect-status</code> - The status of the interconnect for the Capacity Block (<code>ok</code> | <code>impaired</code> | <code>insufficient-data</code>).</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_status_request.DescribeCapacityBlockStatusRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_capacity_block_status_result.DescribeCapacityBlockStatusResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_capacity_block_status

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCapacityBlockStatus")
    )
    input_: capo_ec2.types.describe_capacity_block_status_request.DescribeCapacityBlockStatusRequest = {}
    if capacity_block_ids is not None:
        input_["capacity_block_ids"] = capacity_block_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