@aws-sdk/client-b2bi 3.459.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +431 -0
- package/dist-cjs/B2bi.js +65 -0
- package/dist-cjs/B2biClient.js +43 -0
- package/dist-cjs/commands/CreateCapabilityCommand.js +51 -0
- package/dist-cjs/commands/CreatePartnershipCommand.js +52 -0
- package/dist-cjs/commands/CreateProfileCommand.js +52 -0
- package/dist-cjs/commands/CreateTransformerCommand.js +51 -0
- package/dist-cjs/commands/DeleteCapabilityCommand.js +51 -0
- package/dist-cjs/commands/DeletePartnershipCommand.js +51 -0
- package/dist-cjs/commands/DeleteProfileCommand.js +51 -0
- package/dist-cjs/commands/DeleteTransformerCommand.js +51 -0
- package/dist-cjs/commands/GetCapabilityCommand.js +51 -0
- package/dist-cjs/commands/GetPartnershipCommand.js +52 -0
- package/dist-cjs/commands/GetProfileCommand.js +52 -0
- package/dist-cjs/commands/GetTransformerCommand.js +51 -0
- package/dist-cjs/commands/GetTransformerJobCommand.js +51 -0
- package/dist-cjs/commands/ListCapabilitiesCommand.js +51 -0
- package/dist-cjs/commands/ListPartnershipsCommand.js +51 -0
- package/dist-cjs/commands/ListProfilesCommand.js +51 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
- package/dist-cjs/commands/ListTransformersCommand.js +51 -0
- package/dist-cjs/commands/StartTransformerJobCommand.js +51 -0
- package/dist-cjs/commands/TagResourceCommand.js +51 -0
- package/dist-cjs/commands/TestMappingCommand.js +51 -0
- package/dist-cjs/commands/TestParsingCommand.js +51 -0
- package/dist-cjs/commands/UntagResourceCommand.js +51 -0
- package/dist-cjs/commands/UpdateCapabilityCommand.js +51 -0
- package/dist-cjs/commands/UpdatePartnershipCommand.js +52 -0
- package/dist-cjs/commands/UpdateProfileCommand.js +52 -0
- package/dist-cjs/commands/UpdateTransformerCommand.js +51 -0
- package/dist-cjs/commands/index.js +30 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/B2biServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +227 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListCapabilitiesPaginator.js +29 -0
- package/dist-cjs/pagination/ListPartnershipsPaginator.js +29 -0
- package/dist-cjs/pagination/ListProfilesPaginator.js +29 -0
- package/dist-cjs/pagination/ListTransformersPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_json1_0.js +1822 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +24 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/B2bi.js +61 -0
- package/dist-es/B2biClient.js +39 -0
- package/dist-es/commands/CreateCapabilityCommand.js +47 -0
- package/dist-es/commands/CreatePartnershipCommand.js +48 -0
- package/dist-es/commands/CreateProfileCommand.js +48 -0
- package/dist-es/commands/CreateTransformerCommand.js +47 -0
- package/dist-es/commands/DeleteCapabilityCommand.js +47 -0
- package/dist-es/commands/DeletePartnershipCommand.js +47 -0
- package/dist-es/commands/DeleteProfileCommand.js +47 -0
- package/dist-es/commands/DeleteTransformerCommand.js +47 -0
- package/dist-es/commands/GetCapabilityCommand.js +47 -0
- package/dist-es/commands/GetPartnershipCommand.js +48 -0
- package/dist-es/commands/GetProfileCommand.js +48 -0
- package/dist-es/commands/GetTransformerCommand.js +47 -0
- package/dist-es/commands/GetTransformerJobCommand.js +47 -0
- package/dist-es/commands/ListCapabilitiesCommand.js +47 -0
- package/dist-es/commands/ListPartnershipsCommand.js +47 -0
- package/dist-es/commands/ListProfilesCommand.js +47 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
- package/dist-es/commands/ListTransformersCommand.js +47 -0
- package/dist-es/commands/StartTransformerJobCommand.js +47 -0
- package/dist-es/commands/TagResourceCommand.js +47 -0
- package/dist-es/commands/TestMappingCommand.js +47 -0
- package/dist-es/commands/TestParsingCommand.js +47 -0
- package/dist-es/commands/UntagResourceCommand.js +47 -0
- package/dist-es/commands/UpdateCapabilityCommand.js +47 -0
- package/dist-es/commands/UpdatePartnershipCommand.js +48 -0
- package/dist-es/commands/UpdateProfileCommand.js +48 -0
- package/dist-es/commands/UpdateTransformerCommand.js +47 -0
- package/dist-es/commands/index.js +27 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/B2biServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +208 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListCapabilitiesPaginator.js +25 -0
- package/dist-es/pagination/ListPartnershipsPaginator.js +25 -0
- package/dist-es/pagination/ListProfilesPaginator.js +25 -0
- package/dist-es/pagination/ListTransformersPaginator.js +25 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocols/Aws_json1_0.js +1764 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +20 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/B2bi.d.ts +209 -0
- package/dist-types/B2biClient.d.ts +206 -0
- package/dist-types/commands/CreateCapabilityCommand.d.ts +156 -0
- package/dist-types/commands/CreatePartnershipCommand.d.ts +117 -0
- package/dist-types/commands/CreateProfileCommand.d.ts +113 -0
- package/dist-types/commands/CreateTransformerCommand.d.ts +123 -0
- package/dist-types/commands/DeleteCapabilityCommand.d.ts +89 -0
- package/dist-types/commands/DeletePartnershipCommand.d.ts +89 -0
- package/dist-types/commands/DeleteProfileCommand.d.ts +89 -0
- package/dist-types/commands/DeleteTransformerCommand.d.ts +89 -0
- package/dist-types/commands/GetCapabilityCommand.d.ts +118 -0
- package/dist-types/commands/GetPartnershipCommand.d.ts +99 -0
- package/dist-types/commands/GetProfileCommand.d.ts +97 -0
- package/dist-types/commands/GetTransformerCommand.d.ts +102 -0
- package/dist-types/commands/GetTransformerJobCommand.d.ts +96 -0
- package/dist-types/commands/ListCapabilitiesCommand.d.ts +83 -0
- package/dist-types/commands/ListPartnershipsCommand.d.ts +103 -0
- package/dist-types/commands/ListProfilesCommand.d.ts +85 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +84 -0
- package/dist-types/commands/ListTransformersCommand.d.ts +92 -0
- package/dist-types/commands/StartTransformerJobCommand.d.ts +97 -0
- package/dist-types/commands/TagResourceCommand.d.ts +87 -0
- package/dist-types/commands/TestMappingCommand.d.ts +90 -0
- package/dist-types/commands/TestParsingCommand.d.ts +98 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +80 -0
- package/dist-types/commands/UpdateCapabilityCommand.d.ts +151 -0
- package/dist-types/commands/UpdatePartnershipCommand.d.ts +109 -0
- package/dist-types/commands/UpdateProfileCommand.d.ts +107 -0
- package/dist-types/commands/UpdateTransformerCommand.d.ts +119 -0
- package/dist-types/commands/index.d.ts +27 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +25 -0
- package/dist-types/models/B2biServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1859 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListCapabilitiesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPartnershipsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListProfilesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTransformersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +245 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +46 -0
- package/dist-types/runtimeConfig.native.d.ts +45 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/B2bi.d.ts +464 -0
- package/dist-types/ts3.4/B2biClient.d.ts +280 -0
- package/dist-types/ts3.4/commands/CreateCapabilityCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreatePartnershipCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateProfileCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateTransformerCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteCapabilityCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/DeletePartnershipCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeleteProfileCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/DeleteTransformerCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/GetCapabilityCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetPartnershipCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetProfileCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetTransformerCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetTransformerJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListCapabilitiesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListPartnershipsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListProfilesCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTransformersCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartTransformerJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/TestMappingCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/TestParsingCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/UpdateCapabilityCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdatePartnershipCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateProfileCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateTransformerCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +27 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/B2biServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +537 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListCapabilitiesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPartnershipsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListProfilesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTransformersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +329 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +104 -0
|
@@ -0,0 +1,1859 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { B2biServiceException as __BaseException } from "./B2biServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* <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>
|
|
18
|
+
*/
|
|
19
|
+
export declare class ConflictException extends __BaseException {
|
|
20
|
+
readonly name: "ConflictException";
|
|
21
|
+
readonly $fault: "client";
|
|
22
|
+
/**
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
* <p>Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File
|
|
30
|
+
* locations in Amazon S3 are identified using a combination of the bucket and key.</p>
|
|
31
|
+
*/
|
|
32
|
+
export interface S3Location {
|
|
33
|
+
/**
|
|
34
|
+
* @public
|
|
35
|
+
* <p>Specifies the name of the Amazon S3 bucket.</p>
|
|
36
|
+
*/
|
|
37
|
+
bucketName?: string;
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
* <p>Specifies the Amazon S3 key for the file location.</p>
|
|
41
|
+
*/
|
|
42
|
+
key?: string;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* @public
|
|
46
|
+
* @enum
|
|
47
|
+
*/
|
|
48
|
+
export declare const X12TransactionSet: {
|
|
49
|
+
readonly X12_110: "X12_110";
|
|
50
|
+
readonly X12_180: "X12_180";
|
|
51
|
+
readonly X12_204: "X12_204";
|
|
52
|
+
readonly X12_210: "X12_210";
|
|
53
|
+
readonly X12_214: "X12_214";
|
|
54
|
+
readonly X12_215: "X12_215";
|
|
55
|
+
readonly X12_310: "X12_310";
|
|
56
|
+
readonly X12_315: "X12_315";
|
|
57
|
+
readonly X12_322: "X12_322";
|
|
58
|
+
readonly X12_404: "X12_404";
|
|
59
|
+
readonly X12_410: "X12_410";
|
|
60
|
+
readonly X12_820: "X12_820";
|
|
61
|
+
readonly X12_824: "X12_824";
|
|
62
|
+
readonly X12_830: "X12_830";
|
|
63
|
+
readonly X12_846: "X12_846";
|
|
64
|
+
readonly X12_850: "X12_850";
|
|
65
|
+
readonly X12_852: "X12_852";
|
|
66
|
+
readonly X12_855: "X12_855";
|
|
67
|
+
readonly X12_856: "X12_856";
|
|
68
|
+
readonly X12_860: "X12_860";
|
|
69
|
+
readonly X12_861: "X12_861";
|
|
70
|
+
readonly X12_864: "X12_864";
|
|
71
|
+
readonly X12_940: "X12_940";
|
|
72
|
+
readonly X12_990: "X12_990";
|
|
73
|
+
readonly X12_997: "X12_997";
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export type X12TransactionSet = (typeof X12TransactionSet)[keyof typeof X12TransactionSet];
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
* @enum
|
|
82
|
+
*/
|
|
83
|
+
export declare const X12Version: {
|
|
84
|
+
readonly VERSION_4010: "VERSION_4010";
|
|
85
|
+
readonly VERSION_4030: "VERSION_4030";
|
|
86
|
+
readonly VERSION_5010: "VERSION_5010";
|
|
87
|
+
};
|
|
88
|
+
/**
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export type X12Version = (typeof X12Version)[keyof typeof X12Version];
|
|
92
|
+
/**
|
|
93
|
+
* @public
|
|
94
|
+
* <p>A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.</p>
|
|
95
|
+
*/
|
|
96
|
+
export interface X12Details {
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
* <p>Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.</p>
|
|
100
|
+
*/
|
|
101
|
+
transactionSet?: X12TransactionSet;
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
* <p>Returns the version to use for the specified X12 transaction set. Supported versions are <code>4010</code>, <code>4030</code>, and <code>5010</code>.</p>
|
|
105
|
+
*/
|
|
106
|
+
version?: X12Version;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
* <p>Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
111
|
+
*/
|
|
112
|
+
export type EdiType = EdiType.X12DetailsMember | EdiType.$UnknownMember;
|
|
113
|
+
/**
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
export declare namespace EdiType {
|
|
117
|
+
/**
|
|
118
|
+
* @public
|
|
119
|
+
* <p>Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
120
|
+
*/
|
|
121
|
+
interface X12DetailsMember {
|
|
122
|
+
x12Details: X12Details;
|
|
123
|
+
$unknown?: never;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
interface $UnknownMember {
|
|
129
|
+
x12Details?: never;
|
|
130
|
+
$unknown: [string, any];
|
|
131
|
+
}
|
|
132
|
+
interface Visitor<T> {
|
|
133
|
+
x12Details: (value: X12Details) => T;
|
|
134
|
+
_: (name: string, value: any) => T;
|
|
135
|
+
}
|
|
136
|
+
const visit: <T>(value: EdiType, visitor: Visitor<T>) => T;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* <p>Specifies the details for the EDI (electronic data interchange) transformation.</p>
|
|
141
|
+
*/
|
|
142
|
+
export interface EdiConfiguration {
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* <p>Returns the type of the capability. Currently, only <code>edi</code> is supported.</p>
|
|
146
|
+
*/
|
|
147
|
+
type: EdiType | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* <p>Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an <code>S3Location</code> object.</p>
|
|
151
|
+
*/
|
|
152
|
+
inputLocation: S3Location | undefined;
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* <p>Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an <code>S3Location</code> object.</p>
|
|
156
|
+
*/
|
|
157
|
+
outputLocation: S3Location | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
* <p>Returns the system-assigned unique identifier for the transformer.</p>
|
|
161
|
+
*/
|
|
162
|
+
transformerId: string | undefined;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* @public
|
|
166
|
+
* <p>A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>
|
|
167
|
+
*/
|
|
168
|
+
export type CapabilityConfiguration = CapabilityConfiguration.EdiMember | CapabilityConfiguration.$UnknownMember;
|
|
169
|
+
/**
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
export declare namespace CapabilityConfiguration {
|
|
173
|
+
/**
|
|
174
|
+
* @public
|
|
175
|
+
* <p>An EDI (electronic data interchange) configuration object.</p>
|
|
176
|
+
*/
|
|
177
|
+
interface EdiMember {
|
|
178
|
+
edi: EdiConfiguration;
|
|
179
|
+
$unknown?: never;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
interface $UnknownMember {
|
|
185
|
+
edi?: never;
|
|
186
|
+
$unknown: [string, any];
|
|
187
|
+
}
|
|
188
|
+
interface Visitor<T> {
|
|
189
|
+
edi: (value: EdiConfiguration) => T;
|
|
190
|
+
_: (name: string, value: any) => T;
|
|
191
|
+
}
|
|
192
|
+
const visit: <T>(value: CapabilityConfiguration, visitor: Visitor<T>) => T;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* @public
|
|
196
|
+
* <p>Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes.
|
|
197
|
+
* You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes,
|
|
198
|
+
* you might create a tag called <code>Group</code> and assign the values <code>Research</code> and <code>Accounting</code> to that group.</p>
|
|
199
|
+
*/
|
|
200
|
+
export interface Tag {
|
|
201
|
+
/**
|
|
202
|
+
* @public
|
|
203
|
+
* <p>Specifies the name assigned to the tag that you create.</p>
|
|
204
|
+
*/
|
|
205
|
+
Key: string | undefined;
|
|
206
|
+
/**
|
|
207
|
+
* @public
|
|
208
|
+
* <p>Contains one or more values that you assigned to the key name that you create.</p>
|
|
209
|
+
*/
|
|
210
|
+
Value: string | undefined;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* @public
|
|
214
|
+
* @enum
|
|
215
|
+
*/
|
|
216
|
+
export declare const CapabilityType: {
|
|
217
|
+
readonly EDI: "edi";
|
|
218
|
+
};
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
export type CapabilityType = (typeof CapabilityType)[keyof typeof CapabilityType];
|
|
223
|
+
/**
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
export interface CreateCapabilityRequest {
|
|
227
|
+
/**
|
|
228
|
+
* @public
|
|
229
|
+
* <p>Specifies the name of the capability, used to identify it.</p>
|
|
230
|
+
*/
|
|
231
|
+
name: string | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* @public
|
|
234
|
+
* <p>Specifies the type of the capability. Currently, only <code>edi</code> is supported.</p>
|
|
235
|
+
*/
|
|
236
|
+
type: CapabilityType | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* @public
|
|
239
|
+
* <p>Specifies a structure that contains the details for a capability.</p>
|
|
240
|
+
*/
|
|
241
|
+
configuration: CapabilityConfiguration | undefined;
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
* <p>Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.</p>
|
|
245
|
+
*/
|
|
246
|
+
instructionsDocuments?: S3Location[];
|
|
247
|
+
/**
|
|
248
|
+
* @public
|
|
249
|
+
* <p>Reserved for future use.</p>
|
|
250
|
+
*/
|
|
251
|
+
clientToken?: string;
|
|
252
|
+
/**
|
|
253
|
+
* @public
|
|
254
|
+
* <p>Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>
|
|
255
|
+
*/
|
|
256
|
+
tags?: Tag[];
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
export interface CreateCapabilityResponse {
|
|
262
|
+
/**
|
|
263
|
+
* @public
|
|
264
|
+
* <p>Returns a system-assigned unique identifier for the capability.</p>
|
|
265
|
+
*/
|
|
266
|
+
capabilityId: string | undefined;
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
270
|
+
*/
|
|
271
|
+
capabilityArn: string | undefined;
|
|
272
|
+
/**
|
|
273
|
+
* @public
|
|
274
|
+
* <p>Returns the name of the capability used to identify it.</p>
|
|
275
|
+
*/
|
|
276
|
+
name: string | undefined;
|
|
277
|
+
/**
|
|
278
|
+
* @public
|
|
279
|
+
* <p>Returns the type of the capability. Currently, only <code>edi</code> is supported.</p>
|
|
280
|
+
*/
|
|
281
|
+
type: CapabilityType | undefined;
|
|
282
|
+
/**
|
|
283
|
+
* @public
|
|
284
|
+
* <p>Returns a structure that contains the details for a capability.</p>
|
|
285
|
+
*/
|
|
286
|
+
configuration: CapabilityConfiguration | undefined;
|
|
287
|
+
/**
|
|
288
|
+
* @public
|
|
289
|
+
* <p>Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.</p>
|
|
290
|
+
*/
|
|
291
|
+
instructionsDocuments?: S3Location[];
|
|
292
|
+
/**
|
|
293
|
+
* @public
|
|
294
|
+
* <p>Returns a timestamp for creation date and time of the capability.</p>
|
|
295
|
+
*/
|
|
296
|
+
createdAt: Date | undefined;
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* @public
|
|
300
|
+
* <p>This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.</p>
|
|
301
|
+
*/
|
|
302
|
+
export declare class InternalServerException extends __BaseException {
|
|
303
|
+
readonly name: "InternalServerException";
|
|
304
|
+
readonly $fault: "server";
|
|
305
|
+
$retryable: {};
|
|
306
|
+
/**
|
|
307
|
+
* @public
|
|
308
|
+
* <p>The server attempts to retry a failed command.</p>
|
|
309
|
+
*/
|
|
310
|
+
retryAfterSeconds?: number;
|
|
311
|
+
/**
|
|
312
|
+
* @internal
|
|
313
|
+
*/
|
|
314
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* @public
|
|
318
|
+
* <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>
|
|
319
|
+
*/
|
|
320
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
321
|
+
readonly name: "ResourceNotFoundException";
|
|
322
|
+
readonly $fault: "client";
|
|
323
|
+
/**
|
|
324
|
+
* @internal
|
|
325
|
+
*/
|
|
326
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
327
|
+
}
|
|
328
|
+
/**
|
|
329
|
+
* @public
|
|
330
|
+
* <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>
|
|
331
|
+
*/
|
|
332
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
333
|
+
readonly name: "ServiceQuotaExceededException";
|
|
334
|
+
readonly $fault: "client";
|
|
335
|
+
/**
|
|
336
|
+
* @public
|
|
337
|
+
* <p>The ID for the resource that exceeded the quota, which caused the exception.</p>
|
|
338
|
+
*/
|
|
339
|
+
resourceId: string | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* @public
|
|
342
|
+
* <p>The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.</p>
|
|
343
|
+
*/
|
|
344
|
+
resourceType: string | undefined;
|
|
345
|
+
/**
|
|
346
|
+
* @public
|
|
347
|
+
* <p>The code responsible for exceeding the quota, which caused the exception.</p>
|
|
348
|
+
*/
|
|
349
|
+
serviceCode: string | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* @public
|
|
352
|
+
* <p>The quota that was exceeded, which caused the exception.</p>
|
|
353
|
+
*/
|
|
354
|
+
quotaCode: string | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* @internal
|
|
357
|
+
*/
|
|
358
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* @public
|
|
362
|
+
* <p>The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.</p>
|
|
363
|
+
*/
|
|
364
|
+
export declare class ThrottlingException extends __BaseException {
|
|
365
|
+
readonly name: "ThrottlingException";
|
|
366
|
+
readonly $fault: "client";
|
|
367
|
+
$retryable: {};
|
|
368
|
+
/**
|
|
369
|
+
* @public
|
|
370
|
+
* <p>The server attempts to retry a command that was throttled.</p>
|
|
371
|
+
*/
|
|
372
|
+
retryAfterSeconds?: number;
|
|
373
|
+
/**
|
|
374
|
+
* @internal
|
|
375
|
+
*/
|
|
376
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* @public
|
|
380
|
+
* <p>Occurs when a B2BI object cannot be validated against a request from another object.</p>
|
|
381
|
+
*/
|
|
382
|
+
export declare class ValidationException extends __BaseException {
|
|
383
|
+
readonly name: "ValidationException";
|
|
384
|
+
readonly $fault: "client";
|
|
385
|
+
Message: string | undefined;
|
|
386
|
+
/**
|
|
387
|
+
* @internal
|
|
388
|
+
*/
|
|
389
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
export interface DeleteCapabilityRequest {
|
|
395
|
+
/**
|
|
396
|
+
* @public
|
|
397
|
+
* <p>Specifies a system-assigned unique identifier for the capability.</p>
|
|
398
|
+
*/
|
|
399
|
+
capabilityId: string | undefined;
|
|
400
|
+
}
|
|
401
|
+
/**
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
export interface GetCapabilityRequest {
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
* <p>Specifies a system-assigned unique identifier for the capability.</p>
|
|
408
|
+
*/
|
|
409
|
+
capabilityId: string | undefined;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
export interface GetCapabilityResponse {
|
|
415
|
+
/**
|
|
416
|
+
* @public
|
|
417
|
+
* <p>Returns a system-assigned unique identifier for the capability.</p>
|
|
418
|
+
*/
|
|
419
|
+
capabilityId: string | undefined;
|
|
420
|
+
/**
|
|
421
|
+
* @public
|
|
422
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
423
|
+
*/
|
|
424
|
+
capabilityArn: string | undefined;
|
|
425
|
+
/**
|
|
426
|
+
* @public
|
|
427
|
+
* <p>Returns the name of the capability, used to identify it.</p>
|
|
428
|
+
*/
|
|
429
|
+
name: string | undefined;
|
|
430
|
+
/**
|
|
431
|
+
* @public
|
|
432
|
+
* <p>Returns the type of the capability. Currently, only <code>edi</code> is supported.</p>
|
|
433
|
+
*/
|
|
434
|
+
type: CapabilityType | undefined;
|
|
435
|
+
/**
|
|
436
|
+
* @public
|
|
437
|
+
* <p>Returns a structure that contains the details for a capability.</p>
|
|
438
|
+
*/
|
|
439
|
+
configuration: CapabilityConfiguration | undefined;
|
|
440
|
+
/**
|
|
441
|
+
* @public
|
|
442
|
+
* <p>Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.</p>
|
|
443
|
+
*/
|
|
444
|
+
instructionsDocuments?: S3Location[];
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
* <p>Returns a timestamp for creation date and time of the capability.</p>
|
|
448
|
+
*/
|
|
449
|
+
createdAt: Date | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* @public
|
|
452
|
+
* <p>Returns a timestamp for last time the capability was modified.</p>
|
|
453
|
+
*/
|
|
454
|
+
modifiedAt?: Date;
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
export interface ListCapabilitiesRequest {
|
|
460
|
+
/**
|
|
461
|
+
* @public
|
|
462
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
463
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
464
|
+
*/
|
|
465
|
+
nextToken?: string;
|
|
466
|
+
/**
|
|
467
|
+
* @public
|
|
468
|
+
* <p>Specifies the maximum number of capabilities to return.</p>
|
|
469
|
+
*/
|
|
470
|
+
maxResults?: number;
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* @public
|
|
474
|
+
* <p>Returns the capability summary details. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>
|
|
475
|
+
*/
|
|
476
|
+
export interface CapabilitySummary {
|
|
477
|
+
/**
|
|
478
|
+
* @public
|
|
479
|
+
* <p>Returns a system-assigned unique identifier for the capability.</p>
|
|
480
|
+
*/
|
|
481
|
+
capabilityId: string | undefined;
|
|
482
|
+
/**
|
|
483
|
+
* @public
|
|
484
|
+
* <p>The display name of the capability.</p>
|
|
485
|
+
*/
|
|
486
|
+
name: string | undefined;
|
|
487
|
+
/**
|
|
488
|
+
* @public
|
|
489
|
+
* <p>Returns the type of the capability. Currently, only <code>edi</code> is supported.</p>
|
|
490
|
+
*/
|
|
491
|
+
type: CapabilityType | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* @public
|
|
494
|
+
* <p>Returns a timestamp for creation date and time of the capability.</p>
|
|
495
|
+
*/
|
|
496
|
+
createdAt: Date | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* @public
|
|
499
|
+
* <p>Returns a timestamp that identifies the most recent date and time that the capability was modified.</p>
|
|
500
|
+
*/
|
|
501
|
+
modifiedAt?: Date;
|
|
502
|
+
}
|
|
503
|
+
/**
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
export interface ListCapabilitiesResponse {
|
|
507
|
+
/**
|
|
508
|
+
* @public
|
|
509
|
+
* <p>Returns one or more capabilities associated with this partnership.</p>
|
|
510
|
+
*/
|
|
511
|
+
capabilities: CapabilitySummary[] | undefined;
|
|
512
|
+
/**
|
|
513
|
+
* @public
|
|
514
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
515
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
516
|
+
*/
|
|
517
|
+
nextToken?: string;
|
|
518
|
+
}
|
|
519
|
+
/**
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
export interface UpdateCapabilityRequest {
|
|
523
|
+
/**
|
|
524
|
+
* @public
|
|
525
|
+
* <p>Specifies a system-assigned unique identifier for the capability.</p>
|
|
526
|
+
*/
|
|
527
|
+
capabilityId: string | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* @public
|
|
530
|
+
* <p>Specifies a new name for the capability, to replace the existing name.</p>
|
|
531
|
+
*/
|
|
532
|
+
name?: string;
|
|
533
|
+
/**
|
|
534
|
+
* @public
|
|
535
|
+
* <p>Specifies a structure that contains the details for a capability.</p>
|
|
536
|
+
*/
|
|
537
|
+
configuration?: CapabilityConfiguration;
|
|
538
|
+
/**
|
|
539
|
+
* @public
|
|
540
|
+
* <p>Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.</p>
|
|
541
|
+
*/
|
|
542
|
+
instructionsDocuments?: S3Location[];
|
|
543
|
+
}
|
|
544
|
+
/**
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
export interface UpdateCapabilityResponse {
|
|
548
|
+
/**
|
|
549
|
+
* @public
|
|
550
|
+
* <p>Returns a system-assigned unique identifier for the capability.</p>
|
|
551
|
+
*/
|
|
552
|
+
capabilityId: string | undefined;
|
|
553
|
+
/**
|
|
554
|
+
* @public
|
|
555
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
556
|
+
*/
|
|
557
|
+
capabilityArn: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* @public
|
|
560
|
+
* <p>Returns the name of the capability, used to identify it.</p>
|
|
561
|
+
*/
|
|
562
|
+
name: string | undefined;
|
|
563
|
+
/**
|
|
564
|
+
* @public
|
|
565
|
+
* <p>Returns the type of the capability. Currently, only <code>edi</code> is supported.</p>
|
|
566
|
+
*/
|
|
567
|
+
type: CapabilityType | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* @public
|
|
570
|
+
* <p>Returns a structure that contains the details for a capability.</p>
|
|
571
|
+
*/
|
|
572
|
+
configuration: CapabilityConfiguration | undefined;
|
|
573
|
+
/**
|
|
574
|
+
* @public
|
|
575
|
+
* <p>Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.</p>
|
|
576
|
+
*/
|
|
577
|
+
instructionsDocuments?: S3Location[];
|
|
578
|
+
/**
|
|
579
|
+
* @public
|
|
580
|
+
* <p>Returns a timestamp for creation date and time of the capability.</p>
|
|
581
|
+
*/
|
|
582
|
+
createdAt: Date | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* @public
|
|
585
|
+
* <p>Returns a timestamp for last time the capability was modified.</p>
|
|
586
|
+
*/
|
|
587
|
+
modifiedAt?: Date;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
export interface GetTransformerJobRequest {
|
|
593
|
+
/**
|
|
594
|
+
* @public
|
|
595
|
+
* <p>Specifies the unique, system-generated identifier for a transformer run.</p>
|
|
596
|
+
*/
|
|
597
|
+
transformerJobId: string | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* @public
|
|
600
|
+
* <p>Specifies the system-assigned unique identifier for the transformer.</p>
|
|
601
|
+
*/
|
|
602
|
+
transformerId: string | undefined;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* @public
|
|
606
|
+
* @enum
|
|
607
|
+
*/
|
|
608
|
+
export declare const TransformerJobStatus: {
|
|
609
|
+
readonly FAILED: "failed";
|
|
610
|
+
readonly RUNNING: "running";
|
|
611
|
+
readonly SUCCEEDED: "succeeded";
|
|
612
|
+
};
|
|
613
|
+
/**
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
export type TransformerJobStatus = (typeof TransformerJobStatus)[keyof typeof TransformerJobStatus];
|
|
617
|
+
/**
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
export interface GetTransformerJobResponse {
|
|
621
|
+
/**
|
|
622
|
+
* @public
|
|
623
|
+
* <p>Returns the current state of the transformer job, either <code>running</code>,
|
|
624
|
+
* <code>succeeded</code>, or <code>failed</code>.</p>
|
|
625
|
+
*/
|
|
626
|
+
status: TransformerJobStatus | undefined;
|
|
627
|
+
/**
|
|
628
|
+
* @public
|
|
629
|
+
* <p>Returns the location for the output files. If the caller specified a directory for the
|
|
630
|
+
* output, then this contains the full path to the output file, including the file name
|
|
631
|
+
* generated by the service.</p>
|
|
632
|
+
*/
|
|
633
|
+
outputFiles?: S3Location[];
|
|
634
|
+
/**
|
|
635
|
+
* @public
|
|
636
|
+
* <p>Returns an optional error message, which gets populated when the job is not run
|
|
637
|
+
* successfully.</p>
|
|
638
|
+
*/
|
|
639
|
+
message?: string;
|
|
640
|
+
}
|
|
641
|
+
/**
|
|
642
|
+
* @public
|
|
643
|
+
*/
|
|
644
|
+
export interface ListTagsForResourceRequest {
|
|
645
|
+
/**
|
|
646
|
+
* @public
|
|
647
|
+
* <p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
648
|
+
*/
|
|
649
|
+
ResourceARN: string | undefined;
|
|
650
|
+
}
|
|
651
|
+
/**
|
|
652
|
+
* @public
|
|
653
|
+
*/
|
|
654
|
+
export interface ListTagsForResourceResponse {
|
|
655
|
+
/**
|
|
656
|
+
* @public
|
|
657
|
+
* <p>Returns the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>
|
|
658
|
+
*/
|
|
659
|
+
Tags?: Tag[];
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
export interface CreatePartnershipRequest {
|
|
665
|
+
/**
|
|
666
|
+
* @public
|
|
667
|
+
* <p>Specifies the unique, system-generated identifier for the profile connected to this partnership.</p>
|
|
668
|
+
*/
|
|
669
|
+
profileId: string | undefined;
|
|
670
|
+
/**
|
|
671
|
+
* @public
|
|
672
|
+
* <p>Specifies a descriptive name for the partnership.</p>
|
|
673
|
+
*/
|
|
674
|
+
name: string | undefined;
|
|
675
|
+
/**
|
|
676
|
+
* @public
|
|
677
|
+
* <p>Specifies the email address associated with this trading partner.</p>
|
|
678
|
+
*/
|
|
679
|
+
email: string | undefined;
|
|
680
|
+
/**
|
|
681
|
+
* @public
|
|
682
|
+
* <p>Specifies the phone number associated with the partnership.</p>
|
|
683
|
+
*/
|
|
684
|
+
phone?: string;
|
|
685
|
+
/**
|
|
686
|
+
* @public
|
|
687
|
+
* <p>Specifies a list of the capabilities associated with this partnership.</p>
|
|
688
|
+
*/
|
|
689
|
+
capabilities?: string[];
|
|
690
|
+
/**
|
|
691
|
+
* @public
|
|
692
|
+
* <p>Reserved for future use.</p>
|
|
693
|
+
*/
|
|
694
|
+
clientToken?: string;
|
|
695
|
+
/**
|
|
696
|
+
* @public
|
|
697
|
+
* <p>Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>
|
|
698
|
+
*/
|
|
699
|
+
tags?: Tag[];
|
|
700
|
+
}
|
|
701
|
+
/**
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
export interface CreatePartnershipResponse {
|
|
705
|
+
/**
|
|
706
|
+
* @public
|
|
707
|
+
* <p>Returns the unique, system-generated identifier for the profile connected to this partnership.</p>
|
|
708
|
+
*/
|
|
709
|
+
profileId: string | undefined;
|
|
710
|
+
/**
|
|
711
|
+
* @public
|
|
712
|
+
* <p>Returns the unique, system-generated identifier for a partnership.</p>
|
|
713
|
+
*/
|
|
714
|
+
partnershipId: string | undefined;
|
|
715
|
+
/**
|
|
716
|
+
* @public
|
|
717
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
718
|
+
*/
|
|
719
|
+
partnershipArn: string | undefined;
|
|
720
|
+
/**
|
|
721
|
+
* @public
|
|
722
|
+
* <p>Returns a descriptive name for the partnership.</p>
|
|
723
|
+
*/
|
|
724
|
+
name?: string;
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
* <p>Returns the email address associated with this trading partner.</p>
|
|
728
|
+
*/
|
|
729
|
+
email?: string;
|
|
730
|
+
/**
|
|
731
|
+
* @public
|
|
732
|
+
* <p>Returns the phone number associated with the partnership.</p>
|
|
733
|
+
*/
|
|
734
|
+
phone?: string;
|
|
735
|
+
/**
|
|
736
|
+
* @public
|
|
737
|
+
* <p>Returns one or more capabilities associated with this partnership.</p>
|
|
738
|
+
*/
|
|
739
|
+
capabilities?: string[];
|
|
740
|
+
/**
|
|
741
|
+
* @public
|
|
742
|
+
* <p>Returns the unique, system-generated identifier for a trading partner.</p>
|
|
743
|
+
*/
|
|
744
|
+
tradingPartnerId?: string;
|
|
745
|
+
/**
|
|
746
|
+
* @public
|
|
747
|
+
* <p>Returns a timestamp for creation date and time of the partnership.</p>
|
|
748
|
+
*/
|
|
749
|
+
createdAt: Date | undefined;
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
export interface DeletePartnershipRequest {
|
|
755
|
+
/**
|
|
756
|
+
* @public
|
|
757
|
+
* <p>Specifies the unique, system-generated identifier for a partnership.</p>
|
|
758
|
+
*/
|
|
759
|
+
partnershipId: string | undefined;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
export interface GetPartnershipRequest {
|
|
765
|
+
/**
|
|
766
|
+
* @public
|
|
767
|
+
* <p>Specifies the unique, system-generated identifier for a partnership.</p>
|
|
768
|
+
*/
|
|
769
|
+
partnershipId: string | undefined;
|
|
770
|
+
}
|
|
771
|
+
/**
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
export interface GetPartnershipResponse {
|
|
775
|
+
/**
|
|
776
|
+
* @public
|
|
777
|
+
* <p>Returns the unique, system-generated identifier for the profile connected to this partnership.</p>
|
|
778
|
+
*/
|
|
779
|
+
profileId: string | undefined;
|
|
780
|
+
/**
|
|
781
|
+
* @public
|
|
782
|
+
* <p>Returns the unique, system-generated identifier for a partnership.</p>
|
|
783
|
+
*/
|
|
784
|
+
partnershipId: string | undefined;
|
|
785
|
+
/**
|
|
786
|
+
* @public
|
|
787
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
788
|
+
*/
|
|
789
|
+
partnershipArn: string | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* @public
|
|
792
|
+
* <p>Returns the display name of the partnership</p>
|
|
793
|
+
*/
|
|
794
|
+
name?: string;
|
|
795
|
+
/**
|
|
796
|
+
* @public
|
|
797
|
+
* <p>Returns the email address associated with this trading partner.</p>
|
|
798
|
+
*/
|
|
799
|
+
email?: string;
|
|
800
|
+
/**
|
|
801
|
+
* @public
|
|
802
|
+
* <p>Returns the phone number associated with the partnership.</p>
|
|
803
|
+
*/
|
|
804
|
+
phone?: string;
|
|
805
|
+
/**
|
|
806
|
+
* @public
|
|
807
|
+
* <p>Returns one or more capabilities associated with this partnership.</p>
|
|
808
|
+
*/
|
|
809
|
+
capabilities?: string[];
|
|
810
|
+
/**
|
|
811
|
+
* @public
|
|
812
|
+
* <p>Returns the unique identifier for the partner for this partnership.</p>
|
|
813
|
+
*/
|
|
814
|
+
tradingPartnerId?: string;
|
|
815
|
+
/**
|
|
816
|
+
* @public
|
|
817
|
+
* <p>Returns a timestamp for creation date and time of the partnership.</p>
|
|
818
|
+
*/
|
|
819
|
+
createdAt: Date | undefined;
|
|
820
|
+
/**
|
|
821
|
+
* @public
|
|
822
|
+
* <p>Returns a timestamp that identifies the most recent date and time that the partnership was modified.</p>
|
|
823
|
+
*/
|
|
824
|
+
modifiedAt?: Date;
|
|
825
|
+
}
|
|
826
|
+
/**
|
|
827
|
+
* @public
|
|
828
|
+
*/
|
|
829
|
+
export interface ListPartnershipsRequest {
|
|
830
|
+
/**
|
|
831
|
+
* @public
|
|
832
|
+
* <p>Specifies the unique, system-generated identifier for the profile connected to this partnership.</p>
|
|
833
|
+
*/
|
|
834
|
+
profileId?: string;
|
|
835
|
+
/**
|
|
836
|
+
* @public
|
|
837
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
838
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
839
|
+
*/
|
|
840
|
+
nextToken?: string;
|
|
841
|
+
/**
|
|
842
|
+
* @public
|
|
843
|
+
* <p>Specifies the maximum number of capabilities to return.</p>
|
|
844
|
+
*/
|
|
845
|
+
maxResults?: number;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* @public
|
|
849
|
+
* <p>A structure that contains the details for a partnership. 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>
|
|
850
|
+
*/
|
|
851
|
+
export interface PartnershipSummary {
|
|
852
|
+
/**
|
|
853
|
+
* @public
|
|
854
|
+
* <p>Returns the unique, system-generated identifier for the profile connected to this partnership.</p>
|
|
855
|
+
*/
|
|
856
|
+
profileId: string | undefined;
|
|
857
|
+
/**
|
|
858
|
+
* @public
|
|
859
|
+
* <p>Returns the unique, system-generated identifier for a partnership.</p>
|
|
860
|
+
*/
|
|
861
|
+
partnershipId: string | undefined;
|
|
862
|
+
/**
|
|
863
|
+
* @public
|
|
864
|
+
* <p>Returns the name of the partnership.</p>
|
|
865
|
+
*/
|
|
866
|
+
name?: string;
|
|
867
|
+
/**
|
|
868
|
+
* @public
|
|
869
|
+
* <p>Returns one or more capabilities associated with this partnership.</p>
|
|
870
|
+
*/
|
|
871
|
+
capabilities?: string[];
|
|
872
|
+
/**
|
|
873
|
+
* @public
|
|
874
|
+
* <p>Returns the unique, system-generated identifier for a trading partner.</p>
|
|
875
|
+
*/
|
|
876
|
+
tradingPartnerId?: string;
|
|
877
|
+
/**
|
|
878
|
+
* @public
|
|
879
|
+
* <p>Returns a timestamp for creation date and time of the partnership.</p>
|
|
880
|
+
*/
|
|
881
|
+
createdAt: Date | undefined;
|
|
882
|
+
/**
|
|
883
|
+
* @public
|
|
884
|
+
* <p>Returns a timestamp that identifies the most recent date and time that the partnership was modified.</p>
|
|
885
|
+
*/
|
|
886
|
+
modifiedAt?: Date;
|
|
887
|
+
}
|
|
888
|
+
/**
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
891
|
+
export interface ListPartnershipsResponse {
|
|
892
|
+
/**
|
|
893
|
+
* @public
|
|
894
|
+
* <p>Specifies a list of your partnerships.</p>
|
|
895
|
+
*/
|
|
896
|
+
partnerships: PartnershipSummary[] | undefined;
|
|
897
|
+
/**
|
|
898
|
+
* @public
|
|
899
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
900
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
901
|
+
*/
|
|
902
|
+
nextToken?: string;
|
|
903
|
+
}
|
|
904
|
+
/**
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
export interface UpdatePartnershipRequest {
|
|
908
|
+
/**
|
|
909
|
+
* @public
|
|
910
|
+
* <p>Specifies the unique, system-generated identifier for a partnership.</p>
|
|
911
|
+
*/
|
|
912
|
+
partnershipId: string | undefined;
|
|
913
|
+
/**
|
|
914
|
+
* @public
|
|
915
|
+
* <p>The name of the partnership, used to identify it.</p>
|
|
916
|
+
*/
|
|
917
|
+
name?: string;
|
|
918
|
+
/**
|
|
919
|
+
* @public
|
|
920
|
+
* <p>List of the capabilities associated with this partnership.</p>
|
|
921
|
+
*/
|
|
922
|
+
capabilities?: string[];
|
|
923
|
+
}
|
|
924
|
+
/**
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
export interface UpdatePartnershipResponse {
|
|
928
|
+
/**
|
|
929
|
+
* @public
|
|
930
|
+
* <p>Returns the unique, system-generated identifier for the profile connected to this partnership.</p>
|
|
931
|
+
*/
|
|
932
|
+
profileId: string | undefined;
|
|
933
|
+
/**
|
|
934
|
+
* @public
|
|
935
|
+
* <p>Returns the unique, system-generated identifier for a partnership.</p>
|
|
936
|
+
*/
|
|
937
|
+
partnershipId: string | undefined;
|
|
938
|
+
/**
|
|
939
|
+
* @public
|
|
940
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
941
|
+
*/
|
|
942
|
+
partnershipArn: string | undefined;
|
|
943
|
+
/**
|
|
944
|
+
* @public
|
|
945
|
+
* <p>The name of the partnership, used to identify it.</p>
|
|
946
|
+
*/
|
|
947
|
+
name?: string;
|
|
948
|
+
/**
|
|
949
|
+
* @public
|
|
950
|
+
* <p>Returns the email address associated with this trading partner.</p>
|
|
951
|
+
*/
|
|
952
|
+
email?: string;
|
|
953
|
+
/**
|
|
954
|
+
* @public
|
|
955
|
+
* <p>Returns the phone number associated with the partnership.</p>
|
|
956
|
+
*/
|
|
957
|
+
phone?: string;
|
|
958
|
+
/**
|
|
959
|
+
* @public
|
|
960
|
+
* <p>Returns one or more capabilities associated with this partnership.</p>
|
|
961
|
+
*/
|
|
962
|
+
capabilities?: string[];
|
|
963
|
+
/**
|
|
964
|
+
* @public
|
|
965
|
+
* <p>Returns the unique, system-generated identifier for a trading partner.</p>
|
|
966
|
+
*/
|
|
967
|
+
tradingPartnerId?: string;
|
|
968
|
+
/**
|
|
969
|
+
* @public
|
|
970
|
+
* <p>Returns a timestamp that identifies the most recent date and time that the partnership was modified.</p>
|
|
971
|
+
*/
|
|
972
|
+
createdAt: Date | undefined;
|
|
973
|
+
/**
|
|
974
|
+
* @public
|
|
975
|
+
* <p>Returns a timestamp that identifies the most recent date and time that the partnership was modified.</p>
|
|
976
|
+
*/
|
|
977
|
+
modifiedAt?: Date;
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* @public
|
|
981
|
+
* @enum
|
|
982
|
+
*/
|
|
983
|
+
export declare const Logging: {
|
|
984
|
+
readonly DISABLED: "DISABLED";
|
|
985
|
+
readonly ENABLED: "ENABLED";
|
|
986
|
+
};
|
|
987
|
+
/**
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
export type Logging = (typeof Logging)[keyof typeof Logging];
|
|
991
|
+
/**
|
|
992
|
+
* @public
|
|
993
|
+
*/
|
|
994
|
+
export interface CreateProfileRequest {
|
|
995
|
+
/**
|
|
996
|
+
* @public
|
|
997
|
+
* <p>Specifies the name of the profile.</p>
|
|
998
|
+
*/
|
|
999
|
+
name: string | undefined;
|
|
1000
|
+
/**
|
|
1001
|
+
* @public
|
|
1002
|
+
* <p>Specifies the email address associated with this customer profile.</p>
|
|
1003
|
+
*/
|
|
1004
|
+
email?: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* @public
|
|
1007
|
+
* <p>Specifies the phone number associated with the profile.</p>
|
|
1008
|
+
*/
|
|
1009
|
+
phone: string | undefined;
|
|
1010
|
+
/**
|
|
1011
|
+
* @public
|
|
1012
|
+
* <p>Specifies the name for the business associated with this profile.</p>
|
|
1013
|
+
*/
|
|
1014
|
+
businessName: string | undefined;
|
|
1015
|
+
/**
|
|
1016
|
+
* @public
|
|
1017
|
+
* <p>Specifies whether or not logging is enabled for this profile.</p>
|
|
1018
|
+
*/
|
|
1019
|
+
logging: Logging | undefined;
|
|
1020
|
+
/**
|
|
1021
|
+
* @public
|
|
1022
|
+
* <p>Reserved for future use.</p>
|
|
1023
|
+
*/
|
|
1024
|
+
clientToken?: string;
|
|
1025
|
+
/**
|
|
1026
|
+
* @public
|
|
1027
|
+
* <p>Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>
|
|
1028
|
+
*/
|
|
1029
|
+
tags?: Tag[];
|
|
1030
|
+
}
|
|
1031
|
+
/**
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
export interface CreateProfileResponse {
|
|
1035
|
+
/**
|
|
1036
|
+
* @public
|
|
1037
|
+
* <p>Returns the unique, system-generated identifier for the profile.</p>
|
|
1038
|
+
*/
|
|
1039
|
+
profileId: string | undefined;
|
|
1040
|
+
/**
|
|
1041
|
+
* @public
|
|
1042
|
+
* <p>Returns an Amazon Resource Name (ARN) for the profile.</p>
|
|
1043
|
+
*/
|
|
1044
|
+
profileArn: string | undefined;
|
|
1045
|
+
/**
|
|
1046
|
+
* @public
|
|
1047
|
+
* <p>Returns the name of the profile, used to identify it.</p>
|
|
1048
|
+
*/
|
|
1049
|
+
name: string | undefined;
|
|
1050
|
+
/**
|
|
1051
|
+
* @public
|
|
1052
|
+
* <p>Returns the name for the business associated with this profile.</p>
|
|
1053
|
+
*/
|
|
1054
|
+
businessName: string | undefined;
|
|
1055
|
+
/**
|
|
1056
|
+
* @public
|
|
1057
|
+
* <p>Returns the phone number associated with the profile.</p>
|
|
1058
|
+
*/
|
|
1059
|
+
phone: string | undefined;
|
|
1060
|
+
/**
|
|
1061
|
+
* @public
|
|
1062
|
+
* <p>Returns the email address associated with this customer profile.</p>
|
|
1063
|
+
*/
|
|
1064
|
+
email?: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* @public
|
|
1067
|
+
* <p>Returns whether or not logging is turned on for this profile.</p>
|
|
1068
|
+
*/
|
|
1069
|
+
logging?: Logging;
|
|
1070
|
+
/**
|
|
1071
|
+
* @public
|
|
1072
|
+
* <p>Returns the name of the logging group.</p>
|
|
1073
|
+
*/
|
|
1074
|
+
logGroupName?: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* @public
|
|
1077
|
+
* <p>Returns a timestamp representing the time the profile was created.</p>
|
|
1078
|
+
*/
|
|
1079
|
+
createdAt: Date | undefined;
|
|
1080
|
+
}
|
|
1081
|
+
/**
|
|
1082
|
+
* @public
|
|
1083
|
+
*/
|
|
1084
|
+
export interface DeleteProfileRequest {
|
|
1085
|
+
/**
|
|
1086
|
+
* @public
|
|
1087
|
+
* <p>Specifies the unique, system-generated identifier for the profile.</p>
|
|
1088
|
+
*/
|
|
1089
|
+
profileId: string | undefined;
|
|
1090
|
+
}
|
|
1091
|
+
/**
|
|
1092
|
+
* @public
|
|
1093
|
+
*/
|
|
1094
|
+
export interface GetProfileRequest {
|
|
1095
|
+
/**
|
|
1096
|
+
* @public
|
|
1097
|
+
* <p>Specifies the unique, system-generated identifier for the profile.</p>
|
|
1098
|
+
*/
|
|
1099
|
+
profileId: string | undefined;
|
|
1100
|
+
}
|
|
1101
|
+
/**
|
|
1102
|
+
* @public
|
|
1103
|
+
*/
|
|
1104
|
+
export interface GetProfileResponse {
|
|
1105
|
+
/**
|
|
1106
|
+
* @public
|
|
1107
|
+
* <p>Returns the unique, system-generated identifier for the profile.</p>
|
|
1108
|
+
*/
|
|
1109
|
+
profileId: string | undefined;
|
|
1110
|
+
/**
|
|
1111
|
+
* @public
|
|
1112
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
1113
|
+
*/
|
|
1114
|
+
profileArn: string | undefined;
|
|
1115
|
+
/**
|
|
1116
|
+
* @public
|
|
1117
|
+
* <p>Returns the name of the profile, used to identify it.</p>
|
|
1118
|
+
*/
|
|
1119
|
+
name: string | undefined;
|
|
1120
|
+
/**
|
|
1121
|
+
* @public
|
|
1122
|
+
* <p>Returns the email address associated with this customer profile.</p>
|
|
1123
|
+
*/
|
|
1124
|
+
email?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* @public
|
|
1127
|
+
* <p>Returns the phone number associated with the profile.</p>
|
|
1128
|
+
*/
|
|
1129
|
+
phone: string | undefined;
|
|
1130
|
+
/**
|
|
1131
|
+
* @public
|
|
1132
|
+
* <p>Returns the name for the business associated with this profile.</p>
|
|
1133
|
+
*/
|
|
1134
|
+
businessName: string | undefined;
|
|
1135
|
+
/**
|
|
1136
|
+
* @public
|
|
1137
|
+
* <p>Returns whether or not logging is enabled for this profile.</p>
|
|
1138
|
+
*/
|
|
1139
|
+
logging?: Logging;
|
|
1140
|
+
/**
|
|
1141
|
+
* @public
|
|
1142
|
+
* <p>Returns the name of the logging group.</p>
|
|
1143
|
+
*/
|
|
1144
|
+
logGroupName?: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* @public
|
|
1147
|
+
* <p>Returns a timestamp for creation date and time of the transformer.</p>
|
|
1148
|
+
*/
|
|
1149
|
+
createdAt: Date | undefined;
|
|
1150
|
+
/**
|
|
1151
|
+
* @public
|
|
1152
|
+
* <p>Returns a timestamp for last time the profile was modified.</p>
|
|
1153
|
+
*/
|
|
1154
|
+
modifiedAt?: Date;
|
|
1155
|
+
}
|
|
1156
|
+
/**
|
|
1157
|
+
* @public
|
|
1158
|
+
*/
|
|
1159
|
+
export interface ListProfilesRequest {
|
|
1160
|
+
/**
|
|
1161
|
+
* @public
|
|
1162
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
1163
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
1164
|
+
*/
|
|
1165
|
+
nextToken?: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* @public
|
|
1168
|
+
* <p>Specifies the maximum number of profiles to return.</p>
|
|
1169
|
+
*/
|
|
1170
|
+
maxResults?: number;
|
|
1171
|
+
}
|
|
1172
|
+
/**
|
|
1173
|
+
* @public
|
|
1174
|
+
* <p>Contains the details for a profile. Profiles contain basic information about you and your business.</p>
|
|
1175
|
+
*/
|
|
1176
|
+
export interface ProfileSummary {
|
|
1177
|
+
/**
|
|
1178
|
+
* @public
|
|
1179
|
+
* <p>Returns the unique, system-generated identifier for the profile.</p>
|
|
1180
|
+
*/
|
|
1181
|
+
profileId: string | undefined;
|
|
1182
|
+
/**
|
|
1183
|
+
* @public
|
|
1184
|
+
* <p>Returns the display name for profile.</p>
|
|
1185
|
+
*/
|
|
1186
|
+
name: string | undefined;
|
|
1187
|
+
/**
|
|
1188
|
+
* @public
|
|
1189
|
+
* <p>Returns the name for the business associated with this profile.</p>
|
|
1190
|
+
*/
|
|
1191
|
+
businessName: string | undefined;
|
|
1192
|
+
/**
|
|
1193
|
+
* @public
|
|
1194
|
+
* <p>Specifies whether or not logging is enabled for this profile.</p>
|
|
1195
|
+
*/
|
|
1196
|
+
logging?: Logging;
|
|
1197
|
+
/**
|
|
1198
|
+
* @public
|
|
1199
|
+
* <p>Returns the name of the logging group.</p>
|
|
1200
|
+
*/
|
|
1201
|
+
logGroupName?: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* @public
|
|
1204
|
+
* <p>Returns the timestamp for creation date and time of the profile.</p>
|
|
1205
|
+
*/
|
|
1206
|
+
createdAt: Date | undefined;
|
|
1207
|
+
/**
|
|
1208
|
+
* @public
|
|
1209
|
+
* <p>Returns the timestamp that identifies the most recent date and time that the profile was modified.</p>
|
|
1210
|
+
*/
|
|
1211
|
+
modifiedAt?: Date;
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
export interface ListProfilesResponse {
|
|
1217
|
+
/**
|
|
1218
|
+
* @public
|
|
1219
|
+
* <p>Returns an array of <code>ProfileSummary</code> objects.</p>
|
|
1220
|
+
*/
|
|
1221
|
+
profiles: ProfileSummary[] | undefined;
|
|
1222
|
+
/**
|
|
1223
|
+
* @public
|
|
1224
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
1225
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
1226
|
+
*/
|
|
1227
|
+
nextToken?: string;
|
|
1228
|
+
}
|
|
1229
|
+
/**
|
|
1230
|
+
* @public
|
|
1231
|
+
*/
|
|
1232
|
+
export interface UpdateProfileRequest {
|
|
1233
|
+
/**
|
|
1234
|
+
* @public
|
|
1235
|
+
* <p>Specifies the unique, system-generated identifier for the profile.</p>
|
|
1236
|
+
*/
|
|
1237
|
+
profileId: string | undefined;
|
|
1238
|
+
/**
|
|
1239
|
+
* @public
|
|
1240
|
+
* <p>The name of the profile, used to identify it.</p>
|
|
1241
|
+
*/
|
|
1242
|
+
name?: string;
|
|
1243
|
+
/**
|
|
1244
|
+
* @public
|
|
1245
|
+
* <p>Specifies the email address associated with this customer profile.</p>
|
|
1246
|
+
*/
|
|
1247
|
+
email?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* @public
|
|
1250
|
+
* <p>Specifies the phone number associated with the profile.</p>
|
|
1251
|
+
*/
|
|
1252
|
+
phone?: string;
|
|
1253
|
+
/**
|
|
1254
|
+
* @public
|
|
1255
|
+
* <p>Specifies the name for the business associated with this profile.</p>
|
|
1256
|
+
*/
|
|
1257
|
+
businessName?: string;
|
|
1258
|
+
}
|
|
1259
|
+
/**
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
export interface UpdateProfileResponse {
|
|
1263
|
+
/**
|
|
1264
|
+
* @public
|
|
1265
|
+
* <p>Returns the unique, system-generated identifier for the profile.</p>
|
|
1266
|
+
*/
|
|
1267
|
+
profileId: string | undefined;
|
|
1268
|
+
/**
|
|
1269
|
+
* @public
|
|
1270
|
+
* <p>Returns an Amazon Resource Name (ARN) for the profile.</p>
|
|
1271
|
+
*/
|
|
1272
|
+
profileArn: string | undefined;
|
|
1273
|
+
/**
|
|
1274
|
+
* @public
|
|
1275
|
+
* <p>Returns the name of the profile.</p>
|
|
1276
|
+
*/
|
|
1277
|
+
name: string | undefined;
|
|
1278
|
+
/**
|
|
1279
|
+
* @public
|
|
1280
|
+
* <p>Returns the email address associated with this customer profile.</p>
|
|
1281
|
+
*/
|
|
1282
|
+
email?: string;
|
|
1283
|
+
/**
|
|
1284
|
+
* @public
|
|
1285
|
+
* <p>Returns the phone number associated with the profile.</p>
|
|
1286
|
+
*/
|
|
1287
|
+
phone: string | undefined;
|
|
1288
|
+
/**
|
|
1289
|
+
* @public
|
|
1290
|
+
* <p>Returns the name for the business associated with this profile.</p>
|
|
1291
|
+
*/
|
|
1292
|
+
businessName: string | undefined;
|
|
1293
|
+
/**
|
|
1294
|
+
* @public
|
|
1295
|
+
* <p>Specifies whether or not logging is enabled for this profile.</p>
|
|
1296
|
+
*/
|
|
1297
|
+
logging?: Logging;
|
|
1298
|
+
/**
|
|
1299
|
+
* @public
|
|
1300
|
+
* <p>Returns the name of the logging group.</p>
|
|
1301
|
+
*/
|
|
1302
|
+
logGroupName?: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* @public
|
|
1305
|
+
* <p>Returns a timestamp for creation date and time of the profile.</p>
|
|
1306
|
+
*/
|
|
1307
|
+
createdAt: Date | undefined;
|
|
1308
|
+
/**
|
|
1309
|
+
* @public
|
|
1310
|
+
* <p>Returns a timestamp for last time the profile was modified.</p>
|
|
1311
|
+
*/
|
|
1312
|
+
modifiedAt?: Date;
|
|
1313
|
+
}
|
|
1314
|
+
/**
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
export interface StartTransformerJobRequest {
|
|
1318
|
+
/**
|
|
1319
|
+
* @public
|
|
1320
|
+
* <p>Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.</p>
|
|
1321
|
+
*/
|
|
1322
|
+
inputFile: S3Location | undefined;
|
|
1323
|
+
/**
|
|
1324
|
+
* @public
|
|
1325
|
+
* <p>Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.</p>
|
|
1326
|
+
*/
|
|
1327
|
+
outputLocation: S3Location | undefined;
|
|
1328
|
+
/**
|
|
1329
|
+
* @public
|
|
1330
|
+
* <p>Specifies the system-assigned unique identifier for the transformer.</p>
|
|
1331
|
+
*/
|
|
1332
|
+
transformerId: string | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* @public
|
|
1335
|
+
* <p>Reserved for future use.</p>
|
|
1336
|
+
*/
|
|
1337
|
+
clientToken?: string;
|
|
1338
|
+
}
|
|
1339
|
+
/**
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
export interface StartTransformerJobResponse {
|
|
1343
|
+
/**
|
|
1344
|
+
* @public
|
|
1345
|
+
* <p>Returns the unique, system-generated identifier for a transformer run.</p>
|
|
1346
|
+
*/
|
|
1347
|
+
transformerJobId: string | undefined;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
export interface TagResourceRequest {
|
|
1353
|
+
/**
|
|
1354
|
+
* @public
|
|
1355
|
+
* <p>Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
1356
|
+
*/
|
|
1357
|
+
ResourceARN: string | undefined;
|
|
1358
|
+
/**
|
|
1359
|
+
* @public
|
|
1360
|
+
* <p>Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>
|
|
1361
|
+
*/
|
|
1362
|
+
Tags: Tag[] | undefined;
|
|
1363
|
+
}
|
|
1364
|
+
/**
|
|
1365
|
+
* @public
|
|
1366
|
+
* @enum
|
|
1367
|
+
*/
|
|
1368
|
+
export declare const FileFormat: {
|
|
1369
|
+
readonly JSON: "JSON";
|
|
1370
|
+
readonly XML: "XML";
|
|
1371
|
+
};
|
|
1372
|
+
/**
|
|
1373
|
+
* @public
|
|
1374
|
+
*/
|
|
1375
|
+
export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat];
|
|
1376
|
+
/**
|
|
1377
|
+
* @public
|
|
1378
|
+
*/
|
|
1379
|
+
export interface TestMappingRequest {
|
|
1380
|
+
/**
|
|
1381
|
+
* @public
|
|
1382
|
+
* <p>Specify the EDI (electronic data interchange) file that is used as input for the transform.</p>
|
|
1383
|
+
*/
|
|
1384
|
+
inputFileContent: string | undefined;
|
|
1385
|
+
/**
|
|
1386
|
+
* @public
|
|
1387
|
+
* <p>Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the
|
|
1388
|
+
* correct set of objects.</p>
|
|
1389
|
+
*/
|
|
1390
|
+
mappingTemplate: string | undefined;
|
|
1391
|
+
/**
|
|
1392
|
+
* @public
|
|
1393
|
+
* <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1394
|
+
*/
|
|
1395
|
+
fileFormat: FileFormat | undefined;
|
|
1396
|
+
}
|
|
1397
|
+
/**
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
export interface TestMappingResponse {
|
|
1401
|
+
/**
|
|
1402
|
+
* @public
|
|
1403
|
+
* <p>Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint</p>
|
|
1404
|
+
*/
|
|
1405
|
+
mappedFileContent: string | undefined;
|
|
1406
|
+
}
|
|
1407
|
+
/**
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
export interface TestParsingRequest {
|
|
1411
|
+
/**
|
|
1412
|
+
* @public
|
|
1413
|
+
* <p>Specifies an <code>S3Location</code> object, which contains the Amazon S3 bucket and prefix for the location of the input file.</p>
|
|
1414
|
+
*/
|
|
1415
|
+
inputFile: S3Location | undefined;
|
|
1416
|
+
/**
|
|
1417
|
+
* @public
|
|
1418
|
+
* <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1419
|
+
*/
|
|
1420
|
+
fileFormat: FileFormat | undefined;
|
|
1421
|
+
/**
|
|
1422
|
+
* @public
|
|
1423
|
+
* <p>Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
1424
|
+
*/
|
|
1425
|
+
ediType: EdiType | undefined;
|
|
1426
|
+
}
|
|
1427
|
+
/**
|
|
1428
|
+
* @public
|
|
1429
|
+
*/
|
|
1430
|
+
export interface TestParsingResponse {
|
|
1431
|
+
/**
|
|
1432
|
+
* @public
|
|
1433
|
+
* <p>Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.</p>
|
|
1434
|
+
*/
|
|
1435
|
+
parsedFileContent: string | undefined;
|
|
1436
|
+
}
|
|
1437
|
+
/**
|
|
1438
|
+
* @public
|
|
1439
|
+
*/
|
|
1440
|
+
export interface CreateTransformerRequest {
|
|
1441
|
+
/**
|
|
1442
|
+
* @public
|
|
1443
|
+
* <p>Specifies the name of the transformer, used to identify it.</p>
|
|
1444
|
+
*/
|
|
1445
|
+
name: string | undefined;
|
|
1446
|
+
/**
|
|
1447
|
+
* @public
|
|
1448
|
+
* <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1449
|
+
*/
|
|
1450
|
+
fileFormat: FileFormat | undefined;
|
|
1451
|
+
/**
|
|
1452
|
+
* @public
|
|
1453
|
+
* <p>Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the
|
|
1454
|
+
* correct set of objects.</p>
|
|
1455
|
+
*/
|
|
1456
|
+
mappingTemplate: string | undefined;
|
|
1457
|
+
/**
|
|
1458
|
+
* @public
|
|
1459
|
+
* <p>Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
1460
|
+
*/
|
|
1461
|
+
ediType: EdiType | undefined;
|
|
1462
|
+
/**
|
|
1463
|
+
* @public
|
|
1464
|
+
* <p>Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
|
|
1465
|
+
*/
|
|
1466
|
+
sampleDocument?: string;
|
|
1467
|
+
/**
|
|
1468
|
+
* @public
|
|
1469
|
+
* <p>Reserved for future use.</p>
|
|
1470
|
+
*/
|
|
1471
|
+
clientToken?: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* @public
|
|
1474
|
+
* <p>Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>
|
|
1475
|
+
*/
|
|
1476
|
+
tags?: Tag[];
|
|
1477
|
+
}
|
|
1478
|
+
/**
|
|
1479
|
+
* @public
|
|
1480
|
+
* @enum
|
|
1481
|
+
*/
|
|
1482
|
+
export declare const TransformerStatus: {
|
|
1483
|
+
readonly ACTIVE: "active";
|
|
1484
|
+
readonly INACTIVE: "inactive";
|
|
1485
|
+
};
|
|
1486
|
+
/**
|
|
1487
|
+
* @public
|
|
1488
|
+
*/
|
|
1489
|
+
export type TransformerStatus = (typeof TransformerStatus)[keyof typeof TransformerStatus];
|
|
1490
|
+
/**
|
|
1491
|
+
* @public
|
|
1492
|
+
*/
|
|
1493
|
+
export interface CreateTransformerResponse {
|
|
1494
|
+
/**
|
|
1495
|
+
* @public
|
|
1496
|
+
* <p>Returns the system-assigned unique identifier for the transformer.</p>
|
|
1497
|
+
*/
|
|
1498
|
+
transformerId: string | undefined;
|
|
1499
|
+
/**
|
|
1500
|
+
* @public
|
|
1501
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
1502
|
+
*/
|
|
1503
|
+
transformerArn: string | undefined;
|
|
1504
|
+
/**
|
|
1505
|
+
* @public
|
|
1506
|
+
* <p>Returns the name of the transformer, used to identify it.</p>
|
|
1507
|
+
*/
|
|
1508
|
+
name: string | undefined;
|
|
1509
|
+
/**
|
|
1510
|
+
* @public
|
|
1511
|
+
* <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1512
|
+
*/
|
|
1513
|
+
fileFormat: FileFormat | undefined;
|
|
1514
|
+
/**
|
|
1515
|
+
* @public
|
|
1516
|
+
* <p>Returns the name of the mapping template for the transformer. This template is used to convert the input document into the
|
|
1517
|
+
* correct set of objects.</p>
|
|
1518
|
+
*/
|
|
1519
|
+
mappingTemplate: string | undefined;
|
|
1520
|
+
/**
|
|
1521
|
+
* @public
|
|
1522
|
+
* <p>Returns the state of the newly created transformer. The transformer can be either
|
|
1523
|
+
* <code>active</code> or <code>inactive</code>. For the transformer to be used in a
|
|
1524
|
+
* capability, its status must <code>active</code>.</p>
|
|
1525
|
+
*/
|
|
1526
|
+
status: TransformerStatus | undefined;
|
|
1527
|
+
/**
|
|
1528
|
+
* @public
|
|
1529
|
+
* <p>Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
1530
|
+
*/
|
|
1531
|
+
ediType: EdiType | undefined;
|
|
1532
|
+
/**
|
|
1533
|
+
* @public
|
|
1534
|
+
* <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
|
|
1535
|
+
*/
|
|
1536
|
+
sampleDocument?: string;
|
|
1537
|
+
/**
|
|
1538
|
+
* @public
|
|
1539
|
+
* <p>Returns a timestamp for creation date and time of the transformer.</p>
|
|
1540
|
+
*/
|
|
1541
|
+
createdAt: Date | undefined;
|
|
1542
|
+
}
|
|
1543
|
+
/**
|
|
1544
|
+
* @public
|
|
1545
|
+
*/
|
|
1546
|
+
export interface DeleteTransformerRequest {
|
|
1547
|
+
/**
|
|
1548
|
+
* @public
|
|
1549
|
+
* <p>Specifies the system-assigned unique identifier for the transformer.</p>
|
|
1550
|
+
*/
|
|
1551
|
+
transformerId: string | undefined;
|
|
1552
|
+
}
|
|
1553
|
+
/**
|
|
1554
|
+
* @public
|
|
1555
|
+
*/
|
|
1556
|
+
export interface GetTransformerRequest {
|
|
1557
|
+
/**
|
|
1558
|
+
* @public
|
|
1559
|
+
* <p>Specifies the system-assigned unique identifier for the transformer.</p>
|
|
1560
|
+
*/
|
|
1561
|
+
transformerId: string | undefined;
|
|
1562
|
+
}
|
|
1563
|
+
/**
|
|
1564
|
+
* @public
|
|
1565
|
+
*/
|
|
1566
|
+
export interface GetTransformerResponse {
|
|
1567
|
+
/**
|
|
1568
|
+
* @public
|
|
1569
|
+
* <p>Returns the system-assigned unique identifier for the transformer.</p>
|
|
1570
|
+
*/
|
|
1571
|
+
transformerId: string | undefined;
|
|
1572
|
+
/**
|
|
1573
|
+
* @public
|
|
1574
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
1575
|
+
*/
|
|
1576
|
+
transformerArn: string | undefined;
|
|
1577
|
+
/**
|
|
1578
|
+
* @public
|
|
1579
|
+
* <p>Returns the name of the transformer, used to identify it.</p>
|
|
1580
|
+
*/
|
|
1581
|
+
name: string | undefined;
|
|
1582
|
+
/**
|
|
1583
|
+
* @public
|
|
1584
|
+
* <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1585
|
+
*/
|
|
1586
|
+
fileFormat: FileFormat | undefined;
|
|
1587
|
+
/**
|
|
1588
|
+
* @public
|
|
1589
|
+
* <p>Returns the name of the mapping template for the transformer. This template is used to convert the input document into the
|
|
1590
|
+
* correct set of objects.</p>
|
|
1591
|
+
*/
|
|
1592
|
+
mappingTemplate: string | undefined;
|
|
1593
|
+
/**
|
|
1594
|
+
* @public
|
|
1595
|
+
* <p>Returns the state of the newly created transformer. The transformer can be either
|
|
1596
|
+
* <code>active</code> or <code>inactive</code>. For the transformer to be used in a
|
|
1597
|
+
* capability, its status must <code>active</code>.</p>
|
|
1598
|
+
*/
|
|
1599
|
+
status: TransformerStatus | undefined;
|
|
1600
|
+
/**
|
|
1601
|
+
* @public
|
|
1602
|
+
* <p>Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
1603
|
+
*/
|
|
1604
|
+
ediType: EdiType | undefined;
|
|
1605
|
+
/**
|
|
1606
|
+
* @public
|
|
1607
|
+
* <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
|
|
1608
|
+
*/
|
|
1609
|
+
sampleDocument?: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* @public
|
|
1612
|
+
* <p>Returns a timestamp for creation date and time of the transformer.</p>
|
|
1613
|
+
*/
|
|
1614
|
+
createdAt: Date | undefined;
|
|
1615
|
+
/**
|
|
1616
|
+
* @public
|
|
1617
|
+
* <p>Returns a timestamp for last time the transformer was modified.</p>
|
|
1618
|
+
*/
|
|
1619
|
+
modifiedAt?: Date;
|
|
1620
|
+
}
|
|
1621
|
+
/**
|
|
1622
|
+
* @public
|
|
1623
|
+
*/
|
|
1624
|
+
export interface ListTransformersRequest {
|
|
1625
|
+
/**
|
|
1626
|
+
* @public
|
|
1627
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
1628
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
1629
|
+
*/
|
|
1630
|
+
nextToken?: string;
|
|
1631
|
+
/**
|
|
1632
|
+
* @public
|
|
1633
|
+
* <p>Specifies the number of items to return for the API response.</p>
|
|
1634
|
+
*/
|
|
1635
|
+
maxResults?: number;
|
|
1636
|
+
}
|
|
1637
|
+
/**
|
|
1638
|
+
* @public
|
|
1639
|
+
* <p>Contains the details for a transformer object. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>
|
|
1640
|
+
*/
|
|
1641
|
+
export interface TransformerSummary {
|
|
1642
|
+
/**
|
|
1643
|
+
* @public
|
|
1644
|
+
* <p>Returns the system-assigned unique identifier for the transformer.</p>
|
|
1645
|
+
*/
|
|
1646
|
+
transformerId: string | undefined;
|
|
1647
|
+
/**
|
|
1648
|
+
* @public
|
|
1649
|
+
* <p>Returns the descriptive name for the transformer.</p>
|
|
1650
|
+
*/
|
|
1651
|
+
name: string | undefined;
|
|
1652
|
+
/**
|
|
1653
|
+
* @public
|
|
1654
|
+
* <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1655
|
+
*/
|
|
1656
|
+
fileFormat: FileFormat | undefined;
|
|
1657
|
+
/**
|
|
1658
|
+
* @public
|
|
1659
|
+
* <p>Returns the name of the mapping template for the transformer. This template is used to convert the input document into the
|
|
1660
|
+
* correct set of objects.</p>
|
|
1661
|
+
*/
|
|
1662
|
+
mappingTemplate: string | undefined;
|
|
1663
|
+
/**
|
|
1664
|
+
* @public
|
|
1665
|
+
* <p>Returns the state of the newly created transformer. The transformer can be either
|
|
1666
|
+
* <code>active</code> or <code>inactive</code>. For the transformer to be used in a
|
|
1667
|
+
* capability, its status must <code>active</code>.</p>
|
|
1668
|
+
*/
|
|
1669
|
+
status: TransformerStatus | undefined;
|
|
1670
|
+
/**
|
|
1671
|
+
* @public
|
|
1672
|
+
* <p>Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
1673
|
+
*/
|
|
1674
|
+
ediType: EdiType | undefined;
|
|
1675
|
+
/**
|
|
1676
|
+
* @public
|
|
1677
|
+
* <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
|
|
1678
|
+
*/
|
|
1679
|
+
sampleDocument?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* @public
|
|
1682
|
+
* <p>Returns a timestamp indicating when the transformer was created. For example,
|
|
1683
|
+
* <code>2023-07-20T19:58:44.624Z</code>.</p>
|
|
1684
|
+
*/
|
|
1685
|
+
createdAt: Date | undefined;
|
|
1686
|
+
/**
|
|
1687
|
+
* @public
|
|
1688
|
+
* <p>Returns a timestamp representing the date and time for the most recent change for the transformer object.</p>
|
|
1689
|
+
*/
|
|
1690
|
+
modifiedAt?: Date;
|
|
1691
|
+
}
|
|
1692
|
+
/**
|
|
1693
|
+
* @public
|
|
1694
|
+
*/
|
|
1695
|
+
export interface ListTransformersResponse {
|
|
1696
|
+
/**
|
|
1697
|
+
* @public
|
|
1698
|
+
* <p>Returns an array of one or more transformer objects.</p>
|
|
1699
|
+
* <p>For each transformer, a <code>TransformerSummary</code> object is returned.
|
|
1700
|
+
* The <code>TransformerSummary</code> contains all the details for a specific transformer.</p>
|
|
1701
|
+
*/
|
|
1702
|
+
transformers: TransformerSummary[] | undefined;
|
|
1703
|
+
/**
|
|
1704
|
+
* @public
|
|
1705
|
+
* <p>When additional results are obtained from the command, a <code>NextToken</code> parameter is returned in the output.
|
|
1706
|
+
* You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional resources.</p>
|
|
1707
|
+
*/
|
|
1708
|
+
nextToken?: string;
|
|
1709
|
+
}
|
|
1710
|
+
/**
|
|
1711
|
+
* @public
|
|
1712
|
+
*/
|
|
1713
|
+
export interface UpdateTransformerRequest {
|
|
1714
|
+
/**
|
|
1715
|
+
* @public
|
|
1716
|
+
* <p>Specifies the system-assigned unique identifier for the transformer.</p>
|
|
1717
|
+
*/
|
|
1718
|
+
transformerId: string | undefined;
|
|
1719
|
+
/**
|
|
1720
|
+
* @public
|
|
1721
|
+
* <p>Specify a new name for the transformer, if you want to update it.</p>
|
|
1722
|
+
*/
|
|
1723
|
+
name?: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* @public
|
|
1726
|
+
* <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1727
|
+
*/
|
|
1728
|
+
fileFormat?: FileFormat;
|
|
1729
|
+
/**
|
|
1730
|
+
* @public
|
|
1731
|
+
* <p>Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the
|
|
1732
|
+
* correct set of objects.</p>
|
|
1733
|
+
*/
|
|
1734
|
+
mappingTemplate?: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* @public
|
|
1737
|
+
* <p>Specifies the transformer's status. You can update the state of the transformer, from <code>active</code> to <code>inactive</code>, or <code>inactive</code> to <code>active</code>.</p>
|
|
1738
|
+
*/
|
|
1739
|
+
status?: TransformerStatus;
|
|
1740
|
+
/**
|
|
1741
|
+
* @public
|
|
1742
|
+
* <p>Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
1743
|
+
*/
|
|
1744
|
+
ediType?: EdiType;
|
|
1745
|
+
/**
|
|
1746
|
+
* @public
|
|
1747
|
+
* <p>Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
|
|
1748
|
+
*/
|
|
1749
|
+
sampleDocument?: string;
|
|
1750
|
+
}
|
|
1751
|
+
/**
|
|
1752
|
+
* @public
|
|
1753
|
+
*/
|
|
1754
|
+
export interface UpdateTransformerResponse {
|
|
1755
|
+
/**
|
|
1756
|
+
* @public
|
|
1757
|
+
* <p>Returns the system-assigned unique identifier for the transformer.</p>
|
|
1758
|
+
*/
|
|
1759
|
+
transformerId: string | undefined;
|
|
1760
|
+
/**
|
|
1761
|
+
* @public
|
|
1762
|
+
* <p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
1763
|
+
*/
|
|
1764
|
+
transformerArn: string | undefined;
|
|
1765
|
+
/**
|
|
1766
|
+
* @public
|
|
1767
|
+
* <p>Returns the name of the transformer.</p>
|
|
1768
|
+
*/
|
|
1769
|
+
name: string | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* @public
|
|
1772
|
+
* <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
|
|
1773
|
+
*/
|
|
1774
|
+
fileFormat: FileFormat | undefined;
|
|
1775
|
+
/**
|
|
1776
|
+
* @public
|
|
1777
|
+
* <p>Returns the name of the mapping template for the transformer. This template is used to convert the input document into the
|
|
1778
|
+
* correct set of objects.</p>
|
|
1779
|
+
*/
|
|
1780
|
+
mappingTemplate: string | undefined;
|
|
1781
|
+
/**
|
|
1782
|
+
* @public
|
|
1783
|
+
* <p>Returns the state of the newly created transformer. The transformer can be either
|
|
1784
|
+
* <code>active</code> or <code>inactive</code>. For the transformer to be used in a
|
|
1785
|
+
* capability, its status must <code>active</code>.</p>
|
|
1786
|
+
*/
|
|
1787
|
+
status: TransformerStatus | undefined;
|
|
1788
|
+
/**
|
|
1789
|
+
* @public
|
|
1790
|
+
* <p>Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.</p>
|
|
1791
|
+
*/
|
|
1792
|
+
ediType: EdiType | undefined;
|
|
1793
|
+
/**
|
|
1794
|
+
* @public
|
|
1795
|
+
* <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
|
|
1796
|
+
*/
|
|
1797
|
+
sampleDocument?: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* @public
|
|
1800
|
+
* <p>Returns a timestamp for creation date and time of the transformer.</p>
|
|
1801
|
+
*/
|
|
1802
|
+
createdAt: Date | undefined;
|
|
1803
|
+
/**
|
|
1804
|
+
* @public
|
|
1805
|
+
* <p>Returns a timestamp for last time the transformer was modified.</p>
|
|
1806
|
+
*/
|
|
1807
|
+
modifiedAt: Date | undefined;
|
|
1808
|
+
}
|
|
1809
|
+
/**
|
|
1810
|
+
* @public
|
|
1811
|
+
*/
|
|
1812
|
+
export interface UntagResourceRequest {
|
|
1813
|
+
/**
|
|
1814
|
+
* @public
|
|
1815
|
+
* <p>Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>
|
|
1816
|
+
*/
|
|
1817
|
+
ResourceARN: string | undefined;
|
|
1818
|
+
/**
|
|
1819
|
+
* @public
|
|
1820
|
+
* <p>Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>
|
|
1821
|
+
*/
|
|
1822
|
+
TagKeys: string[] | undefined;
|
|
1823
|
+
}
|
|
1824
|
+
/**
|
|
1825
|
+
* @internal
|
|
1826
|
+
*/
|
|
1827
|
+
export declare const CreatePartnershipRequestFilterSensitiveLog: (obj: CreatePartnershipRequest) => any;
|
|
1828
|
+
/**
|
|
1829
|
+
* @internal
|
|
1830
|
+
*/
|
|
1831
|
+
export declare const CreatePartnershipResponseFilterSensitiveLog: (obj: CreatePartnershipResponse) => any;
|
|
1832
|
+
/**
|
|
1833
|
+
* @internal
|
|
1834
|
+
*/
|
|
1835
|
+
export declare const GetPartnershipResponseFilterSensitiveLog: (obj: GetPartnershipResponse) => any;
|
|
1836
|
+
/**
|
|
1837
|
+
* @internal
|
|
1838
|
+
*/
|
|
1839
|
+
export declare const UpdatePartnershipResponseFilterSensitiveLog: (obj: UpdatePartnershipResponse) => any;
|
|
1840
|
+
/**
|
|
1841
|
+
* @internal
|
|
1842
|
+
*/
|
|
1843
|
+
export declare const CreateProfileRequestFilterSensitiveLog: (obj: CreateProfileRequest) => any;
|
|
1844
|
+
/**
|
|
1845
|
+
* @internal
|
|
1846
|
+
*/
|
|
1847
|
+
export declare const CreateProfileResponseFilterSensitiveLog: (obj: CreateProfileResponse) => any;
|
|
1848
|
+
/**
|
|
1849
|
+
* @internal
|
|
1850
|
+
*/
|
|
1851
|
+
export declare const GetProfileResponseFilterSensitiveLog: (obj: GetProfileResponse) => any;
|
|
1852
|
+
/**
|
|
1853
|
+
* @internal
|
|
1854
|
+
*/
|
|
1855
|
+
export declare const UpdateProfileRequestFilterSensitiveLog: (obj: UpdateProfileRequest) => any;
|
|
1856
|
+
/**
|
|
1857
|
+
* @internal
|
|
1858
|
+
*/
|
|
1859
|
+
export declare const UpdateProfileResponseFilterSensitiveLog: (obj: UpdateProfileResponse) => any;
|