« blib/lib/Paws/Kendra/DescribeDataSourceResponse.pm
↑ Summary
blib/lib/Paws/Kendra/DescribeFaqResponse.pm »
| 1 | |||
| 2 | package Paws::Kendra::DescribeFaq; | ||
| 3 | use Moose; | ||
| 4 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeFaq'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::DescribeFaqResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Kendra::DescribeFaq - Arguments for method DescribeFaq on L<Paws::Kendra> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeFaq on the | ||
| 23 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeFaq. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeFaq. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kendra = Paws->service('Kendra'); | ||
| 31 | my $DescribeFaqResponse = $kendra->DescribeFaq( | ||
| 32 | Id => 'MyFaqId', | ||
| 33 | IndexId => 'MyIndexId', | ||
| 34 | |||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $CreatedAt = $DescribeFaqResponse->CreatedAt; | ||
| 39 | my $Description = $DescribeFaqResponse->Description; | ||
| 40 | my $ErrorMessage = $DescribeFaqResponse->ErrorMessage; | ||
| 41 | my $FileFormat = $DescribeFaqResponse->FileFormat; | ||
| 42 | my $Id = $DescribeFaqResponse->Id; | ||
| 43 | my $IndexId = $DescribeFaqResponse->IndexId; | ||
| 44 | my $Name = $DescribeFaqResponse->Name; | ||
| 45 | my $RoleArn = $DescribeFaqResponse->RoleArn; | ||
| 46 | my $S3Path = $DescribeFaqResponse->S3Path; | ||
| 47 | my $Status = $DescribeFaqResponse->Status; | ||
| 48 | my $UpdatedAt = $DescribeFaqResponse->UpdatedAt; | ||
| 49 | |||
| 50 | # Returns a L<Paws::Kendra::DescribeFaqResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/DescribeFaq> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> Id => Str | ||
| 59 | |||
| 60 | The unique identifier of the FAQ. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> IndexId => Str | ||
| 65 | |||
| 66 | The identifier of the index that contains the FAQ. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method DescribeFaq in L<Paws::Kendra> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |