@aws-sdk/client-amplifybackend 3.295.0 → 3.297.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.
Files changed (36) hide show
  1. package/dist-types/AmplifyBackend.d.ts +32 -0
  2. package/dist-types/AmplifyBackendClient.d.ts +24 -4
  3. package/dist-types/commands/CloneBackendCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateBackendAPICommand.d.ts +16 -0
  5. package/dist-types/commands/CreateBackendAuthCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateBackendCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateBackendConfigCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateBackendStorageCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateTokenCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteBackendAPICommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteBackendAuthCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteBackendCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteBackendStorageCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteTokenCommand.d.ts +16 -0
  15. package/dist-types/commands/GenerateBackendAPIModelsCommand.d.ts +16 -0
  16. package/dist-types/commands/GetBackendAPICommand.d.ts +16 -0
  17. package/dist-types/commands/GetBackendAPIModelsCommand.d.ts +16 -0
  18. package/dist-types/commands/GetBackendAuthCommand.d.ts +16 -0
  19. package/dist-types/commands/GetBackendCommand.d.ts +16 -0
  20. package/dist-types/commands/GetBackendJobCommand.d.ts +16 -0
  21. package/dist-types/commands/GetBackendStorageCommand.d.ts +16 -0
  22. package/dist-types/commands/GetTokenCommand.d.ts +16 -0
  23. package/dist-types/commands/ImportBackendAuthCommand.d.ts +16 -0
  24. package/dist-types/commands/ImportBackendStorageCommand.d.ts +16 -0
  25. package/dist-types/commands/ListBackendJobsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListS3BucketsCommand.d.ts +16 -0
  27. package/dist-types/commands/RemoveAllBackendsCommand.d.ts +16 -0
  28. package/dist-types/commands/RemoveBackendConfigCommand.d.ts +16 -0
  29. package/dist-types/commands/UpdateBackendAPICommand.d.ts +16 -0
  30. package/dist-types/commands/UpdateBackendAuthCommand.d.ts +16 -0
  31. package/dist-types/commands/UpdateBackendConfigCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateBackendJobCommand.d.ts +16 -0
  33. package/dist-types/commands/UpdateBackendStorageCommand.d.ts +16 -0
  34. package/dist-types/models/AmplifyBackendServiceException.d.ts +2 -0
  35. package/dist-types/models/models_0.d.ts +222 -0
  36. package/package.json +29 -29
@@ -32,190 +32,222 @@ import { UpdateBackendConfigCommandInput, UpdateBackendConfigCommandOutput } fro
32
32
  import { UpdateBackendJobCommandInput, UpdateBackendJobCommandOutput } from "./commands/UpdateBackendJobCommand";
33
33
  import { UpdateBackendStorageCommandInput, UpdateBackendStorageCommandOutput } from "./commands/UpdateBackendStorageCommand";
34
34
  /**
35
+ * @public
35
36
  * <p>AWS Amplify Admin API</p>
36
37
  */
37
38
  export declare class AmplifyBackend extends AmplifyBackendClient {
38
39
  /**
40
+ * @public
39
41
  * <p>This operation clones an existing backend.</p>
40
42
  */
41
43
  cloneBackend(args: CloneBackendCommandInput, options?: __HttpHandlerOptions): Promise<CloneBackendCommandOutput>;
42
44
  cloneBackend(args: CloneBackendCommandInput, cb: (err: any, data?: CloneBackendCommandOutput) => void): void;
43
45
  cloneBackend(args: CloneBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloneBackendCommandOutput) => void): void;
44
46
  /**
47
+ * @public
45
48
  * <p>This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.</p>
46
49
  */
47
50
  createBackend(args: CreateBackendCommandInput, options?: __HttpHandlerOptions): Promise<CreateBackendCommandOutput>;
48
51
  createBackend(args: CreateBackendCommandInput, cb: (err: any, data?: CreateBackendCommandOutput) => void): void;
49
52
  createBackend(args: CreateBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendCommandOutput) => void): void;
50
53
  /**
54
+ * @public
51
55
  * <p>Creates a new backend API resource.</p>
52
56
  */
53
57
  createBackendAPI(args: CreateBackendAPICommandInput, options?: __HttpHandlerOptions): Promise<CreateBackendAPICommandOutput>;
54
58
  createBackendAPI(args: CreateBackendAPICommandInput, cb: (err: any, data?: CreateBackendAPICommandOutput) => void): void;
55
59
  createBackendAPI(args: CreateBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendAPICommandOutput) => void): void;
56
60
  /**
61
+ * @public
57
62
  * <p>Creates a new backend authentication resource.</p>
58
63
  */
59
64
  createBackendAuth(args: CreateBackendAuthCommandInput, options?: __HttpHandlerOptions): Promise<CreateBackendAuthCommandOutput>;
60
65
  createBackendAuth(args: CreateBackendAuthCommandInput, cb: (err: any, data?: CreateBackendAuthCommandOutput) => void): void;
61
66
  createBackendAuth(args: CreateBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendAuthCommandOutput) => void): void;
62
67
  /**
68
+ * @public
63
69
  * <p>Creates a config object for a backend.</p>
64
70
  */
65
71
  createBackendConfig(args: CreateBackendConfigCommandInput, options?: __HttpHandlerOptions): Promise<CreateBackendConfigCommandOutput>;
66
72
  createBackendConfig(args: CreateBackendConfigCommandInput, cb: (err: any, data?: CreateBackendConfigCommandOutput) => void): void;
67
73
  createBackendConfig(args: CreateBackendConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendConfigCommandOutput) => void): void;
68
74
  /**
75
+ * @public
69
76
  * <p>Creates a backend storage resource.</p>
70
77
  */
71
78
  createBackendStorage(args: CreateBackendStorageCommandInput, options?: __HttpHandlerOptions): Promise<CreateBackendStorageCommandOutput>;
72
79
  createBackendStorage(args: CreateBackendStorageCommandInput, cb: (err: any, data?: CreateBackendStorageCommandOutput) => void): void;
73
80
  createBackendStorage(args: CreateBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendStorageCommandOutput) => void): void;
74
81
  /**
82
+ * @public
75
83
  * <p>Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.</p>
76
84
  */
77
85
  createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise<CreateTokenCommandOutput>;
78
86
  createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
79
87
  createToken(args: CreateTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
80
88
  /**
89
+ * @public
81
90
  * <p>Removes an existing environment from your Amplify project.</p>
82
91
  */
83
92
  deleteBackend(args: DeleteBackendCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackendCommandOutput>;
84
93
  deleteBackend(args: DeleteBackendCommandInput, cb: (err: any, data?: DeleteBackendCommandOutput) => void): void;
85
94
  deleteBackend(args: DeleteBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendCommandOutput) => void): void;
86
95
  /**
96
+ * @public
87
97
  * <p>Deletes an existing backend API resource.</p>
88
98
  */
89
99
  deleteBackendAPI(args: DeleteBackendAPICommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackendAPICommandOutput>;
90
100
  deleteBackendAPI(args: DeleteBackendAPICommandInput, cb: (err: any, data?: DeleteBackendAPICommandOutput) => void): void;
91
101
  deleteBackendAPI(args: DeleteBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendAPICommandOutput) => void): void;
92
102
  /**
103
+ * @public
93
104
  * <p>Deletes an existing backend authentication resource.</p>
94
105
  */
95
106
  deleteBackendAuth(args: DeleteBackendAuthCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackendAuthCommandOutput>;
96
107
  deleteBackendAuth(args: DeleteBackendAuthCommandInput, cb: (err: any, data?: DeleteBackendAuthCommandOutput) => void): void;
97
108
  deleteBackendAuth(args: DeleteBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendAuthCommandOutput) => void): void;
98
109
  /**
110
+ * @public
99
111
  * <p>Removes the specified backend storage resource.</p>
100
112
  */
101
113
  deleteBackendStorage(args: DeleteBackendStorageCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackendStorageCommandOutput>;
102
114
  deleteBackendStorage(args: DeleteBackendStorageCommandInput, cb: (err: any, data?: DeleteBackendStorageCommandOutput) => void): void;
103
115
  deleteBackendStorage(args: DeleteBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendStorageCommandOutput) => void): void;
104
116
  /**
117
+ * @public
105
118
  * <p>Deletes the challenge token based on the given appId and sessionId.</p>
106
119
  */
107
120
  deleteToken(args: DeleteTokenCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTokenCommandOutput>;
108
121
  deleteToken(args: DeleteTokenCommandInput, cb: (err: any, data?: DeleteTokenCommandOutput) => void): void;
109
122
  deleteToken(args: DeleteTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTokenCommandOutput) => void): void;
110
123
  /**
124
+ * @public
111
125
  * <p>Generates a model schema for an existing backend API resource.</p>
112
126
  */
113
127
  generateBackendAPIModels(args: GenerateBackendAPIModelsCommandInput, options?: __HttpHandlerOptions): Promise<GenerateBackendAPIModelsCommandOutput>;
114
128
  generateBackendAPIModels(args: GenerateBackendAPIModelsCommandInput, cb: (err: any, data?: GenerateBackendAPIModelsCommandOutput) => void): void;
115
129
  generateBackendAPIModels(args: GenerateBackendAPIModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateBackendAPIModelsCommandOutput) => void): void;
116
130
  /**
131
+ * @public
117
132
  * <p>Provides project-level details for your Amplify UI project.</p>
118
133
  */
119
134
  getBackend(args: GetBackendCommandInput, options?: __HttpHandlerOptions): Promise<GetBackendCommandOutput>;
120
135
  getBackend(args: GetBackendCommandInput, cb: (err: any, data?: GetBackendCommandOutput) => void): void;
121
136
  getBackend(args: GetBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendCommandOutput) => void): void;
122
137
  /**
138
+ * @public
123
139
  * <p>Gets the details for a backend API.</p>
124
140
  */
125
141
  getBackendAPI(args: GetBackendAPICommandInput, options?: __HttpHandlerOptions): Promise<GetBackendAPICommandOutput>;
126
142
  getBackendAPI(args: GetBackendAPICommandInput, cb: (err: any, data?: GetBackendAPICommandOutput) => void): void;
127
143
  getBackendAPI(args: GetBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendAPICommandOutput) => void): void;
128
144
  /**
145
+ * @public
129
146
  * <p>Gets a model introspection schema for an existing backend API resource.</p>
130
147
  */
131
148
  getBackendAPIModels(args: GetBackendAPIModelsCommandInput, options?: __HttpHandlerOptions): Promise<GetBackendAPIModelsCommandOutput>;
132
149
  getBackendAPIModels(args: GetBackendAPIModelsCommandInput, cb: (err: any, data?: GetBackendAPIModelsCommandOutput) => void): void;
133
150
  getBackendAPIModels(args: GetBackendAPIModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendAPIModelsCommandOutput) => void): void;
134
151
  /**
152
+ * @public
135
153
  * <p>Gets a backend auth details.</p>
136
154
  */
137
155
  getBackendAuth(args: GetBackendAuthCommandInput, options?: __HttpHandlerOptions): Promise<GetBackendAuthCommandOutput>;
138
156
  getBackendAuth(args: GetBackendAuthCommandInput, cb: (err: any, data?: GetBackendAuthCommandOutput) => void): void;
139
157
  getBackendAuth(args: GetBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendAuthCommandOutput) => void): void;
140
158
  /**
159
+ * @public
141
160
  * <p>Returns information about a specific job.</p>
142
161
  */
143
162
  getBackendJob(args: GetBackendJobCommandInput, options?: __HttpHandlerOptions): Promise<GetBackendJobCommandOutput>;
144
163
  getBackendJob(args: GetBackendJobCommandInput, cb: (err: any, data?: GetBackendJobCommandOutput) => void): void;
145
164
  getBackendJob(args: GetBackendJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendJobCommandOutput) => void): void;
146
165
  /**
166
+ * @public
147
167
  * <p>Gets details for a backend storage resource.</p>
148
168
  */
149
169
  getBackendStorage(args: GetBackendStorageCommandInput, options?: __HttpHandlerOptions): Promise<GetBackendStorageCommandOutput>;
150
170
  getBackendStorage(args: GetBackendStorageCommandInput, cb: (err: any, data?: GetBackendStorageCommandOutput) => void): void;
151
171
  getBackendStorage(args: GetBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendStorageCommandOutput) => void): void;
152
172
  /**
173
+ * @public
153
174
  * <p>Gets the challenge token based on the given appId and sessionId.</p>
154
175
  */
155
176
  getToken(args: GetTokenCommandInput, options?: __HttpHandlerOptions): Promise<GetTokenCommandOutput>;
156
177
  getToken(args: GetTokenCommandInput, cb: (err: any, data?: GetTokenCommandOutput) => void): void;
157
178
  getToken(args: GetTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTokenCommandOutput) => void): void;
158
179
  /**
180
+ * @public
159
181
  * <p>Imports an existing backend authentication resource.</p>
160
182
  */
161
183
  importBackendAuth(args: ImportBackendAuthCommandInput, options?: __HttpHandlerOptions): Promise<ImportBackendAuthCommandOutput>;
162
184
  importBackendAuth(args: ImportBackendAuthCommandInput, cb: (err: any, data?: ImportBackendAuthCommandOutput) => void): void;
163
185
  importBackendAuth(args: ImportBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportBackendAuthCommandOutput) => void): void;
164
186
  /**
187
+ * @public
165
188
  * <p>Imports an existing backend storage resource.</p>
166
189
  */
167
190
  importBackendStorage(args: ImportBackendStorageCommandInput, options?: __HttpHandlerOptions): Promise<ImportBackendStorageCommandOutput>;
168
191
  importBackendStorage(args: ImportBackendStorageCommandInput, cb: (err: any, data?: ImportBackendStorageCommandOutput) => void): void;
169
192
  importBackendStorage(args: ImportBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportBackendStorageCommandOutput) => void): void;
170
193
  /**
194
+ * @public
171
195
  * <p>Lists the jobs for the backend of an Amplify app.</p>
172
196
  */
173
197
  listBackendJobs(args: ListBackendJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBackendJobsCommandOutput>;
174
198
  listBackendJobs(args: ListBackendJobsCommandInput, cb: (err: any, data?: ListBackendJobsCommandOutput) => void): void;
175
199
  listBackendJobs(args: ListBackendJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackendJobsCommandOutput) => void): void;
176
200
  /**
201
+ * @public
177
202
  * <p>The list of S3 buckets in your account.</p>
178
203
  */
179
204
  listS3Buckets(args: ListS3BucketsCommandInput, options?: __HttpHandlerOptions): Promise<ListS3BucketsCommandOutput>;
180
205
  listS3Buckets(args: ListS3BucketsCommandInput, cb: (err: any, data?: ListS3BucketsCommandOutput) => void): void;
181
206
  listS3Buckets(args: ListS3BucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListS3BucketsCommandOutput) => void): void;
182
207
  /**
208
+ * @public
183
209
  * <p>Removes all backend environments from your Amplify project.</p>
184
210
  */
185
211
  removeAllBackends(args: RemoveAllBackendsCommandInput, options?: __HttpHandlerOptions): Promise<RemoveAllBackendsCommandOutput>;
186
212
  removeAllBackends(args: RemoveAllBackendsCommandInput, cb: (err: any, data?: RemoveAllBackendsCommandOutput) => void): void;
187
213
  removeAllBackends(args: RemoveAllBackendsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAllBackendsCommandOutput) => void): void;
188
214
  /**
215
+ * @public
189
216
  * <p>Removes the AWS resources required to access the Amplify Admin UI.</p>
190
217
  */
191
218
  removeBackendConfig(args: RemoveBackendConfigCommandInput, options?: __HttpHandlerOptions): Promise<RemoveBackendConfigCommandOutput>;
192
219
  removeBackendConfig(args: RemoveBackendConfigCommandInput, cb: (err: any, data?: RemoveBackendConfigCommandOutput) => void): void;
193
220
  removeBackendConfig(args: RemoveBackendConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveBackendConfigCommandOutput) => void): void;
194
221
  /**
222
+ * @public
195
223
  * <p>Updates an existing backend API resource.</p>
196
224
  */
197
225
  updateBackendAPI(args: UpdateBackendAPICommandInput, options?: __HttpHandlerOptions): Promise<UpdateBackendAPICommandOutput>;
198
226
  updateBackendAPI(args: UpdateBackendAPICommandInput, cb: (err: any, data?: UpdateBackendAPICommandOutput) => void): void;
199
227
  updateBackendAPI(args: UpdateBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendAPICommandOutput) => void): void;
200
228
  /**
229
+ * @public
201
230
  * <p>Updates an existing backend authentication resource.</p>
202
231
  */
203
232
  updateBackendAuth(args: UpdateBackendAuthCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBackendAuthCommandOutput>;
204
233
  updateBackendAuth(args: UpdateBackendAuthCommandInput, cb: (err: any, data?: UpdateBackendAuthCommandOutput) => void): void;
205
234
  updateBackendAuth(args: UpdateBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendAuthCommandOutput) => void): void;
206
235
  /**
236
+ * @public
207
237
  * <p>Updates the AWS resources required to access the Amplify Admin UI.</p>
208
238
  */
209
239
  updateBackendConfig(args: UpdateBackendConfigCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBackendConfigCommandOutput>;
210
240
  updateBackendConfig(args: UpdateBackendConfigCommandInput, cb: (err: any, data?: UpdateBackendConfigCommandOutput) => void): void;
211
241
  updateBackendConfig(args: UpdateBackendConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendConfigCommandOutput) => void): void;
212
242
  /**
243
+ * @public
213
244
  * <p>Updates a specific job.</p>
214
245
  */
215
246
  updateBackendJob(args: UpdateBackendJobCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBackendJobCommandOutput>;
216
247
  updateBackendJob(args: UpdateBackendJobCommandInput, cb: (err: any, data?: UpdateBackendJobCommandOutput) => void): void;
217
248
  updateBackendJob(args: UpdateBackendJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendJobCommandOutput) => void): void;
218
249
  /**
250
+ * @public
219
251
  * <p>Updates an existing backend storage resource.</p>
220
252
  */
221
253
  updateBackendStorage(args: UpdateBackendStorageCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBackendStorageCommandOutput>;
@@ -39,15 +39,24 @@ import { UpdateBackendConfigCommandInput, UpdateBackendConfigCommandOutput } fro
39
39
  import { UpdateBackendJobCommandInput, UpdateBackendJobCommandOutput } from "./commands/UpdateBackendJobCommand";
40
40
  import { UpdateBackendStorageCommandInput, UpdateBackendStorageCommandOutput } from "./commands/UpdateBackendStorageCommand";
41
41
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
42
+ /**
43
+ * @public
44
+ */
42
45
  export type ServiceInputTypes = CloneBackendCommandInput | CreateBackendAPICommandInput | CreateBackendAuthCommandInput | CreateBackendCommandInput | CreateBackendConfigCommandInput | CreateBackendStorageCommandInput | CreateTokenCommandInput | DeleteBackendAPICommandInput | DeleteBackendAuthCommandInput | DeleteBackendCommandInput | DeleteBackendStorageCommandInput | DeleteTokenCommandInput | GenerateBackendAPIModelsCommandInput | GetBackendAPICommandInput | GetBackendAPIModelsCommandInput | GetBackendAuthCommandInput | GetBackendCommandInput | GetBackendJobCommandInput | GetBackendStorageCommandInput | GetTokenCommandInput | ImportBackendAuthCommandInput | ImportBackendStorageCommandInput | ListBackendJobsCommandInput | ListS3BucketsCommandInput | RemoveAllBackendsCommandInput | RemoveBackendConfigCommandInput | UpdateBackendAPICommandInput | UpdateBackendAuthCommandInput | UpdateBackendConfigCommandInput | UpdateBackendJobCommandInput | UpdateBackendStorageCommandInput;
46
+ /**
47
+ * @public
48
+ */
43
49
  export type ServiceOutputTypes = CloneBackendCommandOutput | CreateBackendAPICommandOutput | CreateBackendAuthCommandOutput | CreateBackendCommandOutput | CreateBackendConfigCommandOutput | CreateBackendStorageCommandOutput | CreateTokenCommandOutput | DeleteBackendAPICommandOutput | DeleteBackendAuthCommandOutput | DeleteBackendCommandOutput | DeleteBackendStorageCommandOutput | DeleteTokenCommandOutput | GenerateBackendAPIModelsCommandOutput | GetBackendAPICommandOutput | GetBackendAPIModelsCommandOutput | GetBackendAuthCommandOutput | GetBackendCommandOutput | GetBackendJobCommandOutput | GetBackendStorageCommandOutput | GetTokenCommandOutput | ImportBackendAuthCommandOutput | ImportBackendStorageCommandOutput | ListBackendJobsCommandOutput | ListS3BucketsCommandOutput | RemoveAllBackendsCommandOutput | RemoveBackendConfigCommandOutput | UpdateBackendAPICommandOutput | UpdateBackendAuthCommandOutput | UpdateBackendConfigCommandOutput | UpdateBackendJobCommandOutput | UpdateBackendStorageCommandOutput;
50
+ /**
51
+ * @public
52
+ */
44
53
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
45
54
  /**
46
55
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
47
56
  */
48
57
  requestHandler?: __HttpHandler;
49
58
  /**
50
- * A constructor for a class implementing the {@link __Checksum} interface
59
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
51
60
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
52
61
  * @internal
53
62
  */
@@ -137,23 +146,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
137
146
  */
138
147
  logger?: __Logger;
139
148
  /**
140
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
149
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
150
  */
142
151
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
143
152
  }
153
+ /**
154
+ * @public
155
+ */
144
156
  type AmplifyBackendClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
145
157
  /**
146
- * The configuration interface of AmplifyBackendClient class constructor that set the region, credentials and other options.
158
+ * @public
159
+ *
160
+ * The configuration interface of AmplifyBackendClient class constructor that set the region, credentials and other options.
147
161
  */
148
162
  export interface AmplifyBackendClientConfig extends AmplifyBackendClientConfigType {
149
163
  }
164
+ /**
165
+ * @public
166
+ */
150
167
  type AmplifyBackendClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
151
168
  /**
152
- * The resolved configuration interface of AmplifyBackendClient class. This is resolved and normalized from the {@link AmplifyBackendClientConfig | constructor configuration interface}.
169
+ * @public
170
+ *
171
+ * The resolved configuration interface of AmplifyBackendClient class. This is resolved and normalized from the {@link AmplifyBackendClientConfig | constructor configuration interface}.
153
172
  */
154
173
  export interface AmplifyBackendClientResolvedConfig extends AmplifyBackendClientResolvedConfigType {
155
174
  }
156
175
  /**
176
+ * @public
157
177
  * <p>AWS Amplify Admin API</p>
158
178
  */
159
179
  export declare class AmplifyBackendClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, AmplifyBackendClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyBackendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyBackendClient";
