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