Skip to content

StartResourceEvaluationRequest

Source code in docs_src/capo_config_service/types/start_resource_evaluation_request.py
class StartResourceEvaluationRequest(TypedDict, closed=True):
    resource_details: "capo_config_service.types.resource_details.ResourceDetails"
    """<p>Returns a <code>ResourceDetails</code> object.</p>"""
    evaluation_context: NotRequired[
        "capo_config_service.types.evaluation_context.EvaluationContext"
    ]
    """<p>Returns an <code>EvaluationContext</code> object.</p>"""
    evaluation_mode: "capo_config_service.types.evaluation_mode.EvaluationMode"
    """<p>The mode of an evaluation.</p> <note> <p>The only valid value for this API is <code>PROACTIVE</code>.</p> </note>"""
    evaluation_timeout: "capo_config_service.types.evaluation_timeout.EvaluationTimeout"
    """<p>The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.</p>"""
    client_token: NotRequired["capo_config_service.types.client_token.ClientToken"]
    """<p>A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.</p> <note> <p>Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.</p> </note>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

evaluation_context instance-attribute

evaluation_context: NotRequired[EvaluationContext]

Returns an EvaluationContext object.

evaluation_mode instance-attribute

evaluation_mode: EvaluationMode

The mode of an evaluation.

The only valid value for this API is PROACTIVE.

evaluation_timeout instance-attribute

evaluation_timeout: EvaluationTimeout

The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

resource_details instance-attribute

resource_details: ResourceDetails

Returns a ResourceDetails object.