Skip to content

Commit 943533d

Browse files
author
awstools
committed
docs(client-guardduty): Documentation update for API description.
1 parent 790c085 commit 943533d

File tree

4 files changed

+22
-4
lines changed

4 files changed

+22
-4
lines changed

‎clients/client-guardduty/src/GuardDuty.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -953,7 +953,8 @@ export class GuardDuty extends GuardDutyClient {
953953

954954
/**
955955
* <p>Disassociates GuardDuty member accounts (to the current GuardDuty administrator account)
956-
* specified by the account IDs.</p>
956+
* specified by the account IDs. Member accounts added through <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html">Invitation</a> get deleted from the
957+
* current GuardDuty administrator account after 30 days of disassociation.</p>
957958
*/
958959
public disassociateMembers(
959960
args: DisassociateMembersCommandInput,

‎clients/client-guardduty/src/commands/DisassociateMembersCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes
2323

2424
/**
2525
* <p>Disassociates GuardDuty member accounts (to the current GuardDuty administrator account)
26-
* specified by the account IDs.</p>
26+
* specified by the account IDs. Member accounts added through <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html">Invitation</a> get deleted from the
27+
* current GuardDuty administrator account after 30 days of disassociation.</p>
2728
* @example
2829
* Use a bare-bones client and the command you need to make an API call.
2930
* ```javascript

‎clients/client-guardduty/src/models/models_0.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,11 @@ export interface AwsApiCallAction {
447447
*/
448448
ErrorCode?: string;
449449

450+
/**
451+
* <p>The agent through which the API request was made.</p>
452+
*/
450453
UserAgent?: string;
454+
451455
/**
452456
* <p>The remote IP information of the connection that initiated the Amazon Web Services API call.</p>
453457
*/
@@ -1367,6 +1371,9 @@ export interface CreateFilterRequest {
13671371
* <p>service.action.awsApiCallAction.errorCode</p>
13681372
* </li>
13691373
* <li>
1374+
* <p>service.action.awsApiCallAction.userAgent</p>
1375+
* </li>
1376+
* <li>
13701377
* <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p>
13711378
* </li>
13721379
* <li>

‎codegen/sdk-codegen/aws-models/guardduty.json

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,6 +406,7 @@
406406
"UserAgent": {
407407
"target": "com.amazonaws.guardduty#String",
408408
"traits": {
409+
"smithy.api#documentation": "<p>The agent through which the API request was made.</p>",
409410
"smithy.api#jsonName": "userAgent"
410411
}
411412
},
@@ -929,7 +930,7 @@
929930
"FindingCriteria": {
930931
"target": "com.amazonaws.guardduty#FindingCriteria",
931932
"traits": {
932-
"smithy.api#documentation": "<p>Represents the criteria to be used in the filter for querying findings.</p>\n <p>You can only use the following attributes to query findings:</p>\n <ul>\n <li>\n <p>accountId</p>\n </li>\n <li>\n <p>region</p>\n </li>\n <li>\n <p>confidence</p>\n </li>\n <li>\n <p>id</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.accessKeyId</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.principalId</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.userName</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.userType</p>\n </li>\n <li>\n <p>resource.instanceDetails.iamInstanceProfile.id</p>\n </li>\n <li>\n <p>resource.instanceDetails.imageId</p>\n </li>\n <li>\n <p>resource.instanceDetails.instanceId</p>\n </li>\n <li>\n <p>resource.instanceDetails.outpostArn</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.publicDnsName</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.publicIp</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.subnetId</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.vpcId</p>\n </li>\n <li>\n <p>resource.instanceDetails.tags.key</p>\n </li>\n <li>\n <p>resource.instanceDetails.tags.value</p>\n </li>\n <li>\n <p>resource.resourceType</p>\n </li>\n <li>\n <p>service.action.actionType</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.api</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.callerType</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.errorCode</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.serviceName</p>\n </li>\n <li>\n <p>service.action.dnsRequestAction.domain</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.blocked</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.connectionDirection</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.localPortDetails.port</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.protocol</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.localIpDetails.ipAddressV4</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remotePortDetails.port</p>\n </li>\n <li>\n <p>service.additionalInfo.threatListName</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.publicAccess.effectivePermissions</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.name</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.tags.key</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.tags.value</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.type</p>\n </li>\n <li>\n <p>service.archived</p>\n <p>When this attribute is set to TRUE, only archived findings are listed. When it's set\n to FALSE, only unarchived findings are listed. When this attribute is not set, all\n existing findings are listed.</p>\n </li>\n <li>\n <p>service.resourceRole</p>\n </li>\n <li>\n <p>severity</p>\n </li>\n <li>\n <p>type</p>\n </li>\n <li>\n <p>updatedAt</p>\n <p>Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.</p>\n </li>\n </ul>",
933+
"smithy.api#documentation": "<p>Represents the criteria to be used in the filter for querying findings.</p>\n <p>You can only use the following attributes to query findings:</p>\n <ul>\n <li>\n <p>accountId</p>\n </li>\n <li>\n <p>region</p>\n </li>\n <li>\n <p>confidence</p>\n </li>\n <li>\n <p>id</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.accessKeyId</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.principalId</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.userName</p>\n </li>\n <li>\n <p>resource.accessKeyDetails.userType</p>\n </li>\n <li>\n <p>resource.instanceDetails.iamInstanceProfile.id</p>\n </li>\n <li>\n <p>resource.instanceDetails.imageId</p>\n </li>\n <li>\n <p>resource.instanceDetails.instanceId</p>\n </li>\n <li>\n <p>resource.instanceDetails.outpostArn</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.publicDnsName</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.publicIp</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.subnetId</p>\n </li>\n <li>\n <p>resource.instanceDetails.networkInterfaces.vpcId</p>\n </li>\n <li>\n <p>resource.instanceDetails.tags.key</p>\n </li>\n <li>\n <p>resource.instanceDetails.tags.value</p>\n </li>\n <li>\n <p>resource.resourceType</p>\n </li>\n <li>\n <p>service.action.actionType</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.api</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.callerType</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.errorCode</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.userAgent</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p>\n </li>\n <li>\n <p>service.action.awsApiCallAction.serviceName</p>\n </li>\n <li>\n <p>service.action.dnsRequestAction.domain</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.blocked</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.connectionDirection</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.localPortDetails.port</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.protocol</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.localIpDetails.ipAddressV4</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p>\n </li>\n <li>\n <p>service.action.networkConnectionAction.remotePortDetails.port</p>\n </li>\n <li>\n <p>service.additionalInfo.threatListName</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.publicAccess.effectivePermissions</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.name</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.tags.key</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.tags.value</p>\n </li>\n <li>\n <p>resource.s3BucketDetails.type</p>\n </li>\n <li>\n <p>service.archived</p>\n <p>When this attribute is set to TRUE, only archived findings are listed. When it's set\n to FALSE, only unarchived findings are listed. When this attribute is not set, all\n existing findings are listed.</p>\n </li>\n <li>\n <p>service.resourceRole</p>\n </li>\n <li>\n <p>severity</p>\n </li>\n <li>\n <p>type</p>\n </li>\n <li>\n <p>updatedAt</p>\n <p>Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.</p>\n </li>\n </ul>",
933934
"smithy.api#jsonName": "findingCriteria",
934935
"smithy.api#required": {}
935936
}
@@ -2306,7 +2307,7 @@
23062307
}
23072308
],
23082309
"traits": {
2309-
"smithy.api#documentation": "<p>Disassociates GuardDuty member accounts (to the current GuardDuty administrator account)\n specified by the account IDs.</p>",
2310+
"smithy.api#documentation": "<p>Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) \n specified by the account IDs. Member accounts added through <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html\">Invitation</a> get deleted from the \n current GuardDuty administrator account after 30 days of disassociation.</p>",
23102311
"smithy.api#http": {
23112312
"method": "POST",
23122313
"uri": "/detector/{DetectorId}/member/disassociate",
@@ -4546,6 +4547,7 @@
45464547
"smithy.api#paginated": {
45474548
"inputToken": "NextToken",
45484549
"outputToken": "NextToken",
4550+
"items": "DetectorIds",
45494551
"pageSize": "MaxResults"
45504552
}
45514553
}
@@ -4617,6 +4619,7 @@
46174619
"smithy.api#paginated": {
46184620
"inputToken": "NextToken",
46194621
"outputToken": "NextToken",
4622+
"items": "FilterNames",
46204623
"pageSize": "MaxResults"
46214624
}
46224625
}
@@ -4697,6 +4700,7 @@
46974700
"smithy.api#paginated": {
46984701
"inputToken": "NextToken",
46994702
"outputToken": "NextToken",
4703+
"items": "FindingIds",
47004704
"pageSize": "MaxResults"
47014705
}
47024706
}
@@ -4789,6 +4793,7 @@
47894793
"smithy.api#paginated": {
47904794
"inputToken": "NextToken",
47914795
"outputToken": "NextToken",
4796+
"items": "IpSetIds",
47924797
"pageSize": "MaxResults"
47934798
}
47944799
}
@@ -4869,6 +4874,7 @@
48694874
"smithy.api#paginated": {
48704875
"inputToken": "NextToken",
48714876
"outputToken": "NextToken",
4877+
"items": "Invitations",
48724878
"pageSize": "MaxResults"
48734879
}
48744880
}
@@ -4939,6 +4945,7 @@
49394945
"smithy.api#paginated": {
49404946
"inputToken": "NextToken",
49414947
"outputToken": "NextToken",
4948+
"items": "Members",
49424949
"pageSize": "MaxResults"
49434950
}
49444951
}
@@ -5026,6 +5033,7 @@
50265033
"smithy.api#paginated": {
50275034
"inputToken": "NextToken",
50285035
"outputToken": "NextToken",
5036+
"items": "AdminAccounts",
50295037
"pageSize": "MaxResults"
50305038
}
50315039
}
@@ -5227,6 +5235,7 @@
52275235
"smithy.api#paginated": {
52285236
"inputToken": "NextToken",
52295237
"outputToken": "NextToken",
5238+
"items": "ThreatIntelSetIds",
52305239
"pageSize": "MaxResults"
52315240
}
52325241
}

0 commit comments

Comments
 (0)