Redshift / Client / describe_cluster_db_revisions

describe_cluster_db_revisions#

Redshift.Client.describe_cluster_db_revisions(**kwargs)#

Returns an array of ClusterDbRevision objects.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_db_revisions(
    ClusterIdentifier='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • ClusterIdentifier (string) – A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

  • MaxRecords (integer) –

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • Marker (string) –

    An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'ClusterDbRevisions': [
        {
            'ClusterIdentifier': 'string',
            'CurrentDatabaseRevision': 'string',
            'DatabaseRevisionReleaseDate': datetime(2015, 1, 1),
            'RevisionTargets': [
                {
                    'DatabaseRevision': 'string',
                    'Description': 'string',
                    'DatabaseRevisionReleaseDate': datetime(2015, 1, 1)
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.

    • ClusterDbRevisions (list) –

      A list of revisions.

      • (dict) –

        Describes a ClusterDbRevision.

        • ClusterIdentifier (string) –

          The unique identifier of the cluster.

        • CurrentDatabaseRevision (string) –

          A string representing the current cluster version.

        • DatabaseRevisionReleaseDate (datetime) –

          The date on which the database revision was released.

        • RevisionTargets (list) –

          A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.

          • (dict) –

            Describes a RevisionTarget.

            • DatabaseRevision (string) –

              A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.

            • Description (string) –

              A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.

            • DatabaseRevisionReleaseDate (datetime) –

              The date on which the database revision was released.

Exceptions