software.amazon.awssdk.services.iam.model

Class AccessDetail

java.lang.Object

software.amazon.awssdk.services.iam.model.AccessDetail

All Implemented Interfaces:

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

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

An object that contains details about when a principal in the reported AWS Organizations entity last attempted to access an AWS service. A principal can be an IAM user, an IAM role, or the AWS account root user within the reported Organizations entity.

This data type is a response element in the GetOrganizationsAccessReport operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AccessDetail.Builder

Method Summary

Modifier and Type	Method and Description
static AccessDetail.Builder	builder()
String	entityPath() The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastAuthenticatedTime() The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service.
String	region() The Region where the last service access attempt occurred.
List<SdkField<?>>	sdkFields()
static Class<? extends AccessDetail.Builder>	serializableBuilderClass()
String	serviceName() The name of the service in which access was attempted.
String	serviceNamespace() The namespace of the service in which access was attempted.
AccessDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalAuthenticatedEntities() The number of accounts with authenticated principals (root users, IAM users, and IAM roles) that attempted to access the service in the reporting period.

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

serviceName

public String serviceName()

The name of the service in which access was attempted.

Returns:

The name of the service in which access was attempted.

serviceNamespace

public String serviceNamespace()

The namespace of the service in which access was attempted.

To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.

Returns:

The namespace of the service in which access was attempted.

To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.

region

public String region()

The Region where the last service access attempt occurred.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

Returns:

The Region where the last service access attempt occurred.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

entityPath

public String entityPath()

The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no principals (IAM users, IAM roles, or root users) in the reported Organizations entity attempted to access the service within the reporting period.

Returns:

The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no principals (IAM users, IAM roles, or root users) in the reported Organizations entity attempted to access the service within the reporting period.

lastAuthenticatedTime

public Instant lastAuthenticatedTime()

The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

Returns:

The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

totalAuthenticatedEntities

public Integer totalAuthenticatedEntities()

The number of accounts with authenticated principals (root users, IAM users, and IAM roles) that attempted to access the service in the reporting period.

Returns:

The number of accounts with authenticated principals (root users, IAM users, and IAM roles) that attempted to access the service in the reporting period.

toBuilder

public AccessDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccessDetail.Builder,AccessDetail>

builder

public static AccessDetail.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo