Class ListMappingsCommandProtected

Retrieves a list of all mappings in the current account. The current account is determined by the API key passed in the Authorization-header. Return payload depends on the value of metadata_only query parameter.

Example

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

import { MappingsClient, ListMappingsCommand } from "@stedi/sdk-client-mappings"; // ES Modules import
// const { MappingsClient, ListMappingsCommand } = require("@stedi/sdk-client-mappings"); // CommonJS import
const client = new MappingsClient(config);
const input = { // ListMappingsInput
  metadataOnly: true || false,
  pageToken: "STRING_VALUE",
  pageSize: Number("int"),
};
const command = new ListMappingsCommand(input);
const response = await client.send(command);
// { // ListMappingsOutput
//   nextPageToken: "STRING_VALUE",
//   mappings: [ // MappingMetadatas // required
//     { // MappingMetadata
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       type: "only_mapped_keys" || "merge_with_target_example" || "pass_through", // required
//       mapping: "STRING_VALUE",
//       source: { // MappingSource
//         name: "STRING_VALUE",
//         type: "jsonschema@2020-12", // required
//         content: "STRING_VALUE", // required
//         connection: { // MappingDocumentConnection Union: only one key present
//           stediGuides: { // MappingDocumentStediGuidesConnection
//             guideId: "STRING_VALUE", // required
//             guideName: "STRING_VALUE",
//             subGuideName: "STRING_VALUE",
//             ediSampleId: "STRING_VALUE",
//             ediSamplesNames: [ // EDISamplesNames
//               "STRING_VALUE",
//             ],
//             pulledAt: "STRING_VALUE", // required
//           },
//           stediEvents: { // MappingDocumentStediEventsConnection
//             eventType: "STRING_VALUE", // required
//             guideId: "STRING_VALUE",
//             guideName: "STRING_VALUE",
//             subGuideName: "STRING_VALUE",
//             ediSampleId: "STRING_VALUE",
//             ediSamplesNames: [
//               "STRING_VALUE",
//             ],
//             pulledAt: "STRING_VALUE", // required
//           },
//         },
//       },
//       target: { // MappingTarget
//         name: "STRING_VALUE",
//         type: "jsonschema@2020-12", // required
//         content: "STRING_VALUE", // required
//         connection: {//  Union: only one key present
//           stediGuides: {
//             guideId: "STRING_VALUE", // required
//             guideName: "STRING_VALUE",
//             subGuideName: "STRING_VALUE",
//             ediSampleId: "STRING_VALUE",
//             ediSamplesNames: [
//               "STRING_VALUE",
//             ],
//             pulledAt: "STRING_VALUE", // required
//           },
//           stediEvents: {
//             eventType: "STRING_VALUE", // required
//             guideId: "STRING_VALUE",
//             guideName: "STRING_VALUE",
//             subGuideName: "STRING_VALUE",
//             ediSampleId: "STRING_VALUE",
//             ediSamplesNames: [
//               "STRING_VALUE",
//             ],
//             pulledAt: "STRING_VALUE", // required
//           },
//         },
//       },
//       lookupTables: [ // LookupTables
//         { // LookupTable
//           name: "STRING_VALUE", // required
//           values: [ // LookupTableValues // required
//             { // LookupTableValuesMember
//               "<keys>": "STRING_VALUE",
//             },
//           ],
//         },
//       ],
//       lockStatus: "unlocked" || "locked", // required
//       lockingScope: [ // MappingLockScopeList // required
//         "mapping" || "source" || "target" || "lookup_tables",
//       ],
//       lockedBy: "STRING_VALUE",
//       unpublishedChanges: true || false, // required
//       publishedAt: "STRING_VALUE",
//       createdAt: "STRING_VALUE", // required
//       updatedAt: "STRING_VALUE", // required
//     },
//   ],
// };

Param

ListMappingsCommandInput

Returns

ListMappingsCommandOutput

See

• ListMappingsCommandInput for command's input shape.
• ListMappingsCommandOutput for command's response shape.
• config for MappingsClient's config shape.

Throws

BadRequestException (client fault) The server cannot process the request due to an apparent client error.

Throws

AccessDeniedException (client fault) The server response for authorization failure.

Throws

InternalFailureException (server fault) The server response when an unexpected error occurred while processing request.

Throws

ThrottlingException (client fault) The server response when usage plan or account-level throttling limits exceeded.

Throws

UnauthorizedException (client fault) The server response when the authorizer failed to authenticate the caller.

Throws

MappingsServiceException

Base exception class for all service exceptions from Mappings service.