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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

This operation returns paginated results.

Synopsis

data ListSharedProjects = ListSharedProjects' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SharedResourceSortByType
- sortOrder :: Maybe SortOrderType
}
newListSharedProjects :: ListSharedProjects
listSharedProjects_maxResults :: Lens' ListSharedProjects (Maybe Natural)
listSharedProjects_nextToken :: Lens' ListSharedProjects (Maybe Text)
listSharedProjects_sortBy :: Lens' ListSharedProjects (Maybe SharedResourceSortByType)
listSharedProjects_sortOrder :: Lens' ListSharedProjects (Maybe SortOrderType)
data ListSharedProjectsResponse = ListSharedProjectsResponse' {
- nextToken :: Maybe Text
- projects :: Maybe (NonEmpty Text)
- httpStatus :: Int
}
newListSharedProjectsResponse :: Int -> ListSharedProjectsResponse
listSharedProjectsResponse_nextToken :: Lens' ListSharedProjectsResponse (Maybe Text)
listSharedProjectsResponse_projects :: Lens' ListSharedProjectsResponse (Maybe (NonEmpty Text))
listSharedProjectsResponse_httpStatus :: Lens' ListSharedProjectsResponse Int

Creating a Request

data ListSharedProjects Source #

See: newListSharedProjects smart constructor.

Constructors

ListSharedProjects'

Fields

maxResults :: Maybe Natural
The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.
nextToken :: Maybe Text
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. 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 SharedResourceSortByType
The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:
- ARN: List based on the ARN.
- MODIFIED_TIME: List based on when information about the shared project was last changed.
sortOrder :: Maybe SortOrderType
The order in which to list shared build projects. Valid values include:
- ASCENDING: List in ascending order.
- DESCENDING: List in descending order.

Instances

Instances details

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

newListSharedProjects :: ListSharedProjects Source #

Create a value of ListSharedProjects 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:maxResults:ListSharedProjects', listSharedProjects_maxResults - The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.

ListSharedProjects, listSharedProjects_nextToken - During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. 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:ListSharedProjects', listSharedProjects_sortBy - The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:

ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.

$sel:sortOrder:ListSharedProjects', listSharedProjects_sortOrder - The order in which to list shared build projects. Valid values include:

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

Request Lenses

listSharedProjects_maxResults :: Lens' ListSharedProjects (Maybe Natural) Source #

The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.

listSharedProjects_nextToken :: Lens' ListSharedProjects (Maybe Text) Source #

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. 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.

listSharedProjects_sortBy :: Lens' ListSharedProjects (Maybe SharedResourceSortByType) Source #

The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:

ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.

listSharedProjects_sortOrder :: Lens' ListSharedProjects (Maybe SortOrderType) Source #

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

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

Destructuring the Response

data ListSharedProjectsResponse Source #

See: newListSharedProjectsResponse smart constructor.

Constructors

ListSharedProjectsResponse'

Fields

nextToken :: Maybe Text
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. 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.
projects :: Maybe (NonEmpty Text)
The list of ARNs for the build projects shared with the current Amazon Web Services account or user.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListSharedProjectsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListSharedProjects Associated Types type Rep ListSharedProjectsResponse :: Type -> Type # Methods from :: ListSharedProjectsResponse -> Rep ListSharedProjectsResponse x # to :: Rep ListSharedProjectsResponse x -> ListSharedProjectsResponse #
Read ListSharedProjectsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListSharedProjects Methods readsPrec :: Int -> ReadS ListSharedProjectsResponse # readList :: ReadS [ListSharedProjectsResponse] # readPrec :: ReadPrec ListSharedProjectsResponse # readListPrec :: ReadPrec [ListSharedProjectsResponse] #
Show ListSharedProjectsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListSharedProjects Methods showsPrec :: Int -> ListSharedProjectsResponse -> ShowS # show :: ListSharedProjectsResponse -> String # showList :: [ListSharedProjectsResponse] -> ShowS #
NFData ListSharedProjectsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListSharedProjects Methods rnf :: ListSharedProjectsResponse -> () #
Eq ListSharedProjectsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListSharedProjects Methods (==) :: ListSharedProjectsResponse -> ListSharedProjectsResponse -> Bool # (/=) :: ListSharedProjectsResponse -> ListSharedProjectsResponse -> Bool #
type Rep ListSharedProjectsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListSharedProjects type Rep ListSharedProjectsResponse = D1 ('MetaData "ListSharedProjectsResponse" "Amazonka.CodeBuild.ListSharedProjects" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ListSharedProjectsResponse'" '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))))

newListSharedProjectsResponse Source #

Arguments

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

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

ListSharedProjects, listSharedProjectsResponse_nextToken - During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. 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:projects:ListSharedProjectsResponse', listSharedProjectsResponse_projects - The list of ARNs for the build projects shared with the current Amazon Web Services account or user.

$sel:httpStatus:ListSharedProjectsResponse', listSharedProjectsResponse_httpStatus - The response's http status code.

Response Lenses

listSharedProjectsResponse_nextToken :: Lens' ListSharedProjectsResponse (Maybe Text) Source #

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. 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.

listSharedProjectsResponse_projects :: Lens' ListSharedProjectsResponse (Maybe (NonEmpty Text)) Source #

The list of ARNs for the build projects shared with the current Amazon Web Services account or user.

listSharedProjectsResponse_httpStatus :: Lens' ListSharedProjectsResponse Int Source #

The response's http status code.