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

Interface ClaimPhoneNumberRequest.Builder

    • Method Detail

      • targetArn

        ClaimPhoneNumberRequest.Builder targetArn​(String targetArn)

        The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

        Parameters:
        targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceId

        ClaimPhoneNumberRequest.Builder instanceId​(String instanceId)

        The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

        Parameters:
        instanceId - The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phoneNumber

        ClaimPhoneNumberRequest.Builder phoneNumber​(String phoneNumber)

        The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

        Parameters:
        phoneNumber - The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phoneNumberDescription

        ClaimPhoneNumberRequest.Builder phoneNumberDescription​(String phoneNumberDescription)

        The description of the phone number.

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

      • tags

        ClaimPhoneNumberRequest.Builder tags​(Map<String,​String> tags)

        The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

        Parameters:
        tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

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

        Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

        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.

        Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

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