1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package guardduty
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/guardduty/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists GuardDuty findings for the specified detector ID.
//
// There might be regional differences because some flags might not be available
// in all the Regions where GuardDuty is currently supported. For more information,
// see [Regions and endpoints].
//
// [Regions and endpoints]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html
func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, optFns ...func(*Options)) (*ListFindingsOutput, error) {
if params == nil {
params = &ListFindingsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListFindings", params, optFns, c.addOperationListFindingsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListFindingsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListFindingsInput struct {
// The ID of the detector that specifies the GuardDuty service whose findings you
// want to list.
//
// This member is required.
DetectorId *string
// Represents the criteria used for querying findings. Valid values include:
//
// - JSON field name
//
// - accountId
//
// - region
//
// - confidence
//
// - id
//
// - resource.accessKeyDetails.accessKeyId
//
// - resource.accessKeyDetails.principalId
//
// - resource.accessKeyDetails.userName
//
// - resource.accessKeyDetails.userType
//
// - resource.instanceDetails.iamInstanceProfile.id
//
// - resource.instanceDetails.imageId
//
// - resource.instanceDetails.instanceId
//
// - resource.instanceDetails.networkInterfaces.ipv6Addresses
//
// -
// resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
//
// - resource.instanceDetails.networkInterfaces.publicDnsName
//
// - resource.instanceDetails.networkInterfaces.publicIp
//
// - resource.instanceDetails.networkInterfaces.securityGroups.groupId
//
// - resource.instanceDetails.networkInterfaces.securityGroups.groupName
//
// - resource.instanceDetails.networkInterfaces.subnetId
//
// - resource.instanceDetails.networkInterfaces.vpcId
//
// - resource.instanceDetails.tags.key
//
// - resource.instanceDetails.tags.value
//
// - resource.resourceType
//
// - service.action.actionType
//
// - service.action.awsApiCallAction.api
//
// - service.action.awsApiCallAction.callerType
//
// - service.action.awsApiCallAction.remoteIpDetails.city.cityName
//
// - service.action.awsApiCallAction.remoteIpDetails.country.countryName
//
// - service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
//
// - service.action.awsApiCallAction.remoteIpDetails.organization.asn
//
// - service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
//
// - service.action.awsApiCallAction.serviceName
//
// - service.action.dnsRequestAction.domain
//
// - service.action.dnsRequestAction.domainWithSuffix
//
// - service.action.networkConnectionAction.blocked
//
// - service.action.networkConnectionAction.connectionDirection
//
// - service.action.networkConnectionAction.localPortDetails.port
//
// - service.action.networkConnectionAction.protocol
//
// - service.action.networkConnectionAction.remoteIpDetails.country.countryName
//
// - service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
//
// - service.action.networkConnectionAction.remoteIpDetails.organization.asn
//
// - service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
//
// - service.action.networkConnectionAction.remotePortDetails.port
//
// - service.additionalInfo.threatListName
//
// - service.archived
//
// When this attribute is set to 'true', only archived findings are listed. When
// it's set to 'false', only unarchived findings are listed. When this attribute is
// not set, all existing findings are listed.
//
// - service.resourceRole
//
// - severity
//
// - type
//
// - updatedAt
//
// Type: Timestamp in Unix Epoch millisecond format: 1486685375000
FindingCriteria *types.FindingCriteria
// You can use this parameter to indicate the maximum number of items you want in
// the response. The default value is 50. The maximum value is 50.
MaxResults *int32
// You can use this parameter when paginating results. Set the value of this
// parameter to null on your first call to the list action. For subsequent calls to
// the action, fill nextToken in the request with the value of NextToken from the
// previous response to continue listing data.
NextToken *string
// Represents the criteria used for sorting findings.
SortCriteria *types.SortCriteria
noSmithyDocumentSerde
}
type ListFindingsOutput struct {
// The IDs of the findings that you're listing.
//
// This member is required.
FindingIds []string
// The pagination parameter to be used on the next list operation to retrieve more
// items.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListFindingsMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpListFindings{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListFindings{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ListFindings"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpListFindingsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListFindings(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
// ListFindingsPaginatorOptions is the paginator options for ListFindings
type ListFindingsPaginatorOptions struct {
// You can use this parameter to indicate the maximum number of items you want in
// the response. The default value is 50. The maximum value is 50.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListFindingsPaginator is a paginator for ListFindings
type ListFindingsPaginator struct {
options ListFindingsPaginatorOptions
client ListFindingsAPIClient
params *ListFindingsInput
nextToken *string
firstPage bool
}
// NewListFindingsPaginator returns a new ListFindingsPaginator
func NewListFindingsPaginator(client ListFindingsAPIClient, params *ListFindingsInput, optFns ...func(*ListFindingsPaginatorOptions)) *ListFindingsPaginator {
if params == nil {
params = &ListFindingsInput{}
}
options := ListFindingsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListFindingsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListFindingsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListFindings page.
func (p *ListFindingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFindingsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
optFns = append([]func(*Options){
addIsPaginatorUserAgent,
}, optFns...)
result, err := p.client.ListFindings(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
// ListFindingsAPIClient is a client that implements the ListFindings operation.
type ListFindingsAPIClient interface {
ListFindings(context.Context, *ListFindingsInput, ...func(*Options)) (*ListFindingsOutput, error)
}
var _ ListFindingsAPIClient = (*Client)(nil)
func newServiceMetadataMiddleware_opListFindings(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ListFindings",
}
}
|