« blib/lib/Paws/IoTSiteWise/CreateDashboardResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/CreateGatewayResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::CreateGateway; | ||
| 3 | use Moose; | ||
| 4 | has GatewayName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'gatewayName', required => 1); | ||
| 5 | has GatewayPlatform => (is => 'ro', isa => 'Paws::IoTSiteWise::GatewayPlatform', traits => ['NameInRequest'], request_name => 'gatewayPlatform', required => 1); | ||
| 6 | has Tags => (is => 'ro', isa => 'Paws::IoTSiteWise::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateGateway'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/20200301/gateways'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::CreateGatewayResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IoTSiteWise::CreateGateway - Arguments for method CreateGateway on L<Paws::IoTSiteWise> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateGateway on the | ||
| 25 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateGateway. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGateway. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 33 | my $CreateGatewayResponse = $iotsitewise->CreateGateway( | ||
| 34 | GatewayName => 'MyName', | ||
| 35 | GatewayPlatform => { | ||
| 36 | Greengrass => { | ||
| 37 | GroupArn => 'MyARN', # min: 1, max: 1600 | ||
| 38 | |||
| 39 | }, | ||
| 40 | |||
| 41 | }, | ||
| 42 | Tags => { | ||
| 43 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 44 | }, # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $GatewayArn = $CreateGatewayResponse->GatewayArn; | ||
| 49 | my $GatewayId = $CreateGatewayResponse->GatewayId; | ||
| 50 | |||
| 51 | # Returns a L<Paws::IoTSiteWise::CreateGatewayResponse> 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/CreateGateway> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> GatewayName => Str | ||
| 60 | |||
| 61 | A unique, friendly name for the gateway. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> GatewayPlatform => L<Paws::IoTSiteWise::GatewayPlatform> | ||
| 66 | |||
| 67 | The gateway's platform. You can only specify one platform in a gateway. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Tags => L<Paws::IoTSiteWise::TagMap> | ||
| 72 | |||
| 73 | A list of key-value pairs that contain metadata for the gateway. For | ||
| 74 | more information, see Tagging your AWS IoT SiteWise resources | ||
| 75 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) | ||
| 76 | in the I<AWS IoT SiteWise User Guide>. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method CreateGateway in L<Paws::IoTSiteWise> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |