Class LockGuideCommandProtected

Locks guide to prevent unexpected updating, deleting, and publishing.

Example

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

import { GuidesClient, LockGuideCommand } from "@stedi/sdk-client-guides"; // ES Modules import
// const { GuidesClient, LockGuideCommand } = require("@stedi/sdk-client-guides"); // CommonJS import
const client = new GuidesClient(config);
const input = { // LockGuideInput
  id: "STRING_VALUE", // required
  lockedBy: "STRING_VALUE",
};
const command = new LockGuideCommand(input);
const response = await client.send(command);
// { // LockGuideOutput
//   id: "STRING_VALUE", // required
//   lockStatus: "unlocked" || "locked", // required
// };

Param

LockGuideCommandInput

Returns

LockGuideCommandOutput

See

• LockGuideCommandInput for command's input shape.
• LockGuideCommandOutput for command's response shape.
• config for GuidesClient's config shape.

Throws

InternalFailureException (server fault) The server response when an unexpected error occurred while processing request.

Throws

ThrottlingException (client fault) The server response when usage plan or account-level throttling limits exceeded.

Throws

ValidationException (client fault) A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

Throws

AccessDeniedException (client fault) The server response for authorization failure.

Throws

UnauthorizedException (client fault) The server response when the authorizer failed to authenticate the caller.

Throws

ResourceConflictException (client fault) The server could not process the request because of conflict in the current state of the resource.

Throws

ResourceLockedException (client fault) The server response when the resource is locked and no updates are allowed.

Throws

BadRequestException (client fault) The server cannot process the request due to an apparent client error.

Throws

ResourceNotFoundException (client fault) The server response when the specified resource cannot be found after an API request passes authentication and authorization.

Throws

GuidesServiceException

Base exception class for all service exceptions from Guides service.