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