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

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListSharedReportGroups Source #

See: newListSharedReportGroups smart constructor.

Constructors

ListSharedReportGroups' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup 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 report groups 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 report group was last changed.
  • sortOrder :: Maybe SortOrderType

    The order in which to list shared report groups. Valid values include:

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

Instances

Instances details
ToJSON ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

toJSON :: ListSharedReportGroups -> Value #

toEncoding :: ListSharedReportGroups -> Encoding #

toJSONList :: [ListSharedReportGroups] -> Value #

toEncodingList :: [ListSharedReportGroups] -> Encoding #

ToHeaders ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

toHeaders :: ListSharedReportGroups -> [Header] #

ToPath ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

toPath :: ListSharedReportGroups -> ByteString #

ToQuery ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

toQuery :: ListSharedReportGroups -> QueryString #

AWSPager ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

page :: ListSharedReportGroups -> AWSResponse ListSharedReportGroups -> Maybe ListSharedReportGroups #

AWSRequest ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Associated Types

type AWSResponse ListSharedReportGroups #

Methods

request :: (Service -> Service) -> ListSharedReportGroups -> Request ListSharedReportGroups #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSharedReportGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSharedReportGroups))) #

Generic ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Associated Types

type Rep ListSharedReportGroups :: Type -> Type #

Methods

from :: ListSharedReportGroups -> Rep ListSharedReportGroups x #

to :: Rep ListSharedReportGroups x -> ListSharedReportGroups #

Read ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

readsPrec :: Int -> ReadS ListSharedReportGroups #

readList :: ReadS [ListSharedReportGroups] #

readPrec :: ReadPrec ListSharedReportGroups #

readListPrec :: ReadPrec [ListSharedReportGroups] #

Show ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

showsPrec :: Int -> ListSharedReportGroups -> ShowS #

show :: ListSharedReportGroups -> String #

showList :: [ListSharedReportGroups] -> ShowS #

NFData ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

rnf :: ListSharedReportGroups -> () #

Eq ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

(==) :: ListSharedReportGroups -> ListSharedReportGroups -> Bool #

(/=) :: ListSharedReportGroups -> ListSharedReportGroups -> Bool #

Hashable ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

hashWithSalt :: Int -> ListSharedReportGroups -> Int #

hash :: ListSharedReportGroups -> Int #

type AWSResponse ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

type AWSResponse ListSharedReportGroups = ListSharedReportGroupsResponse
type Rep ListSharedReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

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

newListSharedReportGroups :: ListSharedReportGroups Source #

Create a value of ListSharedReportGroups 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:ListSharedReportGroups', listSharedReportGroups_maxResults - The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

ListSharedReportGroups, listSharedReportGroups_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:ListSharedReportGroups', listSharedReportGroups_sortBy - The criterion to be used to list report groups 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 report group was last changed.

$sel:sortOrder:ListSharedReportGroups', listSharedReportGroups_sortOrder - The order in which to list shared report groups. Valid values include:

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

Request Lenses

listSharedReportGroups_maxResults :: Lens' ListSharedReportGroups (Maybe Natural) Source #

The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

listSharedReportGroups_nextToken :: Lens' ListSharedReportGroups (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.

listSharedReportGroups_sortBy :: Lens' ListSharedReportGroups (Maybe SharedResourceSortByType) Source #

The criterion to be used to list report groups 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 report group was last changed.

listSharedReportGroups_sortOrder :: Lens' ListSharedReportGroups (Maybe SortOrderType) Source #

The order in which to list shared report groups. Valid values include:

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

Destructuring the Response

data ListSharedReportGroupsResponse Source #

See: newListSharedReportGroupsResponse smart constructor.

Constructors

ListSharedReportGroupsResponse' 

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.

  • reportGroups :: Maybe (NonEmpty Text)

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSharedReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Associated Types

type Rep ListSharedReportGroupsResponse :: Type -> Type #

Methods

from :: ListSharedReportGroupsResponse -> Rep ListSharedReportGroupsResponse x #

to :: Rep ListSharedReportGroupsResponse x -> ListSharedReportGroupsResponse #

Read ListSharedReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

readsPrec :: Int -> ReadS ListSharedReportGroupsResponse #

readList :: ReadS [ListSharedReportGroupsResponse] #

readPrec :: ReadPrec ListSharedReportGroupsResponse #

readListPrec :: ReadPrec [ListSharedReportGroupsResponse] #

Show ListSharedReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

showsPrec :: Int -> ListSharedReportGroupsResponse -> ShowS #

show :: ListSharedReportGroupsResponse -> String #

showList :: [ListSharedReportGroupsResponse] -> ShowS #

NFData ListSharedReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

rnf :: ListSharedReportGroupsResponse -> () #

Eq ListSharedReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

Methods

(==) :: ListSharedReportGroupsResponse -> ListSharedReportGroupsResponse -> Bool #

(/=) :: ListSharedReportGroupsResponse -> ListSharedReportGroupsResponse -> Bool #

type Rep ListSharedReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListSharedReportGroups

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

newListSharedReportGroupsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListSharedReportGroupsResponse'

-> ListSharedReportGroupsResponse 

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

ListSharedReportGroups, listSharedReportGroupsResponse_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:reportGroups:ListSharedReportGroupsResponse', listSharedReportGroupsResponse_reportGroups - The list of ARNs for the report groups shared with the current Amazon Web Services account or user.

$sel:httpStatus:ListSharedReportGroupsResponse', listSharedReportGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listSharedReportGroupsResponse_nextToken :: Lens' ListSharedReportGroupsResponse (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.

listSharedReportGroupsResponse_reportGroups :: Lens' ListSharedReportGroupsResponse (Maybe (NonEmpty Text)) Source #

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

listSharedReportGroupsResponse_httpStatus :: Lens' ListSharedReportGroupsResponse Int Source #

The response's http status code.