Package software.amazon.awssdk.services.connect.model

Interface CreateContactRequest.Builder

    • Method Detail

      • 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

        Parameters:
        channel - The channel for the contact
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Channel, Channel

      • channel

        CreateContactRequest.Builder channel​(Channel channel)

        The channel for the contact

        Parameters:
        channel - The channel for the contact
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Channel, Channel

      • 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

        Parameters:
        userInfo - User details for the contact
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • initiateAs

        CreateContactRequest.Builder initiateAs​(String initiateAs)

        Initial state of the contact when it's created

        Parameters:
        initiateAs - Initial state of the contact when it's created
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InitiateAs, InitiateAs

      • initiateAs

        CreateContactRequest.Builder initiateAs​(InitiateAs initiateAs)

        Initial state of the contact when it's created

        Parameters:
        initiateAs - Initial state of the contact when it's created
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InitiateAs, InitiateAs

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