« blib/lib/Paws/XRay/GetTraceGraphResult.pm
↑ Summary
blib/lib/Paws/XRay/GetTraceSummariesResult.pm »
| 1 | |||
| 2 | package Paws::XRay::GetTraceSummaries; | ||
| 3 | use Moose; | ||
| 4 | has EndTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FilterExpression => (is => 'ro', isa => 'Str'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has Sampling => (is => 'ro', isa => 'Bool'); | ||
| 8 | has SamplingStrategy => (is => 'ro', isa => 'Paws::XRay::SamplingStrategy'); | ||
| 9 | has StartTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has TimeRangeType => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetTraceSummaries'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/TraceSummaries'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::XRay::GetTraceSummariesResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::XRay::GetTraceSummaries - Arguments for method GetTraceSummaries on L<Paws::XRay> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method GetTraceSummaries on the | ||
| 29 | L<AWS X-Ray|Paws::XRay> service. Use the attributes of this class | ||
| 30 | as arguments to method GetTraceSummaries. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetTraceSummaries. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $xray = Paws->service('XRay'); | ||
| 37 | my $GetTraceSummariesResult = $xray->GetTraceSummaries( | ||
| 38 | EndTime => '1970-01-01T01:00:00', | ||
| 39 | StartTime => '1970-01-01T01:00:00', | ||
| 40 | FilterExpression => 'MyFilterExpression', # OPTIONAL | ||
| 41 | NextToken => 'MyString', # OPTIONAL | ||
| 42 | Sampling => 1, # OPTIONAL | ||
| 43 | SamplingStrategy => { | ||
| 44 | Name => 'PartialScan', # values: PartialScan, FixedRate; OPTIONAL | ||
| 45 | Value => 1, # OPTIONAL | ||
| 46 | }, # OPTIONAL | ||
| 47 | TimeRangeType => 'TraceId', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $ApproximateTime = $GetTraceSummariesResult->ApproximateTime; | ||
| 52 | my $NextToken = $GetTraceSummariesResult->NextToken; | ||
| 53 | my $TraceSummaries = $GetTraceSummariesResult->TraceSummaries; | ||
| 54 | my $TracesProcessedCount = $GetTraceSummariesResult->TracesProcessedCount; | ||
| 55 | |||
| 56 | # Returns a L<Paws::XRay::GetTraceSummariesResult> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/xray/GetTraceSummaries> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> EndTime => Str | ||
| 65 | |||
| 66 | The end of the time frame for which to retrieve traces. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 FilterExpression => Str | ||
| 71 | |||
| 72 | Specify a filter expression to retrieve trace summaries for services or | ||
| 73 | requests that meet certain requirements. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 NextToken => Str | ||
| 78 | |||
| 79 | Specify the pagination token returned by a previous request to retrieve | ||
| 80 | the next page of results. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 Sampling => Bool | ||
| 85 | |||
| 86 | Set to C<true> to get summaries for only a subset of available traces. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 SamplingStrategy => L<Paws::XRay::SamplingStrategy> | ||
| 91 | |||
| 92 | A parameter to indicate whether to enable sampling on trace summaries. | ||
| 93 | Input parameters are Name and Value. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> StartTime => Str | ||
| 98 | |||
| 99 | The start of the time frame for which to retrieve traces. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 TimeRangeType => Str | ||
| 104 | |||
| 105 | A parameter to indicate whether to query trace summaries by TraceId or | ||
| 106 | Event time. | ||
| 107 | |||
| 108 | Valid values are: C<"TraceId">, C<"Event"> | ||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method GetTraceSummaries in L<Paws::XRay> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |