NAME

Paws::Transfer::DescribeAccess - Arguments for method DescribeAccess on Paws::Transfer

DESCRIPTION

This class represents the parameters used for calling the method DescribeAccess on the AWS Transfer Family service. Use the attributes of this class as arguments to method DescribeAccess.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAccess.

SYNOPSIS

    my $transfer = Paws->service('Transfer');
    my $DescribeAccessResponse = $transfer->DescribeAccess(
      ExternalId => 'MyExternalId',
      ServerId   => 'MyServerId',

    );

    # Results:
    my $Access   = $DescribeAccessResponse->Access;
    my $ServerId = $DescribeAccessResponse->ServerId;

    # Returns a L<Paws::Transfer::DescribeAccessResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/transfer/DescribeAccess

ATTRIBUTES

REQUIRED ExternalId => Str

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

REQUIRED ServerId => Str

A system-assigned unique identifier for a server that has this access assigned.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeAccess in Paws::Transfer

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues