@aws-sdk/client-b2bi 3.839.0 → 3.840.0

package/dist-types/commands/ListProfilesCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListProfilesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of
- *    a private network.</p>
+ * <p>Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListTransformersCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListTransformersCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,
- *     a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.</p>
+ * <p>Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -66,6 +65,13 @@ declare const ListTransformersCommand_base: {
  * //             version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
  * //           },
  * //         },
+ * //         advancedOptions: { // AdvancedOptions
+ * //           x12: { // X12AdvancedOptions
+ * //             splitOptions: { // X12SplitOptions
+ * //               splitBy: "NONE" || "TRANSACTION", // required
+ * //             },
+ * //           },
+ * //         },
  * //       },
  * //       mapping: { // Mapping
  * //         templateLanguage: "XSLT" || "JSONATA", // required

package/dist-types/commands/StartTransformerJobCommand.d.ts

@@ -27,9 +27,7 @@ declare const StartTransformerJobCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.</p>
- *          <p>If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just
- *       create and configure a transformer, and then run the <code>StartTransformerJob</code> API to process your files.</p>
+ * <p>Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.</p> <p>If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the <code>StartTransformerJob</code> API to process your files.</p> <note> <p>The system stores transformer jobs for 30 days. During that period, you can run <a href="https://docs.aws.amazon.com/b2bi/latest/APIReference/API_GetTransformerJob.html">GetTransformerJob</a> and supply its <code>transformerId</code> and <code>transformerJobId</code> to return details of the job.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TagResourceCommand.d.ts

@@ -27,8 +27,7 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.</p>
- *          <p>There is no response returned from this call.</p>
+ * <p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.</p> <p>There is no response returned from this call.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TestParsingCommand.d.ts

@@ -46,11 +46,21 @@ declare const TestParsingCommand_base: {
  *       version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
  *     },
  *   },
+ *   advancedOptions: { // AdvancedOptions
+ *     x12: { // X12AdvancedOptions
+ *       splitOptions: { // X12SplitOptions
+ *         splitBy: "NONE" || "TRANSACTION", // required
+ *       },
+ *     },
+ *   },
  * };
  * const command = new TestParsingCommand(input);
  * const response = await client.send(command);
  * // { // TestParsingResponse
  * //   parsedFileContent: "STRING_VALUE", // required
+ * //   parsedSplitFileContents: [ // ParsedSplitFileContentsList
+ * //     "STRING_VALUE",
+ * //   ],
  * // };
  *
  * ```
@@ -105,6 +115,74 @@ declare const TestParsingCommand_base: {
  * *\/
  * ```
  *
+ * @example Sample TestParsing call without EDI Splitting
+ * ```javascript
+ * //
+ * const input = {
+ *   advancedOptions: {
+ *     x12: {
+ *       splitOptions: {
+ *         splitBy: "NONE"
+ *       }
+ *     }
+ *   },
+ *   ediType: {
+ *     x12Details: {
+ *       transactionSet: "X12_110",
+ *       version: "VERSION_4010"
+ *     }
+ *   },
+ *   fileFormat: "JSON",
+ *   inputFile: {
+ *     bucketName: "test-bucket",
+ *     key: "sampleFile.txt"
+ *   }
+ * };
+ * const command = new TestParsingCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   parsedFileContent: "Sample parsed file content"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Sample TestParsing call with EDI Splitting by Transaction
+ * ```javascript
+ * //
+ * const input = {
+ *   advancedOptions: {
+ *     x12: {
+ *       splitOptions: {
+ *         splitBy: "TRANSACTION"
+ *       }
+ *     }
+ *   },
+ *   ediType: {
+ *     x12Details: {
+ *       transactionSet: "X12_110",
+ *       version: "VERSION_4010"
+ *     }
+ *   },
+ *   fileFormat: "JSON",
+ *   inputFile: {
+ *     bucketName: "test-bucket",
+ *     key: "sampleFile.txt"
+ *   }
+ * };
+ * const command = new TestParsingCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   parsedFileContent: "",
+ *   parsedSplitFileContents: [
+ *     "sample split parsed file content",
+ *     "sample split parsed file content"
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class TestParsingCommand extends TestParsingCommand_base {

package/dist-types/commands/UpdateCapabilityCommand.d.ts

@@ -27,8 +27,7 @@ declare const UpdateCapabilityCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates some of the parameters for a capability, based on the specified parameters.
- *       A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>
+ * <p>Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdatePartnershipCommand.d.ts

@@ -27,8 +27,7 @@ declare const UpdatePartnershipCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties
- *    together a profile and one or more trading capabilities.</p>
+ * <p>Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -65,6 +64,25 @@ declare const UpdatePartnershipCommand_base: {
  *             segmentTerminator: "STRING_VALUE",
  *           },
  *           validateEdi: true || false,
+ *           controlNumbers: { // X12ControlNumbers
+ *             startingInterchangeControlNumber: Number("int"),
+ *             startingFunctionalGroupControlNumber: Number("int"),
+ *             startingTransactionSetControlNumber: Number("int"),
+ *           },
+ *           gs05TimeFormat: "HHMM" || "HHMMSS" || "HHMMSSDD",
+ *         },
+ *         wrapOptions: { // WrapOptions
+ *           wrapBy: "SEGMENT" || "ONE_LINE" || "LINE_LENGTH", // required
+ *           lineTerminator: "CRLF" || "LF" || "CR",
+ *           lineLength: Number("int"),
+ *         },
+ *       },
+ *     },
+ *     inboundEdi: { // InboundEdiOptions
+ *       x12: { // X12InboundEdiOptions
+ *         acknowledgmentOptions: { // X12AcknowledgmentOptions
+ *           functionalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS" || "GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP", // required
+ *           technicalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS", // required
  *         },
  *       },
  *     },
@@ -106,6 +124,25 @@ declare const UpdatePartnershipCommand_base: {
  * //             segmentTerminator: "STRING_VALUE",
  * //           },
  * //           validateEdi: true || false,
+ * //           controlNumbers: { // X12ControlNumbers
+ * //             startingInterchangeControlNumber: Number("int"),
+ * //             startingFunctionalGroupControlNumber: Number("int"),
+ * //             startingTransactionSetControlNumber: Number("int"),
+ * //           },
+ * //           gs05TimeFormat: "HHMM" || "HHMMSS" || "HHMMSSDD",
+ * //         },
+ * //         wrapOptions: { // WrapOptions
+ * //           wrapBy: "SEGMENT" || "ONE_LINE" || "LINE_LENGTH", // required
+ * //           lineTerminator: "CRLF" || "LF" || "CR",
+ * //           lineLength: Number("int"),
+ * //         },
+ * //       },
+ * //     },
+ * //     inboundEdi: { // InboundEdiOptions
+ * //       x12: { // X12InboundEdiOptions
+ * //         acknowledgmentOptions: { // X12AcknowledgmentOptions
+ * //           functionalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS" || "GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP", // required
+ * //           technicalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS", // required
  * //         },
  * //       },
  * //     },

package/dist-types/commands/UpdateProfileCommand.d.ts

@@ -27,8 +27,7 @@ declare const UpdateProfileCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of
- *    a private network.</p>
+ * <p>Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateTransformerCommand.d.ts

@@ -27,8 +27,7 @@ declare const UpdateTransformerCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,
- *     a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.</p>
+ * <p>Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -56,6 +55,13 @@ declare const UpdateTransformerCommand_base: {
  *         version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
  *       },
  *     },
+ *     advancedOptions: { // AdvancedOptions
+ *       x12: { // X12AdvancedOptions
+ *         splitOptions: { // X12SplitOptions
+ *           splitBy: "NONE" || "TRANSACTION", // required
+ *         },
+ *       },
+ *     },
  *   },
  *   mapping: { // Mapping
  *     templateLanguage: "XSLT" || "JSONATA", // required
@@ -106,6 +112,13 @@ declare const UpdateTransformerCommand_base: {
  * //         version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
  * //       },
  * //     },
+ * //     advancedOptions: { // AdvancedOptions
+ * //       x12: { // X12AdvancedOptions
+ * //         splitOptions: { // X12SplitOptions
+ * //           splitBy: "NONE" || "TRANSACTION", // required
+ * //         },
+ * //       },
+ * //     },
  * //   },
  * //   mapping: { // Mapping
  * //     templateLanguage: "XSLT" || "JSONATA", // required

package/dist-types/index.d.ts

@@ -1,15 +1,5 @@
 /**
- * <p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p>
- *          <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud
- *          scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange
- *          transactional data with trading partners, such as suppliers and end customers, using
- *          standardized formats such as X12.</p>
- *          <note>
- *             <p>Rather than actually running a command, you can use the
- *             <code>--generate-cli-skeleton</code> parameter with any API call to generate and display
- *             a parameter template. You can then use the generated template to customize and use as input
- *             on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p>
- *          </note>
+ * <p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p> <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.</p> <note> <p>Rather than actually running a command, you can use the <code>--generate-cli-skeleton</code> parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p> </note>
  *
  * @packageDocumentation
  */
@@ -20,5 +10,6 @@ export type { RuntimeExtension } from "./runtimeExtensions";
 export type { B2biExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
+export * from "./waiters";
 export * from "./models";
 export { B2biServiceException } from "./models/B2biServiceException";