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.Scheduler.DeleteScheduleGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a DELETING state until all of its associated schedules are deleted. Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets until the schedule group and its associated schedules are deleted.

This operation is eventually consistent.

Creating a Request

data DeleteScheduleGroup Source #

See: newDeleteScheduleGroup smart constructor.

Constructors

DeleteScheduleGroup'
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. name :: Text The name of the schedule group to delete.

Instances

Instances details

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

newDeleteScheduleGroup Source #

Arguments

:: Text	`DeleteScheduleGroup`
-> DeleteScheduleGroup

Create a value of DeleteScheduleGroup 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:DeleteScheduleGroup', deleteScheduleGroup_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.

DeleteScheduleGroup, deleteScheduleGroup_name - The name of the schedule group to delete.

Request Lenses

deleteScheduleGroup_clientToken :: Lens' DeleteScheduleGroup (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.

deleteScheduleGroup_name :: Lens' DeleteScheduleGroup Text Source #

The name of the schedule group to delete.

Destructuring the Response

data DeleteScheduleGroupResponse Source #

See: newDeleteScheduleGroupResponse smart constructor.

Constructors

DeleteScheduleGroupResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteScheduleGroupResponse Source #

Arguments

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

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

Response Lenses

deleteScheduleGroupResponse_httpStatus :: Lens' DeleteScheduleGroupResponse Int Source #

The response's http status code.