software.amazon.awssdk.services.securityhub.model

Class AwsApiCallAction

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsApiCallAction

All Implemented Interfaces:

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

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

Provided if ActionType is AWS_API_CALL. It provides details about the API call that was detected.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsApiCallAction.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	affectedResources() Identifies the resources that were affected by the API call.
String	api() The name of the API method that was issued.
static AwsApiCallAction.Builder	builder()
String	callerType() Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain ( domain).
AwsApiCallActionDomainDetails	domainDetails() Provided if CallerType is domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstSeen() An ISO8601-formatted timestamp that indicates when the API call was first observed.
<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()
String	lastSeen() An ISO8601-formatted timestamp that indicates when the API call was most recently observed.
ActionRemoteIpDetails	remoteIpDetails() Provided if CallerType is remoteIp.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsApiCallAction.Builder>	serializableBuilderClass()
String	serviceName() The name of the Amazon Web Services service that the API method belongs to.
AwsApiCallAction.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 name of the API method that was issued.

Returns:

The name of the API method that was issued.

serviceName

public final String serviceName()

The name of the Amazon Web Services service that the API method belongs to.

Returns:

The name of the Amazon Web Services service that the API method belongs to.

callerType

public final String callerType()

Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain ( domain).

Returns:

Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).

remoteIpDetails

public final ActionRemoteIpDetails remoteIpDetails()

Provided if CallerType is remoteIp. Provides information about the remote IP address that the API call originated from.

Returns:

Provided if CallerType is remoteIp. Provides information about the remote IP address that the API call originated from.

domainDetails

public final AwsApiCallActionDomainDetails domainDetails()

Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

Returns:

Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

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()

Identifies the resources that were affected by the 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:

Identifies the resources that were affected by the API call.

firstSeen

public final String firstSeen()

An ISO8601-formatted timestamp that indicates when the API call was first observed.

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

Returns:

An ISO8601-formatted timestamp that indicates when the API call was first observed.

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

lastSeen

public final String lastSeen()

An ISO8601-formatted timestamp that indicates when the API call was most recently observed.

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

Returns:

An ISO8601-formatted timestamp that indicates when the API call was most recently observed.

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

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