« blib/lib/Paws/ComputeOptimizer/AutoScalingGroupRecommendationOption.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/DescribeRecommendationExportJobsResponse.pm »
| 1 | |||
| 2 | package Paws::ComputeOptimizer::DescribeRecommendationExportJobs; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::JobFilter]', traits => ['NameInRequest'], request_name => 'filters' ); | ||
| 5 | has JobIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'jobIds' ); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeRecommendationExportJobs'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ComputeOptimizer::DescribeRecommendationExportJobsResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ComputeOptimizer::DescribeRecommendationExportJobs - Arguments for method DescribeRecommendationExportJobs on L<Paws::ComputeOptimizer> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeRecommendationExportJobs on the | ||
| 25 | L<AWS Compute Optimizer|Paws::ComputeOptimizer> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeRecommendationExportJobs. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeRecommendationExportJobs. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $compute-optimizer = Paws->service('ComputeOptimizer'); | ||
| 33 | my $DescribeRecommendationExportJobsResponse = | ||
| 34 | $compute -optimizer->DescribeRecommendationExportJobs( | ||
| 35 | Filters => [ | ||
| 36 | { | ||
| 37 | Name => 'ResourceType', # values: ResourceType, JobStatus; OPTIONAL | ||
| 38 | Values => [ 'MyFilterValue', ... ], # OPTIONAL | ||
| 39 | }, | ||
| 40 | ... | ||
| 41 | ], # OPTIONAL | ||
| 42 | JobIds => [ 'MyJobId', ... ], # OPTIONAL | ||
| 43 | MaxResults => 1, # OPTIONAL | ||
| 44 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $NextToken = $DescribeRecommendationExportJobsResponse->NextToken; | ||
| 49 | my $RecommendationExportJobs = | ||
| 50 | $DescribeRecommendationExportJobsResponse->RecommendationExportJobs; | ||
| 51 | |||
| 52 | # Returns a L<Paws::ComputeOptimizer::DescribeRecommendationExportJobsResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer/DescribeRecommendationExportJobs> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Filters => ArrayRef[L<Paws::ComputeOptimizer::JobFilter>] | ||
| 61 | |||
| 62 | An array of objects that describe a filter to return a more specific | ||
| 63 | list of export jobs. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 JobIds => ArrayRef[Str|Undef] | ||
| 68 | |||
| 69 | The identification numbers of the export jobs to return. | ||
| 70 | |||
| 71 | An export job ID is returned when you create an export using the | ||
| 72 | C<ExportAutoScalingGroupRecommendations> or | ||
| 73 | C<ExportEC2InstanceRecommendations> actions. | ||
| 74 | |||
| 75 | All export jobs created in the last seven days are returned if this | ||
| 76 | parameter is omitted. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 MaxResults => Int | ||
| 81 | |||
| 82 | The maximum number of export jobs to return with a single request. | ||
| 83 | |||
| 84 | To retrieve the remaining results, make another request with the | ||
| 85 | returned C<NextToken> value. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 NextToken => Str | ||
| 90 | |||
| 91 | The token to advance to the next page of export jobs. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method DescribeRecommendationExportJobs in L<Paws::ComputeOptimizer> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |