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

Amazonka.DataPipeline.QueryObjects

Description

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

This operation returns paginated results.

Synopsis

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

Read QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Show QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Generic QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Associated Types

type Rep QueryObjects :: Type -> Type #

NFData QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Methods

rnf :: QueryObjects -> () #

Hashable QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

ToJSON QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

AWSPager QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

AWSRequest QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Associated Types

type AWSResponse QueryObjects #

ToHeaders QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

ToPath QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

ToQuery QueryObjects Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

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

newQueryObjects Source #

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_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

Read QueryObjectsResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Show QueryObjectsResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Generic QueryObjectsResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.QueryObjects

Associated Types

type Rep QueryObjectsResponse :: Type -> Type #

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 #

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.