Redshift / Client / modify_snapshot_schedule

modify_snapshot_schedule#

Redshift.Client.modify_snapshot_schedule(**kwargs)#

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

See also: AWS API Documentation

Request Syntax

response = client.modify_snapshot_schedule(
    ScheduleIdentifier='string',
    ScheduleDefinitions=[
        'string',
    ]
)
Parameters:

  • ScheduleIdentifier (string) –

    [REQUIRED]

    A unique alphanumeric identifier of the schedule to modify.

  • ScheduleDefinitions (list) –

    [REQUIRED]

    An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, “cron(30 12 *)” or “rate(12 hours)”.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ScheduleDefinitions': [
        'string',
    ],
    'ScheduleIdentifier': 'string',
    'ScheduleDescription': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextInvocations': [
        datetime(2015, 1, 1),
    ],
    'AssociatedClusterCount': 123,
    'AssociatedClusters': [
        {
            'ClusterIdentifier': 'string',
            'ScheduleAssociationState': 'MODIFYING'|'ACTIVE'|'FAILED'
        },
    ]
}

Response Structure

  • (dict) –

    Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.

    • ScheduleDefinitions (list) –

      A list of ScheduleDefinitions.

      • (string) –

    • ScheduleIdentifier (string) –

      A unique identifier for the schedule.

    • ScheduleDescription (string) –

      The description of the schedule.

    • Tags (list) –

      An optional set of tags describing the schedule.

      • (dict) –

        A tag consisting of a name/value pair for a resource.

        • Key (string) –

          The key, or name, for the resource tag.

        • Value (string) –

          The value for the resource tag.

    • NextInvocations (list) –

      • (datetime) –

    • AssociatedClusterCount (integer) –

      The number of clusters associated with the schedule.

    • AssociatedClusters (list) –

      A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

      • (dict) –

        • ClusterIdentifier (string) –

        • ScheduleAssociationState (string) –

Exceptions