Package software.amazon.awssdk.services.qconnect.model

Class CreateAssistantRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qconnect.model.QConnectRequest

software.amazon.awssdk.services.qconnect.model.CreateAssistantRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAssistantRequest.Builder,CreateAssistantRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAssistantRequest
extends QConnectRequest
implements ToCopyableBuilder<CreateAssistantRequest.Builder,CreateAssistantRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAssistantRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateAssistantRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	description()	The description of the assistant.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the assistant.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAssistantRequest.Builder>	serializableBuilderClass()
ServerSideEncryptionConfiguration	serverSideEncryptionConfiguration()	The configuration information for the customer managed key used for encryption.
Map<String,String>	tags()	The tags used to organize, track, or control access for this resource.
CreateAssistantRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AssistantType	type()	The type of assistant.
String	typeAsString()	The type of assistant.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

description

public final String description()

The description of the assistant.

Returns:

The description of the assistant.

name

public final String name()

The name of the assistant.

Returns:

The name of the assistant.

serverSideEncryptionConfiguration

public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

The configuration information for the customer managed key used for encryption.

The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

Returns:

The configuration information for the customer managed key used for encryption.

The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

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 Map<String,String> tags()

The tags used to organize, track, or control access for this 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:

The tags used to organize, track, or control access for this resource.

type

public final AssistantType type()

The type of assistant.

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

Returns:

The type of assistant.

See Also:

AssistantType

typeAsString

public final String typeAsString()

The type of assistant.

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

Returns:

The type of assistant.

See Also:

AssistantType

toBuilder

public CreateAssistantRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAssistantRequest.Builder,CreateAssistantRequest>

Specified by:

toBuilder in class QConnectRequest

builder

public static CreateAssistantRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo