@aws-sdk/client-codecatalyst 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 (38) hide show
  1. package/dist-types/CodeCatalyst.d.ts +26 -0
  2. package/dist-types/CodeCatalystClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAccessTokenCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDevEnvironmentCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateSourceRepositoryBranchCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteAccessTokenCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteDevEnvironmentCommand.d.ts +16 -0
  9. package/dist-types/commands/GetDevEnvironmentCommand.d.ts +16 -0
  10. package/dist-types/commands/GetProjectCommand.d.ts +16 -0
  11. package/dist-types/commands/GetSourceRepositoryCloneUrlsCommand.d.ts +16 -0
  12. package/dist-types/commands/GetSpaceCommand.d.ts +16 -0
  13. package/dist-types/commands/GetSubscriptionCommand.d.ts +16 -0
  14. package/dist-types/commands/GetUserDetailsCommand.d.ts +16 -0
  15. package/dist-types/commands/ListAccessTokensCommand.d.ts +16 -0
  16. package/dist-types/commands/ListDevEnvironmentsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListEventLogsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListProjectsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListSourceRepositoriesCommand.d.ts +16 -0
  20. package/dist-types/commands/ListSourceRepositoryBranchesCommand.d.ts +16 -0
  21. package/dist-types/commands/ListSpacesCommand.d.ts +16 -0
  22. package/dist-types/commands/StartDevEnvironmentCommand.d.ts +16 -0
  23. package/dist-types/commands/StartDevEnvironmentSessionCommand.d.ts +16 -0
  24. package/dist-types/commands/StopDevEnvironmentCommand.d.ts +16 -0
  25. package/dist-types/commands/StopDevEnvironmentSessionCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateDevEnvironmentCommand.d.ts +16 -0
  27. package/dist-types/commands/VerifySessionCommand.d.ts +16 -0
  28. package/dist-types/models/CodeCatalystServiceException.d.ts +2 -0
  29. package/dist-types/models/models_0.d.ts +199 -0
  30. package/dist-types/pagination/Interfaces.d.ts +3 -0
  31. package/dist-types/pagination/ListAccessTokensPaginator.d.ts +3 -0
  32. package/dist-types/pagination/ListDevEnvironmentsPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListEventLogsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListProjectsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListSourceRepositoriesPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListSourceRepositoryBranchesPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListSpacesPaginator.d.ts +3 -0
  38. package/package.json +27 -27
