@aws-lite/s3-types 0.1.5 → 0.1.7
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/index.d.ts +35 -0
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
import {
|
|
2
2
|
/* ! Do not remove IMPORTS_START / IMPORTS_END ! */
|
|
3
3
|
// $IMPORTS_START
|
|
4
|
+
CreateBucketCommandOutput as CreateBucketResponse,
|
|
5
|
+
DeleteBucketCommandOutput as DeleteBucketResponse,
|
|
6
|
+
DeleteObjectCommandOutput as DeleteObjectResponse,
|
|
7
|
+
DeleteObjectsCommandOutput as DeleteObjectsResponse,
|
|
4
8
|
GetObjectCommandOutput as GetObjectResponse,
|
|
5
9
|
HeadObjectCommandOutput as HeadObjectResponse,
|
|
10
|
+
HeadBucketCommandOutput as HeadBucketResponse,
|
|
6
11
|
ListBucketsCommandOutput as ListBucketsResponse,
|
|
7
12
|
ListObjectsV2CommandOutput as ListObjectsV2Response,
|
|
8
13
|
PutObjectCommandOutput as PutObjectResponse,
|
|
@@ -12,6 +17,30 @@ import {
|
|
|
12
17
|
declare interface AwsLiteS3 {
|
|
13
18
|
/* ! Do not remove METHODS_START / METHODS_END ! */
|
|
14
19
|
// $METHODS_START
|
|
20
|
+
/**
|
|
21
|
+
* @description
|
|
22
|
+
* - AWS docs: {@link https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html S3: CreateBucket}
|
|
23
|
+
* - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/s3/readme.md#CreateBucket S3: CreateBucket}
|
|
24
|
+
*/
|
|
25
|
+
CreateBucket: (input: { Bucket: string, CreateBucketConfiguration: Record<string, any>, ACL?: string, GrantFullControl?: string, GrantRead?: string, GrantReadACP?: string, GrantWrite?: string, GrantWriteACP?: string, ObjectLockEnabledForBucket?: string, ObjectOwnership?: string }) => Promise<CreateBucketResponse>
|
|
26
|
+
/**
|
|
27
|
+
* @description
|
|
28
|
+
* - AWS docs: {@link https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html S3: DeleteBucket}
|
|
29
|
+
* - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/s3/readme.md#DeleteBucket S3: DeleteBucket}
|
|
30
|
+
*/
|
|
31
|
+
DeleteBucket: (input: { Bucket: string, ExpectedBucketOwner?: string }) => Promise<DeleteBucketResponse>
|
|
32
|
+
/**
|
|
33
|
+
* @description
|
|
34
|
+
* - AWS docs: {@link https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html S3: DeleteObject}
|
|
35
|
+
* - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/s3/readme.md#DeleteObject S3: DeleteObject}
|
|
36
|
+
*/
|
|
37
|
+
DeleteObject: (input: { Bucket: string, Key: string, VersionId?: string, MFA?: string, RequestPayer?: string, BypassGovernanceRetention?: string, ExpectedBucketOwner?: string }) => Promise<DeleteObjectResponse>
|
|
38
|
+
/**
|
|
39
|
+
* @description
|
|
40
|
+
* - AWS docs: {@link https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html S3: DeleteObjects}
|
|
41
|
+
* - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/s3/readme.md#DeleteObjects S3: DeleteObjects}
|
|
42
|
+
*/
|
|
43
|
+
DeleteObjects: (input: { Bucket: string, Delete: Record<string, any>, MFA?: string, RequestPayer?: string, BypassGovernanceRetention?: string, ExpectedBucketOwner?: string, ChecksumAlgorithm?: string }) => Promise<DeleteObjectsResponse>
|
|
15
44
|
/**
|
|
16
45
|
* @description
|
|
17
46
|
* - AWS docs: {@link https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html S3: GetObject}
|
|
@@ -24,6 +53,12 @@ declare interface AwsLiteS3 {
|
|
|
24
53
|
* - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/s3/readme.md#HeadObject S3: HeadObject}
|
|
25
54
|
*/
|
|
26
55
|
HeadObject: (input: { Bucket: string, Key: string, PartNumber?: number, VersionId?: string, IfMatch?: string, IfModifiedSince?: string, IfNoneMatch?: string, IfUnmodifiedSince?: string, Range?: string, SSECustomerAlgorithm?: string, SSECustomerKey?: string, SSECustomerKeyMD5?: string, RequestPayer?: string, ExpectedBucketOwner?: string, ChecksumMode?: string }) => Promise<HeadObjectResponse>
|
|
56
|
+
/**
|
|
57
|
+
* @description
|
|
58
|
+
* - AWS docs: {@link https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html S3: HeadBucket}
|
|
59
|
+
* - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/s3/readme.md#HeadBucket S3: HeadBucket}
|
|
60
|
+
*/
|
|
61
|
+
HeadBucket: (input: { Bucket: string, ExpectedBucketOwner?: string }) => Promise<HeadBucketResponse>
|
|
27
62
|
/** @description aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/s3/readme.md#ListBuckets S3: ListBuckets} */
|
|
28
63
|
ListBuckets: () => Promise<ListBucketsResponse>
|
|
29
64
|
/**
|