@aws-sdk/client-cloud9 3.288.0 → 3.289.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 (11) hide show
  1. package/dist-types/commands/CreateEnvironmentEC2Command.d.ts +21 -0
  2. package/dist-types/commands/CreateEnvironmentMembershipCommand.d.ts +23 -0
  3. package/dist-types/commands/DeleteEnvironmentCommand.d.ts +11 -0
  4. package/dist-types/commands/DeleteEnvironmentMembershipCommand.d.ts +12 -0
  5. package/dist-types/commands/DescribeEnvironmentMembershipsCommand.d.ts +86 -0
  6. package/dist-types/commands/DescribeEnvironmentStatusCommand.d.ts +17 -0
  7. package/dist-types/commands/DescribeEnvironmentsCommand.d.ts +42 -0
  8. package/dist-types/commands/ListEnvironmentsCommand.d.ts +17 -0
  9. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +13 -0
  10. package/dist-types/commands/UpdateEnvironmentMembershipCommand.d.ts +23 -0
  11. package/package.json +29 -29
package/dist-types/commands/CreateEnvironmentEC2Command.d.ts CHANGED
@@ -30,6 +30,27 @@ export interface CreateEnvironmentEC2CommandOutput extends CreateEnvironmentEC2R
30
30
  * @see {@link CreateEnvironmentEC2CommandOutput} for command's `response` shape.
31
31
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
32
32
  *
33
+ * @example CreateEnvironmentEC2
34
+ * ```javascript
35
+ * //
36
+ * const input = {
37
+ * "name": "my-demo-environment",
38
+ * "automaticStopTimeMinutes": 60,
39
+ * "description": "This is my demonstration environment.",
40
+ * "instanceType": "t2.micro",
41
+ * "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",
42
+ * "subnetId": "subnet-6300cd1b"
43
+ * };
44
+ * const command = new CreateEnvironmentEC2Command(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
49
+ * }
50
+ * *\/
51
+ * // example id: createenvironmentec2-1516821730547
52
+ * ```
53
+ *
33
54
  */
34
55
  export declare class CreateEnvironmentEC2Command extends $Command<CreateEnvironmentEC2CommandInput, CreateEnvironmentEC2CommandOutput, Cloud9ClientResolvedConfig> {
35
56
  readonly input: CreateEnvironmentEC2CommandInput;
package/dist-types/commands/CreateEnvironmentMembershipCommand.d.ts CHANGED
@@ -29,6 +29,29 @@ export interface CreateEnvironmentMembershipCommandOutput extends CreateEnvironm
29
29
  * @see {@link CreateEnvironmentMembershipCommandOutput} for command's `response` shape.
30
30
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
31
31
  *
32
+ * @example CreateEnvironmentMembership
33
+ * ```javascript
34
+ * //
35
+ * const input = {
36
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
37
+ * "permissions": "read-write",
38
+ * "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
39
+ * };
40
+ * const command = new CreateEnvironmentMembershipCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "membership": {
45
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
46
+ * "permissions": "read-write",
47
+ * "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
48
+ * "userId": "AIDAJ3BA6O2FMJWCWXHEX"
49
+ * }
50
+ * }
51
+ * *\/
52
+ * // example id: createenvironmentmembership-1516822583452
53
+ * ```
54
+ *
32
55
  */
33
56
  export declare class CreateEnvironmentMembershipCommand extends $Command<CreateEnvironmentMembershipCommandInput, CreateEnvironmentMembershipCommandOutput, Cloud9ClientResolvedConfig> {
34
57
  readonly input: CreateEnvironmentMembershipCommandInput;
package/dist-types/commands/DeleteEnvironmentCommand.d.ts CHANGED
@@ -30,6 +30,17 @@ export interface DeleteEnvironmentCommandOutput extends DeleteEnvironmentResult,
30
30
  * @see {@link DeleteEnvironmentCommandOutput} for command's `response` shape.
31
31
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
32
32
  *
33
+ * @example DeleteEnvironment
34
+ * ```javascript
35
+ * //
36
+ * const input = {
37
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
38
+ * };
39
+ * const command = new DeleteEnvironmentCommand(input);
40
+ * await client.send(command);
41
+ * // example id: deleteenvironment-1516822903149
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteEnvironmentCommand extends $Command<DeleteEnvironmentCommandInput, DeleteEnvironmentCommandOutput, Cloud9ClientResolvedConfig> {
35
46
  readonly input: DeleteEnvironmentCommandInput;
package/dist-types/commands/DeleteEnvironmentMembershipCommand.d.ts CHANGED
@@ -29,6 +29,18 @@ export interface DeleteEnvironmentMembershipCommandOutput extends DeleteEnvironm
29
29
  * @see {@link DeleteEnvironmentMembershipCommandOutput} for command's `response` shape.
30
30
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
31
31
  *
32
+ * @example DeleteEnvironmentMembership
33
+ * ```javascript
34
+ * //
35
+ * const input = {
36
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
37
+ * "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
38
+ * };
39
+ * const command = new DeleteEnvironmentMembershipCommand(input);
40
+ * await client.send(command);
41
+ * // example id: deleteenvironmentmembership-1516822975655
42
+ * ```
43
+ *
32
44
  */
33
45
  export declare class DeleteEnvironmentMembershipCommand extends $Command<DeleteEnvironmentMembershipCommandInput, DeleteEnvironmentMembershipCommandOutput, Cloud9ClientResolvedConfig> {
34
46
  readonly input: DeleteEnvironmentMembershipCommandInput;
package/dist-types/commands/DescribeEnvironmentMembershipsCommand.d.ts CHANGED
@@ -29,6 +29,92 @@ export interface DescribeEnvironmentMembershipsCommandOutput extends DescribeEnv
29
29
  * @see {@link DescribeEnvironmentMembershipsCommandOutput} for command's `response` shape.
30
30
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
31
31
  *
32
+ * @example DescribeEnvironmentMemberships1
33
+ * ```javascript
34
+ * // The following example gets information about all of the environment members for the specified development environment.
35
+ * const input = {
36
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
37
+ * };
38
+ * const command = new DescribeEnvironmentMembershipsCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "memberships": [
43
+ * {
44
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
45
+ * "permissions": "read-write",
46
+ * "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
47
+ * "userId": "AIDAJ3BA6O2FMJWCWXHEX"
48
+ * },
49
+ * {
50
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
51
+ * "permissions": "owner",
52
+ * "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
53
+ * "userId": "AIDAJNUEDQAQWFELJDLEX"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: describeenvironmentmemberships1-1516823070453
59
+ * ```
60
+ *
61
+ * @example DescribeEnvironmentMemberships2
62
+ * ```javascript
63
+ * // The following example gets information about the owner of the specified development environment.
64
+ * const input = {
65
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
66
+ * "permissions": [
67
+ * "owner"
68
+ * ]
69
+ * };
70
+ * const command = new DescribeEnvironmentMembershipsCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "memberships": [
75
+ * {
76
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
77
+ * "permissions": "owner",
78
+ * "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
79
+ * "userId": "AIDAJNUEDQAQWFELJDLEX"
80
+ * }
81
+ * ]
82
+ * }
83
+ * *\/
84
+ * // example id: describeenvironmentmemberships2-1516823191355
85
+ * ```
86
+ *
87
+ * @example DescribeEnvironmentMemberships3
88
+ * ```javascript
89
+ * // The following example gets development environment membership information for the specified user.
90
+ * const input = {
91
+ * "userArn": "arn:aws:iam::123456789012:user/MyDemoUser"
92
+ * };
93
+ * const command = new DescribeEnvironmentMembershipsCommand(input);
94
+ * const response = await client.send(command);
95
+ * /* response ==
96
+ * {
97
+ * "memberships": [
98
+ * {
99
+ * "environmentId": "10a75714bd494714929e7f5ec4125aEX",
100
+ * "lastAccess": "2018-01-19T11:06:13Z",
101
+ * "permissions": "owner",
102
+ * "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
103
+ * "userId": "AIDAJNUEDQAQWFELJDLEX"
104
+ * },
105
+ * {
106
+ * "environmentId": "12bfc3cd537f41cb9776f8af5525c9EX",
107
+ * "lastAccess": "2018-01-19T11:39:19Z",
108
+ * "permissions": "owner",
109
+ * "userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
110
+ * "userId": "AIDAJNUEDQAQWFELJDLEX"
111
+ * }
112
+ * ]
113
+ * }
114
+ * *\/
115
+ * // example id: describeenvironmentmemberships3-1516823268793
116
+ * ```
117
+ *
32
118
  */
33
119
  export declare class DescribeEnvironmentMembershipsCommand extends $Command<DescribeEnvironmentMembershipsCommandInput, DescribeEnvironmentMembershipsCommandOutput, Cloud9ClientResolvedConfig> {
34
120
  readonly input: DescribeEnvironmentMembershipsCommandInput;
package/dist-types/commands/DescribeEnvironmentStatusCommand.d.ts CHANGED
@@ -29,6 +29,23 @@ export interface DescribeEnvironmentStatusCommandOutput extends DescribeEnvironm
29
29
  * @see {@link DescribeEnvironmentStatusCommandOutput} for command's `response` shape.
30
30
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
31
31
  *
32
+ * @example DescribeEnvironmentStatus
33
+ * ```javascript
34
+ * //
35
+ * const input = {
36
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
37
+ * };
38
+ * const command = new DescribeEnvironmentStatusCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "message": "Environment is ready to use",
43
+ * "status": "ready"
44
+ * }
45
+ * *\/
46
+ * // example id: describeenvironmentstatus-1516823462133
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class DescribeEnvironmentStatusCommand extends $Command<DescribeEnvironmentStatusCommandInput, DescribeEnvironmentStatusCommandOutput, Cloud9ClientResolvedConfig> {
34
51
  readonly input: DescribeEnvironmentStatusCommandInput;
package/dist-types/commands/DescribeEnvironmentsCommand.d.ts CHANGED
@@ -29,6 +29,48 @@ export interface DescribeEnvironmentsCommandOutput extends DescribeEnvironmentsR
29
29
  * @see {@link DescribeEnvironmentsCommandOutput} for command's `response` shape.
30
30
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
31
31
  *
32
+ * @example DescribeEnvironments
33
+ * ```javascript
34
+ * //
35
+ * const input = {
36
+ * "environmentIds": [
37
+ * "8d9967e2f0624182b74e7690ad69ebEX",
38
+ * "349c86d4579e4e7298d500ff57a6b2EX"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeEnvironmentsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "environments": [
46
+ * {
47
+ * "name": "my-demo-environment",
48
+ * "type": "ec2",
49
+ * "arn": "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX",
50
+ * "description": "This is my demonstration environment.",
51
+ * "id": "8d9967e2f0624182b74e7690ad69ebEX",
52
+ * "lifecycle": {
53
+ * "status": "CREATED"
54
+ * },
55
+ * "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser"
56
+ * },
57
+ * {
58
+ * "name": "another-demo-environment",
59
+ * "type": "ssh",
60
+ * "arn": "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX",
61
+ * "description": "",
62
+ * "id": "349c86d4579e4e7298d500ff57a6b2EX",
63
+ * "lifecycle": {
64
+ * "status": "CREATED"
65
+ * },
66
+ * "ownerArn": "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser"
67
+ * }
68
+ * ]
69
+ * }
70
+ * *\/
71
+ * // example id: describeenvironments-1516823568291
72
+ * ```
73
+ *
32
74
  */
33
75
  export declare class DescribeEnvironmentsCommand extends $Command<DescribeEnvironmentsCommandInput, DescribeEnvironmentsCommandOutput, Cloud9ClientResolvedConfig> {
34
76
  readonly input: DescribeEnvironmentsCommandInput;
package/dist-types/commands/ListEnvironmentsCommand.d.ts CHANGED
@@ -29,6 +29,23 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsResult, _
29
29
  * @see {@link ListEnvironmentsCommandOutput} for command's `response` shape.
30
30
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
31
31
  *
32
+ * @example ListEnvironments
33
+ * ```javascript
34
+ * //
35
+ * const input = {};
36
+ * const command = new ListEnvironmentsCommand(input);
37
+ * const response = await client.send(command);
38
+ * /* response ==
39
+ * {
40
+ * "environmentIds": [
41
+ * "349c86d4579e4e7298d500ff57a6b2EX",
42
+ * "45a3da47af0840f2b0c0824f5ee232EX"
43
+ * ]
44
+ * }
45
+ * *\/
46
+ * // example id: listenvironments-1516823687205
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class ListEnvironmentsCommand extends $Command<ListEnvironmentsCommandInput, ListEnvironmentsCommandOutput, Cloud9ClientResolvedConfig> {
34
51
  readonly input: ListEnvironmentsCommandInput;
package/dist-types/commands/UpdateEnvironmentCommand.d.ts CHANGED
@@ -29,6 +29,19 @@ export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentResult,
29
29
  * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape.
30
30
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
31
31
  *
32
+ * @example UpdateEnvironment
33
+ * ```javascript
34
+ * //
35
+ * const input = {
36
+ * "name": "my-changed-demo-environment",
37
+ * "description": "This is my changed demonstration environment.",
38
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
39
+ * };
40
+ * const command = new UpdateEnvironmentCommand(input);
41
+ * await client.send(command);
42
+ * // example id: updateenvironment-1516823781910
43
+ * ```
44
+ *
32
45
  */
33
46
  export declare class UpdateEnvironmentCommand extends $Command<UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, Cloud9ClientResolvedConfig> {
34
47
  readonly input: UpdateEnvironmentCommandInput;
package/dist-types/commands/UpdateEnvironmentMembershipCommand.d.ts CHANGED
@@ -30,6 +30,29 @@ export interface UpdateEnvironmentMembershipCommandOutput extends UpdateEnvironm
30
30
  * @see {@link UpdateEnvironmentMembershipCommandOutput} for command's `response` shape.
31
31
  * @see {@link Cloud9ClientResolvedConfig | config} for Cloud9Client's `config` shape.
32
32
  *
33
+ * @example UpdateEnvironmentMembership
34
+ * ```javascript
35
+ * //
36
+ * const input = {
37
+ * "environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
38
+ * "permissions": "read-only",
39
+ * "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
40
+ * };
41
+ * const command = new UpdateEnvironmentMembershipCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "membership": {
46
+ * "environmentId": "8d9967e2f0624182b74e7690ad69eb31",
47
+ * "permissions": "read-only",
48
+ * "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
49
+ * "userId": "AIDAJ3BA6O2FMJWCWXHEX"
50
+ * }
51
+ * }
52
+ * *\/
53
+ * // example id: updateenvironmentmembership-1516823876645
54
+ * ```
55
+ *
33
56
  */
34
57
  export declare class UpdateEnvironmentMembershipCommand extends $Command<UpdateEnvironmentMembershipCommandInput, UpdateEnvironmentMembershipCommandOutput, Cloud9ClientResolvedConfig> {
35
58
  readonly input: UpdateEnvironmentMembershipCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloud9",
3
3
  "description": "AWS SDK for JavaScript Cloud9 Client for Node.js, Browser and React Native",
4
- "version": "3.288.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
55
  "tslib": "^2.3.1"
56
56
  },