Class UpdateWebExperienceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.qbusiness.model.QBusinessRequest
software.amazon.awssdk.services.qbusiness.model.UpdateWebExperienceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateWebExperienceRequest.Builder,UpdateWebExperienceRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateWebExperienceRequest extends QBusinessRequest implements ToCopyableBuilder<UpdateWebExperienceRequest.Builder,UpdateWebExperienceRequest>

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the Amazon Q Business application attached to the web experience.

      Returns:
      The identifier of the Amazon Q Business application attached to the web experience.

    • webExperienceId

      public final String webExperienceId()

      The identifier of the Amazon Q Business web experience.

      Returns:
      The identifier of the Amazon Q Business web experience.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

      Returns:
      The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

    • authenticationConfiguration

      @Deprecated public final WebExperienceAuthConfiguration authenticationConfiguration()
      Deprecated.
      Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

      The authentication configuration of the Amazon Q Business web experience.

      Returns:
      The authentication configuration of the Amazon Q Business web experience.

    • title

      public final String title()

      The title of the Amazon Q Business web experience.

      Returns:
      The title of the Amazon Q Business web experience.

    • subtitle

      public final String subtitle()

      The subtitle of the Amazon Q Business web experience.

      Returns:
      The subtitle of the Amazon Q Business web experience.

    • welcomeMessage

      public final String welcomeMessage()

      A customized welcome message for an end user in an Amazon Q Business web experience.

      Returns:
      A customized welcome message for an end user in an Amazon Q Business web experience.

    • samplePromptsControlMode

      public final WebExperienceSamplePromptsControlMode samplePromptsControlMode()

      Determines whether sample prompts are enabled in the web experience for an end user.

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

      Returns:
      Determines whether sample prompts are enabled in the web experience for an end user.
      See Also:

    • samplePromptsControlModeAsString

      public final String samplePromptsControlModeAsString()

      Determines whether sample prompts are enabled in the web experience for an end user.

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

      Returns:
      Determines whether sample prompts are enabled in the web experience for an end user.
      See Also:

    • identityProviderConfiguration

      public final IdentityProviderConfiguration identityProviderConfiguration()

      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      Returns:
      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

    • hasOrigins

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

    • origins

      public final List<String> origins()

      Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https ), the domain name, and the port number (if specified).

      • Any values except null submitted as part of this update will replace all previous values.

      • You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

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

      Returns:
      Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https), the domain name, and the port number (if specified).

      • Any values except null submitted as part of this update will replace all previous values.

      • You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

    • browserExtensionConfiguration

      public final BrowserExtensionConfiguration browserExtensionConfiguration()

      The browser extension configuration for an Amazon Q Business web experience.

      For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

      Returns:
      The browser extension configuration for an Amazon Q Business web experience.

      For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

    • customizationConfiguration

      public final CustomizationConfiguration customizationConfiguration()

      Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

      Returns:
      Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

    • toBuilder

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

    • builder

      public static UpdateWebExperienceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateWebExperienceRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.