« blib/lib/Paws/IoTSiteWise/DescribeAssetResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/DescribeDashboardResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::DescribeDashboard; | ||
| 3 | use Moose; | ||
| 4 | has DashboardId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'dashboardId', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDashboard'); | ||
| 9 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/dashboards/{dashboardId}'); | ||
| 10 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::DescribeDashboardResponse'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::IoTSiteWise::DescribeDashboard - Arguments for method DescribeDashboard on L<Paws::IoTSiteWise> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeDashboard on the | ||
| 23 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeDashboard. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDashboard. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 31 | my $DescribeDashboardResponse = $iotsitewise->DescribeDashboard( | ||
| 32 | DashboardId => 'MyID', | ||
| 33 | |||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $DashboardArn = $DescribeDashboardResponse->DashboardArn; | ||
| 38 | my $DashboardCreationDate = | ||
| 39 | $DescribeDashboardResponse->DashboardCreationDate; | ||
| 40 | my $DashboardDefinition = $DescribeDashboardResponse->DashboardDefinition; | ||
| 41 | my $DashboardDescription = $DescribeDashboardResponse->DashboardDescription; | ||
| 42 | my $DashboardId = $DescribeDashboardResponse->DashboardId; | ||
| 43 | my $DashboardLastUpdateDate = | ||
| 44 | $DescribeDashboardResponse->DashboardLastUpdateDate; | ||
| 45 | my $DashboardName = $DescribeDashboardResponse->DashboardName; | ||
| 46 | my $ProjectId = $DescribeDashboardResponse->ProjectId; | ||
| 47 | |||
| 48 | # Returns a L<Paws::IoTSiteWise::DescribeDashboardResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/DescribeDashboard> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> DashboardId => Str | ||
| 57 | |||
| 58 | The ID of the dashboard. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, documenting arguments for method DescribeDashboard in L<Paws::IoTSiteWise> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |