« blib/lib/Paws/IoTSiteWise/CreateAssetResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/CreateDashboardResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::CreateDashboard; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 5 | has DashboardDefinition => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dashboardDefinition', required => 1); | ||
| 6 | has DashboardDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dashboardDescription'); | ||
| 7 | has DashboardName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dashboardName', required => 1); | ||
| 8 | has ProjectId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'projectId', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'Paws::IoTSiteWise::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDashboard'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/dashboards'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::CreateDashboardResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::IoTSiteWise::CreateDashboard - Arguments for method CreateDashboard on L<Paws::IoTSiteWise> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateDashboard on the | ||
| 28 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateDashboard. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDashboard. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 36 | my $CreateDashboardResponse = $iotsitewise->CreateDashboard( | ||
| 37 | DashboardDefinition => 'MyDashboardDefinition', | ||
| 38 | DashboardName => 'MyName', | ||
| 39 | ProjectId => 'MyID', | ||
| 40 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 41 | DashboardDescription => 'MyDescription', # OPTIONAL | ||
| 42 | Tags => { | ||
| 43 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 44 | }, # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $DashboardArn = $CreateDashboardResponse->DashboardArn; | ||
| 49 | my $DashboardId = $CreateDashboardResponse->DashboardId; | ||
| 50 | |||
| 51 | # Returns a L<Paws::IoTSiteWise::CreateDashboardResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/CreateDashboard> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ClientToken => Str | ||
| 60 | |||
| 61 | A unique case-sensitive identifier that you can provide to ensure the | ||
| 62 | idempotency of the request. Don't reuse this client token if a new | ||
| 63 | idempotent request is required. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> DashboardDefinition => Str | ||
| 68 | |||
| 69 | The dashboard definition specified in a JSON literal. For detailed | ||
| 70 | information, see Creating dashboards (CLI) | ||
| 71 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) | ||
| 72 | in the I<AWS IoT SiteWise User Guide>. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 DashboardDescription => Str | ||
| 77 | |||
| 78 | A description for the dashboard. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> DashboardName => Str | ||
| 83 | |||
| 84 | A friendly name for the dashboard. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> ProjectId => Str | ||
| 89 | |||
| 90 | The ID of the project in which to create the dashboard. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 Tags => L<Paws::IoTSiteWise::TagMap> | ||
| 95 | |||
| 96 | A list of key-value pairs that contain metadata for the dashboard. For | ||
| 97 | more information, see Tagging your AWS IoT SiteWise resources | ||
| 98 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) | ||
| 99 | in the I<AWS IoT SiteWise User Guide>. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, documenting arguments for method CreateDashboard in L<Paws::IoTSiteWise> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |