Class DescribePartnerAppResponse

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

  • Method Details

    • arn

      public final String arn()

      The ARN of the SageMaker Partner AI App that was described.

      Returns:
      The ARN of the SageMaker Partner AI App that was described.

    • name

      public final String name()

      The name of the SageMaker Partner AI App.

      Returns:
      The name of the SageMaker Partner AI App.

    • type

      public final PartnerAppType type()

      The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

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

      Returns:
      The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

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

      Returns:
      The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
      See Also:

    • status

      public final PartnerAppStatus status()

      The status of the SageMaker Partner AI App.

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

      Returns:
      The status of the SageMaker Partner AI App.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the SageMaker Partner AI App.

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

      Returns:
      The status of the SageMaker Partner AI App.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time that the SageMaker Partner AI App was created.

      Returns:
      The time that the SageMaker Partner AI App was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time that the SageMaker Partner AI App was last modified.

      Returns:
      The time that the SageMaker Partner AI App was last modified.

    • executionRoleArn

      public final String executionRoleArn()

      The ARN of the IAM role associated with the SageMaker Partner AI App.

      Returns:
      The ARN of the IAM role associated with the SageMaker Partner AI App.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.

      Returns:
      The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.

    • baseUrl

      public final String baseUrl()

      The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.

      Returns:
      The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.

    • maintenanceConfig

      public final PartnerAppMaintenanceConfig maintenanceConfig()

      Maintenance configuration settings for the SageMaker Partner AI App.

      Returns:
      Maintenance configuration settings for the SageMaker Partner AI App.

    • tier

      public final String tier()

      The instance type and size of the cluster attached to the SageMaker Partner AI App.

      Returns:
      The instance type and size of the cluster attached to the SageMaker Partner AI App.

    • version

      public final String version()

      The version of the SageMaker Partner AI App.

      Returns:
      The version of the SageMaker Partner AI App.

    • applicationConfig

      public final PartnerAppConfig applicationConfig()

      Configuration settings for the SageMaker Partner AI App.

      Returns:
      Configuration settings for the SageMaker Partner AI App.

    • authType

      public final PartnerAppAuthType authType()

      The authorization type that users use to access the SageMaker Partner AI App.

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

      Returns:
      The authorization type that users use to access the SageMaker Partner AI App.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The authorization type that users use to access the SageMaker Partner AI App.

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

      Returns:
      The authorization type that users use to access the SageMaker Partner AI App.
      See Also:

    • enableIamSessionBasedIdentity

      public final Boolean enableIamSessionBasedIdentity()

      When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

      Returns:
      When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

    • error

      public final ErrorInfo error()

      This is an error field object that contains the error code and the reason for an operation failure.

      Returns:
      This is an error field object that contains the error code and the reason for an operation failure.

    • toBuilder

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

    • builder

      public static DescribePartnerAppResponse.Builder builder()

    • serializableBuilderClass

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