@@ -26,6 +26,7 @@ import { StopDevEnvironmentSessionCommandInput, StopDevEnvironmentSessionCommand
26
26
  import { UpdateDevEnvironmentCommandInput, UpdateDevEnvironmentCommandOutput } from "./commands/UpdateDevEnvironmentCommand";
27
27
  import { VerifySessionCommandInput, VerifySessionCommandOutput } from "./commands/VerifySessionCommand";
28
28
  /**
29
+ * @public
29
30
  * <note>
30
31
  * <p>
31
32
  * <b>Amazon CodeCatalyst is in preview release and subject to change.</b>
@@ -141,6 +142,7 @@ import { VerifySessionCommandInput, VerifySessionCommandOutput } from "./command
141
142
  */
142
143
  export declare class CodeCatalyst extends CodeCatalystClient {
143
144
  /**
145
+ * @public
144
146
  * <p>Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password.
145
147
  * It is associated with your user account. You use PATs to access Amazon CodeCatalyst resources such as source repositories from third-party applications
146
148
  * like Git and integrated development environments (IDEs). For more information, see
@@ -150,6 +152,7 @@ export declare class CodeCatalyst extends CodeCatalystClient {
150
152
  createAccessToken(args: CreateAccessTokenCommandInput, cb: (err: any, data?: CreateAccessTokenCommandOutput) => void): void;
151
153
  createAccessToken(args: CreateAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessTokenCommandOutput) => void): void;
152
154
  /**
155
+ * @public
153
156
  * <p>Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development Dev Environment that you can use to quickly work on the code stored in the source repositories of your project.
154
157
  * </p>
155
158
  * <note>
@@ -161,12 +164,14 @@ export declare class CodeCatalyst extends CodeCatalystClient {
161
164
  createDevEnvironment(args: CreateDevEnvironmentCommandInput, cb: (err: any, data?: CreateDevEnvironmentCommandOutput) => void): void;
162
165
  createDevEnvironment(args: CreateDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDevEnvironmentCommandOutput) => void): void;
163
166
  /**
167
+ * @public
164
168
  * <p>Creates a project in a specified space.</p>
165
169
  */
166
170
  createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise<CreateProjectCommandOutput>;
167
171
  createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
168
172
  createProject(args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
169
173
  /**
174
+ * @public
170
175
  * <p>Creates a branch in a specified source repository in Amazon CodeCatalyst. </p>
171
176
  * <note>
172
177
  * <p>This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.</p>
@@ -176,30 +181,35 @@ export declare class CodeCatalyst extends CodeCatalystClient {
176
181
  createSourceRepositoryBranch(args: CreateSourceRepositoryBranchCommandInput, cb: (err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void): void;
177
182
  createSourceRepositoryBranch(args: CreateSourceRepositoryBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void): void;
178
183
  /**
184
+ * @public
179
185
  * <p>Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.</p>
180
186
  */
181
187
  deleteAccessToken(args: DeleteAccessTokenCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessTokenCommandOutput>;
182
188
  deleteAccessToken(args: DeleteAccessTokenCommandInput, cb: (err: any, data?: DeleteAccessTokenCommandOutput) => void): void;
183
189
  deleteAccessToken(args: DeleteAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessTokenCommandOutput) => void): void;
184
190
  /**
191
+ * @public
185
192
  * <p>Deletes a Dev Environment. </p>
186
193
  */
187
194
  deleteDevEnvironment(args: DeleteDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDevEnvironmentCommandOutput>;
188
195
  deleteDevEnvironment(args: DeleteDevEnvironmentCommandInput, cb: (err: any, data?: DeleteDevEnvironmentCommandOutput) => void): void;
189
196
  deleteDevEnvironment(args: DeleteDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDevEnvironmentCommandOutput) => void): void;
190
197
  /**
198
+ * @public
191
199
  * <p>Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.</p>
192
200
  */
193
201
  getDevEnvironment(args: GetDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<GetDevEnvironmentCommandOutput>;
194
202
  getDevEnvironment(args: GetDevEnvironmentCommandInput, cb: (err: any, data?: GetDevEnvironmentCommandOutput) => void): void;
195
203
  getDevEnvironment(args: GetDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevEnvironmentCommandOutput) => void): void;
196
204
  /**
205
+ * @public
197
206
  * <p>Returns information about a project.</p>
198
207
  */
199
208
  getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise<GetProjectCommandOutput>;
200
209
  getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void;
201
210
  getProject(args: GetProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProjectCommandOutput) => void): void;
202
211
  /**
212
+ * @public
203
213
  * <p>Returns information about the URLs that can be used with a Git client to clone a source
204
214
  * repository.</p>
205
215
  */
@@ -207,12 +217,14 @@ export declare class CodeCatalyst extends CodeCatalystClient {
207
217
  getSourceRepositoryCloneUrls(args: GetSourceRepositoryCloneUrlsCommandInput, cb: (err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void): void;
208
218
  getSourceRepositoryCloneUrls(args: GetSourceRepositoryCloneUrlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void): void;
209
219
  /**
220
+ * @public
210
221
  * <p>Returns information about an space.</p>
211
222
  */
212
223
  getSpace(args: GetSpaceCommandInput, options?: __HttpHandlerOptions): Promise<GetSpaceCommandOutput>;
213
224
  getSpace(args: GetSpaceCommandInput, cb: (err: any, data?: GetSpaceCommandOutput) => void): void;
214
225
  getSpace(args: GetSpaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSpaceCommandOutput) => void): void;
215
226
  /**
227
+ * @public
216
228
  * <p>Returns information about the Amazon Web Services account used for billing purposes
217
229
  * and the billing plan for the space.</p>
218
230
  */
@@ -220,84 +232,98 @@ export declare class CodeCatalyst extends CodeCatalystClient {
220
232
  getSubscription(args: GetSubscriptionCommandInput, cb: (err: any, data?: GetSubscriptionCommandOutput) => void): void;
221
233
  getSubscription(args: GetSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionCommandOutput) => void): void;
222
234
  /**
235
+ * @public
223
236
  * <p>Returns information about a user. </p>
224
237
  */
225
238
  getUserDetails(args: GetUserDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetUserDetailsCommandOutput>;
226
239
  getUserDetails(args: GetUserDetailsCommandInput, cb: (err: any, data?: GetUserDetailsCommandOutput) => void): void;
227
240
  getUserDetails(args: GetUserDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserDetailsCommandOutput) => void): void;
228
241
  /**
242
+ * @public
229
243
  * <p>Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your user account.</p>
230
244
  */
231
245
  listAccessTokens(args: ListAccessTokensCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessTokensCommandOutput>;
232
246
  listAccessTokens(args: ListAccessTokensCommandInput, cb: (err: any, data?: ListAccessTokensCommandOutput) => void): void;
233
247
  listAccessTokens(args: ListAccessTokensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessTokensCommandOutput) => void): void;
234
248
  /**
249
+ * @public
235
250
  * <p>Retrives a list of Dev Environments in a project.</p>
236
251
  */
237
252
  listDevEnvironments(args: ListDevEnvironmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListDevEnvironmentsCommandOutput>;
238
253
  listDevEnvironments(args: ListDevEnvironmentsCommandInput, cb: (err: any, data?: ListDevEnvironmentsCommandOutput) => void): void;
239
254
  listDevEnvironments(args: ListDevEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevEnvironmentsCommandOutput) => void): void;
240
255
  /**
256
+ * @public
241
257
  * <p>Retrieves a list of events that occurred during a specified time period in a space. You can use these events to audit user and system activity in a space.</p>
242
258
  */
243
259
  listEventLogs(args: ListEventLogsCommandInput, options?: __HttpHandlerOptions): Promise<ListEventLogsCommandOutput>;
244
260
  listEventLogs(args: ListEventLogsCommandInput, cb: (err: any, data?: ListEventLogsCommandOutput) => void): void;
245
261
  listEventLogs(args: ListEventLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventLogsCommandOutput) => void): void;
246
262
  /**
263
+ * @public
247
264
  * <p>Retrieves a list of projects.</p>
248
265
  */
249
266
  listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise<ListProjectsCommandOutput>;
250
267
  listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void;
251
268
  listProjects(args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void): void;
252
269
  /**
270
+ * @public
253
271
  * <p>Retrieves a list of source repositories in a project.</p>
254
272
  */
255
273
  listSourceRepositories(args: ListSourceRepositoriesCommandInput, options?: __HttpHandlerOptions): Promise<ListSourceRepositoriesCommandOutput>;
256
274
  listSourceRepositories(args: ListSourceRepositoriesCommandInput, cb: (err: any, data?: ListSourceRepositoriesCommandOutput) => void): void;
257
275
  listSourceRepositories(args: ListSourceRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceRepositoriesCommandOutput) => void): void;
258
276
  /**
277
+ * @public
259
278
  * <p>Retrieves a list of branches in a specified source repository.</p>
260
279
  */
261
280
  listSourceRepositoryBranches(args: ListSourceRepositoryBranchesCommandInput, options?: __HttpHandlerOptions): Promise<ListSourceRepositoryBranchesCommandOutput>;
262
281
  listSourceRepositoryBranches(args: ListSourceRepositoryBranchesCommandInput, cb: (err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void): void;
263
282
  listSourceRepositoryBranches(args: ListSourceRepositoryBranchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void): void;
264
283
  /**
284
+ * @public
265
285
  * <p>Retrieves a list of spaces.</p>
266
286
  */
267
287
  listSpaces(args: ListSpacesCommandInput, options?: __HttpHandlerOptions): Promise<ListSpacesCommandOutput>;
268
288
  listSpaces(args: ListSpacesCommandInput, cb: (err: any, data?: ListSpacesCommandOutput) => void): void;
269
289
  listSpaces(args: ListSpacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpacesCommandOutput) => void): void;
270
290
  /**
291
+ * @public
271
292
  * <p>Starts a specified Dev Environment and puts it into an active state. </p>
272
293
  */
273
294
  startDevEnvironment(args: StartDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<StartDevEnvironmentCommandOutput>;
274
295
  startDevEnvironment(args: StartDevEnvironmentCommandInput, cb: (err: any, data?: StartDevEnvironmentCommandOutput) => void): void;
275
296
  startDevEnvironment(args: StartDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDevEnvironmentCommandOutput) => void): void;
276
297
  /**
298
+ * @public
277
299
  * <p>Starts a session for a specified Dev Environment.</p>
278
300
  */
279
301
  startDevEnvironmentSession(args: StartDevEnvironmentSessionCommandInput, options?: __HttpHandlerOptions): Promise<StartDevEnvironmentSessionCommandOutput>;
280
302
  startDevEnvironmentSession(args: StartDevEnvironmentSessionCommandInput, cb: (err: any, data?: StartDevEnvironmentSessionCommandOutput) => void): void;
281
303
  startDevEnvironmentSession(args: StartDevEnvironmentSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDevEnvironmentSessionCommandOutput) => void): void;
282
304
  /**
305
+ * @public
283
306
  * <p>Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.</p>
284
307
  */
285
308
  stopDevEnvironment(args: StopDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<StopDevEnvironmentCommandOutput>;
286
309
  stopDevEnvironment(args: StopDevEnvironmentCommandInput, cb: (err: any, data?: StopDevEnvironmentCommandOutput) => void): void;
287
310
  stopDevEnvironment(args: StopDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDevEnvironmentCommandOutput) => void): void;
288
311
  /**
312
+ * @public
289
313
  * <p>Stops a session for a specified Dev Environment.</p>
290
314
  */
291
315
  stopDevEnvironmentSession(args: StopDevEnvironmentSessionCommandInput, options?: __HttpHandlerOptions): Promise<StopDevEnvironmentSessionCommandOutput>;
292
316
  stopDevEnvironmentSession(args: StopDevEnvironmentSessionCommandInput, cb: (err: any, data?: StopDevEnvironmentSessionCommandOutput) => void): void;
293
317
  stopDevEnvironmentSession(args: StopDevEnvironmentSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDevEnvironmentSessionCommandOutput) => void): void;
294
318
  /**
319
+ * @public
295
320
  * <p>Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.</p>
296
321
  */
297
322
  updateDevEnvironment(args: UpdateDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDevEnvironmentCommandOutput>;
298
323
  updateDevEnvironment(args: UpdateDevEnvironmentCommandInput, cb: (err: any, data?: UpdateDevEnvironmentCommandOutput) => void): void;
299
324
  updateDevEnvironment(args: UpdateDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDevEnvironmentCommandOutput) => void): void;
