RecordHandlerProgressCommand

Suggest an Edit

Reports progress of a resource handler to CloudFormation.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFormationClient, RecordHandlerProgressCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, RecordHandlerProgressCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // RecordHandlerProgressInput
  BearerToken: "STRING_VALUE", // required
  OperationStatus: "PENDING" || "IN_PROGRESS" || "SUCCESS" || "FAILED", // required
  CurrentOperationStatus: "PENDING" || "IN_PROGRESS" || "SUCCESS" || "FAILED",
  StatusMessage: "STRING_VALUE",
  ErrorCode: "NotUpdatable" || "InvalidRequest" || "AccessDenied" || "InvalidCredentials" || "AlreadyExists" || "NotFound" || "ResourceConflict" || "Throttling" || "ServiceLimitExceeded" || "NotStabilized" || "GeneralServiceException" || "ServiceInternalError" || "NetworkFailure" || "InternalFailure" || "InvalidTypeConfiguration" || "HandlerInternalFailure" || "NonCompliant" || "Unknown" || "UnsupportedTarget",
  ResourceModel: "STRING_VALUE",
  ClientRequestToken: "STRING_VALUE",
};
const command = new RecordHandlerProgressCommand(input);
const response = await client.send(command);
// {};

RecordHandlerProgressCommand Input

See RecordHandlerProgressCommandInput for more details

Parameter
Type
Description
BearerToken
Required
string | undefined

Reserved for use by the CloudFormation CLI .

OperationStatus
Required
OperationStatus | undefined

Reserved for use by the CloudFormation CLI .

ClientRequestToken
string | undefined

Reserved for use by the CloudFormation CLI .

CurrentOperationStatus
OperationStatus | undefined

Reserved for use by the CloudFormation CLI .

ErrorCode
HandlerErrorCode | undefined

Reserved for use by the CloudFormation CLI .

ResourceModel
string | undefined

Reserved for use by the CloudFormation CLI .

StatusMessage
string | undefined

Reserved for use by the CloudFormation CLI .

RecordHandlerProgressCommand Output

See RecordHandlerProgressCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidStateTransitionException
client

Error reserved for use by the CloudFormation CLI . CloudFormation doesn't return this error to users.

OperationStatusCheckFailedException
client

Error reserved for use by the CloudFormation CLI . CloudFormation doesn't return this error to users.

CloudFormationServiceException
Base exception class for all service exceptions from CloudFormation service.