5
5
  import { CloneBackendRequest, CloneBackendResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CloneBackendCommand}.
8
10
  */
9
11
  export interface CloneBackendCommandInput extends CloneBackendRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CloneBackendCommand}.
13
17
  */
14
18
  export interface CloneBackendCommandOutput extends CloneBackendResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation clones an existing backend.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CloneBackendCommandOutput extends CloneBackendResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CloneBackendCommandInput - {@link CloneBackendCommandInput}
34
+ * @returns {@link CloneBackendCommandOutput}
28
35
  * @see {@link CloneBackendCommandInput} for command's `input` shape.
29
36
  * @see {@link CloneBackendCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyBackendClientResolvedConfig | config} for AmplifyBackendClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CloneBackendCommandOutput extends CloneBackendResponse, __Metad
46
53
  export declare class CloneBackendCommand extends $Command<CloneBackendCommandInput, CloneBackendCommandOutput, AmplifyBackendClientResolvedConfig> {
47
54
  readonly input: CloneBackendCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CloneBackendCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyBackendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CloneBackendCommandInput, CloneBackendCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyBackendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyBackendClient";
5
5
  import { CreateBackendAPIRequest, CreateBackendAPIResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBackendAPICommand}.
8
10
  */
9
11
  export interface CreateBackendAPICommandInput extends CreateBackendAPIRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBackendAPICommand}.
13
17
  */
14
18
  export interface CreateBackendAPICommandOutput extends CreateBackendAPIResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new backend API resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBackendAPICommandOutput extends CreateBackendAPIResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateBackendAPICommandInput - {@link CreateBackendAPICommandInput}
34
+ * @returns {@link CreateBackendAPICommandOutput}
28
35
  * @see {@link CreateBackendAPICommandInput} for command's `input` shape.
29
36
  * @see {@link CreateBackendAPICommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyBackendClientResolvedConfig | config} for AmplifyBackendClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateBackendAPICommandOutput extends CreateBackendAPIResponse,
46
53
  export declare class CreateBackendAPICommand extends $Command<CreateBackendAPICommandInput, CreateBackendAPICommandOutput, AmplifyBackendClientResolvedConfig> {
47
54
  readonly input: CreateBackendAPICommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateBackendAPICommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyBackendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBackendAPICommandInput, CreateBackendAPICommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyBackendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyBackendClient";
5
5
  import { CreateBackendAuthRequest, CreateBackendAuthResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBackendAuthCommand}.
8
10
  */
9
11
  export interface CreateBackendAuthCommandInput extends CreateBackendAuthRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBackendAuthCommand}.
13
17
  */
14
18
  export interface CreateBackendAuthCommandOutput extends CreateBackendAuthResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new backend authentication resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBackendAuthCommandOutput extends CreateBackendAuthRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateBackendAuthCommandInput - {@link CreateBackendAuthCommandInput}
34
+ * @returns {@link CreateBackendAuthCommandOutput}
28
35
  * @see {@link CreateBackendAuthCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateBackendAuthCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyBackendClientResolvedConfig | config} for AmplifyBackendClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateBackendAuthCommandOutput extends CreateBackendAuthRespons
46
53
  export declare class CreateBackendAuthCommand extends $Command<CreateBackendAuthCommandInput, CreateBackendAuthCommandOutput, AmplifyBackendClientResolvedConfig> {
47
54
  readonly input: CreateBackendAuthCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateBackendAuthCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyBackendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBackendAuthCommandInput, CreateBackendAuthCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyBackendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyBackendClient";
5
5
  import { CreateBackendRequest, CreateBackendResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBackendCommand}.
8
10
  */
9
11
  export interface CreateBackendCommandInput extends CreateBackendRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBackendCommand}.
13
17
  */
