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.PinpointSmsVoiceV2.DisassociateOriginationIdentity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Removes the specified origination identity from an existing pool.

If the origination identity isn't associated with the specified pool, an Error is returned.

Synopsis

Creating a Request

data DisassociateOriginationIdentity Source #

See: newDisassociateOriginationIdentity smart constructor.

Constructors

DisassociateOriginationIdentity'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
poolId :: Text
The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
originationIdentity :: Text
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
isoCountryCode :: Text
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Instances

Instances details

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

newDisassociateOriginationIdentity Source #

Arguments

:: Text	`DisassociateOriginationIdentity`
-> Text	`DisassociateOriginationIdentity`
-> Text	`DisassociateOriginationIdentity`
-> DisassociateOriginationIdentity

Create a value of DisassociateOriginationIdentity 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:DisassociateOriginationIdentity', disassociateOriginationIdentity_clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

DisassociateOriginationIdentity, disassociateOriginationIdentity_poolId - The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

DisassociateOriginationIdentity, disassociateOriginationIdentity_originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.

DisassociateOriginationIdentity, disassociateOriginationIdentity_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Request Lenses

disassociateOriginationIdentity_clientToken :: Lens' DisassociateOriginationIdentity (Maybe Text) Source #

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

disassociateOriginationIdentity_poolId :: Lens' DisassociateOriginationIdentity Text Source #

The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

disassociateOriginationIdentity_originationIdentity :: Lens' DisassociateOriginationIdentity Text Source #

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.

disassociateOriginationIdentity_isoCountryCode :: Lens' DisassociateOriginationIdentity Text Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Destructuring the Response

data DisassociateOriginationIdentityResponse Source #

See: newDisassociateOriginationIdentityResponse smart constructor.

Constructors

DisassociateOriginationIdentityResponse'

Fields

isoCountryCode :: Maybe Text
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
originationIdentity :: Maybe Text
The PhoneNumberId or SenderId of the origination identity.
originationIdentityArn :: Maybe Text
The PhoneNumberArn or SenderIdArn of the origination identity.
poolArn :: Maybe Text
The Amazon Resource Name (ARN) of the pool.
poolId :: Maybe Text
The PoolId of the pool no longer associated with the origination identity.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DisassociateOriginationIdentityResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DisassociateOriginationIdentity Associated Types type Rep DisassociateOriginationIdentityResponse :: Type -> Type # Methods from :: DisassociateOriginationIdentityResponse -> Rep DisassociateOriginationIdentityResponse x # to :: Rep DisassociateOriginationIdentityResponse x -> DisassociateOriginationIdentityResponse #
Read DisassociateOriginationIdentityResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DisassociateOriginationIdentity Methods readsPrec :: Int -> ReadS DisassociateOriginationIdentityResponse # readList :: ReadS [DisassociateOriginationIdentityResponse] # readPrec :: ReadPrec DisassociateOriginationIdentityResponse # readListPrec :: ReadPrec [DisassociateOriginationIdentityResponse] #
Show DisassociateOriginationIdentityResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DisassociateOriginationIdentity Methods showsPrec :: Int -> DisassociateOriginationIdentityResponse -> ShowS # show :: DisassociateOriginationIdentityResponse -> String # showList :: [DisassociateOriginationIdentityResponse] -> ShowS #
NFData DisassociateOriginationIdentityResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DisassociateOriginationIdentity Methods rnf :: DisassociateOriginationIdentityResponse -> () #
Eq DisassociateOriginationIdentityResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DisassociateOriginationIdentity Methods (==) :: DisassociateOriginationIdentityResponse -> DisassociateOriginationIdentityResponse -> Bool # (/=) :: DisassociateOriginationIdentityResponse -> DisassociateOriginationIdentityResponse -> Bool #
type Rep DisassociateOriginationIdentityResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DisassociateOriginationIdentity type Rep DisassociateOriginationIdentityResponse = D1 ('MetaData "DisassociateOriginationIdentityResponse" "Amazonka.PinpointSmsVoiceV2.DisassociateOriginationIdentity" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DisassociateOriginationIdentityResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isoCountryCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "originationIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "originationIdentityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "poolArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDisassociateOriginationIdentityResponse Source #

Arguments

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

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

DisassociateOriginationIdentity, disassociateOriginationIdentityResponse_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

DisassociateOriginationIdentity, disassociateOriginationIdentityResponse_originationIdentity - The PhoneNumberId or SenderId of the origination identity.

DisassociateOriginationIdentityResponse, disassociateOriginationIdentityResponse_originationIdentityArn - The PhoneNumberArn or SenderIdArn of the origination identity.

DisassociateOriginationIdentityResponse, disassociateOriginationIdentityResponse_poolArn - The Amazon Resource Name (ARN) of the pool.

DisassociateOriginationIdentity, disassociateOriginationIdentityResponse_poolId - The PoolId of the pool no longer associated with the origination identity.

$sel:httpStatus:DisassociateOriginationIdentityResponse', disassociateOriginationIdentityResponse_httpStatus - The response's http status code.

Response Lenses

disassociateOriginationIdentityResponse_isoCountryCode :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

disassociateOriginationIdentityResponse_originationIdentity :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #

The PhoneNumberId or SenderId of the origination identity.

disassociateOriginationIdentityResponse_originationIdentityArn :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #

The PhoneNumberArn or SenderIdArn of the origination identity.

disassociateOriginationIdentityResponse_poolArn :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pool.

disassociateOriginationIdentityResponse_poolId :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #

The PoolId of the pool no longer associated with the origination identity.

disassociateOriginationIdentityResponse_httpStatus :: Lens' DisassociateOriginationIdentityResponse Int Source #

The response's http status code.