Skip to content

Commit 7d2c2b4

Browse files
committed
2.0.0 typescript
1 parent 66569de commit 7d2c2b4

File tree

14 files changed

+325
-568
lines changed

14 files changed

+325
-568
lines changed

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,9 @@ build/Release
2727
node_modules
2828

2929
my_config.json
30+
31+
32+
.DS_Store
33+
npm-debug.log
34+
dist
35+
typings

.jshintrc

Lines changed: 0 additions & 17 deletions
This file was deleted.

Gruntfile.js

Lines changed: 0 additions & 45 deletions
This file was deleted.

LICENSE

Lines changed: 21 additions & 177 deletions
Original file line numberDiff line numberDiff line change
@@ -1,178 +1,22 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
4-
5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6-
7-
1. Definitions.
8-
9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Matthias Ludwig ([email protected])
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.
17822

README.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,31 @@ The aws command line interface must be installed and accessible in the path
1717
Then:
1818

1919
```js
20-
var AwsCli = require('aws-cli-js');
20+
var awsCli = require('aws-cli-js');
21+
var Options = awsCli.Options;
22+
var Aws = awsCli.Aws;
2123
```
2224

2325
## Usage
2426

2527
With promise
2628

2729
```js
28-
var awsCli = new AwsCli({
29-
aws_access_key_id: 'PUTVALUEHERE',
30-
aws_secret_access_key: 'abcdefPUTVALUEHERE',
31-
});
30+
var options = new Options(
31+
/* accessKey */ 'your key',
32+
/* secretKey */ 'your key2',
33+
/* currentWorkingDirectory */ null
34+
);
35+
36+
var aws = new Aws(options);
3237

33-
awsCli.command('iam list-users').then(function (data) {
38+
aws.command('iam list-users').then(function (data) {
3439
console.log('data = ', data);
3540
});
3641

3742
//data = {
3843
// command: 'aws iam list-users ',
39-
// raw: '["{\\n \\"Users\\": [\\n {\\n \\"UserName\\": \\"developer\\", \\n \\"PasswordLastUsed\\": \\"2015-10-03T17:58:49Z\\", \\n \\"CreateDate\\": \\"2015-06-03T07:37:25Z\\", \\n \\"UserId\\": \\"AIDAJBXXXXXXXXXXXXXXXXX\\", \\n \\"Path\\": \\"/\\", \\n \\"Arn\\": \\"arn:aws:iam::03XXXXXXXXX:user/developer\\"\\n }\\n ]\\n}\\n",""]',
44+
// raw: '{\\n \\"Users\\": [\\n {\\n \\"UserName\\": \\"developer\\", \\n \\"PasswordLastUsed\\": \\"2015-10-03T17:58:49Z\\", \\n \\"CreateDate\\": \\"2015-06-03T07:37:25Z\\", \\n \\"UserId\\": \\"AIDAJBXXXXXXXXXXXXXXXXX\\", \\n \\"Path\\": \\"/\\", \\n \\"Arn\\": \\"arn:aws:iam::03XXXXXXXXX:user/developer\\"\\n }\\n ]\\n}\\n',
4045
// object:
4146
// {
4247
// Users:
@@ -57,7 +62,7 @@ With callback:
5762

5863
```js
5964

60-
awsCli.command('iam list-users', function (err, data) {
65+
aws.command('iam list-users', function (err, data) {
6166
console.log('data = ', data);
6267
});
6368

@@ -80,6 +85,27 @@ awsCli.command('iam list-users', function (err, data) {
8085

8186
```
8287

88+
Typescript
89+
90+
```js
91+
import { Aws, Options } from 'aws-cli-js';
92+
93+
const options = new Options(
94+
/* accessKey */ 'your key',
95+
/* secretKey */ 'your key2',
96+
/* currentWorkingDirectory */ null
97+
);
98+
99+
100+
const aws = new Aws(options);
101+
102+
return aws.command('iam list-users').then(function (data) {
103+
console.log('data = ', data);
104+
});
105+
```
106+
107+
108+
83109
* describe-instances
84110

85111
```js
@@ -89,19 +115,12 @@ awsCli.command('ec2 describe-instances --instance-ids i-789b3ba7').then(function
89115

90116

91117
//data = { command: 'aws ec2 describe-instances --instance-ids i-789b3ba7 ',
92-
// raw: '["{\\n \\"Reservations\\": [\\n {\\n \\"OwnerId\\": \\"031641171132\\", \\n \\"ReservationId\\": \\"r-a48ad878\\", \\n \\"Groups\\": [], \\n \\"Instances\\": [\\n {\\n
118+
// raw: '{\\n \\"Reservations\\": [\\n {\\n \\"OwnerId\\": \\"031641171132\\", \\n \\"ReservationId\\": \\"r-a48ad878\\", \\n \\"Groups\\": [], \\n \\"Instances\\": [\\n {\\n
93119
// \\"Monitoring\\": {\\n \\"State\\": \\"disabled\\"\\n }, \\n
94120
// \\"PublicDnsName\\": \\"ec2-52-64-166-221.ap-southeast-2.compute.amazonaws.com\\", \\n \\"State\\": {\\n
95121
// ...
96122

97123
```
98-
or with options
99124

100-
```js
101-
awsCli.command('ec2 describe-instances', { 'instance-ids': 'i-789b3ba7' }).then(function (data) {
102-
console.log('data = ', data);
103-
});
104-
105-
```
106125

107126

config.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
{
2-
"aws": {
3-
"accessKeyId": "enter value here",
4-
"secretAccessKey": "enter value here"
5-
}
2+
"accessKeyId": "keyid",
3+
"secretAccessKey": "secret"
64
}

0 commit comments

Comments
 (0)