« blib/lib/Paws/CloudDirectory/ListObjectParentPathsResponse.pm
↑ Summary
blib/lib/Paws/CloudDirectory/ListObjectParentsResponse.pm »
| 1 | |||
| 2 | package Paws::CloudDirectory::ListObjectParents; | ||
| 3 | use Moose; | ||
| 4 | has ConsistencyLevel => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-consistency-level'); | ||
| 5 | has DirectoryArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition', required => 1); | ||
| 6 | has IncludeAllLinksToEachParent => (is => 'ro', isa => 'Bool'); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | has ObjectReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListObjectParents'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/object/parent'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::ListObjectParentsResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CloudDirectory::ListObjectParents - Arguments for method ListObjectParents on L<Paws::CloudDirectory> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListObjectParents on the | ||
| 28 | L<Amazon CloudDirectory|Paws::CloudDirectory> service. Use the attributes of this class | ||
| 29 | as arguments to method ListObjectParents. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListObjectParents. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $clouddirectory = Paws->service('CloudDirectory'); | ||
| 36 | my $ListObjectParentsResponse = $clouddirectory->ListObjectParents( | ||
| 37 | DirectoryArn => 'MyArn', | ||
| 38 | ObjectReference => { | ||
| 39 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 40 | }, | ||
| 41 | ConsistencyLevel => 'SERIALIZABLE', # OPTIONAL | ||
| 42 | IncludeAllLinksToEachParent => 1, # OPTIONAL | ||
| 43 | MaxResults => 1, # OPTIONAL | ||
| 44 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $NextToken = $ListObjectParentsResponse->NextToken; | ||
| 49 | my $ParentLinks = $ListObjectParentsResponse->ParentLinks; | ||
| 50 | my $Parents = $ListObjectParentsResponse->Parents; | ||
| 51 | |||
| 52 | # Returns a L<Paws::CloudDirectory::ListObjectParentsResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/ListObjectParents> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ConsistencyLevel => Str | ||
| 61 | |||
| 62 | Represents the manner and timing in which the successful write or | ||
| 63 | update of an object is reflected in a subsequent read operation of that | ||
| 64 | same object. | ||
| 65 | |||
| 66 | Valid values are: C<"SERIALIZABLE">, C<"EVENTUAL"> | ||
| 67 | |||
| 68 | =head2 B<REQUIRED> DirectoryArn => Str | ||
| 69 | |||
| 70 | The Amazon Resource Name (ARN) that is associated with the Directory | ||
| 71 | where the object resides. For more information, see arns. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 IncludeAllLinksToEachParent => Bool | ||
| 76 | |||
| 77 | When set to True, returns all ListObjectParentsResponse$ParentLinks. | ||
| 78 | There could be multiple links between a parent-child pair. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 MaxResults => Int | ||
| 83 | |||
| 84 | The maximum number of items to be retrieved in a single call. This is | ||
| 85 | an approximate number. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 NextToken => Str | ||
| 90 | |||
| 91 | The pagination token. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> ObjectReference => L<Paws::CloudDirectory::ObjectReference> | ||
| 96 | |||
| 97 | The reference that identifies the object for which parent objects are | ||
| 98 | being listed. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method ListObjectParents in L<Paws::CloudDirectory> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |