Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.PrivateNetworks.ListOrders

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.

If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

This operation returns paginated results.

Synopsis

data ListOrders = ListOrders' {
- filters :: Maybe (HashMap OrderFilterKeys [Text])
- maxResults :: Maybe Natural
- startToken :: Maybe Text
- networkArn :: Text
}
newListOrders :: Text -> ListOrders
listOrders_filters :: Lens' ListOrders (Maybe (HashMap OrderFilterKeys [Text]))
listOrders_maxResults :: Lens' ListOrders (Maybe Natural)
listOrders_startToken :: Lens' ListOrders (Maybe Text)
listOrders_networkArn :: Lens' ListOrders Text
data ListOrdersResponse = ListOrdersResponse' {
- nextToken :: Maybe Text
- orders :: Maybe [Order]
- httpStatus :: Int
}
newListOrdersResponse :: Int -> ListOrdersResponse
listOrdersResponse_nextToken :: Lens' ListOrdersResponse (Maybe Text)
listOrdersResponse_orders :: Lens' ListOrdersResponse (Maybe [Order])
listOrdersResponse_httpStatus :: Lens' ListOrdersResponse Int

Creating a Request

data ListOrders Source #

See: newListOrders smart constructor.

Constructors

ListOrders'

Fields

filters :: Maybe (HashMap OrderFilterKeys [Text])
The filters.
- NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
- STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
maxResults :: Maybe Natural
The maximum number of results to return.
startToken :: Maybe Text
The token for the next page of results.
networkArn :: Text
The Amazon Resource Name (ARN) of the network.

Instances

Instances details

ToJSON ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods toJSON :: ListOrders -> Value # toEncoding :: ListOrders -> Encoding # toJSONList :: [ListOrders] -> Value # toEncodingList :: [ListOrders] -> Encoding #
ToHeaders ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods toHeaders :: ListOrders -> [Header] #
ToPath ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods toPath :: ListOrders -> ByteString #
ToQuery ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods toQuery :: ListOrders -> QueryString #
AWSPager ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods page :: ListOrders -> AWSResponse ListOrders -> Maybe ListOrders #
AWSRequest ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Associated Types type AWSResponse ListOrders # Methods request :: (Service -> Service) -> ListOrders -> Request ListOrders # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListOrders -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListOrders))) #
Generic ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Associated Types type Rep ListOrders :: Type -> Type # Methods from :: ListOrders -> Rep ListOrders x # to :: Rep ListOrders x -> ListOrders #
Read ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods readsPrec :: Int -> ReadS ListOrders # readList :: ReadS [ListOrders] # readPrec :: ReadPrec ListOrders # readListPrec :: ReadPrec [ListOrders] #
Show ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods showsPrec :: Int -> ListOrders -> ShowS # show :: ListOrders -> String # showList :: [ListOrders] -> ShowS #
NFData ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods rnf :: ListOrders -> () #
Eq ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods (==) :: ListOrders -> ListOrders -> Bool # (/=) :: ListOrders -> ListOrders -> Bool #
Hashable ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods hashWithSalt :: Int -> ListOrders -> Int # hash :: ListOrders -> Int #
type AWSResponse ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders type AWSResponse ListOrders = ListOrdersResponse
type Rep ListOrders Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders type Rep ListOrders = D1 ('MetaData "ListOrders" "Amazonka.PrivateNetworks.ListOrders" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ListOrders'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap OrderFilterKeys [Text]))) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "startToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "networkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListOrders Source #

Arguments

:: Text	`ListOrders`
-> ListOrders

Create a value of ListOrders 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:

$sel:filters:ListOrders', listOrders_filters - The filters.

NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

$sel:maxResults:ListOrders', listOrders_maxResults - The maximum number of results to return.

$sel:startToken:ListOrders', listOrders_startToken - The token for the next page of results.

ListOrders, listOrders_networkArn - The Amazon Resource Name (ARN) of the network.

Request Lenses

listOrders_filters :: Lens' ListOrders (Maybe (HashMap OrderFilterKeys [Text])) Source #

The filters.

NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listOrders_maxResults :: Lens' ListOrders (Maybe Natural) Source #

The maximum number of results to return.

listOrders_startToken :: Lens' ListOrders (Maybe Text) Source #

The token for the next page of results.

listOrders_networkArn :: Lens' ListOrders Text Source #

The Amazon Resource Name (ARN) of the network.

Destructuring the Response

data ListOrdersResponse Source #

See: newListOrdersResponse smart constructor.

Constructors

ListOrdersResponse'
Fields nextToken :: Maybe Text The token for the next page of results. orders :: Maybe [Order] Information about the orders. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListOrdersResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Associated Types type Rep ListOrdersResponse :: Type -> Type # Methods from :: ListOrdersResponse -> Rep ListOrdersResponse x # to :: Rep ListOrdersResponse x -> ListOrdersResponse #
Show ListOrdersResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods showsPrec :: Int -> ListOrdersResponse -> ShowS # show :: ListOrdersResponse -> String # showList :: [ListOrdersResponse] -> ShowS #
NFData ListOrdersResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods rnf :: ListOrdersResponse -> () #
Eq ListOrdersResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders Methods (==) :: ListOrdersResponse -> ListOrdersResponse -> Bool # (/=) :: ListOrdersResponse -> ListOrdersResponse -> Bool #
type Rep ListOrdersResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ListOrders type Rep ListOrdersResponse = D1 ('MetaData "ListOrdersResponse" "Amazonka.PrivateNetworks.ListOrders" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ListOrdersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "orders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Order])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListOrdersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListOrdersResponse'`
-> ListOrdersResponse

Create a value of ListOrdersResponse 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:

$sel:nextToken:ListOrdersResponse', listOrdersResponse_nextToken - The token for the next page of results.

$sel:orders:ListOrdersResponse', listOrdersResponse_orders - Information about the orders.

$sel:httpStatus:ListOrdersResponse', listOrdersResponse_httpStatus - The response's http status code.

Response Lenses

listOrdersResponse_nextToken :: Lens' ListOrdersResponse (Maybe Text) Source #

The token for the next page of results.

listOrdersResponse_orders :: Lens' ListOrdersResponse (Maybe [Order]) Source #

Information about the orders.

listOrdersResponse_httpStatus :: Lens' ListOrdersResponse Int Source #

The response's http status code.