Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Connect.UpdatePhoneNumber

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

Creating a Request

data UpdatePhoneNumber Source #

See: newUpdatePhoneNumber smart constructor.

Constructors

UpdatePhoneNumber'

Fields

clientToken :: Maybe Text
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.
phoneNumberId :: Text
A unique identifier for the phone number.
targetArn :: Text
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Instances

Instances details

ToJSON UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods toJSON :: UpdatePhoneNumber -> Value # toEncoding :: UpdatePhoneNumber -> Encoding # toJSONList :: [UpdatePhoneNumber] -> Value # toEncodingList :: [UpdatePhoneNumber] -> Encoding #
ToHeaders UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods toHeaders :: UpdatePhoneNumber -> [Header] #
ToPath UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods toPath :: UpdatePhoneNumber -> ByteString #
ToQuery UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods toQuery :: UpdatePhoneNumber -> QueryString #
AWSRequest UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Associated Types type AWSResponse UpdatePhoneNumber # Methods request :: (Service -> Service) -> UpdatePhoneNumber -> Request UpdatePhoneNumber # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdatePhoneNumber -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePhoneNumber))) #
Generic UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Associated Types type Rep UpdatePhoneNumber :: Type -> Type # Methods from :: UpdatePhoneNumber -> Rep UpdatePhoneNumber x # to :: Rep UpdatePhoneNumber x -> UpdatePhoneNumber #
Read UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods readsPrec :: Int -> ReadS UpdatePhoneNumber # readList :: ReadS [UpdatePhoneNumber] # readPrec :: ReadPrec UpdatePhoneNumber # readListPrec :: ReadPrec [UpdatePhoneNumber] #
Show UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods showsPrec :: Int -> UpdatePhoneNumber -> ShowS # show :: UpdatePhoneNumber -> String # showList :: [UpdatePhoneNumber] -> ShowS #
NFData UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods rnf :: UpdatePhoneNumber -> () #
Eq UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods (==) :: UpdatePhoneNumber -> UpdatePhoneNumber -> Bool # (/=) :: UpdatePhoneNumber -> UpdatePhoneNumber -> Bool #
Hashable UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods hashWithSalt :: Int -> UpdatePhoneNumber -> Int # hash :: UpdatePhoneNumber -> Int #
type AWSResponse UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber type AWSResponse UpdatePhoneNumber = UpdatePhoneNumberResponse
type Rep UpdatePhoneNumber Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber type Rep UpdatePhoneNumber = D1 ('MetaData "UpdatePhoneNumber" "Amazonka.Connect.UpdatePhoneNumber" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdatePhoneNumber'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "phoneNumberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdatePhoneNumber Source #

Arguments

:: Text	`UpdatePhoneNumber`
-> Text	`UpdatePhoneNumber`
-> UpdatePhoneNumber

Create a value of UpdatePhoneNumber 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:clientToken:UpdatePhoneNumber', updatePhoneNumber_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.

UpdatePhoneNumber, updatePhoneNumber_phoneNumberId - A unique identifier for the phone number.

UpdatePhoneNumber, updatePhoneNumber_targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Request Lenses

updatePhoneNumber_clientToken :: Lens' UpdatePhoneNumber (Maybe Text) Source #

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.

updatePhoneNumber_phoneNumberId :: Lens' UpdatePhoneNumber Text Source #

A unique identifier for the phone number.

updatePhoneNumber_targetArn :: Lens' UpdatePhoneNumber Text Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Destructuring the Response

data UpdatePhoneNumberResponse Source #

See: newUpdatePhoneNumberResponse smart constructor.

Constructors

UpdatePhoneNumberResponse'
Fields phoneNumberArn :: Maybe Text The Amazon Resource Name (ARN) of the phone number. phoneNumberId :: Maybe Text A unique identifier for the phone number. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdatePhoneNumberResponse Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Associated Types type Rep UpdatePhoneNumberResponse :: Type -> Type # Methods from :: UpdatePhoneNumberResponse -> Rep UpdatePhoneNumberResponse x # to :: Rep UpdatePhoneNumberResponse x -> UpdatePhoneNumberResponse #
Read UpdatePhoneNumberResponse Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods readsPrec :: Int -> ReadS UpdatePhoneNumberResponse # readList :: ReadS [UpdatePhoneNumberResponse] # readPrec :: ReadPrec UpdatePhoneNumberResponse # readListPrec :: ReadPrec [UpdatePhoneNumberResponse] #
Show UpdatePhoneNumberResponse Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods showsPrec :: Int -> UpdatePhoneNumberResponse -> ShowS # show :: UpdatePhoneNumberResponse -> String # showList :: [UpdatePhoneNumberResponse] -> ShowS #
NFData UpdatePhoneNumberResponse Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods rnf :: UpdatePhoneNumberResponse -> () #
Eq UpdatePhoneNumberResponse Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber Methods (==) :: UpdatePhoneNumberResponse -> UpdatePhoneNumberResponse -> Bool # (/=) :: UpdatePhoneNumberResponse -> UpdatePhoneNumberResponse -> Bool #
type Rep UpdatePhoneNumberResponse Source #
Instance details Defined in Amazonka.Connect.UpdatePhoneNumber type Rep UpdatePhoneNumberResponse = D1 ('MetaData "UpdatePhoneNumberResponse" "Amazonka.Connect.UpdatePhoneNumber" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdatePhoneNumberResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "phoneNumberArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "phoneNumberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdatePhoneNumberResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdatePhoneNumberResponse'`
-> UpdatePhoneNumberResponse

Create a value of UpdatePhoneNumberResponse 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:

UpdatePhoneNumberResponse, updatePhoneNumberResponse_phoneNumberArn - The Amazon Resource Name (ARN) of the phone number.

UpdatePhoneNumber, updatePhoneNumberResponse_phoneNumberId - A unique identifier for the phone number.

$sel:httpStatus:UpdatePhoneNumberResponse', updatePhoneNumberResponse_httpStatus - The response's http status code.

Response Lenses

updatePhoneNumberResponse_phoneNumberArn :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #

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

updatePhoneNumberResponse_phoneNumberId :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #

A unique identifier for the phone number.

updatePhoneNumberResponse_httpStatus :: Lens' UpdatePhoneNumberResponse Int Source #

The response's http status code.