Package software.amazon.awssdk.services.ssoadmin.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstanceResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeInstanceResponse.Builder	builder()
Instant	createdDate()	The date the instance was created.
EncryptionConfigurationDetails	encryptionConfigurationDetails()	Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityStoreId()	The identifier of the identity store that is connected to the instance of IAM Identity Center.
String	instanceArn()	The ARN of the instance of IAM Identity Center under which the operation will run.
String	name()	Specifies the instance name.
String	ownerAccountId()	The identifier of the Amazon Web Services account for which the instance was created.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstanceResponse.Builder>	serializableBuilderClass()
InstanceStatus	status()	The status of the instance.
String	statusAsString()	The status of the instance.
String	statusReason()	Provides additional context about the current status of the IAM Identity Center instance.
DescribeInstanceResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ssoadmin.model.SsoAdminResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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.

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:

InstanceStatus

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:

InstanceStatus

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.

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.

toBuilder

public DescribeInstanceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstanceResponse.Builder,DescribeInstanceResponse>

Specified by:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo