amazonka-codebuild-2.0: Amazon CodeBuild SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeBuild.ListBuilds

Description

Gets a list of build IDs, with each build ID representing a single build.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBuilds Source #

See: newListBuilds smart constructor.

Constructors

ListBuilds' 

Fields

  • nextToken :: Maybe Text

    During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • sortOrder :: Maybe SortOrderType

    The order to list build IDs. Valid values include:

    • ASCENDING: List the build IDs in ascending order by build ID.
    • DESCENDING: List the build IDs in descending order by build ID.

Instances

Instances details
ToJSON ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

ToHeaders ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Methods

toHeaders :: ListBuilds -> [Header] #

ToPath ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

ToQuery ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

AWSPager ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

AWSRequest ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Associated Types

type AWSResponse ListBuilds #

Generic ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Associated Types

type Rep ListBuilds :: Type -> Type #

Read ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Show ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

NFData ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Methods

rnf :: ListBuilds -> () #

Eq ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Hashable ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

type AWSResponse ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

type Rep ListBuilds Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

type Rep ListBuilds = D1 ('MetaData "ListBuilds" "Amazonka.CodeBuild.ListBuilds" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ListBuilds'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrderType))))

newListBuilds :: ListBuilds Source #

Create a value of ListBuilds 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:

ListBuilds, listBuilds_nextToken - During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

$sel:sortOrder:ListBuilds', listBuilds_sortOrder - The order to list build IDs. Valid values include:

  • ASCENDING: List the build IDs in ascending order by build ID.
  • DESCENDING: List the build IDs in descending order by build ID.

Request Lenses

listBuilds_nextToken :: Lens' ListBuilds (Maybe Text) Source #

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

listBuilds_sortOrder :: Lens' ListBuilds (Maybe SortOrderType) Source #

The order to list build IDs. Valid values include:

  • ASCENDING: List the build IDs in ascending order by build ID.
  • DESCENDING: List the build IDs in descending order by build ID.

Destructuring the Response

data ListBuildsResponse Source #

See: newListBuildsResponse smart constructor.

Constructors

ListBuildsResponse' 

Fields

  • ids :: Maybe (NonEmpty Text)

    A list of build IDs, with each build ID representing a single build.

  • nextToken :: Maybe Text

    If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListBuildsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Associated Types

type Rep ListBuildsResponse :: Type -> Type #

Read ListBuildsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Show ListBuildsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

NFData ListBuildsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

Methods

rnf :: ListBuildsResponse -> () #

Eq ListBuildsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

type Rep ListBuildsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuilds

type Rep ListBuildsResponse = D1 ('MetaData "ListBuildsResponse" "Amazonka.CodeBuild.ListBuilds" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ListBuildsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBuildsResponse Source #

Create a value of ListBuildsResponse 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:ListBuildsResponse', listBuildsResponse_ids - A list of build IDs, with each build ID representing a single build.

ListBuilds, listBuildsResponse_nextToken - If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.

$sel:httpStatus:ListBuildsResponse', listBuildsResponse_httpStatus - The response's http status code.

Response Lenses

listBuildsResponse_ids :: Lens' ListBuildsResponse (Maybe (NonEmpty Text)) Source #

A list of build IDs, with each build ID representing a single build.

listBuildsResponse_nextToken :: Lens' ListBuildsResponse (Maybe Text) Source #

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.