com.amazonaws.services.identitymanagement.model.AccessDetail Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iam Show documentation
/*
* Copyright 2020-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.identitymanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* An object that contains details about when a principal in the reported Organizations entity last attempted to access
* an Amazon Web Services service. A principal can be an IAM user, an IAM role, or the Amazon Web Services account root
* user within the reported Organizations entity.
*
*
* This data type is a response element in the GetOrganizationsAccessReport operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AccessDetail implements Serializable, Cloneable {
/**
*
* The name of the service in which access was attempted.
*
*/
private String serviceName;
/**
*
* The namespace of the service in which access was attempted.
*
*
* To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization
* Reference. 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
*
*/
private String serviceNamespace;
/**
*
* 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 tracking period.
*
*/
private String region;
/**
*
* The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
* principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
*
*
* This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity
* attempted to access the service within the tracking period.
*
*/
private String entityPath;
/**
*
* The date and time, in ISO 8601 date-time format, when an
* authenticated principal most recently attempted to access the service. Amazon Web Services does not report
* unauthenticated requests.
*
*
* This field is null if no principals in the reported Organizations entity attempted to access the service within
* the tracking period.
*
*/
private java.util.Date lastAuthenticatedTime;
/**
*
* The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to
* access the service in the tracking period.
*
*/
private Integer totalAuthenticatedEntities;
/**
*
* The name of the service in which access was attempted.
*
*
* @param serviceName
* The name of the service in which access was attempted.
*/
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
/**
*
* The name of the service in which access was attempted.
*
*
* @return The name of the service in which access was attempted.
*/
public String getServiceName() {
return this.serviceName;
}
/**
*
* The name of the service in which access was attempted.
*
*
* @param serviceName
* The name of the service in which access was attempted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessDetail withServiceName(String serviceName) {
setServiceName(serviceName);
return this;
}
/**
*
* The namespace of the service in which access was attempted.
*
*
* To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization
* Reference. 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
*
*
* @param serviceNamespace
* The namespace of the service in which access was attempted.
*
* To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service
* Authorization Reference. 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
*/
public void setServiceNamespace(String serviceNamespace) {
this.serviceNamespace = serviceNamespace;
}
/**
*
* The namespace of the service in which access was attempted.
*
*
* To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization
* Reference. 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
*
*
* @return The namespace of the service in which access was attempted.
*
* To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service
* Authorization Reference. 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
*/
public String getServiceNamespace() {
return this.serviceNamespace;
}
/**
*
* The namespace of the service in which access was attempted.
*
*
* To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization
* Reference. 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
*
*
* @param serviceNamespace
* The namespace of the service in which access was attempted.
*
* To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service
* Authorization Reference. 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessDetail withServiceNamespace(String serviceNamespace) {
setServiceNamespace(serviceNamespace);
return this;
}
/**
*
* 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 tracking period.
*
*
* @param 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 tracking period.
*/
public void setRegion(String region) {
this.region = 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 tracking period.
*
*
* @return 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 tracking period.
*/
public String getRegion() {
return this.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 tracking period.
*
*
* @param 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 tracking period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessDetail withRegion(String region) {
setRegion(region);
return this;
}
/**
*
* The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
* principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
*
*
* This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity
* attempted to access the service within the tracking period.
*
*
* @param entityPath
* The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
* principal last attempted to access the service. Amazon Web Services does not report unauthenticated
* requests.
*
* This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations
* entity attempted to access the service within the tracking period.
*/
public void setEntityPath(String entityPath) {
this.entityPath = entityPath;
}
/**
*
* The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
* principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
*
*
* This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity
* attempted to access the service within the tracking period.
*
*
* @return The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
* principal last attempted to access the service. Amazon Web Services does not report unauthenticated
* requests.
*
* This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations
* entity attempted to access the service within the tracking period.
*/
public String getEntityPath() {
return this.entityPath;
}
/**
*
* The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
* principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
*
*
* This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity
* attempted to access the service within the tracking period.
*
*
* @param entityPath
* The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
* principal last attempted to access the service. Amazon Web Services does not report unauthenticated
* requests.
*
* This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations
* entity attempted to access the service within the tracking period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessDetail withEntityPath(String entityPath) {
setEntityPath(entityPath);
return this;
}
/**
*
* The date and time, in ISO 8601 date-time format, when an
* authenticated principal most recently attempted to access the service. Amazon Web Services does not report
* unauthenticated requests.
*
*
* This field is null if no principals in the reported Organizations entity attempted to access the service within
* the tracking period.
*
*
* @param lastAuthenticatedTime
* The date and time, in ISO 8601 date-time format, when an
* authenticated principal most recently attempted to access the service. Amazon Web Services does not report
* unauthenticated requests.
*
* This field is null if no principals in the reported Organizations entity attempted to access the service
* within the tracking period.
*/
public void setLastAuthenticatedTime(java.util.Date lastAuthenticatedTime) {
this.lastAuthenticatedTime = lastAuthenticatedTime;
}
/**
*
* The date and time, in ISO 8601 date-time format, when an
* authenticated principal most recently attempted to access the service. Amazon Web Services does not report
* unauthenticated requests.
*
*
* This field is null if no principals in the reported Organizations entity attempted to access the service within
* the tracking period.
*
*
* @return The date and time, in ISO 8601 date-time format, when an
* authenticated principal most recently attempted to access the service. Amazon Web Services does not
* report unauthenticated requests.
*
* This field is null if no principals in the reported Organizations entity attempted to access the service
* within the tracking period.
*/
public java.util.Date getLastAuthenticatedTime() {
return this.lastAuthenticatedTime;
}
/**
*
* The date and time, in ISO 8601 date-time format, when an
* authenticated principal most recently attempted to access the service. Amazon Web Services does not report
* unauthenticated requests.
*
*
* This field is null if no principals in the reported Organizations entity attempted to access the service within
* the tracking period.
*
*
* @param lastAuthenticatedTime
* The date and time, in ISO 8601 date-time format, when an
* authenticated principal most recently attempted to access the service. Amazon Web Services does not report
* unauthenticated requests.
*
* This field is null if no principals in the reported Organizations entity attempted to access the service
* within the tracking period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessDetail withLastAuthenticatedTime(java.util.Date lastAuthenticatedTime) {
setLastAuthenticatedTime(lastAuthenticatedTime);
return this;
}
/**
*
* The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to
* access the service in the tracking period.
*
*
* @param totalAuthenticatedEntities
* The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted
* to access the service in the tracking period.
*/
public void setTotalAuthenticatedEntities(Integer totalAuthenticatedEntities) {
this.totalAuthenticatedEntities = totalAuthenticatedEntities;
}
/**
*
* The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to
* access the service in the tracking period.
*
*
* @return The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted
* to access the service in the tracking period.
*/
public Integer getTotalAuthenticatedEntities() {
return this.totalAuthenticatedEntities;
}
/**
*
* The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to
* access the service in the tracking period.
*
*
* @param totalAuthenticatedEntities
* The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted
* to access the service in the tracking period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessDetail withTotalAuthenticatedEntities(Integer totalAuthenticatedEntities) {
setTotalAuthenticatedEntities(totalAuthenticatedEntities);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getServiceName() != null)
sb.append("ServiceName: ").append(getServiceName()).append(",");
if (getServiceNamespace() != null)
sb.append("ServiceNamespace: ").append(getServiceNamespace()).append(",");
if (getRegion() != null)
sb.append("Region: ").append(getRegion()).append(",");
if (getEntityPath() != null)
sb.append("EntityPath: ").append(getEntityPath()).append(",");
if (getLastAuthenticatedTime() != null)
sb.append("LastAuthenticatedTime: ").append(getLastAuthenticatedTime()).append(",");
if (getTotalAuthenticatedEntities() != null)
sb.append("TotalAuthenticatedEntities: ").append(getTotalAuthenticatedEntities());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AccessDetail == false)
return false;
AccessDetail other = (AccessDetail) obj;
if (other.getServiceName() == null ^ this.getServiceName() == null)
return false;
if (other.getServiceName() != null && other.getServiceName().equals(this.getServiceName()) == false)
return false;
if (other.getServiceNamespace() == null ^ this.getServiceNamespace() == null)
return false;
if (other.getServiceNamespace() != null && other.getServiceNamespace().equals(this.getServiceNamespace()) == false)
return false;
if (other.getRegion() == null ^ this.getRegion() == null)
return false;
if (other.getRegion() != null && other.getRegion().equals(this.getRegion()) == false)
return false;
if (other.getEntityPath() == null ^ this.getEntityPath() == null)
return false;
if (other.getEntityPath() != null && other.getEntityPath().equals(this.getEntityPath()) == false)
return false;
if (other.getLastAuthenticatedTime() == null ^ this.getLastAuthenticatedTime() == null)
return false;
if (other.getLastAuthenticatedTime() != null && other.getLastAuthenticatedTime().equals(this.getLastAuthenticatedTime()) == false)
return false;
if (other.getTotalAuthenticatedEntities() == null ^ this.getTotalAuthenticatedEntities() == null)
return false;
if (other.getTotalAuthenticatedEntities() != null && other.getTotalAuthenticatedEntities().equals(this.getTotalAuthenticatedEntities()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getServiceName() == null) ? 0 : getServiceName().hashCode());
hashCode = prime * hashCode + ((getServiceNamespace() == null) ? 0 : getServiceNamespace().hashCode());
hashCode = prime * hashCode + ((getRegion() == null) ? 0 : getRegion().hashCode());
hashCode = prime * hashCode + ((getEntityPath() == null) ? 0 : getEntityPath().hashCode());
hashCode = prime * hashCode + ((getLastAuthenticatedTime() == null) ? 0 : getLastAuthenticatedTime().hashCode());
hashCode = prime * hashCode + ((getTotalAuthenticatedEntities() == null) ? 0 : getTotalAuthenticatedEntities().hashCode());
return hashCode;
}
@Override
public AccessDetail clone() {
try {
return (AccessDetail) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}