get_cost_estimate `async` ¶

get_cost_estimate(
    resource_name: ResourceName,
    start_time: IsoDate,
    end_time: IsoDate,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> GetCostEstimateResult

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

Parameters:

resource_name (ResourceName) –

The resource name.
start_time (IsoDate) –
The cost estimate start time.

Constraints:
- Specified in Coordinated Universal Time (UTC).
- Specified in the Unix time format.
  
  For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
end_time (IsoDate) –
The cost estimate end time.

Constraints:
- Specified in Coordinated Universal Time (UTC).
- Specified in the Unix time format.
  
  For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException –

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
RegionSetupInProgressException –

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/async_lightsail.py

async def get_cost_estimate(
    self,
    resource_name: "capo_lightsail.types.resource_name.ResourceName",
    start_time: "capo_lightsail.types.iso_date.IsoDate",
    end_time: "capo_lightsail.types.iso_date.IsoDate",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> "capo_lightsail.types.get_cost_estimate_result.GetCostEstimateResult":
    """<p>Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.</p>

    Args:
        resource_name: <p>The resource name.</p>
        start_time: <p>The cost estimate start time.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify <code>1538424000</code> as the start time.</p> </li> </ul> <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
        end_time: <p>The cost estimate end time.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify <code>1538427600</code> as the end time.</p> </li> </ul> <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.get_cost_estimate_request.GetCostEstimateRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.get_cost_estimate_result.GetCostEstimateResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_cost_estimate

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.get_cost_estimate.async_get_cost_estimate(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCostEstimate")
    )
    input_: capo_lightsail.types.get_cost_estimate_request.GetCostEstimateRequest = {
        "resource_name": resource_name,
        "start_time": start_time,
        "end_time": end_time,
    }

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

get_cost_estimate async ¶

get_cost_estimate `async` ¶