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

Description

Returns a list of ARNs for the reports that belong to a ReportGroup.

This operation returns paginated results.

Synopsis

Creating a Request

data ListReportsForReportGroup Source #

See: newListReportsForReportGroup smart constructor.

Constructors

ListReportsForReportGroup' 

Fields

  • filter' :: Maybe ReportFilter

    A ReportFilter object used to filter the returned reports.

  • maxResults :: Maybe Natural

    The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report 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.

  • sortOrder :: Maybe SortOrderType

    Use to specify whether the results are returned in ascending or descending order.

  • reportGroupArn :: Text

    The ARN of the report group for which you want to return report ARNs.

Instances

Instances details
ToJSON ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

ToHeaders ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

ToPath ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

ToQuery ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

AWSPager ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

AWSRequest ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Generic ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Associated Types

type Rep ListReportsForReportGroup :: Type -> Type #

Read ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Show ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

NFData ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Eq ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Hashable ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

type AWSResponse ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

type Rep ListReportsForReportGroup Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

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

newListReportsForReportGroup Source #

Create a value of ListReportsForReportGroup 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:filter':ListReportsForReportGroup', listReportsForReportGroup_filter - A ReportFilter object used to filter the returned reports.

$sel:maxResults:ListReportsForReportGroup', listReportsForReportGroup_maxResults - The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

ListReportsForReportGroup, listReportsForReportGroup_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:sortOrder:ListReportsForReportGroup', listReportsForReportGroup_sortOrder - Use to specify whether the results are returned in ascending or descending order.

ListReportsForReportGroup, listReportsForReportGroup_reportGroupArn - The ARN of the report group for which you want to return report ARNs.

Request Lenses

listReportsForReportGroup_filter :: Lens' ListReportsForReportGroup (Maybe ReportFilter) Source #

A ReportFilter object used to filter the returned reports.

listReportsForReportGroup_maxResults :: Lens' ListReportsForReportGroup (Maybe Natural) Source #

The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

listReportsForReportGroup_nextToken :: Lens' ListReportsForReportGroup (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.

listReportsForReportGroup_sortOrder :: Lens' ListReportsForReportGroup (Maybe SortOrderType) Source #

Use to specify whether the results are returned in ascending or descending order.

listReportsForReportGroup_reportGroupArn :: Lens' ListReportsForReportGroup Text Source #

The ARN of the report group for which you want to return report ARNs.

Destructuring the Response

data ListReportsForReportGroupResponse Source #

See: newListReportsForReportGroupResponse smart constructor.

Constructors

ListReportsForReportGroupResponse' 

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.

  • reports :: Maybe (NonEmpty Text)

    The list of report ARNs.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListReportsForReportGroupResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Associated Types

type Rep ListReportsForReportGroupResponse :: Type -> Type #

Read ListReportsForReportGroupResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Show ListReportsForReportGroupResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

NFData ListReportsForReportGroupResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

Eq ListReportsForReportGroupResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

type Rep ListReportsForReportGroupResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportsForReportGroup

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

newListReportsForReportGroupResponse Source #

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

ListReportsForReportGroup, listReportsForReportGroupResponse_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:reports:ListReportsForReportGroupResponse', listReportsForReportGroupResponse_reports - The list of report ARNs.

$sel:httpStatus:ListReportsForReportGroupResponse', listReportsForReportGroupResponse_httpStatus - The response's http status code.

Response Lenses

listReportsForReportGroupResponse_nextToken :: Lens' ListReportsForReportGroupResponse (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.