Amazonka.Connect.DescribePhoneNumber

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Creating a Request

data DescribePhoneNumber

See: newDescribePhoneNumber smart constructor.

Constructors

DescribePhoneNumber'

Fields

• phoneNumberId :: Text

  A unique identifier for the phone number.

Instances

ToHeaders DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

toHeaders :: DescribePhoneNumber -> [Header]

ToPath DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

toPath :: DescribePhoneNumber -> ByteString

ToQuery DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

toQuery :: DescribePhoneNumber -> QueryString

AWSRequest DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Associated Types

type AWSResponse DescribePhoneNumber

Methods

request :: (Service -> Service) -> DescribePhoneNumber -> Request DescribePhoneNumber

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePhoneNumber -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePhoneNumber)))

Generic DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Associated Types

type Rep DescribePhoneNumber :: Type -> Type

Methods

from :: DescribePhoneNumber -> Rep DescribePhoneNumber x

to :: Rep DescribePhoneNumber x -> DescribePhoneNumber

Read DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

readsPrec :: Int -> ReadS DescribePhoneNumber

readList :: ReadS [DescribePhoneNumber]

readPrec :: ReadPrec DescribePhoneNumber

readListPrec :: ReadPrec [DescribePhoneNumber]

Show DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

showsPrec :: Int -> DescribePhoneNumber -> ShowS

show :: DescribePhoneNumber -> String

showList :: [DescribePhoneNumber] -> ShowS

NFData DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

rnf :: DescribePhoneNumber -> ()

Eq DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

(==) :: DescribePhoneNumber -> DescribePhoneNumber -> Bool

(/=) :: DescribePhoneNumber -> DescribePhoneNumber -> Bool

Hashable DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

hashWithSalt :: Int -> DescribePhoneNumber -> Int

hash :: DescribePhoneNumber -> Int

type AWSResponse DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

type AWSResponse DescribePhoneNumber = DescribePhoneNumberResponse

type Rep DescribePhoneNumber

Defined in Amazonka.Connect.DescribePhoneNumber

type Rep DescribePhoneNumber = D1 ('MetaData "DescribePhoneNumber" "Amazonka.Connect.DescribePhoneNumber" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "DescribePhoneNumber'" 'PrefixI 'True) (S1 ('MetaSel ('Just "phoneNumberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribePhoneNumber

Arguments

:: Text

DescribePhoneNumber

-> DescribePhoneNumber

Create a value of DescribePhoneNumber with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribePhoneNumber, describePhoneNumber_phoneNumberId - A unique identifier for the phone number.

Request Lenses

describePhoneNumber_phoneNumberId :: Lens' DescribePhoneNumber Text

A unique identifier for the phone number.

Destructuring the Response

data DescribePhoneNumberResponse

See: newDescribePhoneNumberResponse smart constructor.

Constructors

DescribePhoneNumberResponse'

Fields

• claimedPhoneNumberSummary :: Maybe ClaimedPhoneNumberSummary

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribePhoneNumberResponse

Defined in Amazonka.Connect.DescribePhoneNumber

Associated Types

type Rep DescribePhoneNumberResponse :: Type -> Type

Methods

from :: DescribePhoneNumberResponse -> Rep DescribePhoneNumberResponse x

to :: Rep DescribePhoneNumberResponse x -> DescribePhoneNumberResponse

Read DescribePhoneNumberResponse

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

readsPrec :: Int -> ReadS DescribePhoneNumberResponse

readList :: ReadS [DescribePhoneNumberResponse]

readPrec :: ReadPrec DescribePhoneNumberResponse

readListPrec :: ReadPrec [DescribePhoneNumberResponse]

Show DescribePhoneNumberResponse

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

showsPrec :: Int -> DescribePhoneNumberResponse -> ShowS

show :: DescribePhoneNumberResponse -> String

showList :: [DescribePhoneNumberResponse] -> ShowS

NFData DescribePhoneNumberResponse

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

rnf :: DescribePhoneNumberResponse -> ()

Eq DescribePhoneNumberResponse

Defined in Amazonka.Connect.DescribePhoneNumber

Methods

(==) :: DescribePhoneNumberResponse -> DescribePhoneNumberResponse -> Bool

(/=) :: DescribePhoneNumberResponse -> DescribePhoneNumberResponse -> Bool

type Rep DescribePhoneNumberResponse

Defined in Amazonka.Connect.DescribePhoneNumber

type Rep DescribePhoneNumberResponse = D1 ('MetaData "DescribePhoneNumberResponse" "Amazonka.Connect.DescribePhoneNumber" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "DescribePhoneNumberResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "claimedPhoneNumberSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClaimedPhoneNumberSummary)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribePhoneNumberResponse

Arguments

:: Int

$sel:httpStatus:DescribePhoneNumberResponse'

-> DescribePhoneNumberResponse

Create a value of DescribePhoneNumberResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:claimedPhoneNumberSummary:DescribePhoneNumberResponse', describePhoneNumberResponse_claimedPhoneNumberSummary - Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.

$sel:httpStatus:DescribePhoneNumberResponse', describePhoneNumberResponse_httpStatus - The response's http status code.

Response Lenses

describePhoneNumberResponse_claimedPhoneNumberSummary :: Lens' DescribePhoneNumberResponse (Maybe ClaimedPhoneNumberSummary)

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

describePhoneNumberResponse_httpStatus :: Lens' DescribePhoneNumberResponse Int

The response's http status code.