@aws-sdk/client-accessanalyzer 3.1025.0 → 3.1027.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 +0 -49
- package/dist-cjs/index.js +1 -249
- package/dist-cjs/schemas/schemas_0.js +5 -173
- package/dist-es/AccessAnalyzer.js +1 -23
- package/dist-es/commands/index.js +0 -7
- package/dist-es/index.js +0 -1
- package/dist-es/models/enums.js +0 -31
- package/dist-es/pagination/index.js +0 -1
- package/dist-es/schemas/schemas_0.js +0 -168
- package/dist-types/AccessAnalyzer.d.ts +1 -74
- package/dist-types/AccessAnalyzerClient.d.ts +2 -9
- package/dist-types/commands/index.d.ts +0 -7
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/enums.d.ts +0 -71
- package/dist-types/models/models_0.d.ts +1 -316
- package/dist-types/pagination/index.d.ts +0 -1
- package/dist-types/schemas/schemas_0.d.ts +0 -26
- package/dist-types/ts3.4/AccessAnalyzer.d.ts +0 -150
- package/dist-types/ts3.4/AccessAnalyzerClient.d.ts +0 -42
- package/dist-types/ts3.4/commands/index.d.ts +0 -7
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/dist-types/ts3.4/models/enums.d.ts +0 -41
- package/dist-types/ts3.4/models/models_0.d.ts +0 -83
- package/dist-types/ts3.4/pagination/index.d.ts +0 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +0 -26
- package/package.json +33 -34
- package/dist-es/commands/CancelPolicyPreviewJobCommand.js +0 -16
- package/dist-es/commands/CreatePolicyPreviewConfigurationCommand.js +0 -16
- package/dist-es/commands/DeletePolicyPreviewConfigurationCommand.js +0 -16
- package/dist-es/commands/GetPolicyPreviewConfigurationCommand.js +0 -16
- package/dist-es/commands/GetPolicyPreviewJobCommand.js +0 -16
- package/dist-es/commands/ListPolicyPreviewJobsCommand.js +0 -16
- package/dist-es/commands/StartPolicyPreviewJobCommand.js +0 -16
- package/dist-es/pagination/ListPolicyPreviewJobsPaginator.js +0 -4
- package/dist-es/waiters/index.js +0 -2
- package/dist-es/waiters/waitForPolicyPreviewConfigurationActive.js +0 -54
- package/dist-es/waiters/waitForPolicyPreviewJobCompleted.js +0 -49
- package/dist-types/commands/CancelPolicyPreviewJobCommand.d.ts +0 -100
- package/dist-types/commands/CreatePolicyPreviewConfigurationCommand.d.ts +0 -109
- package/dist-types/commands/DeletePolicyPreviewConfigurationCommand.d.ts +0 -100
- package/dist-types/commands/GetPolicyPreviewConfigurationCommand.d.ts +0 -114
- package/dist-types/commands/GetPolicyPreviewJobCommand.d.ts +0 -187
- package/dist-types/commands/ListPolicyPreviewJobsCommand.d.ts +0 -137
- package/dist-types/commands/StartPolicyPreviewJobCommand.d.ts +0 -154
- package/dist-types/pagination/ListPolicyPreviewJobsPaginator.d.ts +0 -7
- package/dist-types/ts3.4/commands/CancelPolicyPreviewJobCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/CreatePolicyPreviewConfigurationCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/DeletePolicyPreviewConfigurationCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/GetPolicyPreviewConfigurationCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/GetPolicyPreviewJobCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/ListPolicyPreviewJobsCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/StartPolicyPreviewJobCommand.d.ts +0 -51
- package/dist-types/ts3.4/pagination/ListPolicyPreviewJobsPaginator.d.ts +0 -11
- package/dist-types/ts3.4/waiters/index.d.ts +0 -2
- package/dist-types/ts3.4/waiters/waitForPolicyPreviewConfigurationActive.d.ts +0 -11
- package/dist-types/ts3.4/waiters/waitForPolicyPreviewJobCompleted.d.ts +0 -11
- package/dist-types/waiters/index.d.ts +0 -2
- package/dist-types/waiters/waitForPolicyPreviewConfigurationActive.d.ts +0 -14
- package/dist-types/waiters/waitForPolicyPreviewJobCompleted.d.ts +0 -14
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
|
|
4
|
-
import type { DeletePolicyPreviewConfigurationRequest, DeletePolicyPreviewConfigurationResponse } from "../models/models_0";
|
|
5
|
-
/**
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export type { __MetadataBearer };
|
|
9
|
-
export { $Command };
|
|
10
|
-
/**
|
|
11
|
-
* @public
|
|
12
|
-
*
|
|
13
|
-
* The input for {@link DeletePolicyPreviewConfigurationCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface DeletePolicyPreviewConfigurationCommandInput extends DeletePolicyPreviewConfigurationRequest {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link DeletePolicyPreviewConfigurationCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface DeletePolicyPreviewConfigurationCommandOutput extends DeletePolicyPreviewConfigurationResponse, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const DeletePolicyPreviewConfigurationCommand_base: {
|
|
25
|
-
new (input: DeletePolicyPreviewConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePolicyPreviewConfigurationCommandInput, DeletePolicyPreviewConfigurationCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (...[input]: [] | [DeletePolicyPreviewConfigurationCommandInput]): import("@smithy/smithy-client").CommandImpl<DeletePolicyPreviewConfigurationCommandInput, DeletePolicyPreviewConfigurationCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* <p>Deletes the policy preview configuration for your account. After deletion, IAM Access Analyzer will stop collecting CloudTrail authorization events for policy preview analysis.</p>
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { AccessAnalyzerClient, DeletePolicyPreviewConfigurationCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
|
|
35
|
-
* // const { AccessAnalyzerClient, DeletePolicyPreviewConfigurationCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
|
|
36
|
-
* // import type { AccessAnalyzerClientConfig } from "@aws-sdk/client-accessanalyzer";
|
|
37
|
-
* const config = {}; // type is AccessAnalyzerClientConfig
|
|
38
|
-
* const client = new AccessAnalyzerClient(config);
|
|
39
|
-
* const input = { // DeletePolicyPreviewConfigurationRequest
|
|
40
|
-
* clientToken: "STRING_VALUE",
|
|
41
|
-
* };
|
|
42
|
-
* const command = new DeletePolicyPreviewConfigurationCommand(input);
|
|
43
|
-
* const response = await client.send(command);
|
|
44
|
-
* // {};
|
|
45
|
-
*
|
|
46
|
-
* ```
|
|
47
|
-
*
|
|
48
|
-
* @param DeletePolicyPreviewConfigurationCommandInput - {@link DeletePolicyPreviewConfigurationCommandInput}
|
|
49
|
-
* @returns {@link DeletePolicyPreviewConfigurationCommandOutput}
|
|
50
|
-
* @see {@link DeletePolicyPreviewConfigurationCommandInput} for command's `input` shape.
|
|
51
|
-
* @see {@link DeletePolicyPreviewConfigurationCommandOutput} for command's `response` shape.
|
|
52
|
-
* @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
|
|
53
|
-
*
|
|
54
|
-
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
-
* <p>You do not have sufficient access to perform this action.</p>
|
|
56
|
-
*
|
|
57
|
-
* @throws {@link InternalServerException} (server fault)
|
|
58
|
-
* <p>Internal server error.</p>
|
|
59
|
-
*
|
|
60
|
-
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
-
* <p>The specified resource could not be found.</p>
|
|
62
|
-
*
|
|
63
|
-
* @throws {@link ThrottlingException} (client fault)
|
|
64
|
-
* <p>Throttling limit exceeded error.</p>
|
|
65
|
-
*
|
|
66
|
-
* @throws {@link ValidationException} (client fault)
|
|
67
|
-
* <p>Validation exception error.</p>
|
|
68
|
-
*
|
|
69
|
-
* @throws {@link AccessAnalyzerServiceException}
|
|
70
|
-
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* @example Successfully deleted policy preview configuration
|
|
74
|
-
* ```javascript
|
|
75
|
-
* //
|
|
76
|
-
* const input = {
|
|
77
|
-
* clientToken: "unique-token-456"
|
|
78
|
-
* };
|
|
79
|
-
* const command = new DeletePolicyPreviewConfigurationCommand(input);
|
|
80
|
-
* const response = await client.send(command);
|
|
81
|
-
* /* response is
|
|
82
|
-
* { /* empty *\/ }
|
|
83
|
-
* *\/
|
|
84
|
-
* ```
|
|
85
|
-
*
|
|
86
|
-
* @public
|
|
87
|
-
*/
|
|
88
|
-
export declare class DeletePolicyPreviewConfigurationCommand extends DeletePolicyPreviewConfigurationCommand_base {
|
|
89
|
-
/** @internal type navigation helper, not in runtime. */
|
|
90
|
-
protected static __types: {
|
|
91
|
-
api: {
|
|
92
|
-
input: DeletePolicyPreviewConfigurationRequest;
|
|
93
|
-
output: {};
|
|
94
|
-
};
|
|
95
|
-
sdk: {
|
|
96
|
-
input: DeletePolicyPreviewConfigurationCommandInput;
|
|
97
|
-
output: DeletePolicyPreviewConfigurationCommandOutput;
|
|
98
|
-
};
|
|
99
|
-
};
|
|
100
|
-
}
|
|
@@ -1,114 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
|
|
4
|
-
import type { GetPolicyPreviewConfigurationRequest, GetPolicyPreviewConfigurationResponse } from "../models/models_0";
|
|
5
|
-
/**
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export type { __MetadataBearer };
|
|
9
|
-
export { $Command };
|
|
10
|
-
/**
|
|
11
|
-
* @public
|
|
12
|
-
*
|
|
13
|
-
* The input for {@link GetPolicyPreviewConfigurationCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface GetPolicyPreviewConfigurationCommandInput extends GetPolicyPreviewConfigurationRequest {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link GetPolicyPreviewConfigurationCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface GetPolicyPreviewConfigurationCommandOutput extends GetPolicyPreviewConfigurationResponse, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const GetPolicyPreviewConfigurationCommand_base: {
|
|
25
|
-
new (input: GetPolicyPreviewConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetPolicyPreviewConfigurationCommandInput, GetPolicyPreviewConfigurationCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (...[input]: [] | [GetPolicyPreviewConfigurationCommandInput]): import("@smithy/smithy-client").CommandImpl<GetPolicyPreviewConfigurationCommandInput, GetPolicyPreviewConfigurationCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* <p>Retrieves the policy preview configuration for your account.</p>
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { AccessAnalyzerClient, GetPolicyPreviewConfigurationCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
|
|
35
|
-
* // const { AccessAnalyzerClient, GetPolicyPreviewConfigurationCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
|
|
36
|
-
* // import type { AccessAnalyzerClientConfig } from "@aws-sdk/client-accessanalyzer";
|
|
37
|
-
* const config = {}; // type is AccessAnalyzerClientConfig
|
|
38
|
-
* const client = new AccessAnalyzerClient(config);
|
|
39
|
-
* const input = {};
|
|
40
|
-
* const command = new GetPolicyPreviewConfigurationCommand(input);
|
|
41
|
-
* const response = await client.send(command);
|
|
42
|
-
* // { // GetPolicyPreviewConfigurationResponse
|
|
43
|
-
* // policyPreviewConfigurations: [ // PolicyPreviewConfigurationList
|
|
44
|
-
* // { // PolicyPreviewConfiguration
|
|
45
|
-
* // scope: "STRING_VALUE", // required
|
|
46
|
-
* // status: "STRING_VALUE", // required
|
|
47
|
-
* // createdAt: new Date("TIMESTAMP"), // required
|
|
48
|
-
* // updatedAt: new Date("TIMESTAMP"),
|
|
49
|
-
* // },
|
|
50
|
-
* // ],
|
|
51
|
-
* // };
|
|
52
|
-
*
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* @param GetPolicyPreviewConfigurationCommandInput - {@link GetPolicyPreviewConfigurationCommandInput}
|
|
56
|
-
* @returns {@link GetPolicyPreviewConfigurationCommandOutput}
|
|
57
|
-
* @see {@link GetPolicyPreviewConfigurationCommandInput} for command's `input` shape.
|
|
58
|
-
* @see {@link GetPolicyPreviewConfigurationCommandOutput} for command's `response` shape.
|
|
59
|
-
* @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
|
|
60
|
-
*
|
|
61
|
-
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
-
* <p>You do not have sufficient access to perform this action.</p>
|
|
63
|
-
*
|
|
64
|
-
* @throws {@link InternalServerException} (server fault)
|
|
65
|
-
* <p>Internal server error.</p>
|
|
66
|
-
*
|
|
67
|
-
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
-
* <p>The specified resource could not be found.</p>
|
|
69
|
-
*
|
|
70
|
-
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
-
* <p>Throttling limit exceeded error.</p>
|
|
72
|
-
*
|
|
73
|
-
* @throws {@link ValidationException} (client fault)
|
|
74
|
-
* <p>Validation exception error.</p>
|
|
75
|
-
*
|
|
76
|
-
* @throws {@link AccessAnalyzerServiceException}
|
|
77
|
-
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* @example Successfully retrieved policy preview configuration
|
|
81
|
-
* ```javascript
|
|
82
|
-
* //
|
|
83
|
-
* const input = { /* empty *\/ };
|
|
84
|
-
* const command = new GetPolicyPreviewConfigurationCommand(input);
|
|
85
|
-
* const response = await client.send(command);
|
|
86
|
-
* /* response is
|
|
87
|
-
* {
|
|
88
|
-
* policyPreviewConfigurations: [
|
|
89
|
-
* {
|
|
90
|
-
* createdAt: "2023-05-01T10:00:00Z",
|
|
91
|
-
* scope: "GLOBAL",
|
|
92
|
-
* status: "ACTIVE",
|
|
93
|
-
* updatedAt: "2023-05-01T10:30:00Z"
|
|
94
|
-
* }
|
|
95
|
-
* ]
|
|
96
|
-
* }
|
|
97
|
-
* *\/
|
|
98
|
-
* ```
|
|
99
|
-
*
|
|
100
|
-
* @public
|
|
101
|
-
*/
|
|
102
|
-
export declare class GetPolicyPreviewConfigurationCommand extends GetPolicyPreviewConfigurationCommand_base {
|
|
103
|
-
/** @internal type navigation helper, not in runtime. */
|
|
104
|
-
protected static __types: {
|
|
105
|
-
api: {
|
|
106
|
-
input: {};
|
|
107
|
-
output: GetPolicyPreviewConfigurationResponse;
|
|
108
|
-
};
|
|
109
|
-
sdk: {
|
|
110
|
-
input: GetPolicyPreviewConfigurationCommandInput;
|
|
111
|
-
output: GetPolicyPreviewConfigurationCommandOutput;
|
|
112
|
-
};
|
|
113
|
-
};
|
|
114
|
-
}
|
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
|
|
4
|
-
import type { GetPolicyPreviewJobRequest, GetPolicyPreviewJobResponse } from "../models/models_0";
|
|
5
|
-
/**
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export type { __MetadataBearer };
|
|
9
|
-
export { $Command };
|
|
10
|
-
/**
|
|
11
|
-
* @public
|
|
12
|
-
*
|
|
13
|
-
* The input for {@link GetPolicyPreviewJobCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface GetPolicyPreviewJobCommandInput extends GetPolicyPreviewJobRequest {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link GetPolicyPreviewJobCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface GetPolicyPreviewJobCommandOutput extends GetPolicyPreviewJobResponse, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const GetPolicyPreviewJobCommand_base: {
|
|
25
|
-
new (input: GetPolicyPreviewJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetPolicyPreviewJobCommandInput, GetPolicyPreviewJobCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (input: GetPolicyPreviewJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetPolicyPreviewJobCommandInput, GetPolicyPreviewJobCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* <p>Retrieves the metadata, parameters, and status for a policy preview job. Use this operation to monitor job progress and retrieve the Amazon S3 location of the completed analysis report.</p> <note> <p>Job data has a time-to-live (TTL) of 14 days and will be deleted after expiration.</p> </note>
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { AccessAnalyzerClient, GetPolicyPreviewJobCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
|
|
35
|
-
* // const { AccessAnalyzerClient, GetPolicyPreviewJobCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
|
|
36
|
-
* // import type { AccessAnalyzerClientConfig } from "@aws-sdk/client-accessanalyzer";
|
|
37
|
-
* const config = {}; // type is AccessAnalyzerClientConfig
|
|
38
|
-
* const client = new AccessAnalyzerClient(config);
|
|
39
|
-
* const input = { // GetPolicyPreviewJobRequest
|
|
40
|
-
* jobId: "STRING_VALUE", // required
|
|
41
|
-
* };
|
|
42
|
-
* const command = new GetPolicyPreviewJobCommand(input);
|
|
43
|
-
* const response = await client.send(command);
|
|
44
|
-
* // { // GetPolicyPreviewJobResponse
|
|
45
|
-
* // jobId: "STRING_VALUE", // required
|
|
46
|
-
* // jobParameters: { // PolicyPreviewJobParameters
|
|
47
|
-
* // startTime: new Date("TIMESTAMP"), // required
|
|
48
|
-
* // endTime: new Date("TIMESTAMP"), // required
|
|
49
|
-
* // policyConfigurations: [ // PolicyConfigurationsList // required
|
|
50
|
-
* // { // PolicyConfiguration
|
|
51
|
-
* // jobType: "STRING_VALUE", // required
|
|
52
|
-
* // targetId: "STRING_VALUE", // required
|
|
53
|
-
* // policyDocumentsList: [ // PolicyDocumentList // required
|
|
54
|
-
* // "STRING_VALUE",
|
|
55
|
-
* // ],
|
|
56
|
-
* // },
|
|
57
|
-
* // ],
|
|
58
|
-
* // },
|
|
59
|
-
* // jobDetails: { // PolicyPreviewJobDetails
|
|
60
|
-
* // jobStatus: "STRING_VALUE", // required
|
|
61
|
-
* // submittedAt: new Date("TIMESTAMP"), // required
|
|
62
|
-
* // startedAt: new Date("TIMESTAMP"),
|
|
63
|
-
* // completedAt: new Date("TIMESTAMP"),
|
|
64
|
-
* // jobError: { // JobError
|
|
65
|
-
* // code: "STRING_VALUE", // required
|
|
66
|
-
* // message: "STRING_VALUE", // required
|
|
67
|
-
* // },
|
|
68
|
-
* // },
|
|
69
|
-
* // outputS3Uri: "STRING_VALUE", // required
|
|
70
|
-
* // };
|
|
71
|
-
*
|
|
72
|
-
* ```
|
|
73
|
-
*
|
|
74
|
-
* @param GetPolicyPreviewJobCommandInput - {@link GetPolicyPreviewJobCommandInput}
|
|
75
|
-
* @returns {@link GetPolicyPreviewJobCommandOutput}
|
|
76
|
-
* @see {@link GetPolicyPreviewJobCommandInput} for command's `input` shape.
|
|
77
|
-
* @see {@link GetPolicyPreviewJobCommandOutput} for command's `response` shape.
|
|
78
|
-
* @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
|
|
79
|
-
*
|
|
80
|
-
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
-
* <p>You do not have sufficient access to perform this action.</p>
|
|
82
|
-
*
|
|
83
|
-
* @throws {@link InternalServerException} (server fault)
|
|
84
|
-
* <p>Internal server error.</p>
|
|
85
|
-
*
|
|
86
|
-
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
-
* <p>The specified resource could not be found.</p>
|
|
88
|
-
*
|
|
89
|
-
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
-
* <p>Throttling limit exceeded error.</p>
|
|
91
|
-
*
|
|
92
|
-
* @throws {@link ValidationException} (client fault)
|
|
93
|
-
* <p>Validation exception error.</p>
|
|
94
|
-
*
|
|
95
|
-
* @throws {@link AccessAnalyzerServiceException}
|
|
96
|
-
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
* @example Successfully fetched completed policy preview job
|
|
100
|
-
* ```javascript
|
|
101
|
-
* //
|
|
102
|
-
* const input = {
|
|
103
|
-
* jobId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
104
|
-
* };
|
|
105
|
-
* const command = new GetPolicyPreviewJobCommand(input);
|
|
106
|
-
* const response = await client.send(command);
|
|
107
|
-
* /* response is
|
|
108
|
-
* {
|
|
109
|
-
* jobDetails: {
|
|
110
|
-
* completedAt: "2023-05-01T10:30:00Z",
|
|
111
|
-
* jobStatus: "COMPLETED",
|
|
112
|
-
* startedAt: "2023-05-01T10:01:00Z",
|
|
113
|
-
* submittedAt: "2023-05-01T10:00:00Z"
|
|
114
|
-
* },
|
|
115
|
-
* jobId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
116
|
-
* jobParameters: {
|
|
117
|
-
* endTime: "2023-12-31T23:59:59Z",
|
|
118
|
-
* policyConfigurations: [
|
|
119
|
-
* {
|
|
120
|
-
* jobType: "SCP",
|
|
121
|
-
* policyDocumentsList: [
|
|
122
|
-
* `{"Version":"2012-10-17","Statement":[{"Sid":"AllowS3Access","Effect":"Allow","Action":["s3:GetObject","s3:PutObject","s3:ListBucket"],"Resource":["arn:aws:s3:::example-bucket","arn:aws:s3:::example-bucket/*"]}]}`
|
|
123
|
-
* ],
|
|
124
|
-
* targetId: "123456789012"
|
|
125
|
-
* }
|
|
126
|
-
* ],
|
|
127
|
-
* startTime: "2023-01-01T00:00:00Z"
|
|
128
|
-
* },
|
|
129
|
-
* outputS3Uri: "s3://bucket/path"
|
|
130
|
-
* }
|
|
131
|
-
* *\/
|
|
132
|
-
* ```
|
|
133
|
-
*
|
|
134
|
-
* @example Failed policy preview job
|
|
135
|
-
* ```javascript
|
|
136
|
-
* //
|
|
137
|
-
* const input = {
|
|
138
|
-
* jobId: "b2c3d4e5-f6a7-8901-bcde-f12345678901"
|
|
139
|
-
* };
|
|
140
|
-
* const command = new GetPolicyPreviewJobCommand(input);
|
|
141
|
-
* const response = await client.send(command);
|
|
142
|
-
* /* response is
|
|
143
|
-
* {
|
|
144
|
-
* jobDetails: {
|
|
145
|
-
* completedAt: "2023-05-01T10:05:00Z",
|
|
146
|
-
* jobError: {
|
|
147
|
-
* code: "SERVICE_ERROR",
|
|
148
|
-
* message: "Service error occurred during job execution."
|
|
149
|
-
* },
|
|
150
|
-
* jobStatus: "FAILED",
|
|
151
|
-
* startedAt: "2023-05-01T10:01:00Z",
|
|
152
|
-
* submittedAt: "2023-05-01T10:00:00Z"
|
|
153
|
-
* },
|
|
154
|
-
* jobId: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
|
|
155
|
-
* jobParameters: {
|
|
156
|
-
* endTime: "2023-12-31T23:59:59Z",
|
|
157
|
-
* policyConfigurations: [
|
|
158
|
-
* {
|
|
159
|
-
* jobType: "SCP",
|
|
160
|
-
* policyDocumentsList: [
|
|
161
|
-
* `{"Version":"2012-10-17","Statement":[{"Sid":"AllowS3Access","Effect":"Allow","Action":["s3:GetObject","s3:PutObject","s3:ListBucket"],"Resource":["arn:aws:s3:::example-bucket","arn:aws:s3:::example-bucket/*"]}]}`
|
|
162
|
-
* ],
|
|
163
|
-
* targetId: "123456789012"
|
|
164
|
-
* }
|
|
165
|
-
* ],
|
|
166
|
-
* startTime: "2023-01-01T00:00:00Z"
|
|
167
|
-
* },
|
|
168
|
-
* outputS3Uri: "s3://bucket/path"
|
|
169
|
-
* }
|
|
170
|
-
* *\/
|
|
171
|
-
* ```
|
|
172
|
-
*
|
|
173
|
-
* @public
|
|
174
|
-
*/
|
|
175
|
-
export declare class GetPolicyPreviewJobCommand extends GetPolicyPreviewJobCommand_base {
|
|
176
|
-
/** @internal type navigation helper, not in runtime. */
|
|
177
|
-
protected static __types: {
|
|
178
|
-
api: {
|
|
179
|
-
input: GetPolicyPreviewJobRequest;
|
|
180
|
-
output: GetPolicyPreviewJobResponse;
|
|
181
|
-
};
|
|
182
|
-
sdk: {
|
|
183
|
-
input: GetPolicyPreviewJobCommandInput;
|
|
184
|
-
output: GetPolicyPreviewJobCommandOutput;
|
|
185
|
-
};
|
|
186
|
-
};
|
|
187
|
-
}
|
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
|
|
4
|
-
import type { ListPolicyPreviewJobsRequest, ListPolicyPreviewJobsResponse } from "../models/models_0";
|
|
5
|
-
/**
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export type { __MetadataBearer };
|
|
9
|
-
export { $Command };
|
|
10
|
-
/**
|
|
11
|
-
* @public
|
|
12
|
-
*
|
|
13
|
-
* The input for {@link ListPolicyPreviewJobsCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface ListPolicyPreviewJobsCommandInput extends ListPolicyPreviewJobsRequest {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link ListPolicyPreviewJobsCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface ListPolicyPreviewJobsCommandOutput extends ListPolicyPreviewJobsResponse, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const ListPolicyPreviewJobsCommand_base: {
|
|
25
|
-
new (input: ListPolicyPreviewJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPolicyPreviewJobsCommandInput, ListPolicyPreviewJobsCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (...[input]: [] | [ListPolicyPreviewJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPolicyPreviewJobsCommandInput, ListPolicyPreviewJobsCommandOutput, AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* <p>Lists all policy preview jobs with optional filtering by job status or target ID. Results are paginated for efficient retrieval of large result sets.</p>
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { AccessAnalyzerClient, ListPolicyPreviewJobsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
|
|
35
|
-
* // const { AccessAnalyzerClient, ListPolicyPreviewJobsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
|
|
36
|
-
* // import type { AccessAnalyzerClientConfig } from "@aws-sdk/client-accessanalyzer";
|
|
37
|
-
* const config = {}; // type is AccessAnalyzerClientConfig
|
|
38
|
-
* const client = new AccessAnalyzerClient(config);
|
|
39
|
-
* const input = { // ListPolicyPreviewJobsRequest
|
|
40
|
-
* filters: { // PolicyPreviewJobFiltersMap
|
|
41
|
-
* "<keys>": "STRING_VALUE",
|
|
42
|
-
* },
|
|
43
|
-
* maxResults: Number("int"),
|
|
44
|
-
* nextToken: "STRING_VALUE",
|
|
45
|
-
* };
|
|
46
|
-
* const command = new ListPolicyPreviewJobsCommand(input);
|
|
47
|
-
* const response = await client.send(command);
|
|
48
|
-
* // { // ListPolicyPreviewJobsResponse
|
|
49
|
-
* // analysisReports: [ // PolicyPreviewAnalysisReports // required
|
|
50
|
-
* // { // PolicyPreviewAnalysisReport
|
|
51
|
-
* // jobId: "STRING_VALUE", // required
|
|
52
|
-
* // status: "STRING_VALUE", // required
|
|
53
|
-
* // submittedAt: new Date("TIMESTAMP"), // required
|
|
54
|
-
* // startedAt: new Date("TIMESTAMP"),
|
|
55
|
-
* // completedAt: new Date("TIMESTAMP"),
|
|
56
|
-
* // outputS3Uri: "STRING_VALUE", // required
|
|
57
|
-
* // },
|
|
58
|
-
* // ],
|
|
59
|
-
* // nextToken: "STRING_VALUE",
|
|
60
|
-
* // };
|
|
61
|
-
*
|
|
62
|
-
* ```
|
|
63
|
-
*
|
|
64
|
-
* @param ListPolicyPreviewJobsCommandInput - {@link ListPolicyPreviewJobsCommandInput}
|
|
65
|
-
* @returns {@link ListPolicyPreviewJobsCommandOutput}
|
|
66
|
-
* @see {@link ListPolicyPreviewJobsCommandInput} for command's `input` shape.
|
|
67
|
-
* @see {@link ListPolicyPreviewJobsCommandOutput} for command's `response` shape.
|
|
68
|
-
* @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
|
|
69
|
-
*
|
|
70
|
-
* @throws {@link AccessDeniedException} (client fault)
|
|
71
|
-
* <p>You do not have sufficient access to perform this action.</p>
|
|
72
|
-
*
|
|
73
|
-
* @throws {@link InternalServerException} (server fault)
|
|
74
|
-
* <p>Internal server error.</p>
|
|
75
|
-
*
|
|
76
|
-
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
-
* <p>Throttling limit exceeded error.</p>
|
|
78
|
-
*
|
|
79
|
-
* @throws {@link ValidationException} (client fault)
|
|
80
|
-
* <p>Validation exception error.</p>
|
|
81
|
-
*
|
|
82
|
-
* @throws {@link AccessAnalyzerServiceException}
|
|
83
|
-
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* @example Successfully listed policy preview jobs with filters
|
|
87
|
-
* ```javascript
|
|
88
|
-
* //
|
|
89
|
-
* const input = {
|
|
90
|
-
* filters: {
|
|
91
|
-
* jobStatus: "COMPLETED"
|
|
92
|
-
* },
|
|
93
|
-
* maxResults: 10,
|
|
94
|
-
* nextToken: "token-123"
|
|
95
|
-
* };
|
|
96
|
-
* const command = new ListPolicyPreviewJobsCommand(input);
|
|
97
|
-
* const response = await client.send(command);
|
|
98
|
-
* /* response is
|
|
99
|
-
* {
|
|
100
|
-
* analysisReports: [
|
|
101
|
-
* {
|
|
102
|
-
* completedAt: "2023-05-01T10:30:00Z",
|
|
103
|
-
* jobId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
104
|
-
* outputS3Uri: "s3://bucket/path",
|
|
105
|
-
* startedAt: "2023-05-01T10:01:00Z",
|
|
106
|
-
* status: "COMPLETED",
|
|
107
|
-
* submittedAt: "2023-05-01T10:00:00Z"
|
|
108
|
-
* },
|
|
109
|
-
* {
|
|
110
|
-
* completedAt: "2023-05-02T10:30:00Z",
|
|
111
|
-
* jobId: "c3d4e5f6-a7b8-9012-cdef-123456789012",
|
|
112
|
-
* outputS3Uri: "s3://bucket/path",
|
|
113
|
-
* startedAt: "2023-05-02T10:01:00Z",
|
|
114
|
-
* status: "COMPLETED",
|
|
115
|
-
* submittedAt: "2023-05-02T10:00:00Z"
|
|
116
|
-
* }
|
|
117
|
-
* ],
|
|
118
|
-
* nextToken: "token-456"
|
|
119
|
-
* }
|
|
120
|
-
* *\/
|
|
121
|
-
* ```
|
|
122
|
-
*
|
|
123
|
-
* @public
|
|
124
|
-
*/
|
|
125
|
-
export declare class ListPolicyPreviewJobsCommand extends ListPolicyPreviewJobsCommand_base {
|
|
126
|
-
/** @internal type navigation helper, not in runtime. */
|
|
127
|
-
protected static __types: {
|
|
128
|
-
api: {
|
|
129
|
-
input: ListPolicyPreviewJobsRequest;
|
|
130
|
-
output: ListPolicyPreviewJobsResponse;
|
|
131
|
-
};
|
|
132
|
-
sdk: {
|
|
133
|
-
input: ListPolicyPreviewJobsCommandInput;
|
|
134
|
-
output: ListPolicyPreviewJobsCommandOutput;
|
|
135
|
-
};
|
|
136
|
-
};
|
|
137
|
-
}
|