@aws-sdk/client-inspector 3.288.0 → 3.290.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/dist-types/commands/AddAttributesToFindingsCommand.d.ts +42 -0
- package/dist-types/commands/CreateAssessmentTargetCommand.d.ts +43 -0
- package/dist-types/commands/CreateAssessmentTemplateCommand.d.ts +49 -0
- package/dist-types/commands/CreateExclusionsPreviewCommand.d.ts +22 -0
- package/dist-types/commands/CreateResourceGroupCommand.d.ts +39 -0
- package/dist-types/commands/DeleteAssessmentRunCommand.d.ts +33 -0
- package/dist-types/commands/DeleteAssessmentTargetCommand.d.ts +33 -0
- package/dist-types/commands/DeleteAssessmentTemplateCommand.d.ts +33 -0
- package/dist-types/commands/DescribeAssessmentRunsCommand.d.ts +86 -0
- package/dist-types/commands/DescribeAssessmentTargetsCommand.d.ts +35 -0
- package/dist-types/commands/DescribeAssessmentTemplatesCommand.d.ts +40 -0
- package/dist-types/commands/DescribeCrossAccountAccessRoleCommand.d.ts +20 -0
- package/dist-types/commands/DescribeExclusionsCommand.d.ts +8 -0
- package/dist-types/commands/DescribeFindingsCommand.d.ts +54 -0
- package/dist-types/commands/DescribeResourceGroupsCommand.d.ts +38 -0
- package/dist-types/commands/DescribeRulesPackagesCommand.d.ts +35 -0
- package/dist-types/commands/GetAssessmentReportCommand.d.ts +29 -0
- package/dist-types/commands/GetExclusionsPreviewCommand.d.ts +15 -0
- package/dist-types/commands/GetTelemetryMetadataCommand.d.ts +177 -0
- package/dist-types/commands/ListAssessmentRunAgentsCommand.d.ts +187 -0
- package/dist-types/commands/ListAssessmentRunsCommand.d.ts +38 -0
- package/dist-types/commands/ListAssessmentTargetsCommand.d.ts +30 -0
- package/dist-types/commands/ListAssessmentTemplatesCommand.d.ts +38 -0
- package/dist-types/commands/ListEventSubscriptionsCommand.d.ts +44 -0
- package/dist-types/commands/ListExclusionsCommand.d.ts +15 -0
- package/dist-types/commands/ListFindingsCommand.d.ts +38 -0
- package/dist-types/commands/ListRulesPackagesCommand.d.ts +33 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +36 -0
- package/dist-types/commands/PreviewAgentsCommand.d.ts +41 -0
- package/dist-types/commands/RegisterCrossAccountAccessRoleCommand.d.ts +29 -0
- package/dist-types/commands/RemoveAttributesFromFindingsCommand.d.ts +39 -0
- package/dist-types/commands/SetTagsForResourceCommand.d.ts +35 -0
- package/dist-types/commands/StartAssessmentRunCommand.d.ts +47 -0
- package/dist-types/commands/StopAssessmentRunCommand.d.ts +29 -0
- package/dist-types/commands/SubscribeToEventCommand.d.ts +35 -0
- package/dist-types/commands/UnsubscribeFromEventCommand.d.ts +31 -0
- package/dist-types/commands/UpdateAssessmentTargetCommand.d.ts +31 -0
- package/package.json +29 -29
|
@@ -30,6 +30,50 @@ export interface ListEventSubscriptionsCommandOutput extends ListEventSubscripti
|
|
|
30
30
|
* @see {@link ListEventSubscriptionsCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
40
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
41
|
+
* input parameter.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
44
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
45
|
+
* error code describes the entity.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
48
|
+
* @example List event subscriptions
|
|
49
|
+
* ```javascript
|
|
50
|
+
* // Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.
|
|
51
|
+
* const input = {
|
|
52
|
+
* "maxResults": 123,
|
|
53
|
+
* "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0"
|
|
54
|
+
* };
|
|
55
|
+
* const command = new ListEventSubscriptionsCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* /* response ==
|
|
58
|
+
* {
|
|
59
|
+
* "nextToken": "1",
|
|
60
|
+
* "subscriptions": [
|
|
61
|
+
* {
|
|
62
|
+
* "eventSubscriptions": [
|
|
63
|
+
* {
|
|
64
|
+
* "event": "ASSESSMENT_RUN_COMPLETED",
|
|
65
|
+
* "subscribedAt": "1459455440.867"
|
|
66
|
+
* }
|
|
67
|
+
* ],
|
|
68
|
+
* "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0",
|
|
69
|
+
* "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic"
|
|
70
|
+
* }
|
|
71
|
+
* ]
|
|
72
|
+
* }
|
|
73
|
+
* *\/
|
|
74
|
+
* // example id: list-event-subscriptions-1481068376945
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
33
77
|
*/
|
|
34
78
|
export declare class ListEventSubscriptionsCommand extends $Command<ListEventSubscriptionsCommandInput, ListEventSubscriptionsCommandOutput, InspectorClientResolvedConfig> {
|
|
35
79
|
readonly input: ListEventSubscriptionsCommandInput;
|
|
@@ -29,6 +29,21 @@ export interface ListExclusionsCommandOutput extends ListExclusionsResponse, __M
|
|
|
29
29
|
* @see {@link ListExclusionsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
33
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InternalException} (server fault)
|
|
36
|
+
* <p>Internal server error.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
39
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
40
|
+
* input parameter.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
43
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
44
|
+
* error code describes the entity.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
32
47
|
*/
|
|
33
48
|
export declare class ListExclusionsCommand extends $Command<ListExclusionsCommandInput, ListExclusionsCommandOutput, InspectorClientResolvedConfig> {
|
|
34
49
|
readonly input: ListExclusionsCommandInput;
|
|
@@ -30,6 +30,44 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad
|
|
|
30
30
|
* @see {@link ListFindingsCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
40
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
41
|
+
* input parameter.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
44
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
45
|
+
* error code describes the entity.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
48
|
+
* @example List findings
|
|
49
|
+
* ```javascript
|
|
50
|
+
* // Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
|
|
51
|
+
* const input = {
|
|
52
|
+
* "assessmentRunArns": [
|
|
53
|
+
* "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE"
|
|
54
|
+
* ],
|
|
55
|
+
* "maxResults": 123
|
|
56
|
+
* };
|
|
57
|
+
* const command = new ListFindingsCommand(input);
|
|
58
|
+
* const response = await client.send(command);
|
|
59
|
+
* /* response ==
|
|
60
|
+
* {
|
|
61
|
+
* "findingArns": [
|
|
62
|
+
* "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4",
|
|
63
|
+
* "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy"
|
|
64
|
+
* ],
|
|
65
|
+
* "nextToken": "1"
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: list-findings-1481066840611
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
33
71
|
*/
|
|
34
72
|
export declare class ListFindingsCommand extends $Command<ListFindingsCommandInput, ListFindingsCommandOutput, InspectorClientResolvedConfig> {
|
|
35
73
|
readonly input: ListFindingsCommandInput;
|
|
@@ -29,6 +29,39 @@ export interface ListRulesPackagesCommandOutput extends ListRulesPackagesRespons
|
|
|
29
29
|
* @see {@link ListRulesPackagesCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
33
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InternalException} (server fault)
|
|
36
|
+
* <p>Internal server error.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
39
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
40
|
+
* input parameter.</p>
|
|
41
|
+
*
|
|
42
|
+
*
|
|
43
|
+
* @example List rules packages
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // Lists all available Amazon Inspector rules packages.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "maxResults": 123
|
|
48
|
+
* };
|
|
49
|
+
* const command = new ListRulesPackagesCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "nextToken": "1",
|
|
54
|
+
* "rulesPackageArns": [
|
|
55
|
+
* "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p",
|
|
56
|
+
* "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc",
|
|
57
|
+
* "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
|
|
58
|
+
* "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD"
|
|
59
|
+
* ]
|
|
60
|
+
* }
|
|
61
|
+
* *\/
|
|
62
|
+
* // example id: list-rules-packages-1481066954883
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
32
65
|
*/
|
|
33
66
|
export declare class ListRulesPackagesCommand extends $Command<ListRulesPackagesCommandInput, ListRulesPackagesCommandOutput, InspectorClientResolvedConfig> {
|
|
34
67
|
readonly input: ListRulesPackagesCommandInput;
|
|
@@ -29,6 +29,42 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
29
29
|
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
33
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InternalException} (server fault)
|
|
36
|
+
* <p>Internal server error.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
39
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
40
|
+
* input parameter.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
43
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
44
|
+
* error code describes the entity.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
47
|
+
* @example List tags for resource
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // Lists all tags associated with an assessment template.
|
|
50
|
+
* const input = {
|
|
51
|
+
* "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu"
|
|
52
|
+
* };
|
|
53
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* /* response ==
|
|
56
|
+
* {
|
|
57
|
+
* "tags": [
|
|
58
|
+
* {
|
|
59
|
+
* "key": "Name",
|
|
60
|
+
* "value": "Example"
|
|
61
|
+
* }
|
|
62
|
+
* ]
|
|
63
|
+
* }
|
|
64
|
+
* *\/
|
|
65
|
+
* // example id: list-tags-for-resource-1481067025240
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
32
68
|
*/
|
|
33
69
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, InspectorClientResolvedConfig> {
|
|
34
70
|
readonly input: ListTagsForResourceCommandInput;
|
|
@@ -30,6 +30,47 @@ export interface PreviewAgentsCommandOutput extends PreviewAgentsResponse, __Met
|
|
|
30
30
|
* @see {@link PreviewAgentsCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidCrossAccountRoleException} (client fault)
|
|
40
|
+
* <p>Amazon Inspector cannot assume the cross-account role that it needs to list your EC2
|
|
41
|
+
* instances during the assessment run.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
44
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
45
|
+
* input parameter.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
48
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
49
|
+
* error code describes the entity.</p>
|
|
50
|
+
*
|
|
51
|
+
*
|
|
52
|
+
* @example Preview agents
|
|
53
|
+
* ```javascript
|
|
54
|
+
* // Previews the agents installed on the EC2 instances that are part of the specified assessment target.
|
|
55
|
+
* const input = {
|
|
56
|
+
* "maxResults": 123,
|
|
57
|
+
* "previewAgentsArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
|
|
58
|
+
* };
|
|
59
|
+
* const command = new PreviewAgentsCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* /* response ==
|
|
62
|
+
* {
|
|
63
|
+
* "agentPreviews": [
|
|
64
|
+
* {
|
|
65
|
+
* "agentId": "i-49113b93"
|
|
66
|
+
* }
|
|
67
|
+
* ],
|
|
68
|
+
* "nextToken": "1"
|
|
69
|
+
* }
|
|
70
|
+
* *\/
|
|
71
|
+
* // example id: preview-agents-1481067101888
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
33
74
|
*/
|
|
34
75
|
export declare class PreviewAgentsCommand extends $Command<PreviewAgentsCommandInput, PreviewAgentsCommandOutput, InspectorClientResolvedConfig> {
|
|
35
76
|
readonly input: PreviewAgentsCommandInput;
|
|
@@ -30,6 +30,35 @@ export interface RegisterCrossAccountAccessRoleCommandOutput extends __MetadataB
|
|
|
30
30
|
* @see {@link RegisterCrossAccountAccessRoleCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidCrossAccountRoleException} (client fault)
|
|
40
|
+
* <p>Amazon Inspector cannot assume the cross-account role that it needs to list your EC2
|
|
41
|
+
* instances during the assessment run.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
44
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
45
|
+
* input parameter.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
48
|
+
* <p>The serice is temporary unavailable.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
* @example Register cross account access role
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "roleArn": "arn:aws:iam::123456789012:role/inspector"
|
|
56
|
+
* };
|
|
57
|
+
* const command = new RegisterCrossAccountAccessRoleCommand(input);
|
|
58
|
+
* await client.send(command);
|
|
59
|
+
* // example id: register-cross-account-access-role-1481067178301
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
33
62
|
*/
|
|
34
63
|
export declare class RegisterCrossAccountAccessRoleCommand extends $Command<RegisterCrossAccountAccessRoleCommandInput, RegisterCrossAccountAccessRoleCommandOutput, InspectorClientResolvedConfig> {
|
|
35
64
|
readonly input: RegisterCrossAccountAccessRoleCommandInput;
|
|
@@ -30,6 +30,45 @@ export interface RemoveAttributesFromFindingsCommandOutput extends RemoveAttribu
|
|
|
30
30
|
* @see {@link RemoveAttributesFromFindingsCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
40
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
41
|
+
* input parameter.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
44
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
45
|
+
* error code describes the entity.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
48
|
+
* <p>The serice is temporary unavailable.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
* @example Remove attributes from findings
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "attributeKeys": [
|
|
56
|
+
* "key=Example,value=example"
|
|
57
|
+
* ],
|
|
58
|
+
* "findingArns": [
|
|
59
|
+
* "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU"
|
|
60
|
+
* ]
|
|
61
|
+
* };
|
|
62
|
+
* const command = new RemoveAttributesFromFindingsCommand(input);
|
|
63
|
+
* const response = await client.send(command);
|
|
64
|
+
* /* response ==
|
|
65
|
+
* {
|
|
66
|
+
* "failedItems": {}
|
|
67
|
+
* }
|
|
68
|
+
* *\/
|
|
69
|
+
* // example id: remove-attributes-from-findings-1481067246548
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
33
72
|
*/
|
|
34
73
|
export declare class RemoveAttributesFromFindingsCommand extends $Command<RemoveAttributesFromFindingsCommandInput, RemoveAttributesFromFindingsCommandOutput, InspectorClientResolvedConfig> {
|
|
35
74
|
readonly input: RemoveAttributesFromFindingsCommandInput;
|
|
@@ -30,6 +30,41 @@ export interface SetTagsForResourceCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* @see {@link SetTagsForResourceCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
40
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
41
|
+
* input parameter.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
44
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
45
|
+
* error code describes the entity.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
48
|
+
* <p>The serice is temporary unavailable.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
* @example Set tags for resource
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0",
|
|
56
|
+
* "tags": [
|
|
57
|
+
* {
|
|
58
|
+
* "key": "Example",
|
|
59
|
+
* "value": "example"
|
|
60
|
+
* }
|
|
61
|
+
* ]
|
|
62
|
+
* };
|
|
63
|
+
* const command = new SetTagsForResourceCommand(input);
|
|
64
|
+
* await client.send(command);
|
|
65
|
+
* // example id: set-tags-for-resource-1481067329646
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
33
68
|
*/
|
|
34
69
|
export declare class SetTagsForResourceCommand extends $Command<SetTagsForResourceCommandInput, SetTagsForResourceCommandOutput, InspectorClientResolvedConfig> {
|
|
35
70
|
readonly input: SetTagsForResourceCommandInput;
|
|
@@ -31,6 +31,53 @@ export interface StartAssessmentRunCommandOutput extends StartAssessmentRunRespo
|
|
|
31
31
|
* @see {@link StartAssessmentRunCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
35
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link AgentsAlreadyRunningAssessmentException} (client fault)
|
|
38
|
+
* <p>You started an assessment run, but one of the instances is already participating in
|
|
39
|
+
* another assessment run.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InternalException} (server fault)
|
|
42
|
+
* <p>Internal server error.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidCrossAccountRoleException} (client fault)
|
|
45
|
+
* <p>Amazon Inspector cannot assume the cross-account role that it needs to list your EC2
|
|
46
|
+
* instances during the assessment run.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
49
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
50
|
+
* input parameter.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
53
|
+
* <p>The request was rejected because it attempted to create resources beyond the current
|
|
54
|
+
* AWS account limits. The error code describes the limit exceeded.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
57
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
58
|
+
* error code describes the entity.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
61
|
+
* <p>The serice is temporary unavailable.</p>
|
|
62
|
+
*
|
|
63
|
+
*
|
|
64
|
+
* @example Start assessment run
|
|
65
|
+
* ```javascript
|
|
66
|
+
* // Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.
|
|
67
|
+
* const input = {
|
|
68
|
+
* "assessmentRunName": "examplerun",
|
|
69
|
+
* "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
|
|
70
|
+
* };
|
|
71
|
+
* const command = new StartAssessmentRunCommand(input);
|
|
72
|
+
* const response = await client.send(command);
|
|
73
|
+
* /* response ==
|
|
74
|
+
* {
|
|
75
|
+
* "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY"
|
|
76
|
+
* }
|
|
77
|
+
* *\/
|
|
78
|
+
* // example id: start-assessment-run-1481067407484
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
34
81
|
*/
|
|
35
82
|
export declare class StartAssessmentRunCommand extends $Command<StartAssessmentRunCommandInput, StartAssessmentRunCommandOutput, InspectorClientResolvedConfig> {
|
|
36
83
|
readonly input: StartAssessmentRunCommandInput;
|
|
@@ -30,6 +30,35 @@ export interface StopAssessmentRunCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* @see {@link StopAssessmentRunCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
40
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
41
|
+
* input parameter.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
44
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
45
|
+
* error code describes the entity.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
48
|
+
* <p>The serice is temporary unavailable.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
* @example Stop assessment run
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // Stops the assessment run that is specified by the ARN of the assessment run.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe"
|
|
56
|
+
* };
|
|
57
|
+
* const command = new StopAssessmentRunCommand(input);
|
|
58
|
+
* await client.send(command);
|
|
59
|
+
* // example id: stop-assessment-run-1481067502857
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
33
62
|
*/
|
|
34
63
|
export declare class StopAssessmentRunCommand extends $Command<StopAssessmentRunCommandInput, StopAssessmentRunCommandOutput, InspectorClientResolvedConfig> {
|
|
35
64
|
readonly input: StopAssessmentRunCommandInput;
|
|
@@ -30,6 +30,41 @@ export interface SubscribeToEventCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* @see {@link SubscribeToEventCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
40
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
41
|
+
* input parameter.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
44
|
+
* <p>The request was rejected because it attempted to create resources beyond the current
|
|
45
|
+
* AWS account limits. The error code describes the limit exceeded.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
48
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
49
|
+
* error code describes the entity.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
52
|
+
* <p>The serice is temporary unavailable.</p>
|
|
53
|
+
*
|
|
54
|
+
*
|
|
55
|
+
* @example Subscribe to event
|
|
56
|
+
* ```javascript
|
|
57
|
+
* // Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
|
|
58
|
+
* const input = {
|
|
59
|
+
* "event": "ASSESSMENT_RUN_COMPLETED",
|
|
60
|
+
* "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0",
|
|
61
|
+
* "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic"
|
|
62
|
+
* };
|
|
63
|
+
* const command = new SubscribeToEventCommand(input);
|
|
64
|
+
* await client.send(command);
|
|
65
|
+
* // example id: subscribe-to-event-1481067686031
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
33
68
|
*/
|
|
34
69
|
export declare class SubscribeToEventCommand extends $Command<SubscribeToEventCommandInput, SubscribeToEventCommandOutput, InspectorClientResolvedConfig> {
|
|
35
70
|
readonly input: SubscribeToEventCommandInput;
|
|
@@ -30,6 +30,37 @@ export interface UnsubscribeFromEventCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* @see {@link UnsubscribeFromEventCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalException} (server fault)
|
|
37
|
+
* <p>Internal server error.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
40
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
41
|
+
* input parameter.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
44
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
45
|
+
* error code describes the entity.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
48
|
+
* <p>The serice is temporary unavailable.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
* @example Unsubscribe from event
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "event": "ASSESSMENT_RUN_COMPLETED",
|
|
56
|
+
* "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0",
|
|
57
|
+
* "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic"
|
|
58
|
+
* };
|
|
59
|
+
* const command = new UnsubscribeFromEventCommand(input);
|
|
60
|
+
* await client.send(command);
|
|
61
|
+
* // example id: unsubscribe-from-event-1481067781705
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
33
64
|
*/
|
|
34
65
|
export declare class UnsubscribeFromEventCommand extends $Command<UnsubscribeFromEventCommandInput, UnsubscribeFromEventCommandOutput, InspectorClientResolvedConfig> {
|
|
35
66
|
readonly input: UnsubscribeFromEventCommandInput;
|
|
@@ -32,6 +32,37 @@ export interface UpdateAssessmentTargetCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* @see {@link UpdateAssessmentTargetCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
36
|
+
* <p>You do not have required permissions to access the requested resource.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InternalException} (server fault)
|
|
39
|
+
* <p>Internal server error.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
42
|
+
* <p>The request was rejected because an invalid or out-of-range value was supplied for an
|
|
43
|
+
* input parameter.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link NoSuchEntityException} (client fault)
|
|
46
|
+
* <p>The request was rejected because it referenced an entity that does not exist. The
|
|
47
|
+
* error code describes the entity.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ServiceTemporarilyUnavailableException} (server fault)
|
|
50
|
+
* <p>The serice is temporary unavailable.</p>
|
|
51
|
+
*
|
|
52
|
+
*
|
|
53
|
+
* @example Update assessment target
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // Updates the assessment target that is specified by the ARN of the assessment target.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX",
|
|
58
|
+
* "assessmentTargetName": "Example",
|
|
59
|
+
* "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt"
|
|
60
|
+
* };
|
|
61
|
+
* const command = new UpdateAssessmentTargetCommand(input);
|
|
62
|
+
* await client.send(command);
|
|
63
|
+
* // example id: update-assessment-target-1481067866692
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
35
66
|
*/
|
|
36
67
|
export declare class UpdateAssessmentTargetCommand extends $Command<UpdateAssessmentTargetCommandInput, UpdateAssessmentTargetCommandOutput, InspectorClientResolvedConfig> {
|
|
37
68
|
readonly input: UpdateAssessmentTargetCommandInput;
|