Redshift / Paginator / DescribeReservedNodeExchangeStatus

DescribeReservedNodeExchangeStatus

class Redshift.Paginator.DescribeReservedNodeExchangeStatus

paginator = client.get_paginator('describe_reserved_node_exchange_status')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReservedNodeId='string',
    ReservedNodeExchangeRequestId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ReservedNodeId (string) – The identifier of the source reserved node in a reserved-node exchange request.

• ReservedNodeExchangeRequestId (string) – The identifier of the reserved-node exchange request.

• 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

{
    'ReservedNodeExchangeStatusDetails': [
        {
            'ReservedNodeExchangeRequestId': 'string',
            'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
            'RequestTime': datetime(2015, 1, 1),
            'SourceReservedNodeId': 'string',
            'SourceReservedNodeType': 'string',
            'SourceReservedNodeCount': 123,
            'TargetReservedNodeOfferingId': 'string',
            'TargetReservedNodeType': 'string',
            'TargetReservedNodeCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ReservedNodeExchangeStatusDetails (list) –

    The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details.

    • (dict) –

      Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other details.

      • ReservedNodeExchangeRequestId (string) –

        The identifier of the reserved-node exchange request.

      • Status (string) –

        The status of the reserved-node exchange request. Statuses include in-progress and requested.

      • RequestTime (datetime) –

        A date and time that indicate when the reserved-node exchange was requested.

      • SourceReservedNodeId (string) –

        The identifier of the source reserved node.

      • SourceReservedNodeType (string) –

        The source reserved-node type, for example ds2.xlarge.

      • SourceReservedNodeCount (integer) –

        The source reserved-node count in the cluster.

      • TargetReservedNodeOfferingId (string) –

        The identifier of the target reserved node offering.

      • TargetReservedNodeType (string) –

        The node type of the target reserved node, for example ra3.4xlarge.

      • TargetReservedNodeCount (integer) –

        The count of target reserved nodes in the cluster.

  • NextToken (string) –

    A token to resume pagination.