« blib/lib/Paws/CloudDirectory/CreateFacetResponse.pm
↑ Summary
blib/lib/Paws/CloudDirectory/CreateIndexResponse.pm »
| 1 | |||
| 2 | package Paws::CloudDirectory::CreateIndex; | ||
| 3 | use Moose; | ||
| 4 | has DirectoryArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition', required => 1); | ||
| 5 | has IsUnique => (is => 'ro', isa => 'Bool', required => 1); | ||
| 6 | has LinkName => (is => 'ro', isa => 'Str'); | ||
| 7 | has OrderedIndexedAttributeList => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::AttributeKey]', required => 1); | ||
| 8 | has ParentReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIndex'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/index'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::CreateIndexResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudDirectory::CreateIndex - Arguments for method CreateIndex on L<Paws::CloudDirectory> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateIndex on the | ||
| 27 | L<Amazon CloudDirectory|Paws::CloudDirectory> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateIndex. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIndex. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $clouddirectory = Paws->service('CloudDirectory'); | ||
| 35 | my $CreateIndexResponse = $clouddirectory->CreateIndex( | ||
| 36 | DirectoryArn => 'MyArn', | ||
| 37 | IsUnique => 1, | ||
| 38 | OrderedIndexedAttributeList => [ | ||
| 39 | { | ||
| 40 | FacetName => 'MyFacetName', # min: 1, max: 64 | ||
| 41 | Name => 'MyAttributeName', # min: 1, max: 230 | ||
| 42 | SchemaArn => 'MyArn', | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], | ||
| 47 | LinkName => 'MyLinkName', # OPTIONAL | ||
| 48 | ParentReference => { | ||
| 49 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $ObjectIdentifier = $CreateIndexResponse->ObjectIdentifier; | ||
| 55 | |||
| 56 | # Returns a L<Paws::CloudDirectory::CreateIndexResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/CreateIndex> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> DirectoryArn => Str | ||
| 65 | |||
| 66 | The ARN of the directory where the index should be created. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> IsUnique => Bool | ||
| 71 | |||
| 72 | Indicates whether the attribute that is being indexed has unique values | ||
| 73 | or not. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 LinkName => Str | ||
| 78 | |||
| 79 | The name of the link between the parent object and the index object. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> OrderedIndexedAttributeList => ArrayRef[L<Paws::CloudDirectory::AttributeKey>] | ||
| 84 | |||
| 85 | Specifies the attributes that should be indexed on. Currently only a | ||
| 86 | single attribute is supported. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 ParentReference => L<Paws::CloudDirectory::ObjectReference> | ||
| 91 | |||
| 92 | A reference to the parent object that contains the index object. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method CreateIndex in L<Paws::CloudDirectory> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |