@aws-sdk/client-codecatalyst 3.315.0 → 3.319.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/README.md +10 -6
- package/dist-cjs/CodeCatalyst.js +29 -350
- package/dist-cjs/models/models_0.js +1 -5
- package/dist-es/CodeCatalyst.js +29 -350
- package/dist-es/models/models_0.js +0 -4
- package/dist-types/CodeCatalyst.d.ts +147 -179
- package/dist-types/CodeCatalystClient.d.ts +11 -7
- package/dist-types/commands/CreateAccessTokenCommand.d.ts +3 -2
- package/dist-types/commands/CreateDevEnvironmentCommand.d.ts +2 -2
- package/dist-types/commands/ListAccessTokensCommand.d.ts +1 -1
- package/dist-types/commands/ListDevEnvironmentsCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +3 -15
- package/dist-types/ts3.4/CodeCatalyst.d.ts +4 -1
- package/dist-types/ts3.4/models/models_0.d.ts +0 -6
- package/package.json +7 -7
|
@@ -25,308 +25,276 @@ import { StopDevEnvironmentCommandInput, StopDevEnvironmentCommandOutput } from
|
|
|
25
25
|
import { StopDevEnvironmentSessionCommandInput, StopDevEnvironmentSessionCommandOutput } from "./commands/StopDevEnvironmentSessionCommand";
|
|
26
26
|
import { UpdateDevEnvironmentCommandInput, UpdateDevEnvironmentCommandOutput } from "./commands/UpdateDevEnvironmentCommand";
|
|
27
27
|
import { VerifySessionCommandInput, VerifySessionCommandOutput } from "./commands/VerifySessionCommand";
|
|
28
|
-
|
|
29
|
-
* @public
|
|
30
|
-
* <note>
|
|
31
|
-
* <p>
|
|
32
|
-
* <b>Amazon CodeCatalyst is in preview release and subject to change.</b>
|
|
33
|
-
* </p>
|
|
34
|
-
* </note>
|
|
35
|
-
* <p>Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst
|
|
36
|
-
* API to work with the following objects. </p>
|
|
37
|
-
* <p>Dev Environments and the Amazon Web Services Toolkits, by calling the following:</p>
|
|
38
|
-
* <ul>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <a>CreateAccessToken</a>, which creates a personal access token (PAT) for the current user.</p>
|
|
42
|
-
* </li>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>
|
|
45
|
-
* <a>CreateDevEnvironment</a>, which creates a Dev Environment,
|
|
46
|
-
* where you can quickly work on the code stored in the source repositories of your project.</p>
|
|
47
|
-
* </li>
|
|
48
|
-
* <li>
|
|
49
|
-
* <p>
|
|
50
|
-
* <a>CreateProject</a> which creates a project in a specified space.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <a>CreateSourceRepositoryBranch</a>, which creates a branch in a specified repository where you can work on code.</p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>
|
|
58
|
-
* <a>DeleteDevEnvironment</a>, which deletes a Dev Environment.</p>
|
|
59
|
-
* </li>
|
|
60
|
-
* <li>
|
|
61
|
-
* <p>
|
|
62
|
-
* <a>GetDevEnvironment</a>, which returns information about a Dev Environment.</p>
|
|
63
|
-
* </li>
|
|
64
|
-
* <li>
|
|
65
|
-
* <p>
|
|
66
|
-
* <a>GetProject</a>, which returns information about a project.</p>
|
|
67
|
-
* </li>
|
|
68
|
-
* <li>
|
|
69
|
-
* <p>
|
|
70
|
-
* <a>GetSourceRepositoryCloneUrls</a>, which returns information about the URLs that can be used with a Git client to clone a source
|
|
71
|
-
* repository.</p>
|
|
72
|
-
* </li>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>
|
|
75
|
-
* <a>GetSubscription</a>, which returns information about the Amazon Web Services account used for billing purposes
|
|
76
|
-
* and the billing plan for the space.</p>
|
|
77
|
-
* </li>
|
|
78
|
-
* <li>
|
|
79
|
-
* <p>
|
|
80
|
-
* <a>GetUserDetails</a>, which returns information about a user in Amazon CodeCatalyst.</p>
|
|
81
|
-
* </li>
|
|
82
|
-
* <li>
|
|
83
|
-
* <p>
|
|
84
|
-
* <a>ListDevEnvironments</a>, which retrives a list of Dev Environments in a project.</p>
|
|
85
|
-
* </li>
|
|
86
|
-
* <li>
|
|
87
|
-
* <p>
|
|
88
|
-
* <a>ListProjects</a>, which retrieves a list of projects in a space.</p>
|
|
89
|
-
* </li>
|
|
90
|
-
* <li>
|
|
91
|
-
* <p>
|
|
92
|
-
* <a>ListSourceRepositories</a>, which retrieves a list of source repositories in a project.</p>
|
|
93
|
-
* </li>
|
|
94
|
-
* <li>
|
|
95
|
-
* <p>
|
|
96
|
-
* <a>ListSourceRepositoryBranches</a>, which retrieves a list of branches in a source repository.</p>
|
|
97
|
-
* </li>
|
|
98
|
-
* <li>
|
|
99
|
-
* <p>
|
|
100
|
-
* <a>ListSpaces</a>, which retrieves a list of spaces.</p>
|
|
101
|
-
* </li>
|
|
102
|
-
* <li>
|
|
103
|
-
* <p>
|
|
104
|
-
* <a>StartDevEnvironment</a>, which starts a specified Dev Environment and puts it into an active state.</p>
|
|
105
|
-
* </li>
|
|
106
|
-
* <li>
|
|
107
|
-
* <p>
|
|
108
|
-
* <a>StartDevEnvironmentSession</a>, which starts a session to a specified Dev Environment.</p>
|
|
109
|
-
* </li>
|
|
110
|
-
* <li>
|
|
111
|
-
* <p>
|
|
112
|
-
* <a>StopDevEnvironment</a>, which stops a specified Dev Environment and puts it into an stopped state.</p>
|
|
113
|
-
* </li>
|
|
114
|
-
* <li>
|
|
115
|
-
* <p>
|
|
116
|
-
* <a>StopDevEnvironmentSession</a>, which stops a session for a specified Dev Environment.</p>
|
|
117
|
-
* </li>
|
|
118
|
-
* <li>
|
|
119
|
-
* <p>
|
|
120
|
-
* <a>UpdateDevEnvironment</a>, which changes one or more values for a Dev Environment.</p>
|
|
121
|
-
* </li>
|
|
122
|
-
* <li>
|
|
123
|
-
* <p>
|
|
124
|
-
* <a>VerifySession</a>, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.</p>
|
|
125
|
-
* </li>
|
|
126
|
-
* </ul>
|
|
127
|
-
* <p>Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:</p>
|
|
128
|
-
* <ul>
|
|
129
|
-
* <li>
|
|
130
|
-
* <p>
|
|
131
|
-
* <a>DeleteAccessToken</a>, which deletes a specified personal access token (PAT).</p>
|
|
132
|
-
* </li>
|
|
133
|
-
* <li>
|
|
134
|
-
* <p>
|
|
135
|
-
* <a>ListAccessTokens</a>, which lists all personal access tokens (PATs) associated with a user.</p>
|
|
136
|
-
* </li>
|
|
137
|
-
* <li>
|
|
138
|
-
* <p>
|
|
139
|
-
* <a>ListEventLogs</a>, which retrieves a list of events that occurred during a specified time period in a space.</p>
|
|
140
|
-
* </li>
|
|
141
|
-
* </ul>
|
|
142
|
-
*/
|
|
143
|
-
export declare class CodeCatalyst extends CodeCatalystClient {
|
|
28
|
+
export interface CodeCatalyst {
|
|
144
29
|
/**
|
|
145
|
-
* @
|
|
146
|
-
* <p>Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password.
|
|
147
|
-
* It is associated with your user account. You use PATs to access Amazon CodeCatalyst resources such as source repositories from third-party applications
|
|
148
|
-
* like Git and integrated development environments (IDEs). For more information, see
|
|
149
|
-
* <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html">Managing personal access tokens in Amazon CodeCatalyst</a>.</p>
|
|
30
|
+
* @see {@link CreateAccessTokenCommand}
|
|
150
31
|
*/
|
|
151
32
|
createAccessToken(args: CreateAccessTokenCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessTokenCommandOutput>;
|
|
152
33
|
createAccessToken(args: CreateAccessTokenCommandInput, cb: (err: any, data?: CreateAccessTokenCommandOutput) => void): void;
|
|
153
34
|
createAccessToken(args: CreateAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessTokenCommandOutput) => void): void;
|
|
154
35
|
/**
|
|
155
|
-
* @
|
|
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.
|
|
157
|
-
* </p>
|
|
158
|
-
* <note>
|
|
159
|
-
* <p>When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these
|
|
160
|
-
* defaults apply to a Dev Environment created programmatically.</p>
|
|
161
|
-
* </note>
|
|
36
|
+
* @see {@link CreateDevEnvironmentCommand}
|
|
162
37
|
*/
|
|
163
38
|
createDevEnvironment(args: CreateDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateDevEnvironmentCommandOutput>;
|
|
164
39
|
createDevEnvironment(args: CreateDevEnvironmentCommandInput, cb: (err: any, data?: CreateDevEnvironmentCommandOutput) => void): void;
|
|
165
40
|
createDevEnvironment(args: CreateDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDevEnvironmentCommandOutput) => void): void;
|
|
166
41
|
/**
|
|
167
|
-
* @
|
|
168
|
-
* <p>Creates a project in a specified space.</p>
|
|
42
|
+
* @see {@link CreateProjectCommand}
|
|
169
43
|
*/
|
|
170
44
|
createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise<CreateProjectCommandOutput>;
|
|
171
45
|
createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
172
46
|
createProject(args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
173
47
|
/**
|
|
174
|
-
* @
|
|
175
|
-
* <p>Creates a branch in a specified source repository in Amazon CodeCatalyst. </p>
|
|
176
|
-
* <note>
|
|
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>
|
|
178
|
-
* </note>
|
|
48
|
+
* @see {@link CreateSourceRepositoryBranchCommand}
|
|
179
49
|
*/
|
|
180
50
|
createSourceRepositoryBranch(args: CreateSourceRepositoryBranchCommandInput, options?: __HttpHandlerOptions): Promise<CreateSourceRepositoryBranchCommandOutput>;
|
|
181
51
|
createSourceRepositoryBranch(args: CreateSourceRepositoryBranchCommandInput, cb: (err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void): void;
|
|
182
52
|
createSourceRepositoryBranch(args: CreateSourceRepositoryBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void): void;
|
|
183
53
|
/**
|
|
184
|
-
* @
|
|
185
|
-
* <p>Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.</p>
|
|
54
|
+
* @see {@link DeleteAccessTokenCommand}
|
|
186
55
|
*/
|
|
187
56
|
deleteAccessToken(args: DeleteAccessTokenCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessTokenCommandOutput>;
|
|
188
57
|
deleteAccessToken(args: DeleteAccessTokenCommandInput, cb: (err: any, data?: DeleteAccessTokenCommandOutput) => void): void;
|
|
189
58
|
deleteAccessToken(args: DeleteAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessTokenCommandOutput) => void): void;
|
|
190
59
|
/**
|
|
191
|
-
* @
|
|
192
|
-
* <p>Deletes a Dev Environment. </p>
|
|
60
|
+
* @see {@link DeleteDevEnvironmentCommand}
|
|
193
61
|
*/
|
|
194
62
|
deleteDevEnvironment(args: DeleteDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDevEnvironmentCommandOutput>;
|
|
195
63
|
deleteDevEnvironment(args: DeleteDevEnvironmentCommandInput, cb: (err: any, data?: DeleteDevEnvironmentCommandOutput) => void): void;
|
|
196
64
|
deleteDevEnvironment(args: DeleteDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDevEnvironmentCommandOutput) => void): void;
|
|
197
65
|
/**
|
|
198
|
-
* @
|
|
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>
|
|
66
|
+
* @see {@link GetDevEnvironmentCommand}
|
|
200
67
|
*/
|
|
201
68
|
getDevEnvironment(args: GetDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<GetDevEnvironmentCommandOutput>;
|
|
202
69
|
getDevEnvironment(args: GetDevEnvironmentCommandInput, cb: (err: any, data?: GetDevEnvironmentCommandOutput) => void): void;
|
|
203
70
|
getDevEnvironment(args: GetDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevEnvironmentCommandOutput) => void): void;
|
|
204
71
|
/**
|
|
205
|
-
* @
|
|
206
|
-
* <p>Returns information about a project.</p>
|
|
72
|
+
* @see {@link GetProjectCommand}
|
|
207
73
|
*/
|
|
208
74
|
getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise<GetProjectCommandOutput>;
|
|
209
75
|
getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void;
|
|
210
76
|
getProject(args: GetProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProjectCommandOutput) => void): void;
|
|
211
77
|
/**
|
|
212
|
-
* @
|
|
213
|
-
* <p>Returns information about the URLs that can be used with a Git client to clone a source
|
|
214
|
-
* repository.</p>
|
|
78
|
+
* @see {@link GetSourceRepositoryCloneUrlsCommand}
|
|
215
79
|
*/
|
|
216
80
|
getSourceRepositoryCloneUrls(args: GetSourceRepositoryCloneUrlsCommandInput, options?: __HttpHandlerOptions): Promise<GetSourceRepositoryCloneUrlsCommandOutput>;
|
|
217
81
|
getSourceRepositoryCloneUrls(args: GetSourceRepositoryCloneUrlsCommandInput, cb: (err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void): void;
|
|
218
82
|
getSourceRepositoryCloneUrls(args: GetSourceRepositoryCloneUrlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void): void;
|
|
219
83
|
/**
|
|
220
|
-
* @
|
|
221
|
-
* <p>Returns information about an space.</p>
|
|
84
|
+
* @see {@link GetSpaceCommand}
|
|
222
85
|
*/
|
|
223
86
|
getSpace(args: GetSpaceCommandInput, options?: __HttpHandlerOptions): Promise<GetSpaceCommandOutput>;
|
|
224
87
|
getSpace(args: GetSpaceCommandInput, cb: (err: any, data?: GetSpaceCommandOutput) => void): void;
|
|
225
88
|
getSpace(args: GetSpaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSpaceCommandOutput) => void): void;
|
|
226
89
|
/**
|
|
227
|
-
* @
|
|
228
|
-
* <p>Returns information about the Amazon Web Services account used for billing purposes
|
|
229
|
-
* and the billing plan for the space.</p>
|
|
90
|
+
* @see {@link GetSubscriptionCommand}
|
|
230
91
|
*/
|
|
231
92
|
getSubscription(args: GetSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<GetSubscriptionCommandOutput>;
|
|
232
93
|
getSubscription(args: GetSubscriptionCommandInput, cb: (err: any, data?: GetSubscriptionCommandOutput) => void): void;
|
|
233
94
|
getSubscription(args: GetSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionCommandOutput) => void): void;
|
|
234
95
|
/**
|
|
235
|
-
* @
|
|
236
|
-
* <p>Returns information about a user. </p>
|
|
96
|
+
* @see {@link GetUserDetailsCommand}
|
|
237
97
|
*/
|
|
238
98
|
getUserDetails(args: GetUserDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetUserDetailsCommandOutput>;
|
|
239
99
|
getUserDetails(args: GetUserDetailsCommandInput, cb: (err: any, data?: GetUserDetailsCommandOutput) => void): void;
|
|
240
100
|
getUserDetails(args: GetUserDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserDetailsCommandOutput) => void): void;
|
|
241
101
|
/**
|
|
242
|
-
* @
|
|
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>
|
|
102
|
+
* @see {@link ListAccessTokensCommand}
|
|
244
103
|
*/
|
|
245
104
|
listAccessTokens(args: ListAccessTokensCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessTokensCommandOutput>;
|
|
246
105
|
listAccessTokens(args: ListAccessTokensCommandInput, cb: (err: any, data?: ListAccessTokensCommandOutput) => void): void;
|
|
247
106
|
listAccessTokens(args: ListAccessTokensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessTokensCommandOutput) => void): void;
|
|
248
107
|
/**
|
|
249
|
-
* @
|
|
250
|
-
* <p>Retrives a list of Dev Environments in a project.</p>
|
|
108
|
+
* @see {@link ListDevEnvironmentsCommand}
|
|
251
109
|
*/
|
|
252
110
|
listDevEnvironments(args: ListDevEnvironmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListDevEnvironmentsCommandOutput>;
|
|
253
111
|
listDevEnvironments(args: ListDevEnvironmentsCommandInput, cb: (err: any, data?: ListDevEnvironmentsCommandOutput) => void): void;
|
|
254
112
|
listDevEnvironments(args: ListDevEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevEnvironmentsCommandOutput) => void): void;
|
|
255
113
|
/**
|
|
256
|
-
* @
|
|
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>
|
|
114
|
+
* @see {@link ListEventLogsCommand}
|
|
258
115
|
*/
|
|
259
116
|
listEventLogs(args: ListEventLogsCommandInput, options?: __HttpHandlerOptions): Promise<ListEventLogsCommandOutput>;
|
|
260
117
|
listEventLogs(args: ListEventLogsCommandInput, cb: (err: any, data?: ListEventLogsCommandOutput) => void): void;
|
|
261
118
|
listEventLogs(args: ListEventLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventLogsCommandOutput) => void): void;
|
|
262
119
|
/**
|
|
263
|
-
* @
|
|
264
|
-
* <p>Retrieves a list of projects.</p>
|
|
120
|
+
* @see {@link ListProjectsCommand}
|
|
265
121
|
*/
|
|
266
122
|
listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise<ListProjectsCommandOutput>;
|
|
267
123
|
listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void;
|
|
268
124
|
listProjects(args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void): void;
|
|
269
125
|
/**
|
|
270
|
-
* @
|
|
271
|
-
* <p>Retrieves a list of source repositories in a project.</p>
|
|
126
|
+
* @see {@link ListSourceRepositoriesCommand}
|
|
272
127
|
*/
|
|
273
128
|
listSourceRepositories(args: ListSourceRepositoriesCommandInput, options?: __HttpHandlerOptions): Promise<ListSourceRepositoriesCommandOutput>;
|
|
274
129
|
listSourceRepositories(args: ListSourceRepositoriesCommandInput, cb: (err: any, data?: ListSourceRepositoriesCommandOutput) => void): void;
|
|
275
130
|
listSourceRepositories(args: ListSourceRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceRepositoriesCommandOutput) => void): void;
|
|
276
131
|
/**
|
|
277
|
-
* @
|
|
278
|
-
* <p>Retrieves a list of branches in a specified source repository.</p>
|
|
132
|
+
* @see {@link ListSourceRepositoryBranchesCommand}
|
|
279
133
|
*/
|
|
280
134
|
listSourceRepositoryBranches(args: ListSourceRepositoryBranchesCommandInput, options?: __HttpHandlerOptions): Promise<ListSourceRepositoryBranchesCommandOutput>;
|
|
281
135
|
listSourceRepositoryBranches(args: ListSourceRepositoryBranchesCommandInput, cb: (err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void): void;
|
|
282
136
|
listSourceRepositoryBranches(args: ListSourceRepositoryBranchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void): void;
|
|
283
137
|
/**
|
|
284
|
-
* @
|
|
285
|
-
* <p>Retrieves a list of spaces.</p>
|
|
138
|
+
* @see {@link ListSpacesCommand}
|
|
286
139
|
*/
|
|
287
140
|
listSpaces(args: ListSpacesCommandInput, options?: __HttpHandlerOptions): Promise<ListSpacesCommandOutput>;
|
|
288
141
|
listSpaces(args: ListSpacesCommandInput, cb: (err: any, data?: ListSpacesCommandOutput) => void): void;
|
|
289
142
|
listSpaces(args: ListSpacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpacesCommandOutput) => void): void;
|
|
290
143
|
/**
|
|
291
|
-
* @
|
|
292
|
-
* <p>Starts a specified Dev Environment and puts it into an active state. </p>
|
|
144
|
+
* @see {@link StartDevEnvironmentCommand}
|
|
293
145
|
*/
|
|
294
146
|
startDevEnvironment(args: StartDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<StartDevEnvironmentCommandOutput>;
|
|
295
147
|
startDevEnvironment(args: StartDevEnvironmentCommandInput, cb: (err: any, data?: StartDevEnvironmentCommandOutput) => void): void;
|
|
296
148
|
startDevEnvironment(args: StartDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDevEnvironmentCommandOutput) => void): void;
|
|
297
149
|
/**
|
|
298
|
-
* @
|
|
299
|
-
* <p>Starts a session for a specified Dev Environment.</p>
|
|
150
|
+
* @see {@link StartDevEnvironmentSessionCommand}
|
|
300
151
|
*/
|
|
301
152
|
startDevEnvironmentSession(args: StartDevEnvironmentSessionCommandInput, options?: __HttpHandlerOptions): Promise<StartDevEnvironmentSessionCommandOutput>;
|
|
302
153
|
startDevEnvironmentSession(args: StartDevEnvironmentSessionCommandInput, cb: (err: any, data?: StartDevEnvironmentSessionCommandOutput) => void): void;
|
|
303
154
|
startDevEnvironmentSession(args: StartDevEnvironmentSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDevEnvironmentSessionCommandOutput) => void): void;
|
|
304
155
|
/**
|
|
305
|
-
* @
|
|
306
|
-
* <p>Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.</p>
|
|
156
|
+
* @see {@link StopDevEnvironmentCommand}
|
|
307
157
|
*/
|
|
308
158
|
stopDevEnvironment(args: StopDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<StopDevEnvironmentCommandOutput>;
|
|
309
159
|
stopDevEnvironment(args: StopDevEnvironmentCommandInput, cb: (err: any, data?: StopDevEnvironmentCommandOutput) => void): void;
|
|
310
160
|
stopDevEnvironment(args: StopDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDevEnvironmentCommandOutput) => void): void;
|
|
311
161
|
/**
|
|
312
|
-
* @
|
|
313
|
-
* <p>Stops a session for a specified Dev Environment.</p>
|
|
162
|
+
* @see {@link StopDevEnvironmentSessionCommand}
|
|
314
163
|
*/
|
|
315
164
|
stopDevEnvironmentSession(args: StopDevEnvironmentSessionCommandInput, options?: __HttpHandlerOptions): Promise<StopDevEnvironmentSessionCommandOutput>;
|
|
316
165
|
stopDevEnvironmentSession(args: StopDevEnvironmentSessionCommandInput, cb: (err: any, data?: StopDevEnvironmentSessionCommandOutput) => void): void;
|
|
317
166
|
stopDevEnvironmentSession(args: StopDevEnvironmentSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDevEnvironmentSessionCommandOutput) => void): void;
|
|
318
167
|
/**
|
|
319
|
-
* @
|
|
320
|
-
* <p>Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.</p>
|
|
168
|
+
* @see {@link UpdateDevEnvironmentCommand}
|
|
321
169
|
*/
|
|
322
170
|
updateDevEnvironment(args: UpdateDevEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDevEnvironmentCommandOutput>;
|
|
323
171
|
updateDevEnvironment(args: UpdateDevEnvironmentCommandInput, cb: (err: any, data?: UpdateDevEnvironmentCommandOutput) => void): void;
|
|
324
172
|
updateDevEnvironment(args: UpdateDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDevEnvironmentCommandOutput) => void): void;
|
|
325
173
|
/**
|
|
326
|
-
* @
|
|
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>
|
|
174
|
+
* @see {@link VerifySessionCommand}
|
|
328
175
|
*/
|
|
329
176
|
verifySession(args: VerifySessionCommandInput, options?: __HttpHandlerOptions): Promise<VerifySessionCommandOutput>;
|
|
330
177
|
verifySession(args: VerifySessionCommandInput, cb: (err: any, data?: VerifySessionCommandOutput) => void): void;
|
|
331
178
|
verifySession(args: VerifySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifySessionCommandOutput) => void): void;
|
|
332
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
* <p>Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst
|
|
183
|
+
* API to work with the following objects. </p>
|
|
184
|
+
* <p>Dev Environments and the Amazon Web Services Toolkits, by calling the following:</p>
|
|
185
|
+
* <ul>
|
|
186
|
+
* <li>
|
|
187
|
+
* <p>
|
|
188
|
+
* <a>CreateAccessToken</a>, which creates a personal access token (PAT) for the current user.</p>
|
|
189
|
+
* </li>
|
|
190
|
+
* <li>
|
|
191
|
+
* <p>
|
|
192
|
+
* <a>CreateDevEnvironment</a>, which creates a Dev Environment,
|
|
193
|
+
* where you can quickly work on the code stored in the source repositories of your project.</p>
|
|
194
|
+
* </li>
|
|
195
|
+
* <li>
|
|
196
|
+
* <p>
|
|
197
|
+
* <a>CreateProject</a> which creates a project in a specified space.</p>
|
|
198
|
+
* </li>
|
|
199
|
+
* <li>
|
|
200
|
+
* <p>
|
|
201
|
+
* <a>CreateSourceRepositoryBranch</a>, which creates a branch in a specified repository where you can work on code.</p>
|
|
202
|
+
* </li>
|
|
203
|
+
* <li>
|
|
204
|
+
* <p>
|
|
205
|
+
* <a>DeleteDevEnvironment</a>, which deletes a Dev Environment.</p>
|
|
206
|
+
* </li>
|
|
207
|
+
* <li>
|
|
208
|
+
* <p>
|
|
209
|
+
* <a>GetDevEnvironment</a>, which returns information about a Dev Environment.</p>
|
|
210
|
+
* </li>
|
|
211
|
+
* <li>
|
|
212
|
+
* <p>
|
|
213
|
+
* <a>GetProject</a>, which returns information about a project.</p>
|
|
214
|
+
* </li>
|
|
215
|
+
* <li>
|
|
216
|
+
* <p>
|
|
217
|
+
* <a>GetSourceRepositoryCloneUrls</a>, which returns information about the URLs that can be used with a Git client to clone a source
|
|
218
|
+
* repository.</p>
|
|
219
|
+
* </li>
|
|
220
|
+
* <li>
|
|
221
|
+
* <p>
|
|
222
|
+
* <a>GetSpace</a>, which returns information about a space.</p>
|
|
223
|
+
* </li>
|
|
224
|
+
* <li>
|
|
225
|
+
* <p>
|
|
226
|
+
* <a>GetSubscription</a>, which returns information about the Amazon Web Services account used for billing purposes
|
|
227
|
+
* and the billing plan for the space.</p>
|
|
228
|
+
* </li>
|
|
229
|
+
* <li>
|
|
230
|
+
* <p>
|
|
231
|
+
* <a>GetUserDetails</a>, which returns information about a user in Amazon CodeCatalyst.</p>
|
|
232
|
+
* </li>
|
|
233
|
+
* <li>
|
|
234
|
+
* <p>
|
|
235
|
+
* <a>ListDevEnvironments</a>, which retrieves a list of Dev Environments in a project.</p>
|
|
236
|
+
* </li>
|
|
237
|
+
* <li>
|
|
238
|
+
* <p>
|
|
239
|
+
* <a>ListProjects</a>, which retrieves a list of projects in a space.</p>
|
|
240
|
+
* </li>
|
|
241
|
+
* <li>
|
|
242
|
+
* <p>
|
|
243
|
+
* <a>ListSourceRepositories</a>, which retrieves a list of source repositories in a project.</p>
|
|
244
|
+
* </li>
|
|
245
|
+
* <li>
|
|
246
|
+
* <p>
|
|
247
|
+
* <a>ListSourceRepositoryBranches</a>, which retrieves a list of branches in a source repository.</p>
|
|
248
|
+
* </li>
|
|
249
|
+
* <li>
|
|
250
|
+
* <p>
|
|
251
|
+
* <a>ListSpaces</a>, which retrieves a list of spaces.</p>
|
|
252
|
+
* </li>
|
|
253
|
+
* <li>
|
|
254
|
+
* <p>
|
|
255
|
+
* <a>StartDevEnvironment</a>, which starts a specified Dev Environment and puts it into an active state.</p>
|
|
256
|
+
* </li>
|
|
257
|
+
* <li>
|
|
258
|
+
* <p>
|
|
259
|
+
* <a>StartDevEnvironmentSession</a>, which starts a session to a specified Dev Environment.</p>
|
|
260
|
+
* </li>
|
|
261
|
+
* <li>
|
|
262
|
+
* <p>
|
|
263
|
+
* <a>StopDevEnvironment</a>, which stops a specified Dev Environment and puts it into an stopped state.</p>
|
|
264
|
+
* </li>
|
|
265
|
+
* <li>
|
|
266
|
+
* <p>
|
|
267
|
+
* <a>StopDevEnvironmentSession</a>, which stops a session for a specified Dev Environment.</p>
|
|
268
|
+
* </li>
|
|
269
|
+
* <li>
|
|
270
|
+
* <p>
|
|
271
|
+
* <a>UpdateDevEnvironment</a>, which changes one or more values for a Dev Environment.</p>
|
|
272
|
+
* </li>
|
|
273
|
+
* <li>
|
|
274
|
+
* <p>
|
|
275
|
+
* <a>VerifySession</a>, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.</p>
|
|
276
|
+
* </li>
|
|
277
|
+
* </ul>
|
|
278
|
+
* <p>Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:</p>
|
|
279
|
+
* <ul>
|
|
280
|
+
* <li>
|
|
281
|
+
* <p>
|
|
282
|
+
* <a>DeleteAccessToken</a>, which deletes a specified personal access token (PAT).</p>
|
|
283
|
+
* </li>
|
|
284
|
+
* <li>
|
|
285
|
+
* <p>
|
|
286
|
+
* <a>ListAccessTokens</a>, which lists all personal access tokens (PATs) associated with a user.</p>
|
|
287
|
+
* </li>
|
|
288
|
+
* <li>
|
|
289
|
+
* <p>
|
|
290
|
+
* <a>ListEventLogs</a>, which retrieves a list of events that occurred during a specified time period in a space.</p>
|
|
291
|
+
* </li>
|
|
292
|
+
* </ul>
|
|
293
|
+
* <note>
|
|
294
|
+
* <p>If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO).
|
|
295
|
+
* For more information, see <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/set-up-cli.html">Setting up to use the CLI with Amazon CodeCatalyst</a>
|
|
296
|
+
* and the SSO documentation for your SDK.</p>
|
|
297
|
+
* </note>
|
|
298
|
+
*/
|
|
299
|
+
export declare class CodeCatalyst extends CodeCatalystClient implements CodeCatalyst {
|
|
300
|
+
}
|
|
@@ -159,12 +159,7 @@ export interface CodeCatalystClientResolvedConfig extends CodeCatalystClientReso
|
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
161
|
* @public
|
|
162
|
-
* <
|
|
163
|
-
* <p>
|
|
164
|
-
* <b>Amazon CodeCatalyst is in preview release and subject to change.</b>
|
|
165
|
-
* </p>
|
|
166
|
-
* </note>
|
|
167
|
-
* <p>Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst
|
|
162
|
+
* <p>Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst
|
|
168
163
|
* API to work with the following objects. </p>
|
|
169
164
|
* <p>Dev Environments and the Amazon Web Services Toolkits, by calling the following:</p>
|
|
170
165
|
* <ul>
|
|
@@ -204,6 +199,10 @@ export interface CodeCatalystClientResolvedConfig extends CodeCatalystClientReso
|
|
|
204
199
|
* </li>
|
|
205
200
|
* <li>
|
|
206
201
|
* <p>
|
|
202
|
+
* <a>GetSpace</a>, which returns information about a space.</p>
|
|
203
|
+
* </li>
|
|
204
|
+
* <li>
|
|
205
|
+
* <p>
|
|
207
206
|
* <a>GetSubscription</a>, which returns information about the Amazon Web Services account used for billing purposes
|
|
208
207
|
* and the billing plan for the space.</p>
|
|
209
208
|
* </li>
|
|
@@ -213,7 +212,7 @@ export interface CodeCatalystClientResolvedConfig extends CodeCatalystClientReso
|
|
|
213
212
|
* </li>
|
|
214
213
|
* <li>
|
|
215
214
|
* <p>
|
|
216
|
-
* <a>ListDevEnvironments</a>, which
|
|
215
|
+
* <a>ListDevEnvironments</a>, which retrieves a list of Dev Environments in a project.</p>
|
|
217
216
|
* </li>
|
|
218
217
|
* <li>
|
|
219
218
|
* <p>
|
|
@@ -271,6 +270,11 @@ export interface CodeCatalystClientResolvedConfig extends CodeCatalystClientReso
|
|
|
271
270
|
* <a>ListEventLogs</a>, which retrieves a list of events that occurred during a specified time period in a space.</p>
|
|
272
271
|
* </li>
|
|
273
272
|
* </ul>
|
|
273
|
+
* <note>
|
|
274
|
+
* <p>If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO).
|
|
275
|
+
* For more information, see <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/set-up-cli.html">Setting up to use the CLI with Amazon CodeCatalyst</a>
|
|
276
|
+
* and the SSO documentation for your SDK.</p>
|
|
277
|
+
* </note>
|
|
274
278
|
*/
|
|
275
279
|
export declare class CodeCatalystClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CodeCatalystClientResolvedConfig> {
|
|
276
280
|
/**
|
|
@@ -20,8 +20,9 @@ export interface CreateAccessTokenCommandOutput extends CreateAccessTokenRespons
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password.
|
|
23
|
-
* It is associated with your user
|
|
24
|
-
*
|
|
23
|
+
* It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst
|
|
24
|
+
* from resources that include integrated development environments (IDEs) and Git-based source repositories.
|
|
25
|
+
* PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see
|
|
25
26
|
* <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html">Managing personal access tokens in Amazon CodeCatalyst</a>.</p>
|
|
26
27
|
* @example
|
|
27
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -19,8 +19,8 @@ export interface CreateDevEnvironmentCommandOutput extends CreateDevEnvironmentR
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development
|
|
23
|
-
* </p>
|
|
22
|
+
* <p>Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored
|
|
23
|
+
* in the source repositories of your project. </p>
|
|
24
24
|
* <note>
|
|
25
25
|
* <p>When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these
|
|
26
26
|
* defaults apply to a Dev Environment created programmatically.</p>
|
|
@@ -19,7 +19,7 @@ export interface ListAccessTokensCommandOutput extends ListAccessTokensResponse,
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your
|
|
22
|
+
* <p>Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -19,7 +19,7 @@ export interface ListDevEnvironmentsCommandOutput extends ListDevEnvironmentsRes
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>
|
|
22
|
+
* <p>Retrieves a list of Dev Environments in a project.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -114,7 +114,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
114
114
|
*/
|
|
115
115
|
export interface DeleteAccessTokenRequest {
|
|
116
116
|
/**
|
|
117
|
-
* <p>The ID of the personal access token to delete. You can find the IDs of all PATs associated with your
|
|
117
|
+
* <p>The ID of the personal access token to delete. You can find the IDs of all PATs associated with your Amazon Web Services Builder ID in a space by calling <a>ListAccessTokens</a>.</p>
|
|
118
118
|
*/
|
|
119
119
|
id: string | undefined;
|
|
120
120
|
}
|
|
@@ -159,7 +159,7 @@ export interface AccessTokenSummary {
|
|
|
159
159
|
*/
|
|
160
160
|
export interface ListAccessTokensResponse {
|
|
161
161
|
/**
|
|
162
|
-
* <p>A list of personal access tokens (PATs) associated with the calling user.</p>
|
|
162
|
+
* <p>A list of personal access tokens (PATs) associated with the calling user identity.</p>
|
|
163
163
|
*/
|
|
164
164
|
items: AccessTokenSummary[] | undefined;
|
|
165
165
|
/**
|
|
@@ -167,18 +167,6 @@ export interface ListAccessTokensResponse {
|
|
|
167
167
|
*/
|
|
168
168
|
nextToken?: string;
|
|
169
169
|
}
|
|
170
|
-
/**
|
|
171
|
-
* @public
|
|
172
|
-
* @enum
|
|
173
|
-
*/
|
|
174
|
-
export declare const CatalogActionVersionFileRecordType: {
|
|
175
|
-
readonly LICENSE: "LICENSE";
|
|
176
|
-
readonly README: "README";
|
|
177
|
-
};
|
|
178
|
-
/**
|
|
179
|
-
* @public
|
|
180
|
-
*/
|
|
181
|
-
export type CatalogActionVersionFileRecordType = (typeof CatalogActionVersionFileRecordType)[keyof typeof CatalogActionVersionFileRecordType];
|
|
182
170
|
/**
|
|
183
171
|
* @public
|
|
184
172
|
*/
|
|
@@ -485,7 +473,7 @@ export interface ListSpacesResponse {
|
|
|
485
473
|
*/
|
|
486
474
|
nextToken?: string;
|
|
487
475
|
/**
|
|
488
|
-
* <p>Information about the
|
|
476
|
+
* <p>Information about the spaces. </p>
|
|
489
477
|
*/
|
|
490
478
|
items?: SpaceSummary[];
|
|
491
479
|
}
|
|
@@ -100,7 +100,7 @@ import {
|
|
|
100
100
|
VerifySessionCommandInput,
|
|
101
101
|
VerifySessionCommandOutput,
|
|
102
102
|
} from "./commands/VerifySessionCommand";
|
|
103
|
-
export
|
|
103
|
+
export interface CodeCatalyst {
|
|
104
104
|
createAccessToken(
|
|
105
105
|
args: CreateAccessTokenCommandInput,
|
|
106
106
|
options?: __HttpHandlerOptions
|
|
@@ -427,3 +427,6 @@ export declare class CodeCatalyst extends CodeCatalystClient {
|
|
|
427
427
|
cb: (err: any, data?: VerifySessionCommandOutput) => void
|
|
428
428
|
): void;
|
|
429
429
|
}
|
|
430
|
+
export declare class CodeCatalyst
|
|
431
|
+
extends CodeCatalystClient
|
|
432
|
+
implements CodeCatalyst {}
|
|
@@ -68,12 +68,6 @@ export interface ListAccessTokensResponse {
|
|
|
68
68
|
items: AccessTokenSummary[] | undefined;
|
|
69
69
|
nextToken?: string;
|
|
70
70
|
}
|
|
71
|
-
export declare const CatalogActionVersionFileRecordType: {
|
|
72
|
-
readonly LICENSE: "LICENSE";
|
|
73
|
-
readonly README: "README";
|
|
74
|
-
};
|
|
75
|
-
export type CatalogActionVersionFileRecordType =
|
|
76
|
-
(typeof CatalogActionVersionFileRecordType)[keyof typeof CatalogActionVersionFileRecordType];
|
|
77
71
|
export interface GetUserDetailsRequest {
|
|
78
72
|
id?: string;
|
|
79
73
|
userName?: string;
|