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

Description

Gets a list of build project names, with each build project name representing a single build project.

This operation returns paginated results.

Synopsis

Creating a Request

data ListProjects Source #

See: newListProjects smart constructor.

Constructors

ListProjects' 

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.

  • sortBy :: Maybe ProjectSortByType

    The criterion to be used to list build project names. Valid values include:

    • CREATED_TIME: List based on when each build project was created.
    • LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
    • NAME: List based on each build project's name.

    Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

  • sortOrder :: Maybe SortOrderType

    The order in which to list build projects. Valid values include:

    • ASCENDING: List in ascending order.
    • DESCENDING: List in descending order.

    Use sortBy to specify the criterion to be used to list build project names.

Instances

Instances details
ToJSON ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

ToHeaders ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

ToPath ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

ToQuery ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

AWSPager ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

AWSRequest ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Associated Types

type AWSResponse ListProjects #

Generic ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Associated Types

type Rep ListProjects :: Type -> Type #

Read ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Show ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

NFData ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Methods

rnf :: ListProjects -> () #

Eq ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Hashable ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

type AWSResponse ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

type Rep ListProjects Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

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

newListProjects :: ListProjects Source #

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

ListProjects, listProjects_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:sortBy:ListProjects', listProjects_sortBy - The criterion to be used to list build project names. Valid values include:

  • CREATED_TIME: List based on when each build project was created.
  • LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
  • NAME: List based on each build project's name.

Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

$sel:sortOrder:ListProjects', listProjects_sortOrder - The order in which to list build projects. Valid values include:

  • ASCENDING: List in ascending order.
  • DESCENDING: List in descending order.

Use sortBy to specify the criterion to be used to list build project names.

Request Lenses

listProjects_nextToken :: Lens' ListProjects (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.

listProjects_sortBy :: Lens' ListProjects (Maybe ProjectSortByType) Source #

The criterion to be used to list build project names. Valid values include:

  • CREATED_TIME: List based on when each build project was created.
  • LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
  • NAME: List based on each build project's name.

Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

listProjects_sortOrder :: Lens' ListProjects (Maybe SortOrderType) Source #

The order in which to list build projects. Valid values include:

  • ASCENDING: List in ascending order.
  • DESCENDING: List in descending order.

Use sortBy to specify the criterion to be used to list build project names.

Destructuring the Response

data ListProjectsResponse Source #

See: newListProjectsResponse smart constructor.

Constructors

ListProjectsResponse' 

Fields

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

  • projects :: Maybe (NonEmpty Text)

    The list of build project names, with each build project name representing a single build project.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListProjectsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Associated Types

type Rep ListProjectsResponse :: Type -> Type #

Read ListProjectsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Show ListProjectsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

NFData ListProjectsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

Methods

rnf :: ListProjectsResponse -> () #

Eq ListProjectsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

type Rep ListProjectsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListProjects

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

newListProjectsResponse Source #

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

ListProjects, listProjectsResponse_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:projects:ListProjectsResponse', listProjectsResponse_projects - The list of build project names, with each build project name representing a single build project.

$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.

Response Lenses

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (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.

listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe (NonEmpty Text)) Source #

The list of build project names, with each build project name representing a single build project.