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
ActionTypeisAWS_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 interfaceAwsApiCallAction.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>affectedResources()Identifies the resources that were affected by the API call.Stringapi()The name of the API method that was issued.static AwsApiCallAction.Builderbuilder()StringcallerType()Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).AwsApiCallActionDomainDetailsdomainDetails()Provided ifCallerTypeisdomain.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfirstSeen()A timestamp that indicates when the API call was first observed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAffectedResources()For responses, this returns true if the service returned a value for the AffectedResources property.inthashCode()StringlastSeen()A timestamp that indicates when the API call was most recently observed.ActionRemoteIpDetailsremoteIpDetails()Provided ifCallerTypeisremoteIp.List<SdkField<?>>sdkFields()static Class<? extends AwsApiCallAction.Builder>serializableBuilderClass()StringserviceName()The name of the Amazon Web Services service that the API method belongs to.AwsApiCallAction.BuildertoBuilder()StringtoString()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.
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
CallerTypeisremoteIp. Provides information about the remote IP address that the API call originated from.- Returns:
- Provided if
CallerTypeisremoteIp. Provides information about the remote IP address that the API call originated from.
-
domainDetails
public final AwsApiCallActionDomainDetails domainDetails()
Provided if
CallerTypeisdomain. Provides information about the DNS domain that the API call originated from.- Returns:
- Provided if
CallerTypeisdomain. 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 theisEmpty()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
Zor("+" / "-") 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
Zor("+" / "-") 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
Zor("+" / "-") 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
Zor("+" / "-") 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AwsApiCallAction.Builder,AwsApiCallAction>
-
builder
public static AwsApiCallAction.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsApiCallAction.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-