« blib/lib/Paws/CloudWatch/GetMetricStreamOutput.pm
↑ Summary
blib/lib/Paws/CloudWatch/GetMetricWidgetImageOutput.pm »
| 1 | |||
| 2 | package Paws::CloudWatch::GetMetricWidgetImage; | ||
| 3 | use Moose; | ||
| 4 | has MetricWidget => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has OutputFormat => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetMetricWidgetImage'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::GetMetricWidgetImageOutput'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetMetricWidgetImageResult'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::CloudWatch::GetMetricWidgetImage - Arguments for method GetMetricWidgetImage on L<Paws::CloudWatch> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method GetMetricWidgetImage on the | ||
| 23 | L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class | ||
| 24 | as arguments to method GetMetricWidgetImage. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetMetricWidgetImage. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $monitoring = Paws->service('CloudWatch'); | ||
| 31 | my $GetMetricWidgetImageOutput = $monitoring->GetMetricWidgetImage( | ||
| 32 | MetricWidget => 'MyMetricWidget', | ||
| 33 | OutputFormat => 'MyOutputFormat', # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $MetricWidgetImage = $GetMetricWidgetImageOutput->MetricWidgetImage; | ||
| 38 | |||
| 39 | # Returns a L<Paws::CloudWatch::GetMetricWidgetImageOutput> object. | ||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/GetMetricWidgetImage> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> MetricWidget => Str | ||
| 48 | |||
| 49 | A JSON string that defines the bitmap graph to be retrieved. The string | ||
| 50 | includes the metrics to include in the graph, statistics, annotations, | ||
| 51 | title, axis limits, and so on. You can include only one C<MetricWidget> | ||
| 52 | parameter in each C<GetMetricWidgetImage> call. | ||
| 53 | |||
| 54 | For more information about the syntax of C<MetricWidget> see | ||
| 55 | GetMetricWidgetImage: Metric Widget Structure and Syntax | ||
| 56 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html). | ||
| 57 | |||
| 58 | If any metric on the graph could not load all the requested data | ||
| 59 | points, an orange triangle with an exclamation point appears next to | ||
| 60 | the graph legend. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 OutputFormat => Str | ||
| 65 | |||
| 66 | The format of the resulting image. Only PNG images are supported. | ||
| 67 | |||
| 68 | The default is C<png>. If you specify C<png>, the API returns an HTTP | ||
| 69 | response with the content-type set to C<text/xml>. The image data is in | ||
| 70 | a C<MetricWidgetImage> field. For example: | ||
| 71 | |||
| 72 | C<E<lt>GetMetricWidgetImageResponse xmlns=E<lt>URLstringE<gt>E<gt>> | ||
| 73 | |||
| 74 | C<E<lt>GetMetricWidgetImageResultE<gt>> | ||
| 75 | |||
| 76 | C<E<lt>MetricWidgetImageE<gt>> | ||
| 77 | |||
| 78 | C<iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...> | ||
| 79 | |||
| 80 | C<E<lt>/MetricWidgetImageE<gt>> | ||
| 81 | |||
| 82 | C<E<lt>/GetMetricWidgetImageResultE<gt>> | ||
| 83 | |||
| 84 | C<E<lt>ResponseMetadataE<gt>> | ||
| 85 | |||
| 86 | C<E<lt>RequestIdE<gt>6f0d4192-4d42-11e8-82c1-f539a07e0e3bE<lt>/RequestIdE<gt>> | ||
| 87 | |||
| 88 | C<E<lt>/ResponseMetadataE<gt>> | ||
| 89 | |||
| 90 | C<E<lt>/GetMetricWidgetImageResponseE<gt>> | ||
| 91 | |||
| 92 | The C<image/png> setting is intended only for custom HTTP requests. For | ||
| 93 | most use cases, and all actions using an AWS SDK, you should use | ||
| 94 | C<png>. If you specify C<image/png>, the HTTP response has a | ||
| 95 | content-type set to C<image/png>, and the body of the response is a PNG | ||
| 96 | image. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method GetMetricWidgetImage in L<Paws::CloudWatch> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |