Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DataPipeline.QueryObjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data QueryObjects = QueryObjects' {
- query :: Maybe Query
- marker :: Maybe Text
- limit :: Maybe Int
- pipelineId :: Text
- sphere :: Text
}
newQueryObjects :: Text -> Text -> QueryObjects
queryObjects_query :: Lens' QueryObjects (Maybe Query)
queryObjects_marker :: Lens' QueryObjects (Maybe Text)
queryObjects_limit :: Lens' QueryObjects (Maybe Int)
queryObjects_pipelineId :: Lens' QueryObjects Text
queryObjects_sphere :: Lens' QueryObjects Text
data QueryObjectsResponse = QueryObjectsResponse' {
- hasMoreResults :: Maybe Bool
- ids :: Maybe [Text]
- marker :: Maybe Text
- httpStatus :: Int
}
newQueryObjectsResponse :: Int -> QueryObjectsResponse
queryObjectsResponse_hasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool)
queryObjectsResponse_ids :: Lens' QueryObjectsResponse (Maybe [Text])
queryObjectsResponse_marker :: Lens' QueryObjectsResponse (Maybe Text)
queryObjectsResponse_httpStatus :: Lens' QueryObjectsResponse Int

Creating a Request

data QueryObjects Source #

Contains the parameters for QueryObjects.

See: newQueryObjects smart constructor.

Constructors

QueryObjects'

Fields

query :: Maybe Query
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.
marker :: Maybe Text
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.
limit :: Maybe Int
The maximum number of object names that QueryObjects will return in a single call. The default value is 100.
pipelineId :: Text
The ID of the pipeline.
sphere :: Text
Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Instances

Instances details

Eq QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods (==) :: QueryObjects -> QueryObjects -> Bool # (/=) :: QueryObjects -> QueryObjects -> Bool #
Read QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods readsPrec :: Int -> ReadS QueryObjects # readList :: ReadS [QueryObjects] # readPrec :: ReadPrec QueryObjects # readListPrec :: ReadPrec [QueryObjects] #
Show QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods showsPrec :: Int -> QueryObjects -> ShowS # show :: QueryObjects -> String # showList :: [QueryObjects] -> ShowS #
Generic QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Associated Types type Rep QueryObjects :: Type -> Type # Methods from :: QueryObjects -> Rep QueryObjects x # to :: Rep QueryObjects x -> QueryObjects #
NFData QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods rnf :: QueryObjects -> () #
Hashable QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods hashWithSalt :: Int -> QueryObjects -> Int # hash :: QueryObjects -> Int #
ToJSON QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods toJSON :: QueryObjects -> Value # toEncoding :: QueryObjects -> Encoding # toJSONList :: [QueryObjects] -> Value # toEncodingList :: [QueryObjects] -> Encoding #
AWSPager QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods page :: QueryObjects -> AWSResponse QueryObjects -> Maybe QueryObjects #
AWSRequest QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Associated Types type AWSResponse QueryObjects # Methods request :: QueryObjects -> Request QueryObjects # response :: MonadResource m => Logger -> Service -> Proxy QueryObjects -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse QueryObjects))) #
ToHeaders QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods toHeaders :: QueryObjects -> [Header] #
ToPath QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods toPath :: QueryObjects -> ByteString #
ToQuery QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods toQuery :: QueryObjects -> QueryString #
type Rep QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects type Rep QueryObjects = D1 ('MetaData "QueryObjects" "Amazonka.DataPipeline.QueryObjects" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "QueryObjects'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Query)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sphere") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse QueryObjects Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects type AWSResponse QueryObjects = QueryObjectsResponse

newQueryObjects Source #

Arguments

:: Text	`$sel:pipelineId:QueryObjects'`
-> Text	`$sel:sphere:QueryObjects'`
-> QueryObjects

Create a value of QueryObjects 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:query:QueryObjects', queryObjects_query - 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.

$sel:marker:QueryObjects', queryObjects_marker - 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.

$sel:limit:QueryObjects', queryObjects_limit - The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

$sel:pipelineId:QueryObjects', queryObjects_pipelineId - The ID of the pipeline.

$sel:sphere:QueryObjects', queryObjects_sphere - Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Request Lenses

queryObjects_query :: 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.

queryObjects_marker :: 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.

queryObjects_limit :: Lens' QueryObjects (Maybe Int) Source #

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

queryObjects_pipelineId :: Lens' QueryObjects Text Source #

The ID of the pipeline.

queryObjects_sphere :: Lens' QueryObjects Text Source #

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

Destructuring the Response

data QueryObjectsResponse Source #

Contains the output of QueryObjects.

See: newQueryObjectsResponse smart constructor.

Constructors

QueryObjectsResponse'

Fields

hasMoreResults :: Maybe Bool
Indicates whether there are more results that can be obtained by a subsequent call.
ids :: Maybe [Text]
The identifiers that match the query selectors.
marker :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq QueryObjectsResponse Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods (==) :: QueryObjectsResponse -> QueryObjectsResponse -> Bool # (/=) :: QueryObjectsResponse -> QueryObjectsResponse -> Bool #
Read QueryObjectsResponse Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods readsPrec :: Int -> ReadS QueryObjectsResponse # readList :: ReadS [QueryObjectsResponse] # readPrec :: ReadPrec QueryObjectsResponse # readListPrec :: ReadPrec [QueryObjectsResponse] #
Show QueryObjectsResponse Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods showsPrec :: Int -> QueryObjectsResponse -> ShowS # show :: QueryObjectsResponse -> String # showList :: [QueryObjectsResponse] -> ShowS #
Generic QueryObjectsResponse Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Associated Types type Rep QueryObjectsResponse :: Type -> Type # Methods from :: QueryObjectsResponse -> Rep QueryObjectsResponse x # to :: Rep QueryObjectsResponse x -> QueryObjectsResponse #
NFData QueryObjectsResponse Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects Methods rnf :: QueryObjectsResponse -> () #
type Rep QueryObjectsResponse Source #
Instance details Defined in Amazonka.DataPipeline.QueryObjects type Rep QueryObjectsResponse = D1 ('MetaData "QueryObjectsResponse" "Amazonka.DataPipeline.QueryObjects" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "QueryObjectsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hasMoreResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newQueryObjectsResponse Source #

Arguments

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

Create a value of QueryObjectsResponse 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:hasMoreResults:QueryObjectsResponse', queryObjectsResponse_hasMoreResults - Indicates whether there are more results that can be obtained by a subsequent call.

$sel:ids:QueryObjectsResponse', queryObjectsResponse_ids - The identifiers that match the query selectors.

$sel:marker:QueryObjects', queryObjectsResponse_marker - 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.

$sel:httpStatus:QueryObjectsResponse', queryObjectsResponse_httpStatus - The response's http status code.

Response Lenses

queryObjectsResponse_hasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool) Source #

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

queryObjectsResponse_ids :: Lens' QueryObjectsResponse (Maybe [Text]) Source #

The identifiers that match the query selectors.

queryObjectsResponse_marker :: 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.

queryObjectsResponse_httpStatus :: Lens' QueryObjectsResponse Int Source #

The response's http status code.