Skip to content

CloudFormation  >  Operations  >  record_handler_progress

record_handler_progress

Operation

record_handler_progress async

record_handler_progress(request: RecordHandlerProgressInput | RecordHandlerProgressInputDict, /, *, plugins: list[Plugin] | None = None) -> RecordHandlerProgressOutput
record_handler_progress(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RecordHandlerProgressInputDict]) -> RecordHandlerProgressOutput

Reports progress of a resource handler to CloudFormation.

Reserved for use by the CloudFormation CLI. Don't use this API in your code.

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
RecordHandlerProgressOutput

An instance of RecordHandlerProgressOutput.

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

RecordHandlerProgressInput dataclass

Bases: _SerdeShape

Dataclass for RecordHandlerProgressInput structure.

Attributes
bearer_token class-attribute instance-attribute
bearer_token: str | None = ...

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation CLI.

Dictionaries

RecordHandlerProgressInputDict

Bases: TypedDict

Dictionary form of RecordHandlerProgressInput.

Attributes
bearer_token instance-attribute
bearer_token: Required[str]

Reserved for use by the CloudFormation CLI.

client_request_token instance-attribute
client_request_token: str | None

Reserved for use by the CloudFormation CLI.

current_operation_status instance-attribute
current_operation_status: str | None

Reserved for use by the CloudFormation CLI.

error_code instance-attribute
error_code: str | None

Reserved for use by the CloudFormation CLI.

operation_status instance-attribute
operation_status: Required[str]

Reserved for use by the CloudFormation CLI.

resource_model instance-attribute
resource_model: str | None

Reserved for use by the CloudFormation CLI.

status_message instance-attribute
status_message: str | None

Reserved for use by the CloudFormation CLI.

Output

RecordHandlerProgressOutput dataclass

Bases: _SerdeShape

Dataclass for RecordHandlerProgressOutput structure.

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.