libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.DescribeScheduledActions

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

  • 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.

  • scheduledActionName :: Maybe Text

    The name of the scheduled action to retrieve.

  • filters :: Maybe [ScheduledActionFilter]

    List of scheduled action filters.

  • active :: Maybe Bool

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

  • targetActionType :: Maybe ScheduledActionTypeValues

    The type of the scheduled actions to retrieve.

  • 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.

  • 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.

Instances

Instances details
Eq DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Read DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Show DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Generic DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Associated Types

type Rep DescribeScheduledActions :: Type -> Type #

NFData DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Hashable DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

AWSPager DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

AWSRequest DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

ToHeaders DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

ToPath DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

ToQuery DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

type Rep DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

type AWSResponse DescribeScheduledActions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

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:startTime: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:scheduledActionName:DescribeScheduledActions', describeScheduledActions_scheduledActionName - The name of the scheduled action to retrieve.

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

$sel:active:DescribeScheduledActions', describeScheduledActions_active - If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

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

$sel:marker: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.

$sel:endTime: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.

Request Lenses

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_active :: Lens' DescribeScheduledActions (Maybe Bool) Source #

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

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_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.

Destructuring the Response

data DescribeScheduledActionsResponse Source #

See: newDescribeScheduledActionsResponse smart constructor.

Constructors

DescribeScheduledActionsResponse' 

Fields

  • scheduledActions :: Maybe [ScheduledAction]

    List of retrieved scheduled actions.

  • 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeScheduledActionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Read DescribeScheduledActionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Show DescribeScheduledActionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Generic DescribeScheduledActionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

Associated Types

type Rep DescribeScheduledActionsResponse :: Type -> Type #

NFData DescribeScheduledActionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

type Rep DescribeScheduledActionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeScheduledActions

type Rep DescribeScheduledActionsResponse = D1 ('MetaData "DescribeScheduledActionsResponse" "Amazonka.Redshift.DescribeScheduledActions" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeScheduledActionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduledActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduledAction])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

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

$sel:marker: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: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.