Class: Aws::CodeBuild::Types::ListReportsForReportGroupInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass ListReportsForReportGroupInput data as a hash:

{
  report_group_arn: "String", # required
  next_token: "String",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  max_results: 1,
  filter: {
    status: "GENERATING", # accepts GENERATING, SUCCEEDED, FAILED, INCOMPLETE, DELETING
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::ReportFilter

A ReportFilter object used to filter the returned reports.

Returns:



3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3212

class ListReportsForReportGroupInput < Struct.new(
  :report_group_arn,
  :next_token,
  :sort_order,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3212

class ListReportsForReportGroupInput < Struct.new(
  :report_group_arn,
  :next_token,
  :sort_order,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3212

class ListReportsForReportGroupInput < Struct.new(
  :report_group_arn,
  :next_token,
  :sort_order,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#report_group_arnString

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

Returns:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3212

class ListReportsForReportGroupInput < Struct.new(
  :report_group_arn,
  :next_token,
  :sort_order,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#sort_orderString

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

Returns:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3212

class ListReportsForReportGroupInput < Struct.new(
  :report_group_arn,
  :next_token,
  :sort_order,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end