Skip to content

CloudFormation  >  Operations  >  estimate_template_cost

estimate_template_cost

Operation

estimate_template_cost async

estimate_template_cost(request: EstimateTemplateCostInput | EstimateTemplateCostInputDict, /, *, plugins: list[Plugin] | None = None) -> EstimateTemplateCostOutput
estimate_template_cost(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EstimateTemplateCostInputDict]) -> EstimateTemplateCostOutput

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
EstimateTemplateCostOutput

An instance of EstimateTemplateCostOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

EstimateTemplateCostInput dataclass

Bases: _SerdeShape

The input for an EstimateTemplateCost action.

Attributes
parameters class-attribute instance-attribute
parameters: list[Parameter] | None = ...

A list of Parameter structures that specify input parameters.

template_body class-attribute instance-attribute
template_body: str | None = ...

Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

template_url class-attribute instance-attribute
template_url: str | None = ...

The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Dictionaries

EstimateTemplateCostInputDict

Bases: TypedDict

Dictionary form of EstimateTemplateCostInput.

Attributes
parameters instance-attribute
parameters: Sequence[Parameter | ParameterDict] | None

A list of Parameter structures that specify input parameters.

template_body instance-attribute
template_body: str | None

Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

template_url instance-attribute
template_url: str | None

The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Output

EstimateTemplateCostOutput dataclass

Bases: _SerdeShape

The output for a EstimateTemplateCost action.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

url class-attribute instance-attribute
url: str | None = ...

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.