Class AwsApiCallAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsApiCallAction.Builder,
AwsApiCallAction>
Provided if ActionType
is AWS_API_CALL
. It provides details about the API call that was
detected.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionIdentifies 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
Indicates whether the API call originated from a remote IP address (remoteip
) or from a DNS domain (domain
).Provided ifCallerType
isdomain
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A timestamp that indicates when the API call was first observed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
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
Provided ifCallerType
isremoteIp
.static Class
<? extends AwsApiCallAction.Builder> final String
The name of the Amazon Web Services service that the API method belongs to.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
api
The name of the API method that was issued.
- Returns:
- The name of the API method that was issued.
-
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
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
Provided if
CallerType
isremoteIp
. Provides information about the remote IP address that the API call originated from.- Returns:
- Provided if
CallerType
isremoteIp
. Provides information about the remote IP address that the API call originated from.
-
domainDetails
Provided if
CallerType
isdomain
. Provides information about the DNS domain that the API call originated from.- Returns:
- Provided if
CallerType
isdomain
. 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
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
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
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
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 interfaceToCopyableBuilder<AwsApiCallAction.Builder,
AwsApiCallAction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-