Redshift / Paginator / DescribeSnapshotSchedules

DescribeSnapshotSchedules

class Redshift.Paginator.DescribeSnapshotSchedules

paginator = client.get_paginator('describe_snapshot_schedules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_snapshot_schedules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    ScheduleIdentifier='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ClusterIdentifier (string) – The unique identifier for the cluster whose snapshot schedules you want to view.

• ScheduleIdentifier (string) – A unique identifier for a snapshot schedule.

• TagKeys (list) –

  The key value for a snapshot schedule tag.

  • (string) –

• TagValues (list) –

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

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotSchedules': [
        {
            '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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • SnapshotSchedules (list) –

    A list of SnapshotSchedules.

    • (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) –

  • NextToken (string) –

    A token to resume pagination.