- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListResponsePlansCommand
Lists all response plans in your account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SSMIncidentsClient, ListResponsePlansCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
// const { SSMIncidentsClient, ListResponsePlansCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
const client = new SSMIncidentsClient(config);
const input = { // ListResponsePlansInput
maxResults: Number("int"),
nextToken: "STRING_VALUE",
};
const command = new ListResponsePlansCommand(input);
const response = await client.send(command);
// { // ListResponsePlansOutput
// responsePlanSummaries: [ // ResponsePlanSummaryList // required
// { // ResponsePlanSummary
// arn: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// displayName: "STRING_VALUE",
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListResponsePlansCommand Input
See ListResponsePlansCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
maxResults | number | undefined | The maximum number of response plans per page. |
nextToken | string | undefined | The pagination token for the next set of items to return. (You received this token from a previous call.) |
ListResponsePlansCommand Output
See ListResponsePlansCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
responsePlanSummaries Required | ResponsePlanSummary[] | undefined | Details of each response plan. |
nextToken | string | undefined | The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have sufficient access to perform this operation. |
InternalServerException | server | The request processing has failed because of an unknown error, exception or failure. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by an Amazon Web Services service. |
SSMIncidentsServiceException | Base exception class for all service exceptions from SSMIncidents service. |