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 |
Describes properties of scheduled actions.
This operation returns paginated results.
Synopsis
- data DescribeScheduledActions = DescribeScheduledActions' {}
- newDescribeScheduledActions :: DescribeScheduledActions
- describeScheduledActions_active :: Lens' DescribeScheduledActions (Maybe Bool)
- describeScheduledActions_endTime :: Lens' DescribeScheduledActions (Maybe UTCTime)
- describeScheduledActions_filters :: Lens' DescribeScheduledActions (Maybe [ScheduledActionFilter])
- describeScheduledActions_marker :: Lens' DescribeScheduledActions (Maybe Text)
- describeScheduledActions_maxRecords :: Lens' DescribeScheduledActions (Maybe Int)
- describeScheduledActions_scheduledActionName :: Lens' DescribeScheduledActions (Maybe Text)
- describeScheduledActions_startTime :: Lens' DescribeScheduledActions (Maybe UTCTime)
- describeScheduledActions_targetActionType :: Lens' DescribeScheduledActions (Maybe ScheduledActionTypeValues)
- data DescribeScheduledActionsResponse = DescribeScheduledActionsResponse' {
- marker :: Maybe Text
- scheduledActions :: Maybe [ScheduledAction]
- httpStatus :: Int
- newDescribeScheduledActionsResponse :: Int -> DescribeScheduledActionsResponse
- describeScheduledActionsResponse_marker :: Lens' DescribeScheduledActionsResponse (Maybe Text)
- describeScheduledActionsResponse_scheduledActions :: Lens' DescribeScheduledActionsResponse (Maybe [ScheduledAction])
- describeScheduledActionsResponse_httpStatus :: Lens' DescribeScheduledActionsResponse Int
Creating a Request
data DescribeScheduledActions Source #
See: newDescribeScheduledActions
smart constructor.
DescribeScheduledActions' | |
|
Instances
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.
DescribeScheduledActionsResponse' | |
|
Instances
newDescribeScheduledActionsResponse Source #
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.