Class DescribePartnerAppResponse

    • Method Detail

      • 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:
        PartnerAppType
      • 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:
        PartnerAppType
      • 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:
        PartnerAppStatus
      • 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.
      • 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.
      • 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:
        PartnerAppAuthType
      • 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:
        PartnerAppAuthType
      • 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.
      • 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