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.CodeBuild.ListBuildBatches

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the identifiers of your build batches in the current region.

This operation returns paginated results.

Synopsis

data ListBuildBatches = ListBuildBatches' {
- filter' :: Maybe BuildBatchFilter
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortOrder :: Maybe SortOrderType
}
newListBuildBatches :: ListBuildBatches
listBuildBatches_filter :: Lens' ListBuildBatches (Maybe BuildBatchFilter)
listBuildBatches_maxResults :: Lens' ListBuildBatches (Maybe Natural)
listBuildBatches_nextToken :: Lens' ListBuildBatches (Maybe Text)
listBuildBatches_sortOrder :: Lens' ListBuildBatches (Maybe SortOrderType)
data ListBuildBatchesResponse = ListBuildBatchesResponse' {
- ids :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBuildBatchesResponse :: Int -> ListBuildBatchesResponse
listBuildBatchesResponse_ids :: Lens' ListBuildBatchesResponse (Maybe [Text])
listBuildBatchesResponse_nextToken :: Lens' ListBuildBatchesResponse (Maybe Text)
listBuildBatchesResponse_httpStatus :: Lens' ListBuildBatchesResponse Int

Creating a Request

data ListBuildBatches Source #

See: newListBuildBatches smart constructor.

Constructors

ListBuildBatches'

Fields

filter' :: Maybe BuildBatchFilter
A BuildBatchFilter object that specifies the filters for the search.
maxResults :: Maybe Natural
The maximum number of results to return.
nextToken :: Maybe Text
The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
sortOrder :: Maybe SortOrderType
Specifies the sort order of the returned items. Valid values include:
- ASCENDING: List the batch build identifiers in ascending order by identifier.
- DESCENDING: List the batch build identifiers in descending order by identifier.

Instances

Instances details

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

newListBuildBatches :: ListBuildBatches Source #

Create a value of ListBuildBatches 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:filter':ListBuildBatches', listBuildBatches_filter - A BuildBatchFilter object that specifies the filters for the search.

$sel:maxResults:ListBuildBatches', listBuildBatches_maxResults - The maximum number of results to return.

ListBuildBatches, listBuildBatches_nextToken - The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

$sel:sortOrder:ListBuildBatches', listBuildBatches_sortOrder - Specifies the sort order of the returned items. Valid values include:

ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.

Request Lenses

listBuildBatches_filter :: Lens' ListBuildBatches (Maybe BuildBatchFilter) Source #

A BuildBatchFilter object that specifies the filters for the search.

listBuildBatches_maxResults :: Lens' ListBuildBatches (Maybe Natural) Source #

The maximum number of results to return.

listBuildBatches_nextToken :: Lens' ListBuildBatches (Maybe Text) Source #

The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

listBuildBatches_sortOrder :: Lens' ListBuildBatches (Maybe SortOrderType) Source #

Specifies the sort order of the returned items. Valid values include:

ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.

Destructuring the Response

data ListBuildBatchesResponse Source #

See: newListBuildBatchesResponse smart constructor.

Constructors

ListBuildBatchesResponse'
Fields ids :: Maybe [Text] An array of strings that contains the batch build identifiers. nextToken :: Maybe Text If there are more items to return, this contains a token that is passed to a subsequent call to `ListBuildBatches` to retrieve the next set of items. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListBuildBatchesResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListBuildBatches Associated Types type Rep ListBuildBatchesResponse :: Type -> Type # Methods from :: ListBuildBatchesResponse -> Rep ListBuildBatchesResponse x # to :: Rep ListBuildBatchesResponse x -> ListBuildBatchesResponse #
Read ListBuildBatchesResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListBuildBatches Methods readsPrec :: Int -> ReadS ListBuildBatchesResponse # readList :: ReadS [ListBuildBatchesResponse] # readPrec :: ReadPrec ListBuildBatchesResponse # readListPrec :: ReadPrec [ListBuildBatchesResponse] #
Show ListBuildBatchesResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListBuildBatches Methods showsPrec :: Int -> ListBuildBatchesResponse -> ShowS # show :: ListBuildBatchesResponse -> String # showList :: [ListBuildBatchesResponse] -> ShowS #
NFData ListBuildBatchesResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListBuildBatches Methods rnf :: ListBuildBatchesResponse -> () #
Eq ListBuildBatchesResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListBuildBatches Methods (==) :: ListBuildBatchesResponse -> ListBuildBatchesResponse -> Bool # (/=) :: ListBuildBatchesResponse -> ListBuildBatchesResponse -> Bool #
type Rep ListBuildBatchesResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListBuildBatches type Rep ListBuildBatchesResponse = D1 ('MetaData "ListBuildBatchesResponse" "Amazonka.CodeBuild.ListBuildBatches" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ListBuildBatchesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBuildBatchesResponse Source #

Arguments

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

Create a value of ListBuildBatchesResponse 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:ids:ListBuildBatchesResponse', listBuildBatchesResponse_ids - An array of strings that contains the batch build identifiers.

ListBuildBatches, listBuildBatchesResponse_nextToken - If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.

$sel:httpStatus:ListBuildBatchesResponse', listBuildBatchesResponse_httpStatus - The response's http status code.

Response Lenses

listBuildBatchesResponse_ids :: Lens' ListBuildBatchesResponse (Maybe [Text]) Source #

An array of strings that contains the batch build identifiers.

listBuildBatchesResponse_nextToken :: Lens' ListBuildBatchesResponse (Maybe Text) Source #

If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.

listBuildBatchesResponse_httpStatus :: Lens' ListBuildBatchesResponse Int Source #

The response's http status code.