| 1 | |||
| 2 | package Paws::Transfer::DescribeAccess; | ||
| 3 | use Moose; | ||
| 4 | has ExternalId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ServerId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeAccess'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transfer::DescribeAccessResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Transfer::DescribeAccess - Arguments for method DescribeAccess on L<Paws::Transfer> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeAccess on the | ||
| 23 | L<AWS Transfer Family|Paws::Transfer> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeAccess. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAccess. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $transfer = Paws->service('Transfer'); | ||
| 31 | my $DescribeAccessResponse = $transfer->DescribeAccess( | ||
| 32 | ExternalId => 'MyExternalId', | ||
| 33 | ServerId => 'MyServerId', | ||
| 34 | |||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $Access = $DescribeAccessResponse->Access; | ||
| 39 | my $ServerId = $DescribeAccessResponse->ServerId; | ||
| 40 | |||
| 41 | # Returns a L<Paws::Transfer::DescribeAccessResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transfer/DescribeAccess> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> ExternalId => Str | ||
| 50 | |||
| 51 | A unique identifier that is required to identify specific groups within | ||
| 52 | your directory. The users of the group that you associate have access | ||
| 53 | to your Amazon S3 or Amazon EFS resources over the enabled protocols | ||
| 54 | using Amazon Web Services Transfer Family. If you know the group name, | ||
| 55 | you can view the SID values by running the following command using | ||
| 56 | Windows PowerShell. | ||
| 57 | |||
| 58 | C<Get-ADGroup -Filter {samAccountName -like "I<YourGroupName>*"} | ||
| 59 | -Properties * | Select SamAccountName,ObjectSid> | ||
| 60 | |||
| 61 | In that command, replace I<YourGroupName> with the name of your Active | ||
| 62 | Directory group. | ||
| 63 | |||
| 64 | The regex used to validate this parameter is a string of characters | ||
| 65 | consisting of uppercase and lowercase alphanumeric characters with no | ||
| 66 | spaces. You can also include underscores or any of the following | ||
| 67 | characters: =,.@:/- | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> ServerId => Str | ||
| 72 | |||
| 73 | A system-assigned unique identifier for a server that has this access | ||
| 74 | assigned. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, documenting arguments for method DescribeAccess in L<Paws::Transfer> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |