ListOperationsCommand

Suggest an Edit

Lists the operations performed by AWS Systems Manager for SAP.

Example Syntax

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

import { SsmSapClient, ListOperationsCommand } from "@aws-sdk/client-ssm-sap"; // ES Modules import
// const { SsmSapClient, ListOperationsCommand } = require("@aws-sdk/client-ssm-sap"); // CommonJS import
const client = new SsmSapClient(config);
const input = { // ListOperationsInput
  ApplicationId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
      Operator: "Equals" || "GreaterThanOrEquals" || "LessThanOrEquals", // required
    },
  ],
};
const command = new ListOperationsCommand(input);
const response = await client.send(command);
// { // ListOperationsOutput
//   Operations: [ // OperationList
//     { // Operation
//       Id: "STRING_VALUE",
//       Type: "STRING_VALUE",
//       Status: "INPROGRESS" || "SUCCESS" || "ERROR",
//       StatusMessage: "STRING_VALUE",
//       Properties: { // OperationProperties
//         "<keys>": "STRING_VALUE",
//       },
//       ResourceType: "STRING_VALUE",
//       ResourceId: "STRING_VALUE",
//       ResourceArn: "STRING_VALUE",
//       StartTime: new Date("TIMESTAMP"),
//       EndTime: new Date("TIMESTAMP"),
//       LastUpdatedTime: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListOperationsCommand Input

See ListOperationsCommandInput for more details

Parameter
Type
Description
ApplicationId
Required
string | undefined

The ID of the application.

Filters
Filter[] | undefined

The filters of an operation.

MaxResults
number | undefined

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

NextToken
string | undefined

The token for the next page of results.

ListOperationsCommand Output

See ListOperationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Operations
Operation[] | undefined

List of operations performed by AWS Systems Manager for SAP.

Throws

Name
Fault
Details
InternalServerException
server

An internal error has occurred.

ValidationException
client

The input fails to satisfy the constraints specified by an AWS service.

SsmSapServiceException
Base exception class for all service exceptions from SsmSap service.