Interface UpdateContactRequest.Builder

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

  • Method Details

    • instanceId

      UpdateContactRequest.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.

    • contactId

      UpdateContactRequest.Builder contactId(String contactId)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

      Parameters:
      contactId - The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateContactRequest.Builder name(String name)

      The name of the contact.

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

    • description

      UpdateContactRequest.Builder description(String description)

      The description of the contact.

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

    • references

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

      Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

      Parameters:
      references - Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentAttributes

      UpdateContactRequest.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 show channel subtype, such as connect:Guide.

      Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.

      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 show channel subtype, such as connect:Guide.

      Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.

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

    • queueInfo

      UpdateContactRequest.Builder queueInfo(QueueInfoInput queueInfo)

      Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

      Parameters:
      queueInfo - Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queueInfo

      default UpdateContactRequest.Builder queueInfo(Consumer<QueueInfoInput.Builder> queueInfo)

      Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

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

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

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

    • userInfo

      UpdateContactRequest.Builder userInfo(UserInfo userInfo)

      Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

      Parameters:
      userInfo - Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userInfo

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

      Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

      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:

    • customerEndpoint

      UpdateContactRequest.Builder customerEndpoint(Endpoint customerEndpoint)

      The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

      Parameters:
      customerEndpoint - The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerEndpoint

      default UpdateContactRequest.Builder customerEndpoint(Consumer<Endpoint.Builder> customerEndpoint)

      The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

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

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

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

    • systemEndpoint

      UpdateContactRequest.Builder systemEndpoint(Endpoint systemEndpoint)

      External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

      Parameters:
      systemEndpoint - External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • systemEndpoint

      default UpdateContactRequest.Builder systemEndpoint(Consumer<Endpoint.Builder> systemEndpoint)

      External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

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

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

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

    • overrideConfiguration

      UpdateContactRequest.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

      UpdateContactRequest.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.