/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Information about a phone number that has been claimed to your Amazon Connect
* instance or traffic distribution group.See Also:
AWS
* API Reference
A unique identifier for the phone number.
*/ inline const Aws::String& GetPhoneNumberId() const{ return m_phoneNumberId; } /** *A unique identifier for the phone number.
*/ inline bool PhoneNumberIdHasBeenSet() const { return m_phoneNumberIdHasBeenSet; } /** *A unique identifier for the phone number.
*/ inline void SetPhoneNumberId(const Aws::String& value) { m_phoneNumberIdHasBeenSet = true; m_phoneNumberId = value; } /** *A unique identifier for the phone number.
*/ inline void SetPhoneNumberId(Aws::String&& value) { m_phoneNumberIdHasBeenSet = true; m_phoneNumberId = std::move(value); } /** *A unique identifier for the phone number.
*/ inline void SetPhoneNumberId(const char* value) { m_phoneNumberIdHasBeenSet = true; m_phoneNumberId.assign(value); } /** *A unique identifier for the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberId(const Aws::String& value) { SetPhoneNumberId(value); return *this;} /** *A unique identifier for the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberId(Aws::String&& value) { SetPhoneNumberId(std::move(value)); return *this;} /** *A unique identifier for the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberId(const char* value) { SetPhoneNumberId(value); return *this;} /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline const Aws::String& GetPhoneNumberArn() const{ return m_phoneNumberArn; } /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline bool PhoneNumberArnHasBeenSet() const { return m_phoneNumberArnHasBeenSet; } /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline void SetPhoneNumberArn(const Aws::String& value) { m_phoneNumberArnHasBeenSet = true; m_phoneNumberArn = value; } /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline void SetPhoneNumberArn(Aws::String&& value) { m_phoneNumberArnHasBeenSet = true; m_phoneNumberArn = std::move(value); } /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline void SetPhoneNumberArn(const char* value) { m_phoneNumberArnHasBeenSet = true; m_phoneNumberArn.assign(value); } /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberArn(const Aws::String& value) { SetPhoneNumberArn(value); return *this;} /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberArn(Aws::String&& value) { SetPhoneNumberArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberArn(const char* value) { SetPhoneNumberArn(value); return *this;} /** *The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code]
* [subscriber number including area code]
.
The ISO country code.
*/ inline const PhoneNumberCountryCode& GetPhoneNumberCountryCode() const{ return m_phoneNumberCountryCode; } /** *The ISO country code.
*/ inline bool PhoneNumberCountryCodeHasBeenSet() const { return m_phoneNumberCountryCodeHasBeenSet; } /** *The ISO country code.
*/ inline void SetPhoneNumberCountryCode(const PhoneNumberCountryCode& value) { m_phoneNumberCountryCodeHasBeenSet = true; m_phoneNumberCountryCode = value; } /** *The ISO country code.
*/ inline void SetPhoneNumberCountryCode(PhoneNumberCountryCode&& value) { m_phoneNumberCountryCodeHasBeenSet = true; m_phoneNumberCountryCode = std::move(value); } /** *The ISO country code.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberCountryCode(const PhoneNumberCountryCode& value) { SetPhoneNumberCountryCode(value); return *this;} /** *The ISO country code.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberCountryCode(PhoneNumberCountryCode&& value) { SetPhoneNumberCountryCode(std::move(value)); return *this;} /** *The type of phone number.
*/ inline const PhoneNumberType& GetPhoneNumberType() const{ return m_phoneNumberType; } /** *The type of phone number.
*/ inline bool PhoneNumberTypeHasBeenSet() const { return m_phoneNumberTypeHasBeenSet; } /** *The type of phone number.
*/ inline void SetPhoneNumberType(const PhoneNumberType& value) { m_phoneNumberTypeHasBeenSet = true; m_phoneNumberType = value; } /** *The type of phone number.
*/ inline void SetPhoneNumberType(PhoneNumberType&& value) { m_phoneNumberTypeHasBeenSet = true; m_phoneNumberType = std::move(value); } /** *The type of phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberType(const PhoneNumberType& value) { SetPhoneNumberType(value); return *this;} /** *The type of phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberType(PhoneNumberType&& value) { SetPhoneNumberType(std::move(value)); return *this;} /** *The description of the phone number.
*/ inline const Aws::String& GetPhoneNumberDescription() const{ return m_phoneNumberDescription; } /** *The description of the phone number.
*/ inline bool PhoneNumberDescriptionHasBeenSet() const { return m_phoneNumberDescriptionHasBeenSet; } /** *The description of the phone number.
*/ inline void SetPhoneNumberDescription(const Aws::String& value) { m_phoneNumberDescriptionHasBeenSet = true; m_phoneNumberDescription = value; } /** *The description of the phone number.
*/ inline void SetPhoneNumberDescription(Aws::String&& value) { m_phoneNumberDescriptionHasBeenSet = true; m_phoneNumberDescription = std::move(value); } /** *The description of the phone number.
*/ inline void SetPhoneNumberDescription(const char* value) { m_phoneNumberDescriptionHasBeenSet = true; m_phoneNumberDescription.assign(value); } /** *The description of the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberDescription(const Aws::String& value) { SetPhoneNumberDescription(value); return *this;} /** *The description of the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberDescription(Aws::String&& value) { SetPhoneNumberDescription(std::move(value)); return *this;} /** *The description of the phone number.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberDescription(const char* value) { SetPhoneNumberDescription(value); return *this;} /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline const Aws::String& GetTargetArn() const{ return m_targetArn; } /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline bool TargetArnHasBeenSet() const { return m_targetArnHasBeenSet; } /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline void SetTargetArn(const Aws::String& value) { m_targetArnHasBeenSet = true; m_targetArn = value; } /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline void SetTargetArn(Aws::String&& value) { m_targetArnHasBeenSet = true; m_targetArn = std::move(value); } /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline void SetTargetArn(const char* value) { m_targetArnHasBeenSet = true; m_targetArn.assign(value); } /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline ClaimedPhoneNumberSummary& WithTargetArn(const Aws::String& value) { SetTargetArn(value); return *this;} /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline ClaimedPhoneNumberSummary& WithTargetArn(Aws::String&& value) { SetTargetArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to.
*/ inline ClaimedPhoneNumberSummary& WithTargetArn(const char* value) { SetTargetArn(value); return *this;} /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline const Aws::MapThe tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline void SetTags(const Aws::MapThe tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline void SetTags(Aws::MapThe tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& WithTags(const Aws::MapThe tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& WithTags(Aws::MapThe tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *The tags used to organize, track, or control access for this resource. For * example, { "tags": {"key1":"value1", "key2":"value2"} }.
*/ inline ClaimedPhoneNumberSummary& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *The status of the phone number.
CLAIMED
means
* the previous ClaimedPhoneNumber
* or UpdatePhoneNumber
* operation succeeded.
IN_PROGRESS
means a ClaimedPhoneNumber
* or UpdatePhoneNumber
* 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 ClaimedPhoneNumber
* 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.
*/ inline const PhoneNumberStatus& GetPhoneNumberStatus() const{ return m_phoneNumberStatus; } /** *The status of the phone number.
CLAIMED
means
* the previous ClaimedPhoneNumber
* or UpdatePhoneNumber
* operation succeeded.
IN_PROGRESS
means a ClaimedPhoneNumber
* or UpdatePhoneNumber
* 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 ClaimedPhoneNumber
* 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.
*/ inline bool PhoneNumberStatusHasBeenSet() const { return m_phoneNumberStatusHasBeenSet; } /** *The status of the phone number.
CLAIMED
means
* the previous ClaimedPhoneNumber
* or UpdatePhoneNumber
* operation succeeded.
IN_PROGRESS
means a ClaimedPhoneNumber
* or UpdatePhoneNumber
* 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 ClaimedPhoneNumber
* 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.
*/ inline void SetPhoneNumberStatus(const PhoneNumberStatus& value) { m_phoneNumberStatusHasBeenSet = true; m_phoneNumberStatus = value; } /** *The status of the phone number.
CLAIMED
means
* the previous ClaimedPhoneNumber
* or UpdatePhoneNumber
* operation succeeded.
IN_PROGRESS
means a ClaimedPhoneNumber
* or UpdatePhoneNumber
* 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 ClaimedPhoneNumber
* 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.
*/ inline void SetPhoneNumberStatus(PhoneNumberStatus&& value) { m_phoneNumberStatusHasBeenSet = true; m_phoneNumberStatus = std::move(value); } /** *The status of the phone number.
CLAIMED
means
* the previous ClaimedPhoneNumber
* or UpdatePhoneNumber
* operation succeeded.
IN_PROGRESS
means a ClaimedPhoneNumber
* or UpdatePhoneNumber
* 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 ClaimedPhoneNumber
* 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.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberStatus(const PhoneNumberStatus& value) { SetPhoneNumberStatus(value); return *this;} /** *The status of the phone number.
CLAIMED
means
* the previous ClaimedPhoneNumber
* or UpdatePhoneNumber
* operation succeeded.
IN_PROGRESS
means a ClaimedPhoneNumber
* or UpdatePhoneNumber
* 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 ClaimedPhoneNumber
* 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.
*/ inline ClaimedPhoneNumberSummary& WithPhoneNumberStatus(PhoneNumberStatus&& value) { SetPhoneNumberStatus(std::move(value)); return *this;} private: Aws::String m_phoneNumberId; bool m_phoneNumberIdHasBeenSet = false; Aws::String m_phoneNumberArn; bool m_phoneNumberArnHasBeenSet = false; Aws::String m_phoneNumber; bool m_phoneNumberHasBeenSet = false; PhoneNumberCountryCode m_phoneNumberCountryCode; bool m_phoneNumberCountryCodeHasBeenSet = false; PhoneNumberType m_phoneNumberType; bool m_phoneNumberTypeHasBeenSet = false; Aws::String m_phoneNumberDescription; bool m_phoneNumberDescriptionHasBeenSet = false; Aws::String m_targetArn; bool m_targetArnHasBeenSet = false; Aws::Map