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.Redshift.DescribeScheduledActions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes properties of scheduled actions.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeScheduledActions Source #

See: newDescribeScheduledActions smart constructor.

Constructors

DescribeScheduledActions'

Fields

active :: Maybe Bool
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
endTime :: Maybe ISO8601
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
filters :: Maybe [ScheduledActionFilter]
List of scheduled action filters.
marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
maxRecords :: Maybe Int
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
scheduledActionName :: Maybe Text
The name of the scheduled action to retrieve.
startTime :: Maybe ISO8601
The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
targetActionType :: Maybe ScheduledActionTypeValues
The type of the scheduled actions to retrieve.

Instances

Instances details

ToHeaders DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods toHeaders :: DescribeScheduledActions -> [Header] #
ToPath DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods toPath :: DescribeScheduledActions -> ByteString #
ToQuery DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods toQuery :: DescribeScheduledActions -> QueryString #
AWSPager DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods page :: DescribeScheduledActions -> AWSResponse DescribeScheduledActions -> Maybe DescribeScheduledActions #
AWSRequest DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Associated Types type AWSResponse DescribeScheduledActions # Methods request :: (Service -> Service) -> DescribeScheduledActions -> Request DescribeScheduledActions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeScheduledActions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeScheduledActions))) #
Generic DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Associated Types type Rep DescribeScheduledActions :: Type -> Type # Methods from :: DescribeScheduledActions -> Rep DescribeScheduledActions x # to :: Rep DescribeScheduledActions x -> DescribeScheduledActions #
Read DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods readsPrec :: Int -> ReadS DescribeScheduledActions # readList :: ReadS [DescribeScheduledActions] # readPrec :: ReadPrec DescribeScheduledActions # readListPrec :: ReadPrec [DescribeScheduledActions] #
Show DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods showsPrec :: Int -> DescribeScheduledActions -> ShowS # show :: DescribeScheduledActions -> String # showList :: [DescribeScheduledActions] -> ShowS #
NFData DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods rnf :: DescribeScheduledActions -> () #
Eq DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods (==) :: DescribeScheduledActions -> DescribeScheduledActions -> Bool # (/=) :: DescribeScheduledActions -> DescribeScheduledActions -> Bool #
Hashable DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods hashWithSalt :: Int -> DescribeScheduledActions -> Int # hash :: DescribeScheduledActions -> Int #
type AWSResponse DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions type AWSResponse DescribeScheduledActions = DescribeScheduledActionsResponse
type Rep DescribeScheduledActions Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions type Rep DescribeScheduledActions = D1 ('MetaData "DescribeScheduledActions" "Amazonka.Redshift.DescribeScheduledActions" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeScheduledActions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "active") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduledActionFilter])) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "scheduledActionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "targetActionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScheduledActionTypeValues))))))

newDescribeScheduledActions :: DescribeScheduledActions Source #

Create a value of DescribeScheduledActions 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:active:DescribeScheduledActions', describeScheduledActions_active - If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

DescribeScheduledActions, describeScheduledActions_endTime - The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

$sel:filters:DescribeScheduledActions', describeScheduledActions_filters - List of scheduled action filters.

DescribeScheduledActions, describeScheduledActions_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

$sel:maxRecords:DescribeScheduledActions', describeScheduledActions_maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

DescribeScheduledActions, describeScheduledActions_scheduledActionName - The name of the scheduled action to retrieve.

DescribeScheduledActions, describeScheduledActions_startTime - The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

$sel:targetActionType:DescribeScheduledActions', describeScheduledActions_targetActionType - The type of the scheduled actions to retrieve.

Request Lenses

describeScheduledActions_active :: Lens' DescribeScheduledActions (Maybe Bool) Source #

If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

describeScheduledActions_endTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

describeScheduledActions_filters :: Lens' DescribeScheduledActions (Maybe [ScheduledActionFilter]) Source #

List of scheduled action filters.

describeScheduledActions_marker :: Lens' DescribeScheduledActions (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeScheduledActions_maxRecords :: Lens' DescribeScheduledActions (Maybe Int) Source #

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

describeScheduledActions_scheduledActionName :: Lens' DescribeScheduledActions (Maybe Text) Source #

The name of the scheduled action to retrieve.

describeScheduledActions_startTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

describeScheduledActions_targetActionType :: Lens' DescribeScheduledActions (Maybe ScheduledActionTypeValues) Source #

The type of the scheduled actions to retrieve.

Destructuring the Response

data DescribeScheduledActionsResponse Source #

See: newDescribeScheduledActionsResponse smart constructor.

Constructors

DescribeScheduledActionsResponse'

Fields

marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
scheduledActions :: Maybe [ScheduledAction]
List of retrieved scheduled actions.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeScheduledActionsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Associated Types type Rep DescribeScheduledActionsResponse :: Type -> Type # Methods from :: DescribeScheduledActionsResponse -> Rep DescribeScheduledActionsResponse x # to :: Rep DescribeScheduledActionsResponse x -> DescribeScheduledActionsResponse #
Read DescribeScheduledActionsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods readsPrec :: Int -> ReadS DescribeScheduledActionsResponse # readList :: ReadS [DescribeScheduledActionsResponse] # readPrec :: ReadPrec DescribeScheduledActionsResponse # readListPrec :: ReadPrec [DescribeScheduledActionsResponse] #
Show DescribeScheduledActionsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods showsPrec :: Int -> DescribeScheduledActionsResponse -> ShowS # show :: DescribeScheduledActionsResponse -> String # showList :: [DescribeScheduledActionsResponse] -> ShowS #
NFData DescribeScheduledActionsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods rnf :: DescribeScheduledActionsResponse -> () #
Eq DescribeScheduledActionsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions Methods (==) :: DescribeScheduledActionsResponse -> DescribeScheduledActionsResponse -> Bool # (/=) :: DescribeScheduledActionsResponse -> DescribeScheduledActionsResponse -> Bool #
type Rep DescribeScheduledActionsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeScheduledActions type Rep DescribeScheduledActionsResponse = D1 ('MetaData "DescribeScheduledActionsResponse" "Amazonka.Redshift.DescribeScheduledActions" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeScheduledActionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "scheduledActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduledAction])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeScheduledActionsResponse Source #

Arguments

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

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

DescribeScheduledActions, describeScheduledActionsResponse_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

$sel:scheduledActions:DescribeScheduledActionsResponse', describeScheduledActionsResponse_scheduledActions - List of retrieved scheduled actions.

$sel:httpStatus:DescribeScheduledActionsResponse', describeScheduledActionsResponse_httpStatus - The response's http status code.

Response Lenses

describeScheduledActionsResponse_marker :: Lens' DescribeScheduledActionsResponse (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeScheduledActionsResponse_scheduledActions :: Lens' DescribeScheduledActionsResponse (Maybe [ScheduledAction]) Source #

List of retrieved scheduled actions.

describeScheduledActionsResponse_httpStatus :: Lens' DescribeScheduledActionsResponse Int Source #

The response's http status code.