Redshift / Client / describe_reserved_node_exchange_status

describe_reserved_node_exchange_status#

Redshift.Client.describe_reserved_node_exchange_status(**kwargs)#

Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_node_exchange_status(
    ReservedNodeId='string',
    ReservedNodeExchangeRequestId='string',
    MaxRecords=123,
    Marker='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.

  • 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 a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  • Marker (string) – An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

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
        },
    ],
    'Marker': '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.

    • Marker (string) –

      A pagination token provided by a previous DescribeReservedNodeExchangeStatus request.

Exceptions

  • Redshift.Client.exceptions.ReservedNodeNotFoundFault

  • Redshift.Client.exceptions.ReservedNodeExchangeNotFoundFault

  • Redshift.Client.exceptions.UnsupportedOperationFault