Skip to content

Describe Snapshot Schedules

redshift_describe_snapshot_schedules R Documentation

Returns a list of snapshot schedules

Description

Returns a list of snapshot schedules.

Usage

redshift_describe_snapshot_schedules(ClusterIdentifier,
  ScheduleIdentifier, TagKeys, TagValues, Marker, MaxRecords)

Arguments

ClusterIdentifier

The unique identifier for the cluster whose snapshot schedules you want to view.

ScheduleIdentifier

A unique identifier for a snapshot schedule.

TagKeys

The key value for a snapshot schedule tag.

TagValues

The value corresponding to the key of the snapshot schedule tag.

Marker

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

MaxRecords

The maximum number or 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.

Value

A list with the following syntax:

list(
  SnapshotSchedules = list(
    list(
      ScheduleDefinitions = list(
        "string"
      ),
      ScheduleIdentifier = "string",
      ScheduleDescription = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      NextInvocations = list(
        as.POSIXct(
          "2015-01-01"
        )
      ),
      AssociatedClusterCount = 123,
      AssociatedClusters = list(
        list(
          ClusterIdentifier = "string",
          ScheduleAssociationState = "MODIFYING"|"ACTIVE"|"FAILED"
        )
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_snapshot_schedules(
  ClusterIdentifier = "string",
  ScheduleIdentifier = "string",
  TagKeys = list(
    "string"
  ),
  TagValues = list(
    "string"
  ),
  Marker = "string",
  MaxRecords = 123
)