« blib/lib/Paws/LakeFormation/ListLFTagsResponse.pm
↑ Summary
blib/lib/Paws/LakeFormation/ListPermissionsResponse.pm »
| 1 | |||
| 2 | package Paws::LakeFormation::ListPermissions; | ||
| 3 | use Moose; | ||
| 4 | has CatalogId => (is => 'ro', isa => 'Str'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has Principal => (is => 'ro', isa => 'Paws::LakeFormation::DataLakePrincipal'); | ||
| 8 | has Resource => (is => 'ro', isa => 'Paws::LakeFormation::Resource'); | ||
| 9 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListPermissions'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LakeFormation::ListPermissionsResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::LakeFormation::ListPermissions - Arguments for method ListPermissions on L<Paws::LakeFormation> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListPermissions on the | ||
| 27 | L<AWS Lake Formation|Paws::LakeFormation> service. Use the attributes of this class | ||
| 28 | as arguments to method ListPermissions. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListPermissions. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $lakeformation = Paws->service('LakeFormation'); | ||
| 35 | my $ListPermissionsResponse = $lakeformation->ListPermissions( | ||
| 36 | CatalogId => 'MyCatalogIdString', # OPTIONAL | ||
| 37 | MaxResults => 1, # OPTIONAL | ||
| 38 | NextToken => 'MyToken', # OPTIONAL | ||
| 39 | Principal => { | ||
| 40 | DataLakePrincipalIdentifier => | ||
| 41 | 'MyDataLakePrincipalString', # min: 1, max: 255; OPTIONAL | ||
| 42 | }, # OPTIONAL | ||
| 43 | Resource => { | ||
| 44 | Catalog => { | ||
| 45 | |||
| 46 | }, # OPTIONAL | ||
| 47 | DataLocation => { | ||
| 48 | ResourceArn => 'MyResourceArnString', | ||
| 49 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255 | ||
| 50 | }, # OPTIONAL | ||
| 51 | Database => { | ||
| 52 | Name => 'MyNameString', # min: 1, max: 255 | ||
| 53 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255 | ||
| 54 | }, # OPTIONAL | ||
| 55 | LFTag => { | ||
| 56 | TagKey => 'MyNameString', # min: 1, max: 255 | ||
| 57 | TagValues => [ | ||
| 58 | 'MyLFTagValue', ... # max: 256 | ||
| 59 | ], # min: 1, max: 50 | ||
| 60 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255 | ||
| 61 | }, # OPTIONAL | ||
| 62 | LFTagPolicy => { | ||
| 63 | Expression => [ | ||
| 64 | { | ||
| 65 | TagKey => 'MyLFTagKey', # min: 1, max: 128 | ||
| 66 | TagValues => [ | ||
| 67 | 'MyLFTagValue', ... # max: 256 | ||
| 68 | ], # min: 1, max: 50 | ||
| 69 | |||
| 70 | }, | ||
| 71 | ... | ||
| 72 | ], # min: 1, max: 5 | ||
| 73 | ResourceType => 'DATABASE', # values: DATABASE, TABLE | ||
| 74 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255 | ||
| 75 | }, # OPTIONAL | ||
| 76 | Table => { | ||
| 77 | DatabaseName => 'MyNameString', # min: 1, max: 255 | ||
| 78 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255 | ||
| 79 | Name => 'MyNameString', # min: 1, max: 255 | ||
| 80 | TableWildcard => { | ||
| 81 | |||
| 82 | }, # OPTIONAL | ||
| 83 | }, # OPTIONAL | ||
| 84 | TableWithColumns => { | ||
| 85 | DatabaseName => 'MyNameString', # min: 1, max: 255 | ||
| 86 | Name => 'MyNameString', # min: 1, max: 255 | ||
| 87 | CatalogId => 'MyCatalogIdString', # min: 1, max: 255 | ||
| 88 | ColumnNames => [ | ||
| 89 | 'MyNameString', ... # min: 1, max: 255 | ||
| 90 | ], # OPTIONAL | ||
| 91 | ColumnWildcard => { | ||
| 92 | ExcludedColumnNames => [ | ||
| 93 | 'MyNameString', ... # min: 1, max: 255 | ||
| 94 | ], # OPTIONAL | ||
| 95 | }, # OPTIONAL | ||
| 96 | }, # OPTIONAL | ||
| 97 | }, # OPTIONAL | ||
| 98 | ResourceType => 'CATALOG', # OPTIONAL | ||
| 99 | ); | ||
| 100 | |||
| 101 | # Results: | ||
| 102 | my $NextToken = $ListPermissionsResponse->NextToken; | ||
| 103 | my $PrincipalResourcePermissions = | ||
| 104 | $ListPermissionsResponse->PrincipalResourcePermissions; | ||
| 105 | |||
| 106 | # Returns a L<Paws::LakeFormation::ListPermissionsResponse> object. | ||
| 107 | |||
| 108 | 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. | ||
| 109 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lakeformation/ListPermissions> | ||
| 110 | |||
| 111 | =head1 ATTRIBUTES | ||
| 112 | |||
| 113 | |||
| 114 | =head2 CatalogId => Str | ||
| 115 | |||
| 116 | The identifier for the Data Catalog. By default, the account ID. The | ||
| 117 | Data Catalog is the persistent metadata store. It contains database | ||
| 118 | definitions, table definitions, and other control information to manage | ||
| 119 | your AWS Lake Formation environment. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 MaxResults => Int | ||
| 124 | |||
| 125 | The maximum number of results to return. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 NextToken => Str | ||
| 130 | |||
| 131 | A continuation token, if this is not the first call to retrieve this | ||
| 132 | list. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 Principal => L<Paws::LakeFormation::DataLakePrincipal> | ||
| 137 | |||
| 138 | Specifies a principal to filter the permissions returned. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 Resource => L<Paws::LakeFormation::Resource> | ||
| 143 | |||
| 144 | A resource where you will get a list of the principal permissions. | ||
| 145 | |||
| 146 | This operation does not support getting privileges on a table with | ||
| 147 | columns. Instead, call this operation on the table, and the operation | ||
| 148 | returns the table and the table w columns. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 ResourceType => Str | ||
| 153 | |||
| 154 | Specifies a resource type to filter the permissions returned. | ||
| 155 | |||
| 156 | Valid values are: C<"CATALOG">, C<"DATABASE">, C<"TABLE">, C<"DATA_LOCATION">, C<"LF_TAG">, C<"LF_TAG_POLICY">, C<"LF_TAG_POLICY_DATABASE">, C<"LF_TAG_POLICY_TABLE"> | ||
| 157 | |||
| 158 | |||
| 159 | =head1 SEE ALSO | ||
| 160 | |||
| 161 | This class forms part of L<Paws>, documenting arguments for method ListPermissions in L<Paws::LakeFormation> | ||
| 162 | |||
| 163 | =head1 BUGS and CONTRIBUTIONS | ||
| 164 | |||
| 165 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 166 | |||
| 167 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 168 | |||
| 169 | =cut | ||
| 170 |