Package software.amazon.awssdk.services.guardduty.model

Class AwsApiCallAction

java.lang.Object

software.amazon.awssdk.services.guardduty.model.AwsApiCallAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsApiCallAction.Builder,AwsApiCallAction>

@Generated("software.amazon.awssdk:codegen")
public final class AwsApiCallAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsApiCallAction.Builder,AwsApiCallAction>

Contains information about the API action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsApiCallAction.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	affectedResources()	The details of the Amazon Web Services account that made the API call.
String	api()	The Amazon Web Services API name.
static AwsApiCallAction.Builder	builder()
String	callerType()	The Amazon Web Services API caller type.
DomainDetails	domainDetails()	The domain information for the Amazon Web Services API call.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorCode()	The error code of the failed Amazon Web Services API action.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAffectedResources()	For responses, this returns true if the service returned a value for the AffectedResources property.
int	hashCode()
RemoteAccountDetails	remoteAccountDetails()	The details of the Amazon Web Services account that made the API call.
RemoteIpDetails	remoteIpDetails()	The remote IP information of the connection that initiated the Amazon Web Services API call.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsApiCallAction.Builder>	serializableBuilderClass()
String	serviceName()	The Amazon Web Services service name whose API was invoked.
AwsApiCallAction.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userAgent()	The agent through which the API request was made.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

api

public final String api()

The Amazon Web Services API name.

Returns:

The Amazon Web Services API name.

callerType

public final String callerType()

The Amazon Web Services API caller type.

Returns:

The Amazon Web Services API caller type.

domainDetails

public final DomainDetails domainDetails()

The domain information for the Amazon Web Services API call.

Returns:

The domain information for the Amazon Web Services API call.

errorCode

public final String errorCode()

The error code of the failed Amazon Web Services API action.

Returns:

The error code of the failed Amazon Web Services API action.

userAgent

public final String userAgent()

The agent through which the API request was made.

Returns:

The agent through which the API request was made.

remoteIpDetails

public final RemoteIpDetails remoteIpDetails()

The remote IP information of the connection that initiated the Amazon Web Services API call.

Returns:

The remote IP information of the connection that initiated the Amazon Web Services API call.

serviceName

public final String serviceName()

The Amazon Web Services service name whose API was invoked.

Returns:

The Amazon Web Services service name whose API was invoked.

remoteAccountDetails

public final RemoteAccountDetails remoteAccountDetails()

The details of the Amazon Web Services account that made the API call. This field appears if the call was made from outside your account.

Returns:

The details of the Amazon Web Services account that made the API call. This field appears if the call was made from outside your account.

hasAffectedResources

public final boolean hasAffectedResources()

For responses, this returns true if the service returned a value for the AffectedResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

affectedResources

public final Map<String,String> affectedResources()

The details of the Amazon Web Services account that made the API call. This field identifies the resources that were affected by this API call.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAffectedResources() method.

Returns:

The details of the Amazon Web Services account that made the API call. This field identifies the resources that were affected by this API call.

toBuilder

public AwsApiCallAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsApiCallAction.Builder,AwsApiCallAction>

builder

public static AwsApiCallAction.Builder builder()

serializableBuilderClass

public static Class<? extends AwsApiCallAction.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo