libZSservicesZSamazonka-codebuildZSamazonka-codebuild
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.CodeBuild.ListBuildBatches

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListBuildBatches Source #

See: newListBuildBatches smart constructor.

Constructors

ListBuildBatches' 

Fields

  • 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.
  • 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.

  • filter' :: Maybe BuildBatchFilter

    A BuildBatchFilter object that specifies the filters for the search.

  • maxResults :: Maybe Natural

    The maximum number of results to return.

Instances

Instances details
Eq ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Read ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Show ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Generic ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Associated Types

type Rep ListBuildBatches :: Type -> Type #

NFData ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Methods

rnf :: ListBuildBatches -> () #

Hashable ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

ToJSON ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

AWSPager ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

AWSRequest ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Associated Types

type AWSResponse ListBuildBatches #

ToHeaders ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

ToPath ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

ToQuery ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

type Rep ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

type Rep ListBuildBatches = D1 ('MetaData "ListBuildBatches" "Amazonka.CodeBuild.ListBuildBatches" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "ListBuildBatches'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrderType)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BuildBatchFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListBuildBatches Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

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

$sel:nextToken: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: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.

Request Lenses

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.

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

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
Eq ListBuildBatchesResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Read ListBuildBatchesResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Show ListBuildBatchesResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Generic ListBuildBatchesResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

Associated Types

type Rep ListBuildBatchesResponse :: Type -> Type #

NFData ListBuildBatchesResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

type Rep ListBuildBatchesResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildBatches

type Rep ListBuildBatchesResponse = D1 ('MetaData "ListBuildBatchesResponse" "Amazonka.CodeBuild.ListBuildBatches" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" '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 #

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.

$sel:nextToken: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.