Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.ModifyScheduledAction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies a scheduled action.

Synopsis

data ModifyScheduledAction = ModifyScheduledAction' {
- targetAction :: Maybe ScheduledActionType
- startTime :: Maybe ISO8601
- schedule :: Maybe Text
- scheduledActionDescription :: Maybe Text
- enable :: Maybe Bool
- endTime :: Maybe ISO8601
- iamRole :: Maybe Text
- scheduledActionName :: Text
}
newModifyScheduledAction :: Text -> ModifyScheduledAction
modifyScheduledAction_targetAction :: Lens' ModifyScheduledAction (Maybe ScheduledActionType)
modifyScheduledAction_startTime :: Lens' ModifyScheduledAction (Maybe UTCTime)
modifyScheduledAction_schedule :: Lens' ModifyScheduledAction (Maybe Text)
modifyScheduledAction_scheduledActionDescription :: Lens' ModifyScheduledAction (Maybe Text)
modifyScheduledAction_enable :: Lens' ModifyScheduledAction (Maybe Bool)
modifyScheduledAction_endTime :: Lens' ModifyScheduledAction (Maybe UTCTime)
modifyScheduledAction_iamRole :: Lens' ModifyScheduledAction (Maybe Text)
modifyScheduledAction_scheduledActionName :: Lens' ModifyScheduledAction Text
data ScheduledAction = ScheduledAction' {
- state :: Maybe ScheduledActionState
- targetAction :: Maybe ScheduledActionType
- startTime :: Maybe ISO8601
- schedule :: Maybe Text
- scheduledActionName :: Maybe Text
- scheduledActionDescription :: Maybe Text
- nextInvocations :: Maybe [ISO8601]
- endTime :: Maybe ISO8601
- iamRole :: Maybe Text
}
newScheduledAction :: ScheduledAction
scheduledAction_state :: Lens' ScheduledAction (Maybe ScheduledActionState)
scheduledAction_targetAction :: Lens' ScheduledAction (Maybe ScheduledActionType)
scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime)
scheduledAction_schedule :: Lens' ScheduledAction (Maybe Text)
scheduledAction_scheduledActionName :: Lens' ScheduledAction (Maybe Text)
scheduledAction_scheduledActionDescription :: Lens' ScheduledAction (Maybe Text)
scheduledAction_nextInvocations :: Lens' ScheduledAction (Maybe [UTCTime])
scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime)
scheduledAction_iamRole :: Lens' ScheduledAction (Maybe Text)

Creating a Request

data ModifyScheduledAction Source #

See: newModifyScheduledAction smart constructor.

Constructors

ModifyScheduledAction'

Fields

targetAction :: Maybe ScheduledActionType
A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.
startTime :: Maybe ISO8601
A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.
schedule :: Maybe Text
A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
scheduledActionDescription :: Maybe Text
A modified description of the scheduled action.
enable :: Maybe Bool
A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.
endTime :: Maybe ISO8601
A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.
iamRole :: Maybe Text
A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
scheduledActionName :: Text
The name of the scheduled action to modify.

Instances

Instances details

Eq ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods (==) :: ModifyScheduledAction -> ModifyScheduledAction -> Bool # (/=) :: ModifyScheduledAction -> ModifyScheduledAction -> Bool #
Read ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods readsPrec :: Int -> ReadS ModifyScheduledAction # readList :: ReadS [ModifyScheduledAction] # readPrec :: ReadPrec ModifyScheduledAction # readListPrec :: ReadPrec [ModifyScheduledAction] #
Show ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods showsPrec :: Int -> ModifyScheduledAction -> ShowS # show :: ModifyScheduledAction -> String # showList :: [ModifyScheduledAction] -> ShowS #
Generic ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Associated Types type Rep ModifyScheduledAction :: Type -> Type # Methods from :: ModifyScheduledAction -> Rep ModifyScheduledAction x # to :: Rep ModifyScheduledAction x -> ModifyScheduledAction #
NFData ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods rnf :: ModifyScheduledAction -> () #
Hashable ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods hashWithSalt :: Int -> ModifyScheduledAction -> Int # hash :: ModifyScheduledAction -> Int #
AWSRequest ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Associated Types type AWSResponse ModifyScheduledAction # Methods request :: ModifyScheduledAction -> Request ModifyScheduledAction # response :: MonadResource m => Logger -> Service -> Proxy ModifyScheduledAction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyScheduledAction))) #
ToHeaders ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods toHeaders :: ModifyScheduledAction -> [Header] #
ToPath ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods toPath :: ModifyScheduledAction -> ByteString #
ToQuery ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction Methods toQuery :: ModifyScheduledAction -> QueryString #
type Rep ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction type Rep ModifyScheduledAction = D1 ('MetaData "ModifyScheduledAction" "Amazonka.Redshift.ModifyScheduledAction" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "ModifyScheduledAction'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "targetAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledActionType)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "scheduledActionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ModifyScheduledAction Source #
Instance details Defined in Amazonka.Redshift.ModifyScheduledAction type AWSResponse ModifyScheduledAction = ScheduledAction

newModifyScheduledAction Source #

Arguments

:: Text	`$sel:scheduledActionName:ModifyScheduledAction'`
-> ModifyScheduledAction

Create a value of ModifyScheduledAction 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:targetAction:ModifyScheduledAction', modifyScheduledAction_targetAction - A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

$sel:startTime:ModifyScheduledAction', modifyScheduledAction_startTime - A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

$sel:schedule:ModifyScheduledAction', modifyScheduledAction_schedule - A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

$sel:scheduledActionDescription:ModifyScheduledAction', modifyScheduledAction_scheduledActionDescription - A modified description of the scheduled action.

$sel:enable:ModifyScheduledAction', modifyScheduledAction_enable - A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

$sel:endTime:ModifyScheduledAction', modifyScheduledAction_endTime - A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

$sel:iamRole:ModifyScheduledAction', modifyScheduledAction_iamRole - A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

$sel:scheduledActionName:ModifyScheduledAction', modifyScheduledAction_scheduledActionName - The name of the scheduled action to modify.

Request Lenses

modifyScheduledAction_targetAction :: Lens' ModifyScheduledAction (Maybe ScheduledActionType) Source #

A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_startTime :: Lens' ModifyScheduledAction (Maybe UTCTime) Source #

A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_schedule :: Lens' ModifyScheduledAction (Maybe Text) Source #

A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_scheduledActionDescription :: Lens' ModifyScheduledAction (Maybe Text) Source #

A modified description of the scheduled action.

modifyScheduledAction_enable :: Lens' ModifyScheduledAction (Maybe Bool) Source #

A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

modifyScheduledAction_endTime :: Lens' ModifyScheduledAction (Maybe UTCTime) Source #

A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_iamRole :: Lens' ModifyScheduledAction (Maybe Text) Source #

A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_scheduledActionName :: Lens' ModifyScheduledAction Text Source #

The name of the scheduled action to modify.

Destructuring the Response

data ScheduledAction Source #

Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.

See: newScheduledAction smart constructor.

Constructors

ScheduledAction'

Fields

state :: Maybe ScheduledActionState
The state of the scheduled action. For example, DISABLED.
targetAction :: Maybe ScheduledActionType
A JSON format string of the Amazon Redshift API operation with input parameters.
"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".
startTime :: Maybe ISO8601
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
schedule :: Maybe Text
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
scheduledActionName :: Maybe Text
The name of the scheduled action.
scheduledActionDescription :: Maybe Text
The description of the scheduled action.
nextInvocations :: Maybe [ISO8601]
List of times when the scheduled action will run.
endTime :: Maybe ISO8601
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
iamRole :: Maybe Text
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Instances

Instances details

Eq ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods (==) :: ScheduledAction -> ScheduledAction -> Bool # (/=) :: ScheduledAction -> ScheduledAction -> Bool #
Read ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods readsPrec :: Int -> ReadS ScheduledAction # readList :: ReadS [ScheduledAction] # readPrec :: ReadPrec ScheduledAction # readListPrec :: ReadPrec [ScheduledAction] #
Show ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods showsPrec :: Int -> ScheduledAction -> ShowS # show :: ScheduledAction -> String # showList :: [ScheduledAction] -> ShowS #
Generic ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Associated Types type Rep ScheduledAction :: Type -> Type # Methods from :: ScheduledAction -> Rep ScheduledAction x # to :: Rep ScheduledAction x -> ScheduledAction #
NFData ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods rnf :: ScheduledAction -> () #
Hashable ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods hashWithSalt :: Int -> ScheduledAction -> Int # hash :: ScheduledAction -> Int #
FromXML ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction Methods parseXML :: [Node] -> Either String ScheduledAction #
type Rep ScheduledAction Source #
Instance details Defined in Amazonka.Redshift.Types.ScheduledAction type Rep ScheduledAction = D1 ('MetaData "ScheduledAction" "Amazonka.Redshift.Types.ScheduledAction" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "ScheduledAction'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledActionState)) :: S1 ('MetaSel ('Just "targetAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledActionType))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "scheduledActionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextInvocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ISO8601])) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newScheduledAction :: ScheduledAction Source #

Create a value of ScheduledAction 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:state:ScheduledAction', scheduledAction_state - The state of the scheduled action. For example, DISABLED.

$sel:targetAction:ScheduledAction', scheduledAction_targetAction - A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

$sel:startTime:ScheduledAction', scheduledAction_startTime - The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

$sel:schedule:ScheduledAction', scheduledAction_schedule - The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

$sel:scheduledActionName:ScheduledAction', scheduledAction_scheduledActionName - The name of the scheduled action.

$sel:scheduledActionDescription:ScheduledAction', scheduledAction_scheduledActionDescription - The description of the scheduled action.

$sel:nextInvocations:ScheduledAction', scheduledAction_nextInvocations - List of times when the scheduled action will run.

$sel:endTime:ScheduledAction', scheduledAction_endTime - The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

$sel:iamRole:ScheduledAction', scheduledAction_iamRole - The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Response Lenses

scheduledAction_state :: Lens' ScheduledAction (Maybe ScheduledActionState) Source #

The state of the scheduled action. For example, DISABLED.

scheduledAction_targetAction :: Lens' ScheduledAction (Maybe ScheduledActionType) Source #

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

scheduledAction_schedule :: Lens' ScheduledAction (Maybe Text) Source #

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

scheduledAction_scheduledActionName :: Lens' ScheduledAction (Maybe Text) Source #

The name of the scheduled action.

scheduledAction_scheduledActionDescription :: Lens' ScheduledAction (Maybe Text) Source #

The description of the scheduled action.

scheduledAction_nextInvocations :: Lens' ScheduledAction (Maybe [UTCTime]) Source #

List of times when the scheduled action will run.

scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

scheduledAction_iamRole :: Lens' ScheduledAction (Maybe Text) Source #

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.