Skip to content

Commit

Permalink
docs(client-guardduty): Updated API and data types descriptions for C…
Browse files Browse the repository at this point in the history
…reateFilter, UpdateFilter, and TriggerDetails.
  • Loading branch information
awstools committed Feb 23, 2023
1 parent 61554a4 commit 995ae11
Show file tree
Hide file tree
Showing 17 changed files with 970 additions and 1,471 deletions.
41 changes: 34 additions & 7 deletions clients/client-guardduty/src/GuardDuty.ts
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,9 @@ export class GuardDuty extends GuardDutyClient {
* GuardDuty service. To start using GuardDuty, you must create a detector in each Region where
* you enable the service. You can have only one detector per account per Region. All data
* sources are enabled in a new detector by default.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public createDetector(
args: CreateDetectorCommandInput,
Expand Down Expand Up @@ -506,11 +509,8 @@ export class GuardDuty extends GuardDutyClient {
* action will enable GuardDuty in the added member accounts, with the exception of the
* organization delegated administrator account, which must enable GuardDuty prior to being added as a
* member.</p>
* <p>If you are adding accounts by invitation use this action after GuardDuty has been enabled
* in potential member accounts and before using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">
* <code>Invite
* Members</code>
* </a>.</p>
* <p>If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in
* potential member accounts and before using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a>.</p>
*/
public createMembers(
args: CreateMembersCommandInput,
Expand Down Expand Up @@ -575,8 +575,8 @@ export class GuardDuty extends GuardDutyClient {
}

/**
* <p>Generates example findings of types specified by the list of finding types. If 'NULL' is
* specified for <code>findingTypes</code>, the API generates example findings of all supported
* <p>Generates sample findings of types specified by the list of finding types. If 'NULL' is
* specified for <code>findingTypes</code>, the API generates sample findings of all supported
* finding types.</p>
*/
public createSampleFindings(
Expand Down Expand Up @@ -896,6 +896,9 @@ export class GuardDuty extends GuardDutyClient {
/**
* <p>Returns a list of malware scans. Each member account can view the malware scans for their
* own accounts. An administrator can view the malware scans for all the member accounts.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public describeMalwareScans(
args: DescribeMalwareScansCommandInput,
Expand Down Expand Up @@ -929,6 +932,9 @@ export class GuardDuty extends GuardDutyClient {
/**
* <p>Returns information about the account selected as the delegated administrator for
* GuardDuty.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public describeOrganizationConfiguration(
args: DescribeOrganizationConfigurationCommandInput,
Expand Down Expand Up @@ -1191,6 +1197,9 @@ export class GuardDuty extends GuardDutyClient {

/**
* <p>Retrieves an Amazon GuardDuty detector specified by the detectorId.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public getDetector(args: GetDetectorCommandInput, options?: __HttpHandlerOptions): Promise<GetDetectorCommandOutput>;
public getDetector(args: GetDetectorCommandInput, cb: (err: any, data?: GetDetectorCommandOutput) => void): void;
Expand Down Expand Up @@ -1360,6 +1369,9 @@ export class GuardDuty extends GuardDutyClient {

/**
* <p>Returns the details of the malware scan settings.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public getMalwareScanSettings(
args: GetMalwareScanSettingsCommandInput,
Expand Down Expand Up @@ -1427,6 +1439,9 @@ export class GuardDuty extends GuardDutyClient {

/**
* <p>Describes which data sources are enabled for the member account's detector.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public getMemberDetectors(
args: GetMemberDetectorsCommandInput,
Expand Down Expand Up @@ -2084,6 +2099,9 @@ export class GuardDuty extends GuardDutyClient {

/**
* <p>Updates the Amazon GuardDuty detector specified by the detectorId.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public updateDetector(
args: UpdateDetectorCommandInput,
Expand Down Expand Up @@ -2203,6 +2221,9 @@ export class GuardDuty extends GuardDutyClient {

/**
* <p>Updates the malware scan settings.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public updateMalwareScanSettings(
args: UpdateMalwareScanSettingsCommandInput,
Expand Down Expand Up @@ -2235,6 +2256,9 @@ export class GuardDuty extends GuardDutyClient {

/**
* <p>Contains information on member accounts to be updated.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public updateMemberDetectors(
args: UpdateMemberDetectorsCommandInput,
Expand Down Expand Up @@ -2267,6 +2291,9 @@ export class GuardDuty extends GuardDutyClient {

/**
* <p>Updates the delegated administrator account with the values provided.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
*/
public updateOrganizationConfiguration(
args: UpdateOrganizationConfigurationCommandInput,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ export interface CreateDetectorCommandOutput extends CreateDetectorResponse, __M
* GuardDuty service. To start using GuardDuty, you must create a detector in each Region where
* you enable the service. You can have only one detector per account per Region. All data
* sources are enabled in a new detector by default.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
7 changes: 2 additions & 5 deletions clients/client-guardduty/src/commands/CreateMembersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,8 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
* action will enable GuardDuty in the added member accounts, with the exception of the
* organization delegated administrator account, which must enable GuardDuty prior to being added as a
* member.</p>
* <p>If you are adding accounts by invitation use this action after GuardDuty has been enabled
* in potential member accounts and before using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">
* <code>Invite
* Members</code>
* </a>.</p>
* <p>If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in
* potential member accounts and before using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html">InviteMembers</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ export interface CreateSampleFindingsCommandInput extends CreateSampleFindingsRe
export interface CreateSampleFindingsCommandOutput extends CreateSampleFindingsResponse, __MetadataBearer {}

/**
* <p>Generates example findings of types specified by the list of finding types. If 'NULL' is
* specified for <code>findingTypes</code>, the API generates example findings of all supported
* <p>Generates sample findings of types specified by the list of finding types. If 'NULL' is
* specified for <code>findingTypes</code>, the API generates sample findings of all supported
* finding types.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ export interface DescribeMalwareScansCommandOutput extends DescribeMalwareScansR
/**
* <p>Returns a list of malware scans. Each member account can view the malware scans for their
* own accounts. An administrator can view the malware scans for all the member accounts.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ export interface DescribeOrganizationConfigurationCommandOutput
/**
* <p>Returns information about the account selected as the delegated administrator for
* GuardDuty.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-guardduty/src/commands/GetDetectorCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface GetDetectorCommandOutput extends GetDetectorResponse, __Metadat

/**
* <p>Retrieves an Amazon GuardDuty detector specified by the detectorId.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface GetMalwareScanSettingsCommandOutput extends GetMalwareScanSetti

/**
* <p>Returns the details of the malware scan settings.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface GetMemberDetectorsCommandOutput extends GetMemberDetectorsRespo

/**
* <p>Describes which data sources are enabled for the member account's detector.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface UpdateDetectorCommandOutput extends UpdateDetectorResponse, __M

/**
* <p>Updates the Amazon GuardDuty detector specified by the detectorId.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface UpdateMalwareScanSettingsCommandOutput extends UpdateMalwareSca

/**
* <p>Updates the malware scan settings.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface UpdateMemberDetectorsCommandOutput extends UpdateMemberDetector

/**
* <p>Contains information on member accounts to be updated.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ export interface UpdateOrganizationConfigurationCommandOutput

/**
* <p>Updates the delegated administrator account with the values provided.</p>
* <p>There might be regional differences because some data sources might not be
* available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more
* information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
};

export interface EndpointParameters extends __EndpointParameters {
Region: string;
Region?: string;
UseDualStack?: boolean;
UseFIPS?: boolean;
Endpoint?: string;
Expand Down
Loading

0 comments on commit 995ae11

Please sign in to comment.