amazonka-pinpoint-sms-voice-v2-2.0: Amazon Pinpoint SMS Voice V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Description

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

Synopsis

Creating a Request

data SetDefaultSenderId Source #

See: newSetDefaultSenderId smart constructor.

Constructors

SetDefaultSenderId' 

Fields

  • configurationSetName :: Text

    The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

  • senderId :: Text

    The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.

Instances

Instances details
ToJSON SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

ToHeaders SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

ToPath SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

ToQuery SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

AWSRequest SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Associated Types

type AWSResponse SetDefaultSenderId #

Generic SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Associated Types

type Rep SetDefaultSenderId :: Type -> Type #

Read SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Show SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

NFData SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Methods

rnf :: SetDefaultSenderId -> () #

Eq SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Hashable SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

type AWSResponse SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

type Rep SetDefaultSenderId Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

type Rep SetDefaultSenderId = D1 ('MetaData "SetDefaultSenderId" "Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "SetDefaultSenderId'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSetDefaultSenderId Source #

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

SetDefaultSenderId, setDefaultSenderId_configurationSetName - The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

SetDefaultSenderId, setDefaultSenderId_senderId - The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.

Request Lenses

setDefaultSenderId_configurationSetName :: Lens' SetDefaultSenderId Text Source #

The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

setDefaultSenderId_senderId :: Lens' SetDefaultSenderId Text Source #

The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.

Destructuring the Response

data SetDefaultSenderIdResponse Source #

See: newSetDefaultSenderIdResponse smart constructor.

Constructors

SetDefaultSenderIdResponse' 

Fields

Instances

Instances details
Generic SetDefaultSenderIdResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Associated Types

type Rep SetDefaultSenderIdResponse :: Type -> Type #

Read SetDefaultSenderIdResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Show SetDefaultSenderIdResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

NFData SetDefaultSenderIdResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

Eq SetDefaultSenderIdResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

type Rep SetDefaultSenderIdResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId

type Rep SetDefaultSenderIdResponse = D1 ('MetaData "SetDefaultSenderIdResponse" "Amazonka.PinpointSmsVoiceV2.SetDefaultSenderId" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "SetDefaultSenderIdResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurationSetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSetDefaultSenderIdResponse Source #

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

SetDefaultSenderIdResponse, setDefaultSenderIdResponse_configurationSetArn - The Amazon Resource Name (ARN) of the updated configuration set.

SetDefaultSenderId, setDefaultSenderIdResponse_configurationSetName - The name of the configuration set that was updated.

SetDefaultSenderId, setDefaultSenderIdResponse_senderId - The default sender ID to set for the ConfigurationSet.

$sel:httpStatus:SetDefaultSenderIdResponse', setDefaultSenderIdResponse_httpStatus - The response's http status code.

Response Lenses

setDefaultSenderIdResponse_configurationSetArn :: Lens' SetDefaultSenderIdResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated configuration set.

setDefaultSenderIdResponse_senderId :: Lens' SetDefaultSenderIdResponse (Maybe Text) Source #

The default sender ID to set for the ConfigurationSet.