Describes properties of scheduled actions.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Active
-
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
Type: Boolean
Required: No
- EndTime
-
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
Type: Timestamp
Required: No
- Filters.ScheduledActionFilter.N
-
List of scheduled action filters.
Type: Array of ScheduledActionFilter objects
Required: No
- 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, AWS returns a value in theMarkerfield of the response. You can retrieve the next set of response records by providing the returned marker value in theMarkerparameter and retrying the request.Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- MaxRecords
-
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified
MaxRecordsvalue, a value is returned in amarkerfield of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
100Constraints: minimum 20, maximum 100.
Type: Integer
Required: No
- ScheduledActionName
-
The name of the scheduled action to retrieve.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- StartTime
-
The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
Type: Timestamp
Required: No
- TargetActionType
-
The type of the scheduled actions to retrieve.
Type: String
Valid Values:
ResizeCluster | PauseCluster | ResumeClusterRequired: No
Response Elements
The following elements are returned by the service.
- 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, AWS returns a value in theMarkerfield of the response. You can retrieve the next set of response records by providing the returned marker value in theMarkerparameter and retrying the request.Type: String
Length Constraints: Maximum length of 2147483647.
- ScheduledActions.ScheduledAction.N
-
List of retrieved scheduled actions.
Type: Array of ScheduledAction objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ScheduledActionNotFound
-
The scheduled action cannot be found.
HTTP Status Code: 400
- UnauthorizedOperation
-
Your account is not authorized to perform the requested operation.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeScheduledActions.
Sample Request
https://redshift.us-east-2.amazonaws.com/
?Action=DescribeScheduledActions
&SignatureMethod=HmacSHA256&SignatureVersion=4
&Version=2012-12-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request
&X-Amz-Date=20190825T160000Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7bSample Response
<DescribeScheduledActionsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
<DescribeScheduledActionsResult>
<ScheduledActions>
<ScheduledAction>
<IamRole>arn:aws:iam::123456789012:role/myRedshiftRole</IamRole>
<Schedule>at(2019-12-10T00:07:00)</Schedule>
<ScheduledActionName>myscheduledaction</ScheduledActionName>
<TargetAction>
<ResizeCluster>
<ClusterIdentifier>mycluster</ClusterIdentifier>
<Classic>false</Classic>
<NumberOfNodes>4</NumberOfNodes>
</ResizeCluster>
</TargetAction>
<NextInvocations/>
<State>DISABLED</State>
</ScheduledAction>
</ScheduledActions>
</DescribeScheduledActionsResult>
<ResponseMetadata>
<RequestId>d9377e44-28d1-11ea-b6af-7126da6f11af</RequestId>
</ResponseMetadata>
</DescribeScheduledActionsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
