Package software.amazon.awssdk.services.sagemaker.model

Class CreatePartnerAppRequest

    • Method Detail

      • name

        public final String name()

        The name to give the SageMaker Partner AI App.

        Returns:
        The name to give the SageMaker Partner AI App.

      • type

        public final PartnerAppType type()

        The type of SageMaker Partner AI App to create. 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 to create. 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 to create. 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 to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
        See Also:
        PartnerAppType

      • executionRoleArn

        public final String executionRoleArn()

        The ARN of the IAM role that the partner application uses.

        Returns:
        The ARN of the IAM role that the partner application uses.

      • kmsKeyId

        public final String kmsKeyId()

        SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.

        Returns:
        SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.

      • 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()

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

        Returns:
        Indicates the instance type and size of the cluster attached to 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.

      • clientToken

        public final String clientToken()

        A unique token that guarantees that the call to this API is idempotent.

        Returns:
        A unique token that guarantees that the call to this API is idempotent.

      • hasTags

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

      • tags

        public final List<Tag> tags()

        Each tag consists of a key and an optional value. Tag keys must be unique per resource.

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

        Returns:
        Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      • 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