« blib/lib/Paws/CloudDirectory/UpdateSchemaResponse.pm
↑ Summary
blib/lib/Paws/CloudDirectory/UpdateTypedLinkFacetResponse.pm »
| 1 | |||
| 2 | package Paws::CloudDirectory::UpdateTypedLinkFacet; | ||
| 3 | use Moose; | ||
| 4 | has AttributeUpdates => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::TypedLinkFacetAttributeUpdate]', required => 1); | ||
| 5 | has IdentityAttributeOrder => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has SchemaArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateTypedLinkFacet'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/typedlink/facet'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::UpdateTypedLinkFacetResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CloudDirectory::UpdateTypedLinkFacet - Arguments for method UpdateTypedLinkFacet on L<Paws::CloudDirectory> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateTypedLinkFacet on the | ||
| 26 | L<Amazon CloudDirectory|Paws::CloudDirectory> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateTypedLinkFacet. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateTypedLinkFacet. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $clouddirectory = Paws->service('CloudDirectory'); | ||
| 34 | my $UpdateTypedLinkFacetResponse = $clouddirectory->UpdateTypedLinkFacet( | ||
| 35 | AttributeUpdates => [ | ||
| 36 | { | ||
| 37 | Action => 'CREATE_OR_UPDATE', # values: CREATE_OR_UPDATE, DELETE | ||
| 38 | Attribute => { | ||
| 39 | Name => 'MyAttributeName', # min: 1, max: 230 | ||
| 40 | RequiredBehavior => | ||
| 41 | 'REQUIRED_ALWAYS', # values: REQUIRED_ALWAYS, NOT_REQUIRED | ||
| 42 | Type => 'STRING' | ||
| 43 | , # values: STRING, BINARY, BOOLEAN, NUMBER, DATETIME, VARIANT | ||
| 44 | DefaultValue => { | ||
| 45 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 46 | BooleanValue => 1, # OPTIONAL | ||
| 47 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 48 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 49 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | IsImmutable => 1, # OPTIONAL | ||
| 52 | Rules => { | ||
| 53 | 'MyRuleKey' => { | ||
| 54 | Parameters => | ||
| 55 | { 'MyRuleParameterKey' => 'MyRuleParameterValue', } | ||
| 56 | , # OPTIONAL | ||
| 57 | Type => 'BINARY_LENGTH' | ||
| 58 | , # values: BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH; OPTIONAL | ||
| 59 | }, # key: min: 1, max: 64 | ||
| 60 | }, # OPTIONAL | ||
| 61 | }, | ||
| 62 | |||
| 63 | }, | ||
| 64 | ... | ||
| 65 | ], | ||
| 66 | IdentityAttributeOrder => [ | ||
| 67 | 'MyAttributeName', | ||
| 68 | ... # min: 1, max: 230 | ||
| 69 | ], | ||
| 70 | Name => 'MyTypedLinkName', | ||
| 71 | SchemaArn => 'MyArn', | ||
| 72 | |||
| 73 | ); | ||
| 74 | |||
| 75 | 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. | ||
| 76 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/UpdateTypedLinkFacet> | ||
| 77 | |||
| 78 | =head1 ATTRIBUTES | ||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> AttributeUpdates => ArrayRef[L<Paws::CloudDirectory::TypedLinkFacetAttributeUpdate>] | ||
| 82 | |||
| 83 | Attributes update structure. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> IdentityAttributeOrder => ArrayRef[Str|Undef] | ||
| 88 | |||
| 89 | The order of identity attributes for the facet, from most significant | ||
| 90 | to least significant. The ability to filter typed links considers the | ||
| 91 | order that the attributes are defined on the typed link facet. When | ||
| 92 | providing ranges to a typed link selection, any inexact ranges must be | ||
| 93 | specified at the end. Any attributes that do not have a range specified | ||
| 94 | are presumed to match the entire range. Filters are interpreted in the | ||
| 95 | order of the attributes on the typed link facet, not the order in which | ||
| 96 | they are supplied to any API calls. For more information about identity | ||
| 97 | attributes, see Typed Links | ||
| 98 | (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> Name => Str | ||
| 103 | |||
| 104 | The unique name of the typed link facet. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 B<REQUIRED> SchemaArn => Str | ||
| 109 | |||
| 110 | The Amazon Resource Name (ARN) that is associated with the schema. For | ||
| 111 | more information, see arns. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, documenting arguments for method UpdateTypedLinkFacet in L<Paws::CloudDirectory> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |