« blib/lib/Paws/DataPipeline/DeletePipeline.pm
↑ Summary
blib/lib/Paws/DataPipeline/DescribeObjectsOutput.pm »
| 1 | |||
| 2 | package Paws::DataPipeline::DescribeObjects; | ||
| 3 | use Moose; | ||
| 4 | has EvaluateExpressions => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'evaluateExpressions' ); | ||
| 5 | has Marker => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'marker' ); | ||
| 6 | has ObjectIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'objectIds' , required => 1); | ||
| 7 | has PipelineId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pipelineId' , required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeObjects'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DataPipeline::DescribeObjectsOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DataPipeline::DescribeObjects - Arguments for method DescribeObjects on L<Paws::DataPipeline> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeObjects on the | ||
| 25 | L<AWS Data Pipeline|Paws::DataPipeline> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeObjects. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeObjects. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $datapipeline = Paws->service('DataPipeline'); | ||
| 33 | my $DescribeObjectsOutput = $datapipeline->DescribeObjects( | ||
| 34 | ObjectIds => [ | ||
| 35 | 'Myid', ... # min: 1, max: 1024 | ||
| 36 | ], | ||
| 37 | PipelineId => 'Myid', | ||
| 38 | EvaluateExpressions => 1, # OPTIONAL | ||
| 39 | Marker => 'Mystring', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $HasMoreResults = $DescribeObjectsOutput->HasMoreResults; | ||
| 44 | my $Marker = $DescribeObjectsOutput->Marker; | ||
| 45 | my $PipelineObjects = $DescribeObjectsOutput->PipelineObjects; | ||
| 46 | |||
| 47 | # Returns a L<Paws::DataPipeline::DescribeObjectsOutput> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datapipeline/DescribeObjects> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 EvaluateExpressions => Bool | ||
| 56 | |||
| 57 | Indicates whether any expressions in the object should be evaluated | ||
| 58 | when the object descriptions are returned. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 Marker => Str | ||
| 63 | |||
| 64 | The starting point for the results to be returned. For the first call, | ||
| 65 | this value should be empty. As long as there are more results, continue | ||
| 66 | to call C<DescribeObjects> with the marker value from the previous call | ||
| 67 | to retrieve the next set of results. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> ObjectIds => ArrayRef[Str|Undef] | ||
| 72 | |||
| 73 | The IDs of the pipeline objects that contain the definitions to be | ||
| 74 | described. You can pass as many as 25 identifiers in a single call to | ||
| 75 | C<DescribeObjects>. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> PipelineId => Str | ||
| 80 | |||
| 81 | The ID of the pipeline that contains the object definitions. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method DescribeObjects in L<Paws::DataPipeline> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |