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

Description

Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBuildsForProject Source #

See: newListBuildsForProject smart constructor.

Constructors

ListBuildsForProject' 

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 sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.

    Valid values include:

    • ASCENDING: List the build identifiers in ascending order, by build number.
    • DESCENDING: List the build identifiers in descending order, by build number.

    If the project has more than 100 builds, setting the sort order will result in an error.

  • projectName :: Text

    The name of the CodeBuild project.

Instances

Instances details
ToJSON ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

ToHeaders ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

ToPath ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

ToQuery ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

AWSPager ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

AWSRequest ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Associated Types

type AWSResponse ListBuildsForProject #

Generic ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Associated Types

type Rep ListBuildsForProject :: Type -> Type #

Read ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Show ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

NFData ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Methods

rnf :: ListBuildsForProject -> () #

Eq ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Hashable ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

type AWSResponse ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

type Rep ListBuildsForProject Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

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

newListBuildsForProject Source #

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

ListBuildsForProject, listBuildsForProject_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:ListBuildsForProject', listBuildsForProject_sortOrder - The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.

Valid values include:

  • ASCENDING: List the build identifiers in ascending order, by build number.
  • DESCENDING: List the build identifiers in descending order, by build number.

If the project has more than 100 builds, setting the sort order will result in an error.

ListBuildsForProject, listBuildsForProject_projectName - The name of the CodeBuild project.

Request Lenses

listBuildsForProject_nextToken :: Lens' ListBuildsForProject (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.

listBuildsForProject_sortOrder :: Lens' ListBuildsForProject (Maybe SortOrderType) Source #

The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.

Valid values include:

  • ASCENDING: List the build identifiers in ascending order, by build number.
  • DESCENDING: List the build identifiers in descending order, by build number.

If the project has more than 100 builds, setting the sort order will result in an error.

Destructuring the Response

data ListBuildsForProjectResponse Source #

See: newListBuildsForProjectResponse smart constructor.

Constructors

ListBuildsForProjectResponse' 

Fields

  • ids :: Maybe (NonEmpty Text)

    A list of build identifiers for the specified build project, 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 ListBuildsForProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Associated Types

type Rep ListBuildsForProjectResponse :: Type -> Type #

Read ListBuildsForProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Show ListBuildsForProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

NFData ListBuildsForProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

Eq ListBuildsForProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

type Rep ListBuildsForProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListBuildsForProject

type Rep ListBuildsForProjectResponse = D1 ('MetaData "ListBuildsForProjectResponse" "Amazonka.CodeBuild.ListBuildsForProject" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ListBuildsForProjectResponse'" '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))))

newListBuildsForProjectResponse Source #

Create a value of ListBuildsForProjectResponse 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:ListBuildsForProjectResponse', listBuildsForProjectResponse_ids - A list of build identifiers for the specified build project, with each build ID representing a single build.

ListBuildsForProject, listBuildsForProjectResponse_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:ListBuildsForProjectResponse', listBuildsForProjectResponse_httpStatus - The response's http status code.

Response Lenses

listBuildsForProjectResponse_ids :: Lens' ListBuildsForProjectResponse (Maybe (NonEmpty Text)) Source #

A list of build identifiers for the specified build project, with each build ID representing a single build.

listBuildsForProjectResponse_nextToken :: Lens' ListBuildsForProjectResponse (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.