300
325
  /**
326
+ * @public
301
327
  * <p>Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.</p>
302
328
  */
303
329
  verifySession(args: VerifySessionCommandInput, options?: __HttpHandlerOptions): Promise<VerifySessionCommandOutput>;
@@ -33,15 +33,24 @@ import { StopDevEnvironmentSessionCommandInput, StopDevEnvironmentSessionCommand
33
33
  import { UpdateDevEnvironmentCommandInput, UpdateDevEnvironmentCommandOutput } from "./commands/UpdateDevEnvironmentCommand";
34
34
  import { VerifySessionCommandInput, VerifySessionCommandOutput } from "./commands/VerifySessionCommand";
35
35
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
36
+ /**
37
+ * @public
38
+ */
36
39
  export type ServiceInputTypes = CreateAccessTokenCommandInput | CreateDevEnvironmentCommandInput | CreateProjectCommandInput | CreateSourceRepositoryBranchCommandInput | DeleteAccessTokenCommandInput | DeleteDevEnvironmentCommandInput | GetDevEnvironmentCommandInput | GetProjectCommandInput | GetSourceRepositoryCloneUrlsCommandInput | GetSpaceCommandInput | GetSubscriptionCommandInput | GetUserDetailsCommandInput | ListAccessTokensCommandInput | ListDevEnvironmentsCommandInput | ListEventLogsCommandInput | ListProjectsCommandInput | ListSourceRepositoriesCommandInput | ListSourceRepositoryBranchesCommandInput | ListSpacesCommandInput | StartDevEnvironmentCommandInput | StartDevEnvironmentSessionCommandInput | StopDevEnvironmentCommandInput | StopDevEnvironmentSessionCommandInput | UpdateDevEnvironmentCommandInput | VerifySessionCommandInput;
40
+ /**
41
+ * @public
42
+ */
37
43
  export type ServiceOutputTypes = CreateAccessTokenCommandOutput | CreateDevEnvironmentCommandOutput | CreateProjectCommandOutput | CreateSourceRepositoryBranchCommandOutput | DeleteAccessTokenCommandOutput | DeleteDevEnvironmentCommandOutput | GetDevEnvironmentCommandOutput | GetProjectCommandOutput | GetSourceRepositoryCloneUrlsCommandOutput | GetSpaceCommandOutput | GetSubscriptionCommandOutput | GetUserDetailsCommandOutput | ListAccessTokensCommandOutput | ListDevEnvironmentsCommandOutput | ListEventLogsCommandOutput | ListProjectsCommandOutput | ListSourceRepositoriesCommandOutput | ListSourceRepositoryBranchesCommandOutput | ListSpacesCommandOutput | StartDevEnvironmentCommandOutput | StartDevEnvironmentSessionCommandOutput | StopDevEnvironmentCommandOutput | StopDevEnvironmentSessionCommandOutput | UpdateDevEnvironmentCommandOutput | VerifySessionCommandOutput;
44
+ /**
45
+ * @public
46
+ */
38
47
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
39
48
  /**
40
49
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
41
50
  */
42
51
  requestHandler?: __HttpHandler;
43
52
  /**
44
- * A constructor for a class implementing the {@link __Checksum} interface
53
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
45
54
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
46
55
  * @internal
47
56
  */
@@ -122,23 +131,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
122
131
  */
123
132
  logger?: __Logger;
124
133
  /**
125
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
134
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
126
135
  */
127
136
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
128
137
  }
138
+ /**
139
+ * @public
140
+ */
129
141
  type CodeCatalystClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & TokenInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
130
142
  /**
131
- * The configuration interface of CodeCatalystClient class constructor that set the region, credentials and other options.
143
+ * @public
144
+ *
145
+ * The configuration interface of CodeCatalystClient class constructor that set the region, credentials and other options.
132
146
  */
133
147
  export interface CodeCatalystClientConfig extends CodeCatalystClientConfigType {
134
148
  }
149
+ /**
150
+ * @public
151
+ */
135
152
  type CodeCatalystClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & TokenResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
136
153
  /**
137
- * The resolved configuration interface of CodeCatalystClient class. This is resolved and normalized from the {@link CodeCatalystClientConfig | constructor configuration interface}.
154
+ * @public
155
+ *
156
+ * The resolved configuration interface of CodeCatalystClient class. This is resolved and normalized from the {@link CodeCatalystClientConfig | constructor configuration interface}.
138
157
  */
139
158
  export interface CodeCatalystClientResolvedConfig extends CodeCatalystClientResolvedConfigType {
140
159
  }
141
160
  /**
161
+ * @public
142
162
  * <note>
143
163
  * <p>
144
164
  * <b>Amazon CodeCatalyst is in preview release and subject to change.</b>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
5
5
  import { CreateAccessTokenRequest, CreateAccessTokenResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAccessTokenCommand}.
8
10
  */
9
11
  export interface CreateAccessTokenCommandInput extends CreateAccessTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAccessTokenCommand}.
13
17
  */
14
18
  export interface CreateAccessTokenCommandOutput extends CreateAccessTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password.
18
23
  * It is associated with your user account. You use PATs to access Amazon CodeCatalyst resources such as source repositories from third-party applications
19
24
  * like Git and integrated development environments (IDEs). For more information, see
@@ -28,6 +33,8 @@ export interface CreateAccessTokenCommandOutput extends CreateAccessTokenRespons
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateAccessTokenCommandInput - {@link CreateAccessTokenCommandInput}
37
+ * @returns {@link CreateAccessTokenCommandOutput}
31
38
  * @see {@link CreateAccessTokenCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateAccessTokenCommandOutput} for command's `response` shape.
33
40
  * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateAccessTokenCommandOutput extends CreateAccessTokenRespons
57
64
  export declare class CreateAccessTokenCommand extends $Command<CreateAccessTokenCommandInput, CreateAccessTokenCommandOutput, CodeCatalystClientResolvedConfig> {
58
65
  readonly input: CreateAccessTokenCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateAccessTokenCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessTokenCommandInput, CreateAccessTokenCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
5
5
  import { CreateDevEnvironmentRequest, CreateDevEnvironmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDevEnvironmentCommand}.
8
10
  */
9
11
  export interface CreateDevEnvironmentCommandInput extends CreateDevEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDevEnvironmentCommand}.
13
17
  */
14
18
  export interface CreateDevEnvironmentCommandOutput extends CreateDevEnvironmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development Dev Environment that you can use to quickly work on the code stored in the source repositories of your project.
18
23
  * </p>
19
24
  * <note>
@@ -30,6 +35,8 @@ export interface CreateDevEnvironmentCommandOutput extends CreateDevEnvironmentR
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param CreateDevEnvironmentCommandInput - {@link CreateDevEnvironmentCommandInput}
39
+ * @returns {@link CreateDevEnvironmentCommandOutput}
33
40
  * @see {@link CreateDevEnvironmentCommandInput} for command's `input` shape.
34
41
  * @see {@link CreateDevEnvironmentCommandOutput} for command's `response` shape.
35
42
  * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
@@ -59,11 +66,20 @@ export interface CreateDevEnvironmentCommandOutput extends CreateDevEnvironmentR
59
66
  export declare class CreateDevEnvironmentCommand extends $Command<CreateDevEnvironmentCommandInput, CreateDevEnvironmentCommandOutput, CodeCatalystClientResolvedConfig> {
60
67
  readonly input: CreateDevEnvironmentCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: CreateDevEnvironmentCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDevEnvironmentCommandInput, CreateDevEnvironmentCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
5
5
  import { CreateProjectRequest, CreateProjectResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateProjectCommand}.
8
10
  */
9
11
  export interface CreateProjectCommandInput extends CreateProjectRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateProjectCommand}.
13
17
  */
14
18
  export interface CreateProjectCommandOutput extends CreateProjectResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a project in a specified space.</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 CreateProjectCommandOutput extends CreateProjectResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateProjectCommandInput - {@link CreateProjectCommandInput}
34
+ * @returns {@link CreateProjectCommandOutput}
28
35
  * @see {@link CreateProjectCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateProjectCommandOutput} for command's `response` shape.
30
37
  * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
@@ -54,11 +61,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
54
61
  export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, CodeCatalystClientResolvedConfig> {
55
62
  readonly input: CreateProjectCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: CreateProjectCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProjectCommandInput, CreateProjectCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
5
5
  import { CreateSourceRepositoryBranchRequest, CreateSourceRepositoryBranchResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSourceRepositoryBranchCommand}.
8
10
  */
9
11
  export interface CreateSourceRepositoryBranchCommandInput extends CreateSourceRepositoryBranchRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSourceRepositoryBranchCommand}.
13
17
  */
14
18
  export interface CreateSourceRepositoryBranchCommandOutput extends CreateSourceRepositoryBranchResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a branch in a specified source repository in Amazon CodeCatalyst. </p>
18
23
  * <note>
19
24
  * <p>This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.</p>
@@ -28,6 +33,8 @@ export interface CreateSourceRepositoryBranchCommandOutput extends CreateSourceR
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateSourceRepositoryBranchCommandInput - {@link CreateSourceRepositoryBranchCommandInput}
37
+ * @returns {@link CreateSourceRepositoryBranchCommandOutput}
31
38
  * @see {@link CreateSourceRepositoryBranchCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateSourceRepositoryBranchCommandOutput} for command's `response` shape.
33
40
  * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateSourceRepositoryBranchCommandOutput extends CreateSourceR
57
64
  export declare class CreateSourceRepositoryBranchCommand extends $Command<CreateSourceRepositoryBranchCommandInput, CreateSourceRepositoryBranchCommandOutput, CodeCatalystClientResolvedConfig> {
58
65
  readonly input: CreateSourceRepositoryBranchCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateSourceRepositoryBranchCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSourceRepositoryBranchCommandInput, CreateSourceRepositoryBranchCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
5
5
  import { DeleteAccessTokenRequest, DeleteAccessTokenResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAccessTokenCommand}.
8
10
  */
9
11
  export interface DeleteAccessTokenCommandInput extends DeleteAccessTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAccessTokenCommand}.
13
17
  */
14
18
  export interface DeleteAccessTokenCommandOutput extends DeleteAccessTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.</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 DeleteAccessTokenCommandOutput extends DeleteAccessTokenRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteAccessTokenCommandInput - {@link DeleteAccessTokenCommandInput}
34
+ * @returns {@link DeleteAccessTokenCommandOutput}
28
35
  * @see {@link DeleteAccessTokenCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteAccessTokenCommandOutput} for command's `response` shape.
30
37
  * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteAccessTokenCommandOutput extends DeleteAccessTokenRespons
54
61
  export declare class DeleteAccessTokenCommand extends $Command<DeleteAccessTokenCommandInput, DeleteAccessTokenCommandOutput, CodeCatalystClientResolvedConfig> {
55
62
  readonly input: DeleteAccessTokenCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteAccessTokenCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAccessTokenCommandInput, DeleteAccessTokenCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
5
5
  import { DeleteDevEnvironmentRequest, DeleteDevEnvironmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDevEnvironmentCommand}.
8
10
  */
9
11
  export interface DeleteDevEnvironmentCommandInput extends DeleteDevEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDevEnvironmentCommand}.
13
17
  */
14
18
  export interface DeleteDevEnvironmentCommandOutput extends DeleteDevEnvironmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a Dev Environment. </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 DeleteDevEnvironmentCommandOutput extends DeleteDevEnvironmentR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteDevEnvironmentCommandInput - {@link DeleteDevEnvironmentCommandInput}
34
+ * @returns {@link DeleteDevEnvironmentCommandOutput}
28
35
  * @see {@link DeleteDevEnvironmentCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteDevEnvironmentCommandOutput} for command's `response` shape.
30
37
  * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteDevEnvironmentCommandOutput extends DeleteDevEnvironmentR
54
61
  export declare class DeleteDevEnvironmentCommand extends $Command<DeleteDevEnvironmentCommandInput, DeleteDevEnvironmentCommandOutput, CodeCatalystClientResolvedConfig> {
55
62
  readonly input: DeleteDevEnvironmentCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteDevEnvironmentCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDevEnvironmentCommandInput, DeleteDevEnvironmentCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CodeCatalystClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeCatalystClient";
5
5
  import { GetDevEnvironmentRequest, GetDevEnvironmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDevEnvironmentCommand}.
8
10
  */
9
11
  export interface GetDevEnvironmentCommandInput extends GetDevEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDevEnvironmentCommand}.
13
17
  */
14
18
  export interface GetDevEnvironmentCommandOutput extends GetDevEnvironmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.</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 GetDevEnvironmentCommandOutput extends GetDevEnvironmentRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDevEnvironmentCommandInput - {@link GetDevEnvironmentCommandInput}
34
+ * @returns {@link GetDevEnvironmentCommandOutput}
28
35
  * @see {@link GetDevEnvironmentCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDevEnvironmentCommandOutput} for command's `response` shape.
30
37
  * @see {@link CodeCatalystClientResolvedConfig | config} for CodeCatalystClient's `config` shape.
@@ -54,11 +61,20 @@ export interface GetDevEnvironmentCommandOutput extends GetDevEnvironmentRespons
54
61
  export declare class GetDevEnvironmentCommand extends $Command<GetDevEnvironmentCommandInput, GetDevEnvironmentCommandOutput, CodeCatalystClientResolvedConfig> {
55
62
  readonly input: GetDevEnvironmentCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: GetDevEnvironmentCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeCatalystClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDevEnvironmentCommandInput, GetDevEnvironmentCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }