@aws-sdk/client-guardduty 3.864.0 → 3.872.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.
Files changed (69) hide show
  1. package/README.md +80 -0
  2. package/dist-cjs/index.js +532 -6
  3. package/dist-es/GuardDuty.js +20 -0
  4. package/dist-es/commands/CreateThreatEntitySetCommand.js +22 -0
  5. package/dist-es/commands/CreateTrustedEntitySetCommand.js +22 -0
  6. package/dist-es/commands/DeleteThreatEntitySetCommand.js +22 -0
  7. package/dist-es/commands/DeleteTrustedEntitySetCommand.js +22 -0
  8. package/dist-es/commands/GetThreatEntitySetCommand.js +22 -0
  9. package/dist-es/commands/GetTrustedEntitySetCommand.js +22 -0
  10. package/dist-es/commands/ListThreatEntitySetsCommand.js +22 -0
  11. package/dist-es/commands/ListTrustedEntitySetsCommand.js +22 -0
  12. package/dist-es/commands/UpdateThreatEntitySetCommand.js +22 -0
  13. package/dist-es/commands/UpdateTrustedEntitySetCommand.js +22 -0
  14. package/dist-es/commands/index.js +10 -0
  15. package/dist-es/models/models_0.js +16 -3
  16. package/dist-es/models/models_1.js +21 -0
  17. package/dist-es/pagination/ListThreatEntitySetsPaginator.js +4 -0
  18. package/dist-es/pagination/ListTrustedEntitySetsPaginator.js +4 -0
  19. package/dist-es/pagination/index.js +2 -0
  20. package/dist-es/protocols/Aws_restJson1.js +284 -0
  21. package/dist-types/GuardDuty.d.ts +70 -0
  22. package/dist-types/GuardDutyClient.d.ts +12 -2
  23. package/dist-types/commands/CreateThreatEntitySetCommand.d.ts +91 -0
  24. package/dist-types/commands/CreateTrustedEntitySetCommand.d.ts +92 -0
  25. package/dist-types/commands/DeleteThreatEntitySetCommand.d.ts +78 -0
  26. package/dist-types/commands/DeleteTrustedEntitySetCommand.d.ts +78 -0
  27. package/dist-types/commands/GetAdministratorAccountCommand.d.ts +1 -1
  28. package/dist-types/commands/GetCoverageStatisticsCommand.d.ts +1 -1
  29. package/dist-types/commands/GetDetectorCommand.d.ts +1 -1
  30. package/dist-types/commands/GetFilterCommand.d.ts +1 -1
  31. package/dist-types/commands/GetFindingsCommand.d.ts +1 -2
  32. package/dist-types/commands/GetThreatEntitySetCommand.d.ts +89 -0
  33. package/dist-types/commands/GetTrustedEntitySetCommand.d.ts +89 -0
  34. package/dist-types/commands/ListThreatEntitySetsCommand.d.ts +85 -0
  35. package/dist-types/commands/ListTrustedEntitySetsCommand.d.ts +85 -0
  36. package/dist-types/commands/UpdateThreatEntitySetCommand.d.ts +81 -0
  37. package/dist-types/commands/UpdateTrustedEntitySetCommand.d.ts +81 -0
  38. package/dist-types/commands/index.d.ts +10 -0
  39. package/dist-types/models/models_0.d.ts +200 -200
  40. package/dist-types/models/models_1.d.ts +548 -1
  41. package/dist-types/pagination/ListThreatEntitySetsPaginator.d.ts +7 -0
  42. package/dist-types/pagination/ListTrustedEntitySetsPaginator.d.ts +7 -0
  43. package/dist-types/pagination/index.d.ts +2 -0
  44. package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
  45. package/dist-types/ts3.4/GuardDuty.d.ts +170 -0
  46. package/dist-types/ts3.4/GuardDutyClient.d.ts +62 -2
  47. package/dist-types/ts3.4/commands/CreateThreatEntitySetCommand.d.ts +51 -0
  48. package/dist-types/ts3.4/commands/CreateTrustedEntitySetCommand.d.ts +51 -0
  49. package/dist-types/ts3.4/commands/DeleteThreatEntitySetCommand.d.ts +51 -0
  50. package/dist-types/ts3.4/commands/DeleteTrustedEntitySetCommand.d.ts +51 -0
  51. package/dist-types/ts3.4/commands/GetAdministratorAccountCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/GetCoverageStatisticsCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/GetDetectorCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/GetFilterCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/GetFindingsCommand.d.ts +1 -2
  56. package/dist-types/ts3.4/commands/GetThreatEntitySetCommand.d.ts +51 -0
  57. package/dist-types/ts3.4/commands/GetTrustedEntitySetCommand.d.ts +51 -0
  58. package/dist-types/ts3.4/commands/ListThreatEntitySetsCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/ListTrustedEntitySetsCommand.d.ts +51 -0
  60. package/dist-types/ts3.4/commands/UpdateThreatEntitySetCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/UpdateTrustedEntitySetCommand.d.ts +51 -0
  62. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  63. package/dist-types/ts3.4/models/models_0.d.ts +56 -49
  64. package/dist-types/ts3.4/models/models_1.d.ts +144 -1
  65. package/dist-types/ts3.4/pagination/ListThreatEntitySetsPaginator.d.ts +11 -0
  66. package/dist-types/ts3.4/pagination/ListTrustedEntitySetsPaginator.d.ts +11 -0
  67. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  68. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
  69. package/package.json +2 -2
@@ -3102,6 +3102,83 @@ export interface CreateSampleFindingsRequest {
3102
3102
  */
3103
3103
  export interface CreateSampleFindingsResponse {
3104
3104
  }
3105
+ /**
3106
+ * @public
3107
+ * @enum
3108
+ */
3109
+ export declare const ThreatEntitySetFormat: {
3110
+ readonly ALIEN_VAULT: "ALIEN_VAULT";
3111
+ readonly FIRE_EYE: "FIRE_EYE";
3112
+ readonly OTX_CSV: "OTX_CSV";
3113
+ readonly PROOF_POINT: "PROOF_POINT";
3114
+ readonly STIX: "STIX";
3115
+ readonly TXT: "TXT";
3116
+ };
3117
+ /**
3118
+ * @public
3119
+ */
3120
+ export type ThreatEntitySetFormat = (typeof ThreatEntitySetFormat)[keyof typeof ThreatEntitySetFormat];
3121
+ /**
3122
+ * @public
3123
+ */
3124
+ export interface CreateThreatEntitySetRequest {
3125
+ /**
3126
+ * <p>The unique ID of the detector of the GuardDuty account for which you want to create a threat entity set.</p>
3127
+ * <p>To find the <code>detectorId</code> in the current Region, see the
3128
+ * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
3129
+ * @public
3130
+ */
3131
+ DetectorId: string | undefined;
3132
+ /**
3133
+ * <p>A user-friendly name to identify the threat entity set.</p>
3134
+ * <p>
3135
+ * <b>List naming constraints</b> - The name of your list can include
3136
+ * lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).</p>
3137
+ * @public
3138
+ */
3139
+ Name: string | undefined;
3140
+ /**
3141
+ * <p>The format of the file that contains the threat entity set.</p>
3142
+ * @public
3143
+ */
3144
+ Format: ThreatEntitySetFormat | undefined;
3145
+ /**
3146
+ * <p>The URI of the file that contains the threat entity set.</p>
3147
+ * @public
3148
+ */
3149
+ Location: string | undefined;
3150
+ /**
3151
+ * <p>The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the <b>location</b> parameter.</p>
3152
+ * @public
3153
+ */
3154
+ ExpectedBucketOwner?: string | undefined;
3155
+ /**
3156
+ * <p>A boolean value that indicates whether GuardDuty should start using the uploaded threat entity set to
3157
+ * generate findings.</p>
3158
+ * @public
3159
+ */
3160
+ Activate: boolean | undefined;
3161
+ /**
3162
+ * <p>The idempotency token for the create request.</p>
3163
+ * @public
3164
+ */
3165
+ ClientToken?: string | undefined;
3166
+ /**
3167
+ * <p>The tags to be added to a new threat entity set resource.</p>
3168
+ * @public
3169
+ */
3170
+ Tags?: Record<string, string> | undefined;
3171
+ }
3172
+ /**
3173
+ * @public
3174
+ */
3175
+ export interface CreateThreatEntitySetResponse {
3176
+ /**
3177
+ * <p>The ID returned by GuardDuty after creation of the threat entity set resource.</p>
3178
+ * @public
3179
+ */
3180
+ ThreatEntitySetId: string | undefined;
3181
+ }
3105
3182
  /**
3106
3183
  * @public
3107
3184
  * @enum
@@ -3124,7 +3201,7 @@ export type ThreatIntelSetFormat = (typeof ThreatIntelSetFormat)[keyof typeof Th
3124
3201
  export interface CreateThreatIntelSetRequest {
3125
3202
  /**
3126
3203
  * <p>The unique ID of the detector of the GuardDuty account for which you want to create a
3127
- * <code>ThreatIntelSet</code>.</p>
3204
+ * <code>threatIntelSet</code>.</p>
3128
3205
  * <p>To find the <code>detectorId</code> in the current Region, see the
3129
3206
  * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
3130
3207
  * @public
@@ -3178,6 +3255,84 @@ export interface CreateThreatIntelSetResponse {
3178
3255
  */
3179
3256
  ThreatIntelSetId: string | undefined;
3180
3257
  }
3258
+ /**
3259
+ * @public
3260
+ * @enum
3261
+ */
3262
+ export declare const TrustedEntitySetFormat: {
3263
+ readonly ALIEN_VAULT: "ALIEN_VAULT";
3264
+ readonly FIRE_EYE: "FIRE_EYE";
3265
+ readonly OTX_CSV: "OTX_CSV";
3266
+ readonly PROOF_POINT: "PROOF_POINT";
3267
+ readonly STIX: "STIX";
3268
+ readonly TXT: "TXT";
3269
+ };
3270
+ /**
3271
+ * @public
3272
+ */
3273
+ export type TrustedEntitySetFormat = (typeof TrustedEntitySetFormat)[keyof typeof TrustedEntitySetFormat];
3274
+ /**
3275
+ * @public
3276
+ */
3277
+ export interface CreateTrustedEntitySetRequest {
3278
+ /**
3279
+ * <p>The unique ID of the detector of the GuardDuty account for which you want to create a trusted
3280
+ * entity set.</p>
3281
+ * <p>To find the <code>detectorId</code> in the current Region, see the
3282
+ * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
3283
+ * @public
3284
+ */
3285
+ DetectorId: string | undefined;
3286
+ /**
3287
+ * <p>A user-friendly name to identify the trusted entity set.</p>
3288
+ * <p>
3289
+ * <b>List naming constraints</b> - The name of your list can include
3290
+ * lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).</p>
3291
+ * @public
3292
+ */
3293
+ Name: string | undefined;
3294
+ /**
3295
+ * <p>The format of the file that contains the trusted entity set.</p>
3296
+ * @public
3297
+ */
3298
+ Format: TrustedEntitySetFormat | undefined;
3299
+ /**
3300
+ * <p>The URI of the file that contains the trusted entity set.</p>
3301
+ * @public
3302
+ */
3303
+ Location: string | undefined;
3304
+ /**
3305
+ * <p>The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the <b>location</b>
3306
+ * parameter.</p>
3307
+ * @public
3308
+ */
3309
+ ExpectedBucketOwner?: string | undefined;
3310
+ /**
3311
+ * <p>A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.</p>
3312
+ * @public
3313
+ */
3314
+ Activate: boolean | undefined;
3315
+ /**
3316
+ * <p>The idempotency token for the create request.</p>
3317
+ * @public
3318
+ */
3319
+ ClientToken?: string | undefined;
3320
+ /**
3321
+ * <p>The tags to be added to a new trusted entity set resource.</p>
3322
+ * @public
3323
+ */
3324
+ Tags?: Record<string, string> | undefined;
3325
+ }
3326
+ /**
3327
+ * @public
3328
+ */
3329
+ export interface CreateTrustedEntitySetResponse {
3330
+ /**
3331
+ * <p>The ID returned by GuardDuty after creation of the trusted entity set resource.</p>
3332
+ * @public
3333
+ */
3334
+ TrustedEntitySetId: string | undefined;
3335
+ }
3181
3336
  /**
3182
3337
  * @public
3183
3338
  * @enum
@@ -3539,6 +3694,28 @@ export interface DeletePublishingDestinationRequest {
3539
3694
  */
3540
3695
  export interface DeletePublishingDestinationResponse {
3541
3696
  }
3697
+ /**
3698
+ * @public
3699
+ */
3700
+ export interface DeleteThreatEntitySetRequest {
3701
+ /**
3702
+ * <p>The unique ID of the detector associated with the threat entity set resource.</p>
3703
+ * <p>To find the <code>detectorId</code> in the current Region, see the
3704
+ * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
3705
+ * @public
3706
+ */
3707
+ DetectorId: string | undefined;
3708
+ /**
3709
+ * <p>The unique ID that helps GuardDuty identify which threat entity set needs to be deleted.</p>
3710
+ * @public
3711
+ */
3712
+ ThreatEntitySetId: string | undefined;
3713
+ }
3714
+ /**
3715
+ * @public
3716
+ */
3717
+ export interface DeleteThreatEntitySetResponse {
3718
+ }
3542
3719
  /**
3543
3720
  * @public
3544
3721
  */
@@ -3561,6 +3738,28 @@ export interface DeleteThreatIntelSetRequest {
3561
3738
  */
3562
3739
  export interface DeleteThreatIntelSetResponse {
3563
3740
  }
3741
+ /**
3742
+ * @public
3743
+ */
3744
+ export interface DeleteTrustedEntitySetRequest {
3745
+ /**
3746
+ * <p>The unique ID of the detector associated with the trusted entity set resource.</p>
3747
+ * <p>To find the <code>detectorId</code> in the current Region, see the
3748
+ * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
3749
+ * @public
3750
+ */
3751
+ DetectorId: string | undefined;
3752
+ /**
3753
+ * <p>The unique ID that helps GuardDuty identify which trusted entity set needs to be deleted.</p>
3754
+ * @public
3755
+ */
3756
+ TrustedEntitySetId: string | undefined;
3757
+ }
3758
+ /**
3759
+ * @public
3760
+ */
3761
+ export interface DeleteTrustedEntitySetResponse {
3762
+ }
3564
3763
  /**
3565
3764
  * <p>Contains information about the condition.</p>
3566
3765
  * @public
@@ -7097,205 +7296,6 @@ export interface FindingStatistics {
7097
7296
  */
7098
7297
  GroupedBySeverity?: SeverityStatistics[] | undefined;
7099
7298
  }
7100
- /**
7101
- * @public
7102
- * @enum
7103
- */
7104
- export declare const FindingStatisticType: {
7105
- readonly COUNT_BY_SEVERITY: "COUNT_BY_SEVERITY";
7106
- };
7107
- /**
7108
- * @public
7109
- */
7110
- export type FindingStatisticType = (typeof FindingStatisticType)[keyof typeof FindingStatisticType];
7111
- /**
7112
- * @public
7113
- */
7114
- export interface GetAdministratorAccountRequest {
7115
- /**
7116
- * <p>The unique ID of the detector of the GuardDuty member account.</p>
7117
- * @public
7118
- */
7119
- DetectorId: string | undefined;
7120
- }
7121
- /**
7122
- * @public
7123
- */
7124
- export interface GetAdministratorAccountResponse {
7125
- /**
7126
- * <p>The administrator account details.</p>
7127
- * @public
7128
- */
7129
- Administrator: Administrator | undefined;
7130
- }
7131
- /**
7132
- * @public
7133
- */
7134
- export interface GetCoverageStatisticsRequest {
7135
- /**
7136
- * <p>The unique ID of the GuardDuty detector.</p>
7137
- * <p>To find the <code>detectorId</code> in the current Region, see the
7138
- * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
7139
- * @public
7140
- */
7141
- DetectorId: string | undefined;
7142
- /**
7143
- * <p>Represents the criteria used to filter the coverage statistics.</p>
7144
- * @public
7145
- */
7146
- FilterCriteria?: CoverageFilterCriteria | undefined;
7147
- /**
7148
- * <p>Represents the statistics type used to aggregate the coverage details.</p>
7149
- * @public
7150
- */
7151
- StatisticsType: CoverageStatisticsType[] | undefined;
7152
- }
7153
- /**
7154
- * @public
7155
- */
7156
- export interface GetCoverageStatisticsResponse {
7157
- /**
7158
- * <p>Represents the count aggregated by the <code>statusCode</code> and
7159
- * <code>resourceType</code>.</p>
7160
- * @public
7161
- */
7162
- CoverageStatistics?: CoverageStatistics | undefined;
7163
- }
7164
- /**
7165
- * @public
7166
- */
7167
- export interface GetDetectorRequest {
7168
- /**
7169
- * <p>The unique ID of the detector that you want to get.</p>
7170
- * <p>To find the <code>detectorId</code> in the current Region, see the
7171
- * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
7172
- * @public
7173
- */
7174
- DetectorId: string | undefined;
7175
- }
7176
- /**
7177
- * @public
7178
- */
7179
- export interface GetDetectorResponse {
7180
- /**
7181
- * <p>The timestamp of when the detector was created.</p>
7182
- * @public
7183
- */
7184
- CreatedAt?: string | undefined;
7185
- /**
7186
- * <p>The publishing frequency of the finding.</p>
7187
- * @public
7188
- */
7189
- FindingPublishingFrequency?: FindingPublishingFrequency | undefined;
7190
- /**
7191
- * <p>The GuardDuty service role.</p>
7192
- * @public
7193
- */
7194
- ServiceRole: string | undefined;
7195
- /**
7196
- * <p>The detector status.</p>
7197
- * @public
7198
- */
7199
- Status: DetectorStatus | undefined;
7200
- /**
7201
- * <p>The last-updated timestamp for the detector.</p>
7202
- * @public
7203
- */
7204
- UpdatedAt?: string | undefined;
7205
- /**
7206
- * <p>Describes which data sources are enabled for the detector.</p>
7207
- *
7208
- * @deprecated
7209
- * @public
7210
- */
7211
- DataSources?: DataSourceConfigurationsResult | undefined;
7212
- /**
7213
- * <p>The tags of the detector resource.</p>
7214
- * @public
7215
- */
7216
- Tags?: Record<string, string> | undefined;
7217
- /**
7218
- * <p>Describes the features that have been enabled for the detector.</p>
7219
- * @public
7220
- */
7221
- Features?: DetectorFeatureConfigurationResult[] | undefined;
7222
- }
7223
- /**
7224
- * @public
7225
- */
7226
- export interface GetFilterRequest {
7227
- /**
7228
- * <p>The unique ID of the detector that is associated with this filter.</p>
7229
- * <p>To find the <code>detectorId</code> in the current Region, see the
7230
- * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
7231
- * @public
7232
- */
7233
- DetectorId: string | undefined;
7234
- /**
7235
- * <p>The name of the filter you want to get.</p>
7236
- * @public
7237
- */
7238
- FilterName: string | undefined;
7239
- }
7240
- /**
7241
- * @public
7242
- */
7243
- export interface GetFilterResponse {
7244
- /**
7245
- * <p>The name of the filter.</p>
7246
- * @public
7247
- */
7248
- Name: string | undefined;
7249
- /**
7250
- * <p>The description of the filter.</p>
7251
- * @public
7252
- */
7253
- Description?: string | undefined;
7254
- /**
7255
- * <p>Specifies the action that is to be applied to the findings that match the filter.</p>
7256
- * @public
7257
- */
7258
- Action: FilterAction | undefined;
7259
- /**
7260
- * <p>Specifies the position of the filter in the list of current filters. Also specifies the
7261
- * order in which this filter is applied to the findings.</p>
7262
- * @public
7263
- */
7264
- Rank?: number | undefined;
7265
- /**
7266
- * <p>Represents the criteria to be used in the filter for querying findings.</p>
7267
- * @public
7268
- */
7269
- FindingCriteria: FindingCriteria | undefined;
7270
- /**
7271
- * <p>The tags of the filter resource.</p>
7272
- * @public
7273
- */
7274
- Tags?: Record<string, string> | undefined;
7275
- }
7276
- /**
7277
- * @public
7278
- */
7279
- export interface GetFindingsRequest {
7280
- /**
7281
- * <p>The ID of the detector that specifies the GuardDuty service whose findings you want to
7282
- * retrieve.</p>
7283
- * <p>To find the <code>detectorId</code> in the current Region, see the
7284
- * Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
7285
- * @public
7286
- */
7287
- DetectorId: string | undefined;
7288
- /**
7289
- * <p>The IDs of the findings that you want to retrieve.</p>
7290
- * @public
7291
- */
7292
- FindingIds: string[] | undefined;
7293
- /**
7294
- * <p>Represents the criteria used for sorting findings.</p>
7295
- * @public
7296
- */
7297
- SortCriteria?: SortCriteria | undefined;
7298
- }
7299
7299
  /**
7300
7300
  * @internal
7301
7301
  */