14
18
  export interface CreateBackendCommandOutput extends CreateBackendResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBackendCommandOutput extends CreateBackendResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateBackendCommandInput - {@link CreateBackendCommandInput}
34
+ * @returns {@link CreateBackendCommandOutput}
28
35
  * @see {@link CreateBackendCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateBackendCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyBackendClientResolvedConfig | config} for AmplifyBackendClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateBackendCommandOutput extends CreateBackendResponse, __Met
46
53
  export declare class CreateBackendCommand extends $Command<CreateBackendCommandInput, CreateBackendCommandOutput, AmplifyBackendClientResolvedConfig> {
47
54
  readonly input: CreateBackendCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateBackendCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyBackendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBackendCommandInput, CreateBackendCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyBackendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyBackendClient";
5
5
  import { CreateBackendConfigRequest, CreateBackendConfigResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBackendConfigCommand}.
8
10
  */
9
11
  export interface CreateBackendConfigCommandInput extends CreateBackendConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBackendConfigCommand}.
13
17
  */
14
18
  export interface CreateBackendConfigCommandOutput extends CreateBackendConfigResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a config object for a backend.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBackendConfigCommandOutput extends CreateBackendConfigRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateBackendConfigCommandInput - {@link CreateBackendConfigCommandInput}
34
+ * @returns {@link CreateBackendConfigCommandOutput}
28
35
  * @see {@link CreateBackendConfigCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateBackendConfigCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyBackendClientResolvedConfig | config} for AmplifyBackendClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateBackendConfigCommandOutput extends CreateBackendConfigRes
46
53
  export declare class CreateBackendConfigCommand extends $Command<CreateBackendConfigCommandInput, CreateBackendConfigCommandOutput, AmplifyBackendClientResolvedConfig> {
47
54
  readonly input: CreateBackendConfigCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateBackendConfigCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyBackendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBackendConfigCommandInput, CreateBackendConfigCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyBackendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyBackendClient";
5
5
  import { CreateBackendStorageRequest, CreateBackendStorageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBackendStorageCommand}.
8
10
  */
9
11
  export interface CreateBackendStorageCommandInput extends CreateBackendStorageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBackendStorageCommand}.
13
17
  */
14
18
  export interface CreateBackendStorageCommandOutput extends CreateBackendStorageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a backend storage resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBackendStorageCommandOutput extends CreateBackendStorageR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateBackendStorageCommandInput - {@link CreateBackendStorageCommandInput}
34
+ * @returns {@link CreateBackendStorageCommandOutput}
28
35
  * @see {@link CreateBackendStorageCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateBackendStorageCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyBackendClientResolvedConfig | config} for AmplifyBackendClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateBackendStorageCommandOutput extends CreateBackendStorageR
46
53
  export declare class CreateBackendStorageCommand extends $Command<CreateBackendStorageCommandInput, CreateBackendStorageCommandOutput, AmplifyBackendClientResolvedConfig> {
47
54
  readonly input: CreateBackendStorageCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateBackendStorageCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyBackendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBackendStorageCommandInput, CreateBackendStorageCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyBackendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyBackendClient";
5
5
  import { CreateTokenRequest, CreateTokenResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateTokenCommand}.
8
10
  */
9
11
  export interface CreateTokenCommandInput extends CreateTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateTokenCommand}.
13
17
  */
14
18
  export interface CreateTokenCommandOutput extends CreateTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateTokenCommandInput - {@link CreateTokenCommandInput}
34
+ * @returns {@link CreateTokenCommandOutput}
28
35
  * @see {@link CreateTokenCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateTokenCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyBackendClientResolvedConfig | config} for AmplifyBackendClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
46
53
  export declare class CreateTokenCommand extends $Command<CreateTokenCommandInput, CreateTokenCommandOutput, AmplifyBackendClientResolvedConfig> {
47
54
  readonly input: CreateTokenCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateTokenCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyBackendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateTokenCommandInput, CreateTokenCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }