Class GetOrganizationsAccessReportResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iam.model.IamResponse
software.amazon.awssdk.services.iam.model.GetOrganizationsAccessReportResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetOrganizationsAccessReportResponse.Builder,GetOrganizationsAccessReportResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetOrganizationsAccessReportResponse extends IamResponse implements ToCopyableBuilder<GetOrganizationsAccessReportResponse.Builder,GetOrganizationsAccessReportResponse>

  • Method Details

    • jobStatus

      public final JobStatusType jobStatus()

      The status of the job.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The status of the job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The status of the job.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The status of the job.
      See Also:

    • jobCreationDate

      public final Instant jobCreationDate()

      The date and time, in ISO 8601 date-time format, when the report job was created.

      Returns:
      The date and time, in ISO 8601 date-time format, when the report job was created.

    • jobCompletionDate

      public final Instant jobCompletionDate()

      The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

      This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

      Returns:
      The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

      This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

    • numberOfServicesAccessible

      public final Integer numberOfServicesAccessible()

      The number of services that the applicable SCPs allow account principals to access.

      Returns:
      The number of services that the applicable SCPs allow account principals to access.

    • numberOfServicesNotAccessed

      public final Integer numberOfServicesNotAccessed()

      The number of services that account principals are allowed but did not attempt to access.

      Returns:
      The number of services that account principals are allowed but did not attempt to access.

    • hasAccessDetails

      public final boolean hasAccessDetails()
      For responses, this returns true if the service returned a value for the AccessDetails 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.

    • accessDetails

      public final List<AccessDetail> accessDetails()

      An object that contains details about the most recent attempt to access the service.

      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 hasAccessDetails() method.

      Returns:
      An object that contains details about the most recent attempt to access the service.

    • isTruncated

      public final Boolean isTruncated()

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

      Returns:
      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker

      public final String marker()

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

      Returns:
      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

    • errorDetails

      public final ErrorDetails errorDetails()
      Returns the value of the ErrorDetails property for this object.
      Returns:
      The value of the ErrorDetails property for this object.

    • toBuilder

      public GetOrganizationsAccessReportResponse.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<GetOrganizationsAccessReportResponse.Builder,GetOrganizationsAccessReportResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetOrganizationsAccessReportResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.