Module Values_0.ClaimedPhoneNumberSummarySource

Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

Sourcetype nonrec t = {
  1. phoneNumberId : PhoneNumberId.t option;
    (*

    A unique identifier for the phone number.

    *)
  2. phoneNumberArn : ARN.t option;
    (*

    The Amazon Resource Name (ARN) of the phone number.

    *)
  3. phoneNumber : PhoneNumber.t option;
    (*

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

    *)
  4. phoneNumberCountryCode : PhoneNumberCountryCode.t option;
    (*

    The ISO country code.

    *)
  5. phoneNumberType : PhoneNumberType.t option;
    (*

    The type of phone number.

    *)
  6. phoneNumberDescription : PhoneNumberDescription.t option;
    (*

    The description of the phone number.

    *)
  7. targetArn : ARN.t option;
    (*

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

    *)
  8. instanceId : InstanceId.t option;
    (*

    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.

    *)
  9. tags : TagMap.t option;
    (*

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

    *)
  10. phoneNumberStatus : PhoneNumberStatus.t option;
    (*

    The status of the phone number. CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded. IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed. FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim. You will not be billed for the phone number during the 1-day period if number claiming fails.

    *)
  11. sourcePhoneNumberArn : ARN.t option;
    (*

    The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.

    *)
}
Sourceval make : ?phoneNumberId:??? -> ?phoneNumberArn:??? -> ?phoneNumber:??? -> ?phoneNumberCountryCode:??? -> ?phoneNumberType:??? -> ?phoneNumberDescription:??? -> ?targetArn:??? -> ?instanceId:??? -> ?tags:??? -> ?phoneNumberStatus:??? -> ?sourcePhoneNumberArn:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of PhoneNumberId.t | `Structure of (string * [> `Enum of string | `String of PhoneNumberWorkflowMessage.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t