AWS Redshift #Action=DescribeScheduledActions API

openapi: 3.0.0
info:
  version: '2019-12-20'
  x-release: v4
  title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=DescribeScheduledActions API'
  description: <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: redshift-data
  x-aws-signingName: redshift-data
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-data-2019-12-20.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://redshift-data.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Redshift Data API Service multi-region endpoint
- url: https://redshift-data.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Redshift Data API Service multi-region endpoint
- url: http://redshift-data.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
- url: https://redshift-data.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=DescribeScheduledActions'
paths:
  /#Action=DescribeScheduledActions:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      x-aws-operation-name: DescribeScheduledActions
      operationId: GET_DescribeScheduledActions
      description: 'Describes properties of scheduled actions. '
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ScheduledActionsMessage'
        '480':
          description: ScheduledActionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ScheduledActionNotFoundFault'
        '481':
          description: UnauthorizedOperation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UnauthorizedOperation'
      parameters:
      - name: ScheduledActionName
        in: query
        required: false
        description: 'The name of the scheduled action to retrieve. '
        schema:
          type: string
          maxLength: 2147483647
      - name: TargetActionType
        in: query
        required: false
        description: 'The type of the scheduled actions to retrieve. '
        schema:
          type: string
          enum:
          - ResizeCluster
          - PauseCluster
          - ResumeCluster
      - name: StartTime
        in: query
        required: false
        description: The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
        schema:
          type: string
          format: date-time
      - name: EndTime
        in: query
        required: false
        description: The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
        schema:
          type: string
          format: date-time
      - name: Active
        in: query
        required: false
        description: 'If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. '
        schema:
          type: boolean
      - name: Filters
        in: query
        required: false
        description: 'List of scheduled action filters. '
        schema:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/ScheduledActionFilter'
            - xml:
                name: ScheduledActionFilter
      - name: Marker
        in: query
        required: false
        description: 'An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeScheduledActions</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. '
        schema:
          type: string
          maxLength: 2147483647
      - name: MaxRecords
        in: query
        required: false
        description: '<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>'
        schema:
          type: integer
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeScheduledActions
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - '2012-12-01'
      summary: Amazon Redshift - G E T_ Describe Scheduled Actions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=DescribeScheduledActions'
    post:
      x-aws-operation-name: DescribeScheduledActions
      operationId: POST_DescribeScheduledActions
      description: 'Describes properties of scheduled actions. '
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ScheduledActionsMessage'
        '480':
          description: ScheduledActionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ScheduledActionNotFoundFault'
        '481':
          description: UnauthorizedOperation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UnauthorizedOperation'
      requestBody:
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/DescribeScheduledActionsMessage'
      parameters:
      - name: MaxRecords
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: Marker
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeScheduledActions
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - '2012-12-01'
      summary: Amazon Redshift - P O S T_ Describe Scheduled Actions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=DescribeScheduledActions'
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    ScheduledActionNotFoundFault: {}
    DescribeScheduledActionsMessage:
      type: object
      title: DescribeScheduledActionsMessage
      properties:
        ScheduledActionName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The name of the scheduled action to retrieve. '
        TargetActionType:
          allOf:
          - $ref: '#/components/schemas/ScheduledActionTypeValues'
          - description: 'The type of the scheduled actions to retrieve. '
        StartTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
        EndTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
        Active:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: 'If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. '
        Filters:
          allOf:
          - $ref: '#/components/schemas/ScheduledActionFilterList'
          - description: 'List of scheduled action filters. '
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeScheduledActions</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. '
        MaxRecords:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: '<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>'
    BooleanOptional:
      type: boolean
    TStamp:
      type: string
      format: date-time
    String:
      type: string
      maxLength: 2147483647
    UnauthorizedOperation: {}
    ValueStringList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/String'
        - xml:
            name: item
    ResumeClusterMessage:
      type: object
      required:
      - ClusterIdentifier
      title: ResumeClusterMessage
      properties:
        ClusterIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the cluster to be resumed.
      description: 'Describes a resume cluster operation. For example, a scheduled action to run the <code>ResumeCluster</code> API operation. '
    ScheduledAction:
      type: object
      properties:
        ScheduledActionName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The name of the scheduled action. '
        TargetAction:
          allOf:
          - $ref: '#/components/schemas/ScheduledActionType'
          - description: <p>A JSON format string of the Amazon Redshift API operation with input parameters. </p> <p>"<code>{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}</code>". </p>
        Schedule:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p> <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p> <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>". For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>
        IamRole:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. '
        ScheduledActionDescription:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The description of the scheduled action. '
        State:
          allOf:
          - $ref: '#/components/schemas/ScheduledActionState'
          - description: 'The state of the scheduled action. For example, <code>DISABLED</code>. '
        NextInvocations:
          allOf:
          - $ref: '#/components/schemas/ScheduledActionTimeList'
          - description: 'List of times when the scheduled action will run. '
        StartTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: 'The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. '
        EndTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: 'The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. '
      description: '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 <a>ScheduledActionType</a>. '
    ScheduledActionFilterList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/ScheduledActionFilter'
        - xml:
            name: ScheduledActionFilter
    ScheduledActionState:
      type: string
      enum:
      - ACTIVE
      - DISABLED
    PauseClusterMessage:
      type: object
      required:
      - ClusterIdentifier
      title: PauseClusterMessage
      properties:
        ClusterIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the cluster to be paused.
      description: 'Describes a pause cluster operation. For example, a scheduled action to run the <code>PauseCluster</code> API operation. '
    ResizeClusterMessage:
      type: object
      required:
      - ClusterIdentifier
      title: ResizeClusterMessage
      properties:
        ClusterIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The unique identifier for the cluster to resize.
        ClusterType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The new cluster type for the specified cluster.
        NodeType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
        NumberOfNodes:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.
        Classic:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: 'A boolean value indicating whether the resize operation is using the classic resize process. If you don''t provide this parameter or set the value to <code>false</code>, the resize type is elastic. '
        ReservedNodeId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the reserved node.
        TargetReservedNodeOfferingId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the target reserved node offering.
      description: 'Describes a resize cluster operation. For example, a scheduled action to run the <code>ResizeCluster</code> API operation. '
    ScheduledActionFilter:
      type: object
      required:
      - Name
      - Values
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/ScheduledActionFilterName'
          - description: 'The type of element to filter. '
        Values:
          allOf:
          - $ref: '#/components/schemas/ValueStringList'
          - description: 'List of values. Compare if the value (of type defined by <code>Name</code>) equals an item in the list of scheduled actions. '
      description: 'A set of elements to filter the returned scheduled actions. '
    ScheduledActionFilterName:
      type: string
      enum:
      - cluster-identifier
      - iam-role
    ScheduledActionList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/ScheduledAction'
        - xml:
            name: ScheduledAction
    ScheduledActionType:
      type: object
      properties:
        ResizeCluster:
          allOf:
          - $ref: '#/components/schemas/ResizeClusterMessage'
          - description: 'An action that runs a <code>ResizeCluster</code> API operation. '
        PauseCluster:
          allOf:
          - $ref: '#/components/schemas/PauseClusterMessage'
          - description: 'An action that runs a <code>PauseCluster</code> API operation. '
        ResumeCluster:
          allOf:
          - $ref: '#/components/schemas/ResumeClusterMessage'
          - description: 'An action that runs a <code>ResumeCluster</code> API operation. '
      description: 'The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler. '
    ScheduledActionsMessage:
      type: object
      properties:
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeScheduledActions</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. '
        ScheduledActions:
          allOf:
          - $ref: '#/components/schemas/ScheduledActionList'
          - description: 'List of retrieved scheduled actions. '
    IntegerOptional:
      type: integer
    ScheduledActionTimeList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/TStamp'
        - xml:
            name: ScheduledActionTime
    ScheduledActionTypeValues:
      type: string
      enum:
      - ResizeCluster
      - PauseCluster
      - ResumeCluster
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/redshift-data/
x-hasEquivalentPaths: true