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