amazonka-scheduler-2.0: Amazon EventBridge Scheduler 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.Scheduler.DeleteSchedule

Description

Deletes the specified schedule.

Synopsis

Creating a Request

data DeleteSchedule Source #

See: newDeleteSchedule smart constructor.

Constructors

DeleteSchedule' 

Fields

  • clientToken :: Maybe Text

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

  • groupName :: Maybe Text

    The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

  • name :: Text

    The name of the schedule to delete.

Instances

Instances details
ToHeaders DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

toHeaders :: DeleteSchedule -> [Header] #

ToPath DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

toPath :: DeleteSchedule -> ByteString #

ToQuery DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

toQuery :: DeleteSchedule -> QueryString #

AWSRequest DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Associated Types

type AWSResponse DeleteSchedule #

Methods

request :: (Service -> Service) -> DeleteSchedule -> Request DeleteSchedule #

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

Generic DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Associated Types

type Rep DeleteSchedule :: Type -> Type #

Methods

from :: DeleteSchedule -> Rep DeleteSchedule x #

to :: Rep DeleteSchedule x -> DeleteSchedule #

Read DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

readsPrec :: Int -> ReadS DeleteSchedule #

readList :: ReadS [DeleteSchedule] #

readPrec :: ReadPrec DeleteSchedule #

readListPrec :: ReadPrec [DeleteSchedule] #

Show DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

showsPrec :: Int -> DeleteSchedule -> ShowS #

show :: DeleteSchedule -> String #

showList :: [DeleteSchedule] -> ShowS #

NFData DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

rnf :: DeleteSchedule -> () #

Eq DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

(==) :: DeleteSchedule -> DeleteSchedule -> Bool #

(/=) :: DeleteSchedule -> DeleteSchedule -> Bool #

Hashable DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

hashWithSalt :: Int -> DeleteSchedule -> Int #

hash :: DeleteSchedule -> Int #

type AWSResponse DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

type AWSResponse DeleteSchedule = DeleteScheduleResponse
type Rep DeleteSchedule Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

type Rep DeleteSchedule = D1 ('MetaData "DeleteSchedule" "Amazonka.Scheduler.DeleteSchedule" "amazonka-scheduler-2.0-8LKlva3Whvt7TpHIvtcn6a" 'False) (C1 ('MetaCons "DeleteSchedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteSchedule Source #

Arguments

:: Text

DeleteSchedule

-> DeleteSchedule 

Create a value of DeleteSchedule 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:DeleteSchedule', deleteSchedule_clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

DeleteSchedule, deleteSchedule_groupName - The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

DeleteSchedule, deleteSchedule_name - The name of the schedule to delete.

Request Lenses

deleteSchedule_clientToken :: Lens' DeleteSchedule (Maybe Text) Source #

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

deleteSchedule_groupName :: Lens' DeleteSchedule (Maybe Text) Source #

The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

deleteSchedule_name :: Lens' DeleteSchedule Text Source #

The name of the schedule to delete.

Destructuring the Response

data DeleteScheduleResponse Source #

See: newDeleteScheduleResponse smart constructor.

Constructors

DeleteScheduleResponse' 

Fields

Instances

Instances details
Generic DeleteScheduleResponse Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Associated Types

type Rep DeleteScheduleResponse :: Type -> Type #

Methods

from :: DeleteScheduleResponse -> Rep DeleteScheduleResponse x #

to :: Rep DeleteScheduleResponse x -> DeleteScheduleResponse #

Read DeleteScheduleResponse Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

readsPrec :: Int -> ReadS DeleteScheduleResponse #

readList :: ReadS [DeleteScheduleResponse] #

readPrec :: ReadPrec DeleteScheduleResponse #

readListPrec :: ReadPrec [DeleteScheduleResponse] #

Show DeleteScheduleResponse Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

showsPrec :: Int -> DeleteScheduleResponse -> ShowS #

show :: DeleteScheduleResponse -> String #

showList :: [DeleteScheduleResponse] -> ShowS #

NFData DeleteScheduleResponse Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

rnf :: DeleteScheduleResponse -> () #

Eq DeleteScheduleResponse Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

Methods

(==) :: DeleteScheduleResponse -> DeleteScheduleResponse -> Bool #

(/=) :: DeleteScheduleResponse -> DeleteScheduleResponse -> Bool #

type Rep DeleteScheduleResponse Source # 
Instance details

Defined in Amazonka.Scheduler.DeleteSchedule

type Rep DeleteScheduleResponse = D1 ('MetaData "DeleteScheduleResponse" "Amazonka.Scheduler.DeleteSchedule" "amazonka-scheduler-2.0-8LKlva3Whvt7TpHIvtcn6a" 'False) (C1 ('MetaCons "DeleteScheduleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteScheduleResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteScheduleResponse'

-> DeleteScheduleResponse 

Create a value of DeleteScheduleResponse 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:httpStatus:DeleteScheduleResponse', deleteScheduleResponse_httpStatus - The response's http status code.

Response Lenses

deleteScheduleResponse_httpStatus :: Lens' DeleteScheduleResponse Int Source #

The response's http status code.