Class DescribeInstanceResponse

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

  • Method Details

    • instanceArn

      public final String instanceArn()

      The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      Returns:
      The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    • identityStoreId

      public final String identityStoreId()

      The identifier of the identity store that is connected to the instance of IAM Identity Center.

      Returns:
      The identifier of the identity store that is connected to the instance of IAM Identity Center.

    • identityStoreArn

      public final String identityStoreArn()

      The ARN of the identity store that is connected to the instance of IAM Identity Center.

      Returns:
      The ARN of the identity store that is connected to the instance of IAM Identity Center.

    • ownerAccountId

      public final String ownerAccountId()

      The identifier of the Amazon Web Services account for which the instance was created.

      Returns:
      The identifier of the Amazon Web Services account for which the instance was created.

    • name

      public final String name()

      Specifies the instance name.

      Returns:
      Specifies the instance name.

    • createdDate

      public final Instant createdDate()

      The date the instance was created.

      Returns:
      The date the instance was created.

    • status

      public final InstanceStatus status()

      The status of the instance.

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

      Returns:
      The status of the instance.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the instance.

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

      Returns:
      The status of the instance.
      See Also:

    • statusReason

      public final String statusReason()

      Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.

      Returns:
      Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.

    • primaryRegion

      public final String primaryRegion()

      The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

      Returns:
      The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

    • hasRegions

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

    • regions

      public final List<RegionMetadata> regions()

      The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.

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

      Returns:
      The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.

    • encryptionConfigurationDetails

      public final EncryptionConfigurationDetails encryptionConfigurationDetails()

      Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

      Returns:
      Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

    • permissionSetsEnabled

      public final Boolean permissionSetsEnabled()

      Indicates whether permission sets are enabled for this Identity Center instance.

      Returns:
      Indicates whether permission sets are enabled for this Identity Center instance.

    • toBuilder

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

    • builder

      public static DescribeInstanceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeInstanceResponse.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.