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.DeleteOptOutList

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned.

Creating a Request

data DeleteOptOutList Source #

See: newDeleteOptOutList smart constructor.

Constructors

DeleteOptOutList'
Fields optOutListName :: Text The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Instances

Instances details

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

newDeleteOptOutList Source #

Arguments

:: Text	`DeleteOptOutList`
-> DeleteOptOutList

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

DeleteOptOutList, deleteOptOutList_optOutListName - The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Request Lenses

deleteOptOutList_optOutListName :: Lens' DeleteOptOutList Text Source #

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Destructuring the Response

data DeleteOptOutListResponse Source #

See: newDeleteOptOutListResponse smart constructor.

Constructors

DeleteOptOutListResponse'
Fields createdTimestamp :: Maybe POSIX The time when the OptOutList was created, in UNIX epoch time format. optOutListArn :: Maybe Text The Amazon Resource Name (ARN) of the OptOutList that was removed. optOutListName :: Maybe Text The name of the OptOutList that was removed. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteOptOutListResponse Source #

Arguments

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

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

DeleteOptOutListResponse, deleteOptOutListResponse_createdTimestamp - The time when the OptOutList was created, in UNIX epoch time format.

DeleteOptOutListResponse, deleteOptOutListResponse_optOutListArn - The Amazon Resource Name (ARN) of the OptOutList that was removed.

DeleteOptOutList, deleteOptOutListResponse_optOutListName - The name of the OptOutList that was removed.

$sel:httpStatus:DeleteOptOutListResponse', deleteOptOutListResponse_httpStatus - The response's http status code.

Response Lenses

deleteOptOutListResponse_createdTimestamp :: Lens' DeleteOptOutListResponse (Maybe UTCTime) Source #

The time when the OptOutList was created, in UNIX epoch time format.

deleteOptOutListResponse_optOutListArn :: Lens' DeleteOptOutListResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the OptOutList that was removed.

deleteOptOutListResponse_optOutListName :: Lens' DeleteOptOutListResponse (Maybe Text) Source #

The name of the OptOutList that was removed.

deleteOptOutListResponse_httpStatus :: Lens' DeleteOptOutListResponse Int Source #

The response's http status code.