The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::IoTAnalytics::DescribeChannel - Arguments for method DescribeChannel on Paws::IoTAnalytics

DESCRIPTION

This class represents the parameters used for calling the method DescribeChannel on the AWS IoT Analytics service. Use the attributes of this class as arguments to method DescribeChannel.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeChannel.

SYNOPSIS

    my $iotanalytics = Paws->service('IoTAnalytics');
    my $DescribeChannelResponse = $iotanalytics->DescribeChannel(
      ChannelName       => 'MyChannelName',
      IncludeStatistics => 1,                 # OPTIONAL
    );

    # Results:
    my $Channel    = $DescribeChannelResponse->Channel;
    my $Statistics = $DescribeChannelResponse->Statistics;

    # Returns a L<Paws::IoTAnalytics::DescribeChannelResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/DescribeChannel

ATTRIBUTES

REQUIRED ChannelName => Str

The name of the channel whose information is retrieved.

IncludeStatistics => Bool

If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeChannel in Paws::IoTAnalytics

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues