« blib/lib/Paws/IoT1ClickProjects/CreatePlacementResponse.pm
↑ Summary
blib/lib/Paws/IoT1ClickProjects/CreateProjectResponse.pm »
| 1 | |||
| 2 | package Paws::IoT1ClickProjects::CreateProject; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 5 | has PlacementTemplate => (is => 'ro', isa => 'Paws::IoT1ClickProjects::PlacementTemplate', traits => ['NameInRequest'], request_name => 'placementTemplate'); | ||
| 6 | has ProjectName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'projectName', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'Paws::IoT1ClickProjects::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateProject'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/projects'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT1ClickProjects::CreateProjectResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoT1ClickProjects::CreateProject - Arguments for method CreateProject on L<Paws::IoT1ClickProjects> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateProject on the | ||
| 26 | L<AWS IoT 1-Click Projects Service|Paws::IoT1ClickProjects> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateProject. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateProject. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $projects.iot1click = Paws->service('IoT1ClickProjects'); | ||
| 34 | my $CreateProjectResponse = $projects . iot1click->CreateProject( | ||
| 35 | ProjectName => 'MyProjectName', | ||
| 36 | Description => 'MyDescription', # OPTIONAL | ||
| 37 | PlacementTemplate => { | ||
| 38 | DefaultAttributes => { | ||
| 39 | 'MyAttributeName' => | ||
| 40 | 'MyAttributeDefaultValue', # key: min: 1, max: 128, value: max: 800 | ||
| 41 | }, # OPTIONAL | ||
| 42 | DeviceTemplates => { | ||
| 43 | 'MyDeviceTemplateName' => { | ||
| 44 | CallbackOverrides => { | ||
| 45 | 'MyDeviceCallbackKey' => 'MyDeviceCallbackValue' | ||
| 46 | , # key: min: 1, max: 128, value: max: 200 | ||
| 47 | }, # OPTIONAL | ||
| 48 | DeviceType => 'MyDeviceType', # max: 128; OPTIONAL | ||
| 49 | }, # key: min: 1, max: 128 | ||
| 50 | }, # OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | Tags => { | ||
| 53 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 54 | }, # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/projects.iot1click/CreateProject> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Description => Str | ||
| 64 | |||
| 65 | An optional description for the project. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 PlacementTemplate => L<Paws::IoT1ClickProjects::PlacementTemplate> | ||
| 70 | |||
| 71 | The schema defining the placement to be created. A placement template | ||
| 72 | defines placement default attributes and device templates. You cannot | ||
| 73 | add or remove device templates after the project has been created. | ||
| 74 | However, you can update C<callbackOverrides> for the device templates | ||
| 75 | using the C<UpdateProject> API. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> ProjectName => Str | ||
| 80 | |||
| 81 | The name of the project to create. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 Tags => L<Paws::IoT1ClickProjects::TagMap> | ||
| 86 | |||
| 87 | Optional tags (metadata key/value pairs) to be associated with the | ||
| 88 | project. For example, C<{ {"key1": "value1", "key2": "value2"} }>. For | ||
| 89 | more information, see AWS Tagging Strategies | ||
| 90 | (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method CreateProject in L<Paws::IoT1ClickProjects> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |