« blib/lib/Paws/IoTSiteWise/DescribeGatewayCapabilityConfiguration.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/DescribeGatewayResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::DescribeGatewayCapabilityConfigurationResponse; | ||
| 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 CapabilitySyncStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'capabilitySyncStatus', required => 1); | ||
| 7 | has GatewayId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'gatewayId', required => 1); | ||
| 8 | |||
| 9 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::IoTSiteWise::DescribeGatewayCapabilityConfigurationResponse | ||
| 17 | |||
| 18 | =head1 ATTRIBUTES | ||
| 19 | |||
| 20 | |||
| 21 | =head2 B<REQUIRED> CapabilityConfiguration => Str | ||
| 22 | |||
| 23 | The JSON document that defines the gateway capability's configuration. | ||
| 24 | For more information, see Configuring data sources (CLI) | ||
| 25 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) | ||
| 26 | in the I<AWS IoT SiteWise User Guide>. | ||
| 27 | |||
| 28 | |||
| 29 | =head2 B<REQUIRED> CapabilityNamespace => Str | ||
| 30 | |||
| 31 | The namespace of the gateway capability. | ||
| 32 | |||
| 33 | |||
| 34 | =head2 B<REQUIRED> CapabilitySyncStatus => Str | ||
| 35 | |||
| 36 | The synchronization status of the capability configuration. The sync | ||
| 37 | status can be one of the following: | ||
| 38 | |||
| 39 | =over | ||
| 40 | |||
| 41 | =item * | ||
| 42 | |||
| 43 | C<IN_SYNC> E<ndash> The gateway is running the capability | ||
| 44 | configuration. | ||
| 45 | |||
| 46 | =item * | ||
| 47 | |||
| 48 | C<OUT_OF_SYNC> E<ndash> The gateway hasn't received the capability | ||
| 49 | configuration. | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | C<SYNC_FAILED> E<ndash> The gateway rejected the capability | ||
| 54 | configuration. | ||
| 55 | |||
| 56 | =back | ||
| 57 | |||
| 58 | |||
| 59 | Valid values are: C<"IN_SYNC">, C<"OUT_OF_SYNC">, C<"SYNC_FAILED"> | ||
| 60 | =head2 B<REQUIRED> GatewayId => Str | ||
| 61 | |||
| 62 | The ID of the gateway that defines the capability configuration. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 _request_id => Str | ||
| 66 | |||
| 67 | |||
| 68 | =cut | ||
| 69 |