amazonka-datapipeline-1.3.4: Amazon Data Pipeline SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DataPipeline.QueryObjects

Contents

Description

Queries the specified pipeline for the names of objects that match the specified set of conditions.

See: AWS API Reference for QueryObjects.

This operation returns paginated results.

Synopsis

Creating a Request

queryObjects Source

Creates a value of QueryObjects with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

qoQuery :: Lens' QueryObjects (Maybe Query) Source

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

qoMarker :: Lens' QueryObjects (Maybe Text) Source

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

qoLimit :: Lens' QueryObjects (Maybe Int) Source

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

qoPipelineId :: Lens' QueryObjects Text Source

The ID of the pipeline.

qoSphere :: Lens' QueryObjects Text Source

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Destructuring the Response

queryObjectsResponse Source

Creates a value of QueryObjectsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

qorsHasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool) Source

Indicates whether there are more results that can be obtained by a subsequent call.

qorsIds :: Lens' QueryObjectsResponse [Text] Source

The identifiers that match the query selectors.

qorsMarker :: Lens' QueryObjectsResponse (Maybe Text) Source

The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results.