AWSConnectClaimedPhoneNumberSummary

Objective-C

@interface AWSConnectClaimedPhoneNumberSummary

Swift

class AWSConnectClaimedPhoneNumberSummary

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

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable instanceId;

    Swift

    var instanceId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable phoneNumber;

    Swift

    var phoneNumber: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable phoneNumberArn;

    Swift

    var phoneNumberArn: String? { get set }

  • The ISO country code.

    Declaration

    Objective-C

    @property (nonatomic) AWSConnectPhoneNumberCountryCode phoneNumberCountryCode;

    Swift

    var phoneNumberCountryCode: AWSConnectPhoneNumberCountryCode { get set }

  • The description of the phone number.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable phoneNumberDescription;

    Swift

    var phoneNumberDescription: String? { get set }

  • A unique identifier for the phone number.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable phoneNumberId;

    Swift

    var phoneNumberId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectPhoneNumberStatus *_Nullable phoneNumberStatus;

    Swift

    var phoneNumberStatus: AWSConnectPhoneNumberStatus? { get set }

  • The type of phone number.

    Declaration

    Objective-C

    @property (nonatomic) AWSConnectPhoneNumberType phoneNumberType;

    Swift

    var phoneNumberType: AWSConnectPhoneNumberType { get set }

  • The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourcePhoneNumberArn;

    Swift

    var sourcePhoneNumberArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable tags;

    Swift

    var tags: [String : String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable targetArn;

    Swift

    var targetArn: String? { get set }