ListOpsMetadataCommand

Suggest an Edit

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

Example Syntax

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

import { SSMClient, ListOpsMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, ListOpsMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // ListOpsMetadataRequest
  Filters: [ // OpsMetadataFilterList
    { // OpsMetadataFilter
      Key: "STRING_VALUE", // required
      Values: [ // OpsMetadataFilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListOpsMetadataCommand(input);
const response = await client.send(command);
// { // ListOpsMetadataResult
//   OpsMetadataList: [ // OpsMetadataList
//     { // OpsMetadata
//       ResourceId: "STRING_VALUE",
//       OpsMetadataArn: "STRING_VALUE",
//       LastModifiedDate: new Date("TIMESTAMP"),
//       LastModifiedUser: "STRING_VALUE",
//       CreationDate: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListOpsMetadataCommand Input

See ListOpsMetadataCommandInput for more details

Parameter
Type
Description
Filters
OpsMetadataFilter[] | undefined

One or more filters to limit the number of OpsMetadata objects returned by the call.

MaxResults
number | undefined

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken
string | undefined

A token to start the list. Use this token to get the next set of results.

ListOpsMetadataCommand Output

See ListOpsMetadataCommandOutput for details

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

The token for the next set of items to return. Use this token to get the next set of results.

OpsMetadataList
OpsMetadata[] | undefined

Returns a list of OpsMetadata objects.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

OpsMetadataInvalidArgumentException
client

One of the arguments passed is invalid.

SSMServiceException
Base exception class for all service exceptions from SSM service.