Class: Aws::ECR::Types::DescribeImageScanFindingsRequest

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

Overview

Note:

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

{
  registry_id: "RegistryId",
  repository_name: "RepositoryName", # required
  image_id: { # required
    image_digest: "ImageDigest",
    image_tag: "ImageTag",
  },
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#image_idTypes::ImageIdentifier

An object with identifying information for an Amazon ECR image.



560
561
562
563
564
565
566
567
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 560

class DescribeImageScanFindingsRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

Returns:

  • (Integer)


560
561
562
563
564
565
566
567
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 560

class DescribeImageScanFindingsRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Returns:

  • (String)


560
561
562
563
564
565
566
567
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 560

class DescribeImageScanFindingsRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#registry_idString

The AWS account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

Returns:

  • (String)


560
561
562
563
564
565
566
567
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 560

class DescribeImageScanFindingsRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#repository_nameString

The repository for the image for which to describe the scan findings.

Returns:

  • (String)


560
561
562
563
564
565
566
567
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 560

class DescribeImageScanFindingsRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_id,
  :next_token,
  :max_results)
  include Aws::Structure
end