Class AwsApiCallAction

java.lang.Object

software.amazon.awssdk.services.securityhub.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>

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	Description
static interface	AwsApiCallAction.Builder

Method Summary

Modifier and Type	Method	Description
final Map<String,String>	affectedResources()	Identifies the resources that were affected by the API call.
final String	api()	The name of the API method that was issued.
static AwsApiCallAction.Builder	builder()
final String	callerType()	Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain ( domain).
final AwsApiCallActionDomainDetails	domainDetails()	Provided if CallerType is domain.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final String	firstSeen()	A timestamp that indicates when the API call was first observed.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final boolean	hasAffectedResources()	For responses, this returns true if the service returned a value for the AffectedResources property.
final int	hashCode()
final String	lastSeen()	A timestamp that indicates when the API call was most recently observed.
final ActionRemoteIpDetails	remoteIpDetails()	Provided if CallerType is remoteip.
final List<SdkField<?>>	sdkFields()
static Class<? extends AwsApiCallAction.Builder>	serializableBuilderClass()
final String	serviceName()	The name of the Amazon Web Services service that the API method belongs to.
AwsApiCallAction.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

api

public final String api()

The name of the API method that was issued.

Length Constraints: 128.

Returns:

The name of the API method that was issued.

Length Constraints: 128.

serviceName

public final String serviceName()

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

Length Constraints: 128.

Returns:

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

Length Constraints: 128.

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

A timestamp that indicates when the API call was first observed.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

A timestamp that indicates when the API call was first observed.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

lastSeen

public final String lastSeen()

A timestamp that indicates when the API call was most recently observed.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

A timestamp that indicates when the API call was most recently observed.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

toBuilder

public AwsApiCallAction.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AwsApiCallAction.Builder,AwsApiCallAction>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.