« blib/lib/Paws/IoTSiteWise/UpdateGateway.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/UpdateGatewayCapabilityConfigurationResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::UpdateGatewayCapabilityConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has CapabilityConfiguration => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'capabilityConfiguration', required => 1); | ||
| 5 | has CapabilityNamespace => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'capabilityNamespace', required => 1); | ||
| 6 | has GatewayId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'gatewayId', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateGatewayCapabilityConfiguration'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/20200301/gateways/{gatewayId}/capability'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::UpdateGatewayCapabilityConfigurationResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IoTSiteWise::UpdateGatewayCapabilityConfiguration - Arguments for method UpdateGatewayCapabilityConfiguration on L<Paws::IoTSiteWise> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateGatewayCapabilityConfiguration on the | ||
| 25 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateGatewayCapabilityConfiguration. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateGatewayCapabilityConfiguration. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 33 | my $UpdateGatewayCapabilityConfigurationResponse = | ||
| 34 | $iotsitewise->UpdateGatewayCapabilityConfiguration( | ||
| 35 | CapabilityConfiguration => 'MyCapabilityConfiguration', | ||
| 36 | CapabilityNamespace => 'MyCapabilityNamespace', | ||
| 37 | GatewayId => 'MyID', | ||
| 38 | |||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $CapabilityNamespace = | ||
| 43 | $UpdateGatewayCapabilityConfigurationResponse->CapabilityNamespace; | ||
| 44 | my $CapabilitySyncStatus = | ||
| 45 | $UpdateGatewayCapabilityConfigurationResponse->CapabilitySyncStatus; | ||
| 46 | |||
| 47 | # Returns a L<Paws::IoTSiteWise::UpdateGatewayCapabilityConfigurationResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/UpdateGatewayCapabilityConfiguration> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> CapabilityConfiguration => Str | ||
| 56 | |||
| 57 | The JSON document that defines the configuration for the gateway | ||
| 58 | capability. For more information, see Configuring data sources (CLI) | ||
| 59 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) | ||
| 60 | in the I<AWS IoT SiteWise User Guide>. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> CapabilityNamespace => Str | ||
| 65 | |||
| 66 | The namespace of the gateway capability configuration to be updated. | ||
| 67 | For example, if you configure OPC-UA sources from the AWS IoT SiteWise | ||
| 68 | console, your OPC-UA capability configuration has the namespace | ||
| 69 | C<iotsitewise:opcuacollector:version>, where C<version> is a number | ||
| 70 | such as C<1>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> GatewayId => Str | ||
| 75 | |||
| 76 | The ID of the gateway to be updated. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method UpdateGatewayCapabilityConfiguration 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 |