@aws-sdk/client-b2bi 3.459.0

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

@@ -0,0 +1,109 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { B2biClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../B2biClient";
+import { UpdatePartnershipRequest, UpdatePartnershipResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdatePartnershipCommand}.
+ */
+export interface UpdatePartnershipCommandInput extends UpdatePartnershipRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdatePartnershipCommand}.
+ */
+export interface UpdatePartnershipCommandOutput extends UpdatePartnershipResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates some of the parameters for a partnership between a customer and trading partner. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { B2biClient, UpdatePartnershipCommand } from "@aws-sdk/client-b2bi"; // ES Modules import
+ * // const { B2biClient, UpdatePartnershipCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import
+ * const client = new B2biClient(config);
+ * const input = { // UpdatePartnershipRequest
+ *   partnershipId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   capabilities: [ // PartnershipCapabilities
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UpdatePartnershipCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdatePartnershipResponse
+ * //   profileId: "STRING_VALUE", // required
+ * //   partnershipId: "STRING_VALUE", // required
+ * //   partnershipArn: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE",
+ * //   email: "STRING_VALUE",
+ * //   phone: "STRING_VALUE",
+ * //   capabilities: [ // PartnershipCapabilities
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   tradingPartnerId: "STRING_VALUE",
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   modifiedAt: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param UpdatePartnershipCommandInput - {@link UpdatePartnershipCommandInput}
+ * @returns {@link UpdatePartnershipCommandOutput}
+ * @see {@link UpdatePartnershipCommandInput} for command's `input` shape.
+ * @see {@link UpdatePartnershipCommandOutput} for command's `response` shape.
+ * @see {@link B2biClientResolvedConfig | config} for B2biClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Occurs when a B2BI object cannot be validated against a request from another object.</p>
+ *
+ * @throws {@link B2biServiceException}
+ * <p>Base exception class for all service exceptions from B2bi service.</p>
+ *
+ */
+export declare class UpdatePartnershipCommand extends $Command<UpdatePartnershipCommandInput, UpdatePartnershipCommandOutput, B2biClientResolvedConfig> {
+    readonly input: UpdatePartnershipCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdatePartnershipCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: B2biClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePartnershipCommandInput, UpdatePartnershipCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,107 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { B2biClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../B2biClient";
+import { UpdateProfileRequest, UpdateProfileResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateProfileCommand}.
+ */
+export interface UpdateProfileCommandInput extends UpdateProfileRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateProfileCommand}.
+ */
+export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates the specified parameters for a profile. Profiles contain basic information about you and your business.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { B2biClient, UpdateProfileCommand } from "@aws-sdk/client-b2bi"; // ES Modules import
+ * // const { B2biClient, UpdateProfileCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import
+ * const client = new B2biClient(config);
+ * const input = { // UpdateProfileRequest
+ *   profileId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   email: "STRING_VALUE",
+ *   phone: "STRING_VALUE",
+ *   businessName: "STRING_VALUE",
+ * };
+ * const command = new UpdateProfileCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateProfileResponse
+ * //   profileId: "STRING_VALUE", // required
+ * //   profileArn: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   email: "STRING_VALUE",
+ * //   phone: "STRING_VALUE", // required
+ * //   businessName: "STRING_VALUE", // required
+ * //   logging: "ENABLED" || "DISABLED",
+ * //   logGroupName: "STRING_VALUE",
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   modifiedAt: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateProfileCommandInput - {@link UpdateProfileCommandInput}
+ * @returns {@link UpdateProfileCommandOutput}
+ * @see {@link UpdateProfileCommandInput} for command's `input` shape.
+ * @see {@link UpdateProfileCommandOutput} for command's `response` shape.
+ * @see {@link B2biClientResolvedConfig | config} for B2biClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Occurs when a B2BI object cannot be validated against a request from another object.</p>
+ *
+ * @throws {@link B2biServiceException}
+ * <p>Base exception class for all service exceptions from B2bi service.</p>
+ *
+ */
+export declare class UpdateProfileCommand extends $Command<UpdateProfileCommandInput, UpdateProfileCommandOutput, B2biClientResolvedConfig> {
+    readonly input: UpdateProfileCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateProfileCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: B2biClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateProfileCommandInput, UpdateProfileCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,119 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { B2biClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../B2biClient";
+import { UpdateTransformerRequest, UpdateTransformerResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateTransformerCommand}.
+ */
+export interface UpdateTransformerCommandInput extends UpdateTransformerRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateTransformerCommand}.
+ */
+export interface UpdateTransformerCommandOutput extends UpdateTransformerResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates the specified parameters for a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { B2biClient, UpdateTransformerCommand } from "@aws-sdk/client-b2bi"; // ES Modules import
+ * // const { B2biClient, UpdateTransformerCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import
+ * const client = new B2biClient(config);
+ * const input = { // UpdateTransformerRequest
+ *   transformerId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   fileFormat: "XML" || "JSON",
+ *   mappingTemplate: "STRING_VALUE",
+ *   status: "active" || "inactive",
+ *   ediType: { // EdiType Union: only one key present
+ *     x12Details: { // X12Details
+ *       transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_214" || "X12_215" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_820" || "X12_824" || "X12_830" || "X12_846" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_940" || "X12_990" || "X12_997",
+ *       version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010",
+ *     },
+ *   },
+ *   sampleDocument: "STRING_VALUE",
+ * };
+ * const command = new UpdateTransformerCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateTransformerResponse
+ * //   transformerId: "STRING_VALUE", // required
+ * //   transformerArn: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   fileFormat: "XML" || "JSON", // required
+ * //   mappingTemplate: "STRING_VALUE", // required
+ * //   status: "active" || "inactive", // required
+ * //   ediType: { // EdiType Union: only one key present
+ * //     x12Details: { // X12Details
+ * //       transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_214" || "X12_215" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_820" || "X12_824" || "X12_830" || "X12_846" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_940" || "X12_990" || "X12_997",
+ * //       version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010",
+ * //     },
+ * //   },
+ * //   sampleDocument: "STRING_VALUE",
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   modifiedAt: new Date("TIMESTAMP"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateTransformerCommandInput - {@link UpdateTransformerCommandInput}
+ * @returns {@link UpdateTransformerCommandOutput}
+ * @see {@link UpdateTransformerCommandInput} for command's `input` shape.
+ * @see {@link UpdateTransformerCommandOutput} for command's `response` shape.
+ * @see {@link B2biClientResolvedConfig | config} for B2biClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Occurs when a B2BI object cannot be validated against a request from another object.</p>
+ *
+ * @throws {@link B2biServiceException}
+ * <p>Base exception class for all service exceptions from B2bi service.</p>
+ *
+ */
+export declare class UpdateTransformerCommand extends $Command<UpdateTransformerCommandInput, UpdateTransformerCommandOutput, B2biClientResolvedConfig> {
+    readonly input: UpdateTransformerCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateTransformerCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: B2biClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTransformerCommandInput, UpdateTransformerCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,27 @@
+export * from "./CreateCapabilityCommand";
+export * from "./CreatePartnershipCommand";
+export * from "./CreateProfileCommand";
+export * from "./CreateTransformerCommand";
+export * from "./DeleteCapabilityCommand";
+export * from "./DeletePartnershipCommand";
+export * from "./DeleteProfileCommand";
+export * from "./DeleteTransformerCommand";
+export * from "./GetCapabilityCommand";
+export * from "./GetPartnershipCommand";
+export * from "./GetProfileCommand";
+export * from "./GetTransformerCommand";
+export * from "./GetTransformerJobCommand";
+export * from "./ListCapabilitiesCommand";
+export * from "./ListPartnershipsCommand";
+export * from "./ListProfilesCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./ListTransformersCommand";
+export * from "./StartTransformerJobCommand";
+export * from "./TagResourceCommand";
+export * from "./TestMappingCommand";
+export * from "./TestParsingCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateCapabilityCommand";
+export * from "./UpdatePartnershipCommand";
+export * from "./UpdateProfileCommand";
+export * from "./UpdateTransformerCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,22 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface B2biExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * <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
+ */
+export * from "./B2biClient";
+export * from "./B2bi";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export { RuntimeExtension } from "./runtimeExtensions";
+export { B2biExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+import "@aws-sdk/util-endpoints";
+export { B2biServiceException } from "./models/B2biServiceException";

package/dist-types/models/B2biServiceException.d.ts

@@ -0,0 +1,13 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from B2bi service.
+ */
+export declare class B2biServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";