@aws-sdk/client-storage-gateway 3.743.0 → 3.748.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 +40 -0
- package/dist-cjs/index.js +233 -0
- package/dist-es/StorageGateway.js +10 -0
- package/dist-es/commands/CancelCacheReportCommand.js +22 -0
- package/dist-es/commands/DeleteCacheReportCommand.js +22 -0
- package/dist-es/commands/DescribeCacheReportCommand.js +22 -0
- package/dist-es/commands/ListCacheReportsCommand.js +22 -0
- package/dist-es/commands/StartCacheReportCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +11 -0
- package/dist-es/protocols/Aws_json1_1.js +131 -1
- package/dist-types/StorageGateway.d.ts +36 -0
- package/dist-types/StorageGatewayClient.d.ts +7 -2
- package/dist-types/commands/CancelCacheReportCommand.d.ts +83 -0
- package/dist-types/commands/DeleteCacheReportCommand.d.ts +85 -0
- package/dist-types/commands/DescribeCacheReportCommand.d.ts +112 -0
- package/dist-types/commands/ListCacheReportsCommand.d.ts +117 -0
- package/dist-types/commands/NotifyWhenUploadedCommand.d.ts +5 -4
- package/dist-types/commands/StartCacheReportCommand.d.ts +140 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +324 -12
- package/dist-types/protocols/Aws_json1_1.d.ts +45 -0
- package/dist-types/ts3.4/StorageGateway.d.ts +86 -0
- package/dist-types/ts3.4/StorageGatewayClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CancelCacheReportCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteCacheReportCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DescribeCacheReportCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCacheReportsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartCacheReportCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +72 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
- package/package.json +12 -12
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteCacheReportInput, DeleteCacheReportOutput } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteCacheReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteCacheReportCommandInput extends DeleteCacheReportInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteCacheReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteCacheReportCommandOutput extends DeleteCacheReportOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteCacheReportCommand_base: {
|
|
25
|
+
new (input: DeleteCacheReportCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteCacheReportCommandInput, DeleteCacheReportCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteCacheReportCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteCacheReportCommandInput, DeleteCacheReportCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the
|
|
31
|
+
* report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You
|
|
32
|
+
* can use <code>CancelCacheReport</code> to cancel an IN-PROGRESS report.</p>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>
|
|
35
|
+
* <code>DeleteCacheReport</code> does not delete the report object from your Amazon S3 bucket.</p>
|
|
36
|
+
* </note>
|
|
37
|
+
* @example
|
|
38
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
+
* ```javascript
|
|
40
|
+
* import { StorageGatewayClient, DeleteCacheReportCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
|
|
41
|
+
* // const { StorageGatewayClient, DeleteCacheReportCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
|
|
42
|
+
* const client = new StorageGatewayClient(config);
|
|
43
|
+
* const input = { // DeleteCacheReportInput
|
|
44
|
+
* CacheReportARN: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DeleteCacheReportCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // DeleteCacheReportOutput
|
|
49
|
+
* // CacheReportARN: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param DeleteCacheReportCommandInput - {@link DeleteCacheReportCommandInput}
|
|
55
|
+
* @returns {@link DeleteCacheReportCommandOutput}
|
|
56
|
+
* @see {@link DeleteCacheReportCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link DeleteCacheReportCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InternalServerError} (server fault)
|
|
61
|
+
* <p>An internal server error has occurred during the request. For more information, see the
|
|
62
|
+
* error and message fields.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InvalidGatewayRequestException} (client fault)
|
|
65
|
+
* <p>An exception occurred because an invalid gateway request was issued to the service. For
|
|
66
|
+
* more information, see the error and message fields.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link StorageGatewayServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
70
|
+
*
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
export declare class DeleteCacheReportCommand extends DeleteCacheReportCommand_base {
|
|
74
|
+
/** @internal type navigation helper, not in runtime. */
|
|
75
|
+
protected static __types: {
|
|
76
|
+
api: {
|
|
77
|
+
input: DeleteCacheReportInput;
|
|
78
|
+
output: DeleteCacheReportOutput;
|
|
79
|
+
};
|
|
80
|
+
sdk: {
|
|
81
|
+
input: DeleteCacheReportCommandInput;
|
|
82
|
+
output: DeleteCacheReportCommandOutput;
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DescribeCacheReportInput, DescribeCacheReportOutput } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeCacheReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeCacheReportCommandInput extends DescribeCacheReportInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeCacheReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeCacheReportCommandOutput extends DescribeCacheReportOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeCacheReportCommand_base: {
|
|
25
|
+
new (input: DescribeCacheReportCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeCacheReportCommandInput, DescribeCacheReportCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DescribeCacheReportCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeCacheReportCommandInput, DescribeCacheReportCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns information about the specified cache report, including completion status and
|
|
31
|
+
* generation progress.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { StorageGatewayClient, DescribeCacheReportCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
|
|
36
|
+
* // const { StorageGatewayClient, DescribeCacheReportCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
|
|
37
|
+
* const client = new StorageGatewayClient(config);
|
|
38
|
+
* const input = { // DescribeCacheReportInput
|
|
39
|
+
* CacheReportARN: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DescribeCacheReportCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // DescribeCacheReportOutput
|
|
44
|
+
* // CacheReportInfo: { // CacheReportInfo
|
|
45
|
+
* // CacheReportARN: "STRING_VALUE",
|
|
46
|
+
* // CacheReportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELED" || "FAILED" || "ERROR",
|
|
47
|
+
* // ReportCompletionPercent: Number("int"),
|
|
48
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
49
|
+
* // Role: "STRING_VALUE",
|
|
50
|
+
* // FileShareARN: "STRING_VALUE",
|
|
51
|
+
* // LocationARN: "STRING_VALUE",
|
|
52
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
53
|
+
* // InclusionFilters: [ // CacheReportFilterList
|
|
54
|
+
* // { // CacheReportFilter
|
|
55
|
+
* // Name: "UploadState" || "UploadFailureReason", // required
|
|
56
|
+
* // Values: [ // CacheReportFilterValues // required
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // ExclusionFilters: [
|
|
62
|
+
* // {
|
|
63
|
+
* // Name: "UploadState" || "UploadFailureReason", // required
|
|
64
|
+
* // Values: [ // required
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // ReportName: "STRING_VALUE",
|
|
70
|
+
* // Tags: [ // Tags
|
|
71
|
+
* // { // Tag
|
|
72
|
+
* // Key: "STRING_VALUE", // required
|
|
73
|
+
* // Value: "STRING_VALUE", // required
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // },
|
|
77
|
+
* // };
|
|
78
|
+
*
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
81
|
+
* @param DescribeCacheReportCommandInput - {@link DescribeCacheReportCommandInput}
|
|
82
|
+
* @returns {@link DescribeCacheReportCommandOutput}
|
|
83
|
+
* @see {@link DescribeCacheReportCommandInput} for command's `input` shape.
|
|
84
|
+
* @see {@link DescribeCacheReportCommandOutput} for command's `response` shape.
|
|
85
|
+
* @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InternalServerError} (server fault)
|
|
88
|
+
* <p>An internal server error has occurred during the request. For more information, see the
|
|
89
|
+
* error and message fields.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link InvalidGatewayRequestException} (client fault)
|
|
92
|
+
* <p>An exception occurred because an invalid gateway request was issued to the service. For
|
|
93
|
+
* more information, see the error and message fields.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link StorageGatewayServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class DescribeCacheReportCommand extends DescribeCacheReportCommand_base {
|
|
101
|
+
/** @internal type navigation helper, not in runtime. */
|
|
102
|
+
protected static __types: {
|
|
103
|
+
api: {
|
|
104
|
+
input: DescribeCacheReportInput;
|
|
105
|
+
output: DescribeCacheReportOutput;
|
|
106
|
+
};
|
|
107
|
+
sdk: {
|
|
108
|
+
input: DescribeCacheReportCommandInput;
|
|
109
|
+
output: DescribeCacheReportCommandOutput;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListCacheReportsInput, ListCacheReportsOutput } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListCacheReportsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListCacheReportsCommandInput extends ListCacheReportsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListCacheReportsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListCacheReportsCommandOutput extends ListCacheReportsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListCacheReportsCommand_base: {
|
|
25
|
+
new (input: ListCacheReportsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCacheReportsCommandInput, ListCacheReportsCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListCacheReportsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListCacheReportsCommandInput, ListCacheReportsCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of existing cache reports for all file shares associated with your
|
|
31
|
+
* Amazon Web Services account. This list includes all information provided by the
|
|
32
|
+
* <code>DescribeCacheReport</code> action, such as report name, status, completion
|
|
33
|
+
* progress, start time, end time, filters, and tags.</p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { StorageGatewayClient, ListCacheReportsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
|
|
38
|
+
* // const { StorageGatewayClient, ListCacheReportsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
|
|
39
|
+
* const client = new StorageGatewayClient(config);
|
|
40
|
+
* const input = { // ListCacheReportsInput
|
|
41
|
+
* Marker: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListCacheReportsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListCacheReportsOutput
|
|
46
|
+
* // CacheReportList: [ // CacheReportList
|
|
47
|
+
* // { // CacheReportInfo
|
|
48
|
+
* // CacheReportARN: "STRING_VALUE",
|
|
49
|
+
* // CacheReportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELED" || "FAILED" || "ERROR",
|
|
50
|
+
* // ReportCompletionPercent: Number("int"),
|
|
51
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
52
|
+
* // Role: "STRING_VALUE",
|
|
53
|
+
* // FileShareARN: "STRING_VALUE",
|
|
54
|
+
* // LocationARN: "STRING_VALUE",
|
|
55
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
56
|
+
* // InclusionFilters: [ // CacheReportFilterList
|
|
57
|
+
* // { // CacheReportFilter
|
|
58
|
+
* // Name: "UploadState" || "UploadFailureReason", // required
|
|
59
|
+
* // Values: [ // CacheReportFilterValues // required
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // ExclusionFilters: [
|
|
65
|
+
* // {
|
|
66
|
+
* // Name: "UploadState" || "UploadFailureReason", // required
|
|
67
|
+
* // Values: [ // required
|
|
68
|
+
* // "STRING_VALUE",
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // ReportName: "STRING_VALUE",
|
|
73
|
+
* // Tags: [ // Tags
|
|
74
|
+
* // { // Tag
|
|
75
|
+
* // Key: "STRING_VALUE", // required
|
|
76
|
+
* // Value: "STRING_VALUE", // required
|
|
77
|
+
* // },
|
|
78
|
+
* // ],
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // Marker: "STRING_VALUE",
|
|
82
|
+
* // };
|
|
83
|
+
*
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
86
|
+
* @param ListCacheReportsCommandInput - {@link ListCacheReportsCommandInput}
|
|
87
|
+
* @returns {@link ListCacheReportsCommandOutput}
|
|
88
|
+
* @see {@link ListCacheReportsCommandInput} for command's `input` shape.
|
|
89
|
+
* @see {@link ListCacheReportsCommandOutput} for command's `response` shape.
|
|
90
|
+
* @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link InternalServerError} (server fault)
|
|
93
|
+
* <p>An internal server error has occurred during the request. For more information, see the
|
|
94
|
+
* error and message fields.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link InvalidGatewayRequestException} (client fault)
|
|
97
|
+
* <p>An exception occurred because an invalid gateway request was issued to the service. For
|
|
98
|
+
* more information, see the error and message fields.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link StorageGatewayServiceException}
|
|
101
|
+
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class ListCacheReportsCommand extends ListCacheReportsCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: ListCacheReportsInput;
|
|
110
|
+
output: ListCacheReportsOutput;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: ListCacheReportsCommandInput;
|
|
114
|
+
output: ListCacheReportsCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|
|
@@ -27,13 +27,14 @@ declare const NotifyWhenUploadedCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Sends you notification through
|
|
30
|
+
* <p>Sends you notification through Amazon EventBridge when all files written to your file
|
|
31
31
|
* share have been uploaded to Amazon S3.</p>
|
|
32
|
-
* <p>Storage Gateway can send a notification through Amazon
|
|
32
|
+
* <p>Storage Gateway can send a notification through Amazon EventBridge when all
|
|
33
33
|
* files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you
|
|
34
34
|
* make a request for notification. When the upload is done, Storage Gateway sends you
|
|
35
|
-
* notification through
|
|
36
|
-
*
|
|
35
|
+
* notification through EventBridge. You can configure EventBridge to send the
|
|
36
|
+
* notification through event targets such as Amazon SNS or Lambda
|
|
37
|
+
* function. This operation is only supported for S3 File Gateways.</p>
|
|
37
38
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification">Getting
|
|
38
39
|
* file upload notification</a> in the <i>Amazon S3 File Gateway User
|
|
39
40
|
* Guide</i>.</p>
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { StartCacheReportInput, StartCacheReportOutput } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartCacheReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartCacheReportCommandInput extends StartCacheReportInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartCacheReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartCacheReportCommandOutput extends StartCacheReportOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StartCacheReportCommand_base: {
|
|
25
|
+
new (input: StartCacheReportCommandInput): import("@smithy/smithy-client").CommandImpl<StartCacheReportCommandInput, StartCacheReportCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: StartCacheReportCommandInput): import("@smithy/smithy-client").CommandImpl<StartCacheReportCommandInput, StartCacheReportCommandOutput, StorageGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve
|
|
31
|
+
* issues if you have files failing upload from your gateway to Amazon S3. The report
|
|
32
|
+
* is a CSV file containing a list of files which match the set of filter parameters you
|
|
33
|
+
* specify in the request.</p>
|
|
34
|
+
* <note>
|
|
35
|
+
* <p>The <b>Files Failing Upload</b> flag is reset every 24
|
|
36
|
+
* hours and during gateway reboot. If this report captures the files after the reset, but
|
|
37
|
+
* before they become flagged again, they will not be reported as <b>Files Failing Upload</b>.</p>
|
|
38
|
+
* </note>
|
|
39
|
+
* <p>The following requirements must be met to successfully generate a cache report:</p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>You must have permissions to list the entire Amazon S3 bucket associated
|
|
43
|
+
* with the specified file share.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>No other cache reports can currently be in-progress for the specified file
|
|
47
|
+
* share.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>There must be fewer than 10 existing cache reports for the specified file
|
|
51
|
+
* share.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>The gateway must be online and connected to Amazon Web Services.</p>
|
|
55
|
+
* </li>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>The root disk must have at least 20GB of free space when report generation
|
|
58
|
+
* starts.</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>You must specify at least one value for <code>InclusionFilters</code> or
|
|
62
|
+
* <code>ExclusionFilters</code> in the request.</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* </ul>
|
|
65
|
+
* @example
|
|
66
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
67
|
+
* ```javascript
|
|
68
|
+
* import { StorageGatewayClient, StartCacheReportCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
|
|
69
|
+
* // const { StorageGatewayClient, StartCacheReportCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
|
|
70
|
+
* const client = new StorageGatewayClient(config);
|
|
71
|
+
* const input = { // StartCacheReportInput
|
|
72
|
+
* FileShareARN: "STRING_VALUE", // required
|
|
73
|
+
* Role: "STRING_VALUE", // required
|
|
74
|
+
* LocationARN: "STRING_VALUE", // required
|
|
75
|
+
* BucketRegion: "STRING_VALUE", // required
|
|
76
|
+
* VPCEndpointDNSName: "STRING_VALUE",
|
|
77
|
+
* InclusionFilters: [ // CacheReportFilterList
|
|
78
|
+
* { // CacheReportFilter
|
|
79
|
+
* Name: "UploadState" || "UploadFailureReason", // required
|
|
80
|
+
* Values: [ // CacheReportFilterValues // required
|
|
81
|
+
* "STRING_VALUE",
|
|
82
|
+
* ],
|
|
83
|
+
* },
|
|
84
|
+
* ],
|
|
85
|
+
* ExclusionFilters: [
|
|
86
|
+
* {
|
|
87
|
+
* Name: "UploadState" || "UploadFailureReason", // required
|
|
88
|
+
* Values: [ // required
|
|
89
|
+
* "STRING_VALUE",
|
|
90
|
+
* ],
|
|
91
|
+
* },
|
|
92
|
+
* ],
|
|
93
|
+
* ClientToken: "STRING_VALUE", // required
|
|
94
|
+
* Tags: [ // Tags
|
|
95
|
+
* { // Tag
|
|
96
|
+
* Key: "STRING_VALUE", // required
|
|
97
|
+
* Value: "STRING_VALUE", // required
|
|
98
|
+
* },
|
|
99
|
+
* ],
|
|
100
|
+
* };
|
|
101
|
+
* const command = new StartCacheReportCommand(input);
|
|
102
|
+
* const response = await client.send(command);
|
|
103
|
+
* // { // StartCacheReportOutput
|
|
104
|
+
* // CacheReportARN: "STRING_VALUE",
|
|
105
|
+
* // };
|
|
106
|
+
*
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
109
|
+
* @param StartCacheReportCommandInput - {@link StartCacheReportCommandInput}
|
|
110
|
+
* @returns {@link StartCacheReportCommandOutput}
|
|
111
|
+
* @see {@link StartCacheReportCommandInput} for command's `input` shape.
|
|
112
|
+
* @see {@link StartCacheReportCommandOutput} for command's `response` shape.
|
|
113
|
+
* @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link InternalServerError} (server fault)
|
|
116
|
+
* <p>An internal server error has occurred during the request. For more information, see the
|
|
117
|
+
* error and message fields.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link InvalidGatewayRequestException} (client fault)
|
|
120
|
+
* <p>An exception occurred because an invalid gateway request was issued to the service. For
|
|
121
|
+
* more information, see the error and message fields.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link StorageGatewayServiceException}
|
|
124
|
+
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
125
|
+
*
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
export declare class StartCacheReportCommand extends StartCacheReportCommand_base {
|
|
129
|
+
/** @internal type navigation helper, not in runtime. */
|
|
130
|
+
protected static __types: {
|
|
131
|
+
api: {
|
|
132
|
+
input: StartCacheReportInput;
|
|
133
|
+
output: StartCacheReportOutput;
|
|
134
|
+
};
|
|
135
|
+
sdk: {
|
|
136
|
+
input: StartCacheReportCommandInput;
|
|
137
|
+
output: StartCacheReportCommandOutput;
|
|
138
|
+
};
|
|
139
|
+
};
|
|
140
|
+
}
|
|
@@ -7,6 +7,7 @@ export * from "./AssignTapePoolCommand";
|
|
|
7
7
|
export * from "./AssociateFileSystemCommand";
|
|
8
8
|
export * from "./AttachVolumeCommand";
|
|
9
9
|
export * from "./CancelArchivalCommand";
|
|
10
|
+
export * from "./CancelCacheReportCommand";
|
|
10
11
|
export * from "./CancelRetrievalCommand";
|
|
11
12
|
export * from "./CreateCachediSCSIVolumeCommand";
|
|
12
13
|
export * from "./CreateNFSFileShareCommand";
|
|
@@ -19,6 +20,7 @@ export * from "./CreateTapeWithBarcodeCommand";
|
|
|
19
20
|
export * from "./CreateTapesCommand";
|
|
20
21
|
export * from "./DeleteAutomaticTapeCreationPolicyCommand";
|
|
21
22
|
export * from "./DeleteBandwidthRateLimitCommand";
|
|
23
|
+
export * from "./DeleteCacheReportCommand";
|
|
22
24
|
export * from "./DeleteChapCredentialsCommand";
|
|
23
25
|
export * from "./DeleteFileShareCommand";
|
|
24
26
|
export * from "./DeleteGatewayCommand";
|
|
@@ -31,6 +33,7 @@ export * from "./DescribeAvailabilityMonitorTestCommand";
|
|
|
31
33
|
export * from "./DescribeBandwidthRateLimitCommand";
|
|
32
34
|
export * from "./DescribeBandwidthRateLimitScheduleCommand";
|
|
33
35
|
export * from "./DescribeCacheCommand";
|
|
36
|
+
export * from "./DescribeCacheReportCommand";
|
|
34
37
|
export * from "./DescribeCachediSCSIVolumesCommand";
|
|
35
38
|
export * from "./DescribeChapCredentialsCommand";
|
|
36
39
|
export * from "./DescribeFileSystemAssociationsCommand";
|
|
@@ -52,6 +55,7 @@ export * from "./DisableGatewayCommand";
|
|
|
52
55
|
export * from "./DisassociateFileSystemCommand";
|
|
53
56
|
export * from "./JoinDomainCommand";
|
|
54
57
|
export * from "./ListAutomaticTapeCreationPoliciesCommand";
|
|
58
|
+
export * from "./ListCacheReportsCommand";
|
|
55
59
|
export * from "./ListFileSharesCommand";
|
|
56
60
|
export * from "./ListFileSystemAssociationsCommand";
|
|
57
61
|
export * from "./ListGatewaysCommand";
|
|
@@ -72,6 +76,7 @@ export * from "./SetLocalConsolePasswordCommand";
|
|
|
72
76
|
export * from "./SetSMBGuestPasswordCommand";
|
|
73
77
|
export * from "./ShutdownGatewayCommand";
|
|
74
78
|
export * from "./StartAvailabilityMonitorTestCommand";
|
|
79
|
+
export * from "./StartCacheReportCommand";
|
|
75
80
|
export * from "./StartGatewayCommand";
|
|
76
81
|
export * from "./UpdateAutomaticTapeCreationPolicyCommand";
|
|
77
82
|
export * from "./UpdateBandwidthRateLimitCommand";
|