Redshift / Client / create_snapshot_schedule

create_snapshot_schedule#

Redshift.Client.create_snapshot_schedule(**kwargs)#

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot_schedule(
    ScheduleDefinitions=[
        'string',
    ],
    ScheduleIdentifier='string',
    ScheduleDescription='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DryRun=True|False,
    NextInvocations=123
)
Parameters:

  • ScheduleDefinitions (list) –

    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example “cron(30 12 *)” or “rate(12 hours)”.

    • (string) –

  • ScheduleIdentifier (string) – A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.

  • ScheduleDescription (string) – The description of the snapshot schedule.

  • Tags (list) –

    An optional set of tags you can use to search for 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.

  • DryRun (boolean) –

  • NextInvocations (integer) –

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

  • Redshift.Client.exceptions.SnapshotScheduleAlreadyExistsFault

  • Redshift.Client.exceptions.InvalidScheduleFault

  • Redshift.Client.exceptions.SnapshotScheduleQuotaExceededFault

  • Redshift.Client.exceptions.TagLimitExceededFault

  • Redshift.Client.exceptions.ScheduleDefinitionTypeUnsupportedFault

  • Redshift.Client.exceptions.InvalidTagFault