Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.

WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.

Creating a Request

data GetRateBasedStatementManagedKeys

See: newGetRateBasedStatementManagedKeys smart constructor.

Constructors

GetRateBasedStatementManagedKeys'

Fields

• ruleGroupRuleName :: Maybe Text

  The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.

• scope :: Scope

  Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

  To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
  • API and SDKs - For all calls, use the Region endpoint us-east-1.
• webACLName :: Text

  The name of the web ACL. You cannot change the name of a web ACL after you create it.

• webACLId :: Text

  The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

• ruleName :: Text

  The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.

Instances

ToJSON GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

toJSON :: GetRateBasedStatementManagedKeys -> Value

toEncoding :: GetRateBasedStatementManagedKeys -> Encoding

toJSONList :: [GetRateBasedStatementManagedKeys] -> Value

toEncodingList :: [GetRateBasedStatementManagedKeys] -> Encoding

ToHeaders GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

toHeaders :: GetRateBasedStatementManagedKeys -> [Header]

ToPath GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

toPath :: GetRateBasedStatementManagedKeys -> ByteString

ToQuery GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

toQuery :: GetRateBasedStatementManagedKeys -> QueryString

AWSRequest GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Associated Types

type AWSResponse GetRateBasedStatementManagedKeys

Methods

request :: (Service -> Service) -> GetRateBasedStatementManagedKeys -> Request GetRateBasedStatementManagedKeys

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRateBasedStatementManagedKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRateBasedStatementManagedKeys)))

Generic GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Associated Types

type Rep GetRateBasedStatementManagedKeys :: Type -> Type

Methods

from :: GetRateBasedStatementManagedKeys -> Rep GetRateBasedStatementManagedKeys x

to :: Rep GetRateBasedStatementManagedKeys x -> GetRateBasedStatementManagedKeys

Read GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

readsPrec :: Int -> ReadS GetRateBasedStatementManagedKeys

readList :: ReadS [GetRateBasedStatementManagedKeys]

readPrec :: ReadPrec GetRateBasedStatementManagedKeys

readListPrec :: ReadPrec [GetRateBasedStatementManagedKeys]

Show GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

showsPrec :: Int -> GetRateBasedStatementManagedKeys -> ShowS

show :: GetRateBasedStatementManagedKeys -> String

showList :: [GetRateBasedStatementManagedKeys] -> ShowS

NFData GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

rnf :: GetRateBasedStatementManagedKeys -> ()

Eq GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

(==) :: GetRateBasedStatementManagedKeys -> GetRateBasedStatementManagedKeys -> Bool

(/=) :: GetRateBasedStatementManagedKeys -> GetRateBasedStatementManagedKeys -> Bool

Hashable GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

hashWithSalt :: Int -> GetRateBasedStatementManagedKeys -> Int

hash :: GetRateBasedStatementManagedKeys -> Int

type AWSResponse GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

type AWSResponse GetRateBasedStatementManagedKeys = GetRateBasedStatementManagedKeysResponse

type Rep GetRateBasedStatementManagedKeys

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

type Rep GetRateBasedStatementManagedKeys = D1 ('MetaData "GetRateBasedStatementManagedKeys" "Amazonka.WAFV2.GetRateBasedStatementManagedKeys" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetRateBasedStatementManagedKeys'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ruleGroupRuleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope)) :*: (S1 ('MetaSel ('Just "webACLName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "webACLId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetRateBasedStatementManagedKeys

Arguments

:: Scope

GetRateBasedStatementManagedKeys

-> Text

$sel:webACLName:GetRateBasedStatementManagedKeys'

-> Text

$sel:webACLId:GetRateBasedStatementManagedKeys'

-> Text

$sel:ruleName:GetRateBasedStatementManagedKeys'

-> GetRateBasedStatementManagedKeys

Create a value of GetRateBasedStatementManagedKeys with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ruleGroupRuleName:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_ruleGroupRuleName - The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.

GetRateBasedStatementManagedKeys, getRateBasedStatementManagedKeys_scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
• API and SDKs - For all calls, use the Region endpoint us-east-1.

$sel:webACLName:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_webACLName - The name of the web ACL. You cannot change the name of a web ACL after you create it.

$sel:webACLId:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_webACLId - The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

$sel:ruleName:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_ruleName - The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.

Request Lenses

getRateBasedStatementManagedKeys_ruleGroupRuleName :: Lens' GetRateBasedStatementManagedKeys (Maybe Text)

The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.

getRateBasedStatementManagedKeys_scope :: Lens' GetRateBasedStatementManagedKeys Scope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
• API and SDKs - For all calls, use the Region endpoint us-east-1.

getRateBasedStatementManagedKeys_webACLName :: Lens' GetRateBasedStatementManagedKeys Text

The name of the web ACL. You cannot change the name of a web ACL after you create it.

getRateBasedStatementManagedKeys_webACLId :: Lens' GetRateBasedStatementManagedKeys Text

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

getRateBasedStatementManagedKeys_ruleName :: Lens' GetRateBasedStatementManagedKeys Text

The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.

Destructuring the Response

data GetRateBasedStatementManagedKeysResponse

See: newGetRateBasedStatementManagedKeysResponse smart constructor.

Constructors

GetRateBasedStatementManagedKeysResponse'

Fields

• managedKeysIPV4 :: Maybe RateBasedStatementManagedKeysIPSet

  The keys that are of Internet Protocol version 4 (IPv4).

• managedKeysIPV6 :: Maybe RateBasedStatementManagedKeysIPSet

  The keys that are of Internet Protocol version 6 (IPv6).

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetRateBasedStatementManagedKeysResponse

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Associated Types

type Rep GetRateBasedStatementManagedKeysResponse :: Type -> Type

Methods

from :: GetRateBasedStatementManagedKeysResponse -> Rep GetRateBasedStatementManagedKeysResponse x

to :: Rep GetRateBasedStatementManagedKeysResponse x -> GetRateBasedStatementManagedKeysResponse

Read GetRateBasedStatementManagedKeysResponse

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

readsPrec :: Int -> ReadS GetRateBasedStatementManagedKeysResponse

readList :: ReadS [GetRateBasedStatementManagedKeysResponse]

readPrec :: ReadPrec GetRateBasedStatementManagedKeysResponse

readListPrec :: ReadPrec [GetRateBasedStatementManagedKeysResponse]

Show GetRateBasedStatementManagedKeysResponse

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

showsPrec :: Int -> GetRateBasedStatementManagedKeysResponse -> ShowS

show :: GetRateBasedStatementManagedKeysResponse -> String

showList :: [GetRateBasedStatementManagedKeysResponse] -> ShowS

NFData GetRateBasedStatementManagedKeysResponse

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

rnf :: GetRateBasedStatementManagedKeysResponse -> ()

Eq GetRateBasedStatementManagedKeysResponse

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

Methods

(==) :: GetRateBasedStatementManagedKeysResponse -> GetRateBasedStatementManagedKeysResponse -> Bool

(/=) :: GetRateBasedStatementManagedKeysResponse -> GetRateBasedStatementManagedKeysResponse -> Bool

type Rep GetRateBasedStatementManagedKeysResponse

Defined in Amazonka.WAFV2.GetRateBasedStatementManagedKeys

type Rep GetRateBasedStatementManagedKeysResponse = D1 ('MetaData "GetRateBasedStatementManagedKeysResponse" "Amazonka.WAFV2.GetRateBasedStatementManagedKeys" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetRateBasedStatementManagedKeysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "managedKeysIPV4") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RateBasedStatementManagedKeysIPSet)) :*: (S1 ('MetaSel ('Just "managedKeysIPV6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RateBasedStatementManagedKeysIPSet)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRateBasedStatementManagedKeysResponse

Arguments

:: Int

$sel:httpStatus:GetRateBasedStatementManagedKeysResponse'

-> GetRateBasedStatementManagedKeysResponse

Create a value of GetRateBasedStatementManagedKeysResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:managedKeysIPV4:GetRateBasedStatementManagedKeysResponse', getRateBasedStatementManagedKeysResponse_managedKeysIPV4 - The keys that are of Internet Protocol version 4 (IPv4).

$sel:managedKeysIPV6:GetRateBasedStatementManagedKeysResponse', getRateBasedStatementManagedKeysResponse_managedKeysIPV6 - The keys that are of Internet Protocol version 6 (IPv6).

$sel:httpStatus:GetRateBasedStatementManagedKeysResponse', getRateBasedStatementManagedKeysResponse_httpStatus - The response's http status code.

Response Lenses

getRateBasedStatementManagedKeysResponse_managedKeysIPV4 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet)

The keys that are of Internet Protocol version 4 (IPv4).

getRateBasedStatementManagedKeysResponse_managedKeysIPV6 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet)

The keys that are of Internet Protocol version 6 (IPv6).

getRateBasedStatementManagedKeysResponse_httpStatus :: Lens' GetRateBasedStatementManagedKeysResponse Int

The response's http status code.