Skip to content

describe_spot_fleet_requests async

describe_spot_fleet_requests(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    spot_fleet_request_ids: Optional[SpotFleetRequestIdList] = None,
    next_token: Optional[String] = None,
    max_results: Optional[Integer] = None,
) -> DescribeSpotFleetRequestsResponse

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

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.

  • spot_fleet_request_ids (Optional[SpotFleetRequestIdList], default: None ) –

    The IDs of the Spot Fleet requests.

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

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • max_results (Optional[Integer], 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:

Examples:

To describe a Spot fleet request This example describes the specified Spot fleet request.

>>> await client.describe_spot_fleet_requests(spot_fleet_request_ids=['sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE'])
Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_spot_fleet_requests(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    spot_fleet_request_ids: Optional[
        "capo_ec2.types.spot_fleet_request_id_list.SpotFleetRequestIdList"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
) -> "capo_ec2.types.describe_spot_fleet_requests_response.DescribeSpotFleetRequestsResponse":
    """<p>Describes your Spot Fleet requests.</p> <p>Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.</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>
        spot_fleet_request_ids: <p>The IDs of the Spot Fleet requests.</p>
        next_token: <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</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.

    Examples:
        To describe a Spot fleet request
        This example describes the specified Spot fleet request.

        >>> await client.describe_spot_fleet_requests(spot_fleet_request_ids=['sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE'])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_spot_fleet_requests_request.DescribeSpotFleetRequestsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_spot_fleet_requests_response.DescribeSpotFleetRequestsResponse"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_spot_fleet_requests

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

    def _redact_output(
        output: "capo_ec2.types.describe_spot_fleet_requests_response.DescribeSpotFleetRequestsResponse",
    ) -> dict[str, Any]:
        import capo_ec2.types.describe_spot_fleet_requests_response

        return (
            capo_ec2.types.describe_spot_fleet_requests_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeSpotFleetRequests", redact_output=_redact_output),
    )
    input_: capo_ec2.types.describe_spot_fleet_requests_request.DescribeSpotFleetRequestsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if spot_fleet_request_ids is not None:
        input_["spot_fleet_request_ids"] = spot_fleet_request_ids
    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