Class ListWorkflowTypesCommandProtected

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Example

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

import { SWFClient, ListWorkflowTypesCommand } from "@aws-sdk/client-swf"; // ES Modules import
// const { SWFClient, ListWorkflowTypesCommand } = require("@aws-sdk/client-swf"); // CommonJS import
const client = new SWFClient(config);
const input = { // ListWorkflowTypesInput
  domain: "STRING_VALUE", // required
  name: "STRING_VALUE",
  registrationStatus: "REGISTERED" || "DEPRECATED", // required
  nextPageToken: "STRING_VALUE",
  maximumPageSize: Number("int"),
  reverseOrder: true || false,
};
const command = new ListWorkflowTypesCommand(input);
const response = await client.send(command);
// { // WorkflowTypeInfos
//   typeInfos: [ // WorkflowTypeInfoList // required
//     { // 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"),
//     },
//   ],
//   nextPageToken: "STRING_VALUE",
// };

Param

ListWorkflowTypesCommandInput

Returns

ListWorkflowTypesCommandOutput

See

• ListWorkflowTypesCommandInput for command's input shape.
• ListWorkflowTypesCommandOutput for command's response shape.
• config for SWFClient's config shape.

Throws

OperationNotPermittedFault (client fault)

Returned when the caller doesn't have sufficient permissions to invoke the action.

Throws

UnknownResourceFault (client fault)

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.

Throws

SWFServiceException

Base exception class for all service exceptions from SWF service.