@aws-sdk/client-swf 3.321.1 → 3.326.0

package/dist-types/commands/CountClosedWorkflowExecutionsCommand.d.ts

@@ -98,6 +98,11 @@ export interface CountClosedWorkflowExecutionsCommandOutput extends WorkflowExec
  * };
  * const command = new CountClosedWorkflowExecutionsCommand(input);
  * const response = await client.send(command);
+ * // { // WorkflowExecutionCount
+ * //   count: Number("int"), // required
+ * //   truncated: true || false,
+ * // };
+ *
  * ```
  *
  * @param CountClosedWorkflowExecutionsCommandInput - {@link CountClosedWorkflowExecutionsCommandInput}
@@ -112,6 +117,8 @@ export interface CountClosedWorkflowExecutionsCommandOutput extends WorkflowExec
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class CountClosedWorkflowExecutionsCommand extends $Command<CountClosedWorkflowExecutionsCommandInput, CountClosedWorkflowExecutionsCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/CountOpenWorkflowExecutionsCommand.d.ts

@@ -91,6 +91,11 @@ export interface CountOpenWorkflowExecutionsCommandOutput extends WorkflowExecut
  * };
  * const command = new CountOpenWorkflowExecutionsCommand(input);
  * const response = await client.send(command);
+ * // { // WorkflowExecutionCount
+ * //   count: Number("int"), // required
+ * //   truncated: true || false,
+ * // };
+ *
  * ```
  *
  * @param CountOpenWorkflowExecutionsCommandInput - {@link CountOpenWorkflowExecutionsCommandInput}
@@ -105,6 +110,8 @@ export interface CountOpenWorkflowExecutionsCommandOutput extends WorkflowExecut
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class CountOpenWorkflowExecutionsCommand extends $Command<CountOpenWorkflowExecutionsCommandInput, CountOpenWorkflowExecutionsCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/CountPendingActivityTasksCommand.d.ts

@@ -61,6 +61,11 @@ export interface CountPendingActivityTasksCommandOutput extends PendingTaskCount
  * };
  * const command = new CountPendingActivityTasksCommand(input);
  * const response = await client.send(command);
+ * // { // PendingTaskCount
+ * //   count: Number("int"), // required
+ * //   truncated: true || false,
+ * // };
+ *
  * ```
  *
  * @param CountPendingActivityTasksCommandInput - {@link CountPendingActivityTasksCommandInput}
@@ -75,6 +80,8 @@ export interface CountPendingActivityTasksCommandOutput extends PendingTaskCount
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class CountPendingActivityTasksCommand extends $Command<CountPendingActivityTasksCommandInput, CountPendingActivityTasksCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/CountPendingDecisionTasksCommand.d.ts

@@ -61,6 +61,11 @@ export interface CountPendingDecisionTasksCommandOutput extends PendingTaskCount
  * };
  * const command = new CountPendingDecisionTasksCommand(input);
  * const response = await client.send(command);
+ * // { // PendingTaskCount
+ * //   count: Number("int"), // required
+ * //   truncated: true || false,
+ * // };
+ *
  * ```
  *
  * @param CountPendingDecisionTasksCommandInput - {@link CountPendingDecisionTasksCommandInput}
@@ -75,6 +80,8 @@ export interface CountPendingDecisionTasksCommandOutput extends PendingTaskCount
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class CountPendingDecisionTasksCommand extends $Command<CountPendingDecisionTasksCommandInput, CountPendingDecisionTasksCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/DeprecateActivityTypeCommand.d.ts

@@ -77,6 +77,8 @@ export interface DeprecateActivityTypeCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeprecateActivityTypeCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeprecateActivityTypeCommandInput - {@link DeprecateActivityTypeCommandInput}
@@ -94,6 +96,8 @@ export interface DeprecateActivityTypeCommandOutput extends __MetadataBearer {
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class DeprecateActivityTypeCommand extends $Command<DeprecateActivityTypeCommandInput, DeprecateActivityTypeCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/DeprecateDomainCommand.d.ts

@@ -62,6 +62,8 @@ export interface DeprecateDomainCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeprecateDomainCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeprecateDomainCommandInput - {@link DeprecateDomainCommandInput}
@@ -79,6 +81,8 @@ export interface DeprecateDomainCommandOutput extends __MetadataBearer {
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class DeprecateDomainCommand extends $Command<DeprecateDomainCommandInput, DeprecateDomainCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/DeprecateWorkflowTypeCommand.d.ts

@@ -78,6 +78,8 @@ export interface DeprecateWorkflowTypeCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeprecateWorkflowTypeCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeprecateWorkflowTypeCommandInput - {@link DeprecateWorkflowTypeCommandInput}
@@ -95,6 +97,8 @@ export interface DeprecateWorkflowTypeCommandOutput extends __MetadataBearer {
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class DeprecateWorkflowTypeCommand extends $Command<DeprecateWorkflowTypeCommandInput, DeprecateWorkflowTypeCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/DescribeActivityTypeCommand.d.ts

@@ -73,6 +73,29 @@ export interface DescribeActivityTypeCommandOutput extends ActivityTypeDetail, _
  * };
  * const command = new DescribeActivityTypeCommand(input);
  * const response = await client.send(command);
+ * // { // ActivityTypeDetail
+ * //   typeInfo: { // ActivityTypeInfo
+ * //     activityType: { // ActivityType
+ * //       name: "STRING_VALUE", // required
+ * //       version: "STRING_VALUE", // required
+ * //     },
+ * //     status: "REGISTERED" || "DEPRECATED", // required
+ * //     description: "STRING_VALUE",
+ * //     creationDate: new Date("TIMESTAMP"), // required
+ * //     deprecationDate: new Date("TIMESTAMP"),
+ * //   },
+ * //   configuration: { // ActivityTypeConfiguration
+ * //     defaultTaskStartToCloseTimeout: "STRING_VALUE",
+ * //     defaultTaskHeartbeatTimeout: "STRING_VALUE",
+ * //     defaultTaskList: { // TaskList
+ * //       name: "STRING_VALUE", // required
+ * //     },
+ * //     defaultTaskPriority: "STRING_VALUE",
+ * //     defaultTaskScheduleToStartTimeout: "STRING_VALUE",
+ * //     defaultTaskScheduleToCloseTimeout: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeActivityTypeCommandInput - {@link DescribeActivityTypeCommandInput}
@@ -87,6 +110,8 @@ export interface DescribeActivityTypeCommandOutput extends ActivityTypeDetail, _
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class DescribeActivityTypeCommand extends $Command<DescribeActivityTypeCommandInput, DescribeActivityTypeCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/DescribeDomainCommand.d.ts

@@ -55,6 +55,18 @@ export interface DescribeDomainCommandOutput extends DomainDetail, __MetadataBea
  * };
  * const command = new DescribeDomainCommand(input);
  * const response = await client.send(command);
+ * // { // DomainDetail
+ * //   domainInfo: { // DomainInfo
+ * //     name: "STRING_VALUE", // required
+ * //     status: "REGISTERED" || "DEPRECATED", // required
+ * //     description: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
+ * //   },
+ * //   configuration: { // DomainConfiguration
+ * //     workflowExecutionRetentionPeriodInDays: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeDomainCommandInput - {@link DescribeDomainCommandInput}
@@ -69,6 +81,8 @@ export interface DescribeDomainCommandOutput extends DomainDetail, __MetadataBea
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class DescribeDomainCommand extends $Command<DescribeDomainCommandInput, DescribeDomainCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/DescribeWorkflowExecutionCommand.d.ts

@@ -63,6 +63,50 @@ export interface DescribeWorkflowExecutionCommandOutput extends WorkflowExecutio
  * };
  * const command = new DescribeWorkflowExecutionCommand(input);
  * const response = await client.send(command);
+ * // { // WorkflowExecutionDetail
+ * //   executionInfo: { // WorkflowExecutionInfo
+ * //     execution: { // WorkflowExecution
+ * //       workflowId: "STRING_VALUE", // required
+ * //       runId: "STRING_VALUE", // required
+ * //     },
+ * //     workflowType: { // WorkflowType
+ * //       name: "STRING_VALUE", // required
+ * //       version: "STRING_VALUE", // required
+ * //     },
+ * //     startTimestamp: new Date("TIMESTAMP"), // required
+ * //     closeTimestamp: new Date("TIMESTAMP"),
+ * //     executionStatus: "OPEN" || "CLOSED", // required
+ * //     closeStatus: "COMPLETED" || "FAILED" || "CANCELED" || "TERMINATED" || "CONTINUED_AS_NEW" || "TIMED_OUT",
+ * //     parent: {
+ * //       workflowId: "STRING_VALUE", // required
+ * //       runId: "STRING_VALUE", // required
+ * //     },
+ * //     tagList: [ // TagList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     cancelRequested: true || false,
+ * //   },
+ * //   executionConfiguration: { // WorkflowExecutionConfiguration
+ * //     taskStartToCloseTimeout: "STRING_VALUE", // required
+ * //     executionStartToCloseTimeout: "STRING_VALUE", // required
+ * //     taskList: { // TaskList
+ * //       name: "STRING_VALUE", // required
+ * //     },
+ * //     taskPriority: "STRING_VALUE",
+ * //     childPolicy: "TERMINATE" || "REQUEST_CANCEL" || "ABANDON", // required
+ * //     lambdaRole: "STRING_VALUE",
+ * //   },
+ * //   openCounts: { // WorkflowExecutionOpenCounts
+ * //     openActivityTasks: Number("int"), // required
+ * //     openDecisionTasks: Number("int"), // required
+ * //     openTimers: Number("int"), // required
+ * //     openChildWorkflowExecutions: Number("int"), // required
+ * //     openLambdaFunctions: Number("int"),
+ * //   },
+ * //   latestActivityTaskTimestamp: new Date("TIMESTAMP"),
+ * //   latestExecutionContext: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeWorkflowExecutionCommandInput - {@link DescribeWorkflowExecutionCommandInput}
@@ -77,6 +121,8 @@ export interface DescribeWorkflowExecutionCommandOutput extends WorkflowExecutio
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class DescribeWorkflowExecutionCommand extends $Command<DescribeWorkflowExecutionCommandInput, DescribeWorkflowExecutionCommandOutput, SWFClientResolvedConfig> {

package/dist-types/commands/DescribeWorkflowTypeCommand.d.ts

@@ -73,6 +73,29 @@ export interface DescribeWorkflowTypeCommandOutput extends WorkflowTypeDetail, _
  * };
  * const command = new DescribeWorkflowTypeCommand(input);
  * const response = await client.send(command);
+ * // { // WorkflowTypeDetail
+ * //   typeInfo: { // WorkflowTypeInfo
+ * //     workflowType: { // WorkflowType
+ * //       name: "STRING_VALUE", // required
+ * //       version: "STRING_VALUE", // required
+ * //     },
+ * //     status: "REGISTERED" || "DEPRECATED", // required
+ * //     description: "STRING_VALUE",
+ * //     creationDate: new Date("TIMESTAMP"), // required
+ * //     deprecationDate: new Date("TIMESTAMP"),
+ * //   },
+ * //   configuration: { // WorkflowTypeConfiguration
+ * //     defaultTaskStartToCloseTimeout: "STRING_VALUE",
+ * //     defaultExecutionStartToCloseTimeout: "STRING_VALUE",
+ * //     defaultTaskList: { // TaskList
+ * //       name: "STRING_VALUE", // required
+ * //     },
+ * //     defaultTaskPriority: "STRING_VALUE",
+ * //     defaultChildPolicy: "TERMINATE" || "REQUEST_CANCEL" || "ABANDON",
+ * //     defaultLambdaRole: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeWorkflowTypeCommandInput - {@link DescribeWorkflowTypeCommandInput}
@@ -87,6 +110,8 @@ export interface DescribeWorkflowTypeCommandOutput extends WorkflowTypeDetail, _
  * @throws {@link UnknownResourceFault} (client fault)
  *  <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
  *
+ * @throws {@link SWFServiceException}
+ * <p>Base exception class for all service exceptions from SWF service.</p>
  *
  */
 export declare class DescribeWorkflowTypeCommand extends $Command<DescribeWorkflowTypeCommandInput, DescribeWorkflowTypeCommandOutput, SWFClientResolvedConfig> {