« blib/lib/Paws/LakeFormation/GetLFTagResponse.pm
↑ Summary
blib/lib/Paws/LakeFormation/GetResourceLFTagsResponse.pm »
| 1 | |||
| 2 | package Paws::LakeFormation::GetResourceLFTags; | ||
| 3 | use Moose; | ||
| 4 | has CatalogId => (is => 'ro', isa => 'Str'); | ||
| 5 | has Resource => (is => 'ro', isa => 'Paws::LakeFormation::Resource', required => 1); | ||
| 6 | has ShowAssignedLFTags => (is => 'ro', isa => 'Bool'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetResourceLFTags'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LakeFormation::GetResourceLFTagsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::LakeFormation::GetResourceLFTags - Arguments for method GetResourceLFTags on L<Paws::LakeFormation> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetResourceLFTags on the | ||
| 24 | L<AWS Lake Formation|Paws::LakeFormation> service. Use the attributes of this class | ||
| 25 | as arguments to method GetResourceLFTags. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetResourceLFTags. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $lakeformation = Paws->service('LakeFormation'); | ||
| 32 | my $GetResourceLFTagsResponse = $lakeformation->GetResourceLFTags( | ||
| 33 | Resource => { | ||
| 34 | Catalog => { | ||
| 35 | |||
| 36 | }, # OPTIONAL | ||
| 37 | DataLocation => { | ||
| 38 | ResourceArn => 'MyResourceArnString', | ||
| 39 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | Database => { | ||
| 42 | Name => 'MyNameString', # min: 1, max: 255 | ||
| 43 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | LFTag => { | ||
| 46 | TagKey => 'MyNameString', # min: 1, max: 255 | ||
| 47 | TagValues => [ | ||
| 48 | 'MyLFTagValue', ... # max: 256 | ||
| 49 | ], # min: 1, max: 50 | ||
| 50 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | LFTagPolicy => { | ||
| 53 | Expression => [ | ||
| 54 | { | ||
| 55 | TagKey => 'MyLFTagKey', # min: 1, max: 128 | ||
| 56 | TagValues => [ | ||
| 57 | 'MyLFTagValue', ... # max: 256 | ||
| 58 | ], # min: 1, max: 50 | ||
| 59 | |||
| 60 | }, | ||
| 61 | ... | ||
| 62 | ], # min: 1, max: 5 | ||
| 63 | ResourceType => 'DATABASE', # values: DATABASE, TABLE | ||
| 64 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | Table => { | ||
| 67 | DatabaseName => 'MyNameString', # min: 1, max: 255 | ||
| 68 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL | ||
| 69 | Name => 'MyNameString', # min: 1, max: 255 | ||
| 70 | TableWildcard => { | ||
| 71 | |||
| 72 | }, # OPTIONAL | ||
| 73 | }, # OPTIONAL | ||
| 74 | TableWithColumns => { | ||
| 75 | DatabaseName => 'MyNameString', # min: 1, max: 255 | ||
| 76 | Name => 'MyNameString', # min: 1, max: 255 | ||
| 77 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL | ||
| 78 | ColumnNames => [ | ||
| 79 | 'MyNameString', ... # min: 1, max: 255 | ||
| 80 | ], # OPTIONAL | ||
| 81 | ColumnWildcard => { | ||
| 82 | ExcludedColumnNames => [ | ||
| 83 | 'MyNameString', ... # min: 1, max: 255 | ||
| 84 | ], # OPTIONAL | ||
| 85 | }, # OPTIONAL | ||
| 86 | }, # OPTIONAL | ||
| 87 | }, | ||
| 88 | CatalogId => 'MyCatalogIdString', # OPTIONAL | ||
| 89 | ShowAssignedLFTags => 1, # OPTIONAL | ||
| 90 | ); | ||
| 91 | |||
| 92 | # Results: | ||
| 93 | my $LFTagOnDatabase = $GetResourceLFTagsResponse->LFTagOnDatabase; | ||
| 94 | my $LFTagsOnColumns = $GetResourceLFTagsResponse->LFTagsOnColumns; | ||
| 95 | my $LFTagsOnTable = $GetResourceLFTagsResponse->LFTagsOnTable; | ||
| 96 | |||
| 97 | # Returns a L<Paws::LakeFormation::GetResourceLFTagsResponse> object. | ||
| 98 | |||
| 99 | 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. | ||
| 100 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lakeformation/GetResourceLFTags> | ||
| 101 | |||
| 102 | =head1 ATTRIBUTES | ||
| 103 | |||
| 104 | |||
| 105 | =head2 CatalogId => Str | ||
| 106 | |||
| 107 | The identifier for the Data Catalog. By default, the account ID. The | ||
| 108 | Data Catalog is the persistent metadata store. It contains database | ||
| 109 | definitions, table definitions, and other control information to manage | ||
| 110 | your AWS Lake Formation environment. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> Resource => L<Paws::LakeFormation::Resource> | ||
| 115 | |||
| 116 | The resource for which you want to return tags. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 ShowAssignedLFTags => Bool | ||
| 121 | |||
| 122 | Indicates whether to show the assigned tags. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, documenting arguments for method GetResourceLFTags in L<Paws::LakeFormation> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |