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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribePartnerAppResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PartnerAppConfig
applicationConfig()
Configuration settings for the SageMaker Partner AI App.String
arn()
The ARN of the SageMaker Partner AI App that was described.PartnerAppAuthType
authType()
The authorization type that users use to access the SageMaker Partner AI App.String
authTypeAsString()
The authorization type that users use to access the SageMaker Partner AI App.String
baseUrl()
The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.static DescribePartnerAppResponse.Builder
builder()
Instant
creationTime()
The time that the SageMaker Partner AI App was created.Boolean
enableIamSessionBasedIdentity()
When set toTRUE
, 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.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
ErrorInfo
error()
This is an error field object that contains the error code and the reason for an operation failure.String
executionRoleArn()
The ARN of the IAM role associated with the SageMaker Partner AI App.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
PartnerAppMaintenanceConfig
maintenanceConfig()
Maintenance configuration settings for the SageMaker Partner AI App.String
name()
The name of the SageMaker Partner AI App.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends DescribePartnerAppResponse.Builder>
serializableBuilderClass()
PartnerAppStatus
status()
The status of the SageMaker Partner AI App.String
statusAsString()
The status of the SageMaker Partner AI App.String
tier()
The instance type and size of the cluster attached to the SageMaker Partner AI App.DescribePartnerAppResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.PartnerAppType
type()
The type of SageMaker Partner AI App.String
typeAsString()
The type of SageMaker Partner AI App.String
version()
The version of the SageMaker Partner AI App.-
Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
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
-
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
, orfiddler
.If the service returns an enum value that is not available in the current SDK version,
type
will returnPartnerAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of SageMaker Partner AI App. Must be one of the following:
lakera-guard
,comet
,deepchecks-llm-evaluation
, orfiddler
. - 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
, orfiddler
.If the service returns an enum value that is not available in the current SDK version,
type
will returnPartnerAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of SageMaker Partner AI App. Must be one of the following:
lakera-guard
,comet
,deepchecks-llm-evaluation
, orfiddler
. - See Also:
PartnerAppType
-
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 returnPartnerAppStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the SageMaker Partner AI App.
- See Also:
PartnerAppStatus
-
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 returnPartnerAppStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 returnPartnerAppAuthType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthTypeAsString()
.- 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 returnPartnerAppAuthType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthTypeAsString()
.- 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.
-
toBuilder
public DescribePartnerAppResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribePartnerAppResponse.Builder,DescribePartnerAppResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static DescribePartnerAppResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribePartnerAppResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-