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.DataPipeline.DescribeObjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

This operation returns paginated results.

Synopsis

data DescribeObjects = DescribeObjects' {
- evaluateExpressions :: Maybe Bool
- marker :: Maybe Text
- pipelineId :: Text
- objectIds :: [Text]
}
newDescribeObjects :: Text -> DescribeObjects
describeObjects_evaluateExpressions :: Lens' DescribeObjects (Maybe Bool)
describeObjects_marker :: Lens' DescribeObjects (Maybe Text)
describeObjects_pipelineId :: Lens' DescribeObjects Text
describeObjects_objectIds :: Lens' DescribeObjects [Text]
data DescribeObjectsResponse = DescribeObjectsResponse' {
- hasMoreResults :: Maybe Bool
- marker :: Maybe Text
- httpStatus :: Int
- pipelineObjects :: [PipelineObject]
}
newDescribeObjectsResponse :: Int -> DescribeObjectsResponse
describeObjectsResponse_hasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool)
describeObjectsResponse_marker :: Lens' DescribeObjectsResponse (Maybe Text)
describeObjectsResponse_httpStatus :: Lens' DescribeObjectsResponse Int
describeObjectsResponse_pipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject]

Creating a Request

data DescribeObjects Source #

Contains the parameters for DescribeObjects.

See: newDescribeObjects smart constructor.

Constructors

DescribeObjects'

Fields

evaluateExpressions :: Maybe Bool
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.
pipelineId :: Text
The ID of the pipeline that contains the object definitions.
objectIds :: [Text]
The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Instances

Instances details

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

newDescribeObjects Source #

Arguments

:: Text	`DescribeObjects`
-> DescribeObjects

Create a value of DescribeObjects 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:evaluateExpressions:DescribeObjects', describeObjects_evaluateExpressions - Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

DescribeObjects, describeObjects_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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

DescribeObjects, describeObjects_pipelineId - The ID of the pipeline that contains the object definitions.

$sel:objectIds:DescribeObjects', describeObjects_objectIds - The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Request Lenses

describeObjects_evaluateExpressions :: Lens' DescribeObjects (Maybe Bool) Source #

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

describeObjects_marker :: Lens' DescribeObjects (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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

describeObjects_pipelineId :: Lens' DescribeObjects Text Source #

The ID of the pipeline that contains the object definitions.

describeObjects_objectIds :: Lens' DescribeObjects [Text] Source #

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Destructuring the Response

data DescribeObjectsResponse Source #

Contains the output of DescribeObjects.

See: newDescribeObjectsResponse smart constructor.

Constructors

DescribeObjectsResponse'

Fields

hasMoreResults :: Maybe Bool
Indicates whether there are more results to return.
marker :: Maybe Text
The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value. If the value is null, there are no more results.
httpStatus :: Int
The response's http status code.
pipelineObjects :: [PipelineObject]
An array of object definitions.

Instances

Instances details

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

newDescribeObjectsResponse Source #

Arguments

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

Create a value of DescribeObjectsResponse 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:DescribeObjectsResponse', describeObjectsResponse_hasMoreResults - Indicates whether there are more results to return.

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

$sel:httpStatus:DescribeObjectsResponse', describeObjectsResponse_httpStatus - The response's http status code.

$sel:pipelineObjects:DescribeObjectsResponse', describeObjectsResponse_pipelineObjects - An array of object definitions.

Response Lenses

describeObjectsResponse_hasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool) Source #

Indicates whether there are more results to return.

describeObjectsResponse_marker :: Lens' DescribeObjectsResponse (Maybe Text) Source #

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

describeObjectsResponse_httpStatus :: Lens' DescribeObjectsResponse Int Source #

The response's http status code.

describeObjectsResponse_pipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject] Source #

An array of object definitions.