« blib/lib/Paws/CloudDirectory/GetLinkAttributesResponse.pm
↑ Summary
blib/lib/Paws/CloudDirectory/GetObjectAttributesResponse.pm »
| 1 | |||
| 2 | package Paws::CloudDirectory::GetObjectAttributes; | ||
| 3 | use Moose; | ||
| 4 | has AttributeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 5 | has ConsistencyLevel => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-consistency-level'); | ||
| 6 | has DirectoryArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition', required => 1); | ||
| 7 | has ObjectReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference', required => 1); | ||
| 8 | has SchemaFacet => (is => 'ro', isa => 'Paws::CloudDirectory::SchemaFacet', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetObjectAttributes'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/object/attributes/get'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::GetObjectAttributesResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudDirectory::GetObjectAttributes - Arguments for method GetObjectAttributes on L<Paws::CloudDirectory> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetObjectAttributes on the | ||
| 27 | L<Amazon CloudDirectory|Paws::CloudDirectory> service. Use the attributes of this class | ||
| 28 | as arguments to method GetObjectAttributes. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetObjectAttributes. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $clouddirectory = Paws->service('CloudDirectory'); | ||
| 35 | my $GetObjectAttributesResponse = $clouddirectory->GetObjectAttributes( | ||
| 36 | AttributeNames => [ | ||
| 37 | 'MyAttributeName', ... # min: 1, max: 230 | ||
| 38 | ], | ||
| 39 | DirectoryArn => 'MyArn', | ||
| 40 | ObjectReference => { | ||
| 41 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 42 | }, | ||
| 43 | SchemaFacet => { | ||
| 44 | FacetName => 'MyFacetName', # min: 1, max: 64; OPTIONAL | ||
| 45 | SchemaArn => 'MyArn', | ||
| 46 | }, | ||
| 47 | ConsistencyLevel => 'SERIALIZABLE', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Attributes = $GetObjectAttributesResponse->Attributes; | ||
| 52 | |||
| 53 | # Returns a L<Paws::CloudDirectory::GetObjectAttributesResponse> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/GetObjectAttributes> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> AttributeNames => ArrayRef[Str|Undef] | ||
| 62 | |||
| 63 | List of attribute names whose values will be retrieved. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 ConsistencyLevel => Str | ||
| 68 | |||
| 69 | The consistency level at which to retrieve the attributes on an object. | ||
| 70 | |||
| 71 | Valid values are: C<"SERIALIZABLE">, C<"EVENTUAL"> | ||
| 72 | |||
| 73 | =head2 B<REQUIRED> DirectoryArn => Str | ||
| 74 | |||
| 75 | The Amazon Resource Name (ARN) that is associated with the Directory | ||
| 76 | where the object resides. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> ObjectReference => L<Paws::CloudDirectory::ObjectReference> | ||
| 81 | |||
| 82 | Reference that identifies the object whose attributes will be | ||
| 83 | retrieved. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> SchemaFacet => L<Paws::CloudDirectory::SchemaFacet> | ||
| 88 | |||
| 89 | Identifier for the facet whose attributes will be retrieved. See | ||
| 90 | SchemaFacet for details. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method GetObjectAttributes in L<Paws::CloudDirectory> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |