amazonka-redshift-2.0: Amazon Redshift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedNodeExchangeStatus Source #

Constructors

DescribeReservedNodeExchangeStatus' 

Fields

  • marker :: Maybe Text

    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.

  • maxRecords :: Maybe Int

    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.

  • reservedNodeExchangeRequestId :: Maybe Text

    The identifier of the reserved-node exchange request.

  • reservedNodeId :: Maybe Text

    The identifier of the source reserved node in a reserved-node exchange request.

Instances

Instances details
ToHeaders DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

ToPath DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

ToQuery DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

AWSPager DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

AWSRequest DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Generic DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Associated Types

type Rep DescribeReservedNodeExchangeStatus :: Type -> Type #

Read DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Show DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

NFData DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Eq DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Hashable DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

type AWSResponse DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

type Rep DescribeReservedNodeExchangeStatus Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

type Rep DescribeReservedNodeExchangeStatus = D1 ('MetaData "DescribeReservedNodeExchangeStatus" "Amazonka.Redshift.DescribeReservedNodeExchangeStatus" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeReservedNodeExchangeStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "reservedNodeExchangeRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reservedNodeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeReservedNodeExchangeStatus :: DescribeReservedNodeExchangeStatus Source #

Create a value of DescribeReservedNodeExchangeStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeReservedNodeExchangeStatus, describeReservedNodeExchangeStatus_marker - 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.

$sel:maxRecords:DescribeReservedNodeExchangeStatus', describeReservedNodeExchangeStatus_maxRecords - 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.

DescribeReservedNodeExchangeStatus, describeReservedNodeExchangeStatus_reservedNodeExchangeRequestId - The identifier of the reserved-node exchange request.

DescribeReservedNodeExchangeStatus, describeReservedNodeExchangeStatus_reservedNodeId - The identifier of the source reserved node in a reserved-node exchange request.

Request Lenses

describeReservedNodeExchangeStatus_marker :: Lens' DescribeReservedNodeExchangeStatus (Maybe Text) Source #

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.

describeReservedNodeExchangeStatus_maxRecords :: Lens' DescribeReservedNodeExchangeStatus (Maybe Int) Source #

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.

describeReservedNodeExchangeStatus_reservedNodeId :: Lens' DescribeReservedNodeExchangeStatus (Maybe Text) Source #

The identifier of the source reserved node in a reserved-node exchange request.

Destructuring the Response

data DescribeReservedNodeExchangeStatusResponse Source #

Constructors

DescribeReservedNodeExchangeStatusResponse' 

Fields

Instances

Instances details
Generic DescribeReservedNodeExchangeStatusResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Read DescribeReservedNodeExchangeStatusResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Show DescribeReservedNodeExchangeStatusResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

NFData DescribeReservedNodeExchangeStatusResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

Eq DescribeReservedNodeExchangeStatusResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

type Rep DescribeReservedNodeExchangeStatusResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeReservedNodeExchangeStatus

type Rep DescribeReservedNodeExchangeStatusResponse = D1 ('MetaData "DescribeReservedNodeExchangeStatusResponse" "Amazonka.Redshift.DescribeReservedNodeExchangeStatus" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeReservedNodeExchangeStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reservedNodeExchangeStatusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservedNodeExchangeStatus])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReservedNodeExchangeStatusResponse Source #

Create a value of DescribeReservedNodeExchangeStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeReservedNodeExchangeStatus, describeReservedNodeExchangeStatusResponse_marker - A pagination token provided by a previous DescribeReservedNodeExchangeStatus request.

$sel:reservedNodeExchangeStatusDetails:DescribeReservedNodeExchangeStatusResponse', describeReservedNodeExchangeStatusResponse_reservedNodeExchangeStatusDetails - The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details.

$sel:httpStatus:DescribeReservedNodeExchangeStatusResponse', describeReservedNodeExchangeStatusResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedNodeExchangeStatusResponse_marker :: Lens' DescribeReservedNodeExchangeStatusResponse (Maybe Text) Source #

A pagination token provided by a previous DescribeReservedNodeExchangeStatus request.

describeReservedNodeExchangeStatusResponse_reservedNodeExchangeStatusDetails :: Lens' DescribeReservedNodeExchangeStatusResponse (Maybe [ReservedNodeExchangeStatus]) Source #

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