Interface CreateContactRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<CreateContactRequest.Builder,CreateContactRequest>, SdkBuilder<CreateContactRequest.Builder,CreateContactRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateContactRequest
@Mutable @NotThreadSafe public static interface CreateContactRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<CreateContactRequest.Builder,CreateContactRequest>

  • Method Details

    • instanceId

      CreateContactRequest.Builder instanceId(String instanceId)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Parameters:
      instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateContactRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • relatedContactId

      CreateContactRequest.Builder relatedContactId(String relatedContactId)

      The identifier of the contact in this instance of Amazon Connect.

      Parameters:
      relatedContactId - The identifier of the contact in this instance of Amazon Connect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      CreateContactRequest.Builder attributes(Map<String,String> attributes)

      A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

      Parameters:
      attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • references

      CreateContactRequest.Builder references(Map<String,Reference> references)

      A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.

      Parameters:
      references - A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channel

      CreateContactRequest.Builder channel(String channel)

      The channel for the contact.

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      Parameters:
      channel - The channel for the contact.

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • channel

      CreateContactRequest.Builder channel(Channel channel)

      The channel for the contact.

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      Parameters:
      channel - The channel for the contact.

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initiationMethod

      CreateContactRequest.Builder initiationMethod(String initiationMethod)

      Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

      Parameters:
      initiationMethod - Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initiationMethod

      CreateContactRequest.Builder initiationMethod(ContactInitiationMethod initiationMethod)

      Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

      Parameters:
      initiationMethod - Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expiryDurationInMinutes

      CreateContactRequest.Builder expiryDurationInMinutes(Integer expiryDurationInMinutes)

      Number of minutes the contact will be active for before expiring

      Parameters:
      expiryDurationInMinutes - Number of minutes the contact will be active for before expiring
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userInfo

      CreateContactRequest.Builder userInfo(UserInfo userInfo)

      User details for the contact

      UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

      Parameters:
      userInfo - User details for the contact

      UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userInfo

      default CreateContactRequest.Builder userInfo(Consumer<UserInfo.Builder> userInfo)

      User details for the contact

      UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

      This is a convenience method that creates an instance of the UserInfo.Builder avoiding the need to create one manually via UserInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userInfo(UserInfo).

      Parameters:
      userInfo - a consumer that will call methods on UserInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initiateAs

      CreateContactRequest.Builder initiateAs(String initiateAs)

      Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.

      Parameters:
      initiateAs - Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initiateAs

      CreateContactRequest.Builder initiateAs(InitiateAs initiateAs)

      Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.

      Parameters:
      initiateAs - Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      CreateContactRequest.Builder name(String name)

      The name of a the contact.

      Parameters:
      name - The name of a the contact.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateContactRequest.Builder description(String description)

      A description of the contact.

      Parameters:
      description - A description of the contact.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentAttributes

      CreateContactRequest.Builder segmentAttributes(Map<String,SegmentAttributeValue> segmentAttributes)

      A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

      Attribute keys can include only alphanumeric, -, and _.

      This field can be used to set Segment Contact Expiry as a duration in minutes.

      To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

      Parameters:
      segmentAttributes - A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

      Attribute keys can include only alphanumeric, -, and _.

      This field can be used to set Segment Contact Expiry as a duration in minutes.

      To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • previousContactId

      CreateContactRequest.Builder previousContactId(String previousContactId)

      The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide.

      Parameters:
      previousContactId - The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.