« blib/lib/Paws/ECR/DeleteRepositoryResponse.pm
↑ Summary
blib/lib/Paws/ECR/DescribeImageScanFindingsResponse.pm »
| 1 | |||
| 2 | package Paws::ECR::DescribeImageScanFindings; | ||
| 3 | use Moose; | ||
| 4 | has ImageId => (is => 'ro', isa => 'Paws::ECR::ImageIdentifier', traits => ['NameInRequest'], request_name => 'imageId' , required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 7 | has RegistryId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'registryId' ); | ||
| 8 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeImageScanFindings'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECR::DescribeImageScanFindingsResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ECR::DescribeImageScanFindings - Arguments for method DescribeImageScanFindings on L<Paws::ECR> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeImageScanFindings on the | ||
| 26 | L<Amazon EC2 Container Registry|Paws::ECR> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeImageScanFindings. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeImageScanFindings. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $api.ecr = Paws->service('ECR'); | ||
| 34 | my $DescribeImageScanFindingsResponse = | ||
| 35 | $api . ecr->DescribeImageScanFindings( | ||
| 36 | ImageId => { | ||
| 37 | ImageDigest => 'MyImageDigest', # OPTIONAL | ||
| 38 | ImageTag => 'MyImageTag', # min: 1, max: 300; OPTIONAL | ||
| 39 | }, | ||
| 40 | RepositoryName => 'MyRepositoryName', | ||
| 41 | MaxResults => 1, # OPTIONAL | ||
| 42 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 43 | RegistryId => 'MyRegistryId', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $ImageId = $DescribeImageScanFindingsResponse->ImageId; | ||
| 48 | my $ImageScanFindings = | ||
| 49 | $DescribeImageScanFindingsResponse->ImageScanFindings; | ||
| 50 | my $ImageScanStatus = $DescribeImageScanFindingsResponse->ImageScanStatus; | ||
| 51 | my $NextToken = $DescribeImageScanFindingsResponse->NextToken; | ||
| 52 | my $RegistryId = $DescribeImageScanFindingsResponse->RegistryId; | ||
| 53 | my $RepositoryName = $DescribeImageScanFindingsResponse->RepositoryName; | ||
| 54 | |||
| 55 | # Returns a L<Paws::ECR::DescribeImageScanFindingsResponse> object. | ||
| 56 | |||
| 57 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.ecr/DescribeImageScanFindings> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> ImageId => L<Paws::ECR::ImageIdentifier> | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 MaxResults => Int | ||
| 70 | |||
| 71 | The maximum number of image scan results returned by | ||
| 72 | C<DescribeImageScanFindings> in paginated output. When this parameter | ||
| 73 | is used, C<DescribeImageScanFindings> only returns C<maxResults> | ||
| 74 | results in a single page along with a C<nextToken> response element. | ||
| 75 | The remaining results of the initial request can be seen by sending | ||
| 76 | another C<DescribeImageScanFindings> request with the returned | ||
| 77 | C<nextToken> value. This value can be between 1 and 1000. If this | ||
| 78 | parameter is not used, then C<DescribeImageScanFindings> returns up to | ||
| 79 | 100 results and a C<nextToken> value, if applicable. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NextToken => Str | ||
| 84 | |||
| 85 | The C<nextToken> value returned from a previous paginated | ||
| 86 | C<DescribeImageScanFindings> request where C<maxResults> was used and | ||
| 87 | the results exceeded the value of that parameter. Pagination continues | ||
| 88 | from the end of the previous results that returned the C<nextToken> | ||
| 89 | value. This value is null when there are no more results to return. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 RegistryId => Str | ||
| 94 | |||
| 95 | The AWS account ID associated with the registry that contains the | ||
| 96 | repository in which to describe the image scan findings for. If you do | ||
| 97 | not specify a registry, the default registry is assumed. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 102 | |||
| 103 | The repository for the image for which to describe the scan findings. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, documenting arguments for method DescribeImageScanFindings in L<Paws::ECR> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |