ResponseInspection (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.ResponseInspection

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResponseInspection
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that submit too many failed login attempts in a short amount of time.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

Enable login response inspection by configuring exactly one component of the response to inspect. You can't configure more than one. If you don't configure any of the response inspection options, response inspection is disabled.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ResponseInspection()

Constructors
Constructor and Description
`ResponseInspection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResponseInspection`	`clone()`
`boolean`	`equals(Object obj)`
`ResponseInspectionBodyContains`	`getBodyContains()` Configures inspection of the response body.
`ResponseInspectionHeader`	`getHeader()` Configures inspection of the response header.
`ResponseInspectionJson`	`getJson()` Configures inspection of the response JSON.
`ResponseInspectionStatusCode`	`getStatusCode()` Configures inspection of the response status code.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBodyContains(ResponseInspectionBodyContains bodyContains)` Configures inspection of the response body.
`void`	`setHeader(ResponseInspectionHeader header)` Configures inspection of the response header.
`void`	`setJson(ResponseInspectionJson json)` Configures inspection of the response JSON.
`void`	`setStatusCode(ResponseInspectionStatusCode statusCode)` Configures inspection of the response status code.
`String`	`toString()` Returns a string representation of this object.
`ResponseInspection`	`withBodyContains(ResponseInspectionBodyContains bodyContains)` Configures inspection of the response body.
`ResponseInspection`	`withHeader(ResponseInspectionHeader header)` Configures inspection of the response header.
`ResponseInspection`	`withJson(ResponseInspectionJson json)` Configures inspection of the response JSON.
`ResponseInspection`	`withStatusCode(ResponseInspectionStatusCode statusCode)` Configures inspection of the response status code.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ResponseInspection
```
public ResponseInspection()
```
- Method Detail
  - setStatusCode
```
public void setStatusCode(ResponseInspectionStatusCode statusCode)
```
    Configures inspection of the response status code.
    
    Parameters:
    
    statusCode - Configures inspection of the response status code.
  - getStatusCode
```
public ResponseInspectionStatusCode getStatusCode()
```
    Configures inspection of the response status code.
    
    Returns:
    
    Configures inspection of the response status code.
  - withStatusCode
```
public ResponseInspection withStatusCode(ResponseInspectionStatusCode statusCode)
```
    Configures inspection of the response status code.
    
    Parameters:
    
    statusCode - Configures inspection of the response status code.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeader
```
public void setHeader(ResponseInspectionHeader header)
```
    Configures inspection of the response header.
    
    Parameters:
    
    header - Configures inspection of the response header.
  - getHeader
```
public ResponseInspectionHeader getHeader()
```
    Configures inspection of the response header.
    
    Returns:
    
    Configures inspection of the response header.
  - withHeader
```
public ResponseInspection withHeader(ResponseInspectionHeader header)
```
    Configures inspection of the response header.
    
    Parameters:
    
    header - Configures inspection of the response header.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBodyContains
```
public void setBodyContains(ResponseInspectionBodyContains bodyContains)
```
    Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
    
    Parameters:
    
    bodyContains - Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
  - getBodyContains
```
public ResponseInspectionBodyContains getBodyContains()
```
    Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
    
    Returns:
    
    Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
  - withBodyContains
```
public ResponseInspection withBodyContains(ResponseInspectionBodyContains bodyContains)
```
    Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
    
    Parameters:
    
    bodyContains - Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJson
```
public void setJson(ResponseInspectionJson json)
```
    Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
    
    Parameters:
    
    json - Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
  - getJson
```
public ResponseInspectionJson getJson()
```
    Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
    
    Returns:
    
    Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
  - withJson
```
public ResponseInspection withJson(ResponseInspectionJson json)
```
    Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
    
    Parameters:
    
    json - Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ResponseInspection clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ResponseInspection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResponseInspection

Method Detail

setStatusCode

getStatusCode

withStatusCode

setHeader

getHeader

withHeader

setBodyContains

getBodyContains

withBodyContains

setJson

getJson

withJson

toString

equals

hashCode

clone

marshall