AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetSampledRequestsInput

import "github.com/aws/aws-sdk-go/service/waf"

type GetSampledRequestsInput struct { MaxItems *int64 `min:"1" type:"long" required:"true"` RuleId *string `min:"1" type:"string" required:"true"` TimeWindow *TimeWindow `type:"structure" required:"true"` WebAclId *string `min:"1" type:"string" required:"true"` }

MaxItems

Type: *int64

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

MaxItems is a required field

RuleId

Type: *string

RuleId is one of three values:

  • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

  • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

RuleId is a required field

TimeWindow

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

WebAclId

Type: *string

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

WebAclId is a required field

Method

GoString

func (s GetSampledRequestsInput) GoString() string

GoString returns the string representation

SetMaxItems

func (s *GetSampledRequestsInput) SetMaxItems(v int64) *GetSampledRequestsInput

SetMaxItems sets the MaxItems field's value.

SetRuleId

func (s *GetSampledRequestsInput) SetRuleId(v string) *GetSampledRequestsInput

SetRuleId sets the RuleId field's value.

SetTimeWindow

func (s *GetSampledRequestsInput) SetTimeWindow(v *TimeWindow) *GetSampledRequestsInput

SetTimeWindow sets the TimeWindow field's value.

SetWebAclId

func (s *GetSampledRequestsInput) SetWebAclId(v string) *GetSampledRequestsInput

SetWebAclId sets the WebAclId field's value.

String

func (s GetSampledRequestsInput) String() string

String returns the string representation

Validate

func (s *GetSampledRequestsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: