Class: Aws::Transfer::Types::DescribeAccessRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Note:

When making an API call, you may pass DescribeAccessRequest data as a hash:

{
  server_id: "ServerId", # required
  external_id: "ExternalId", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#external_idString

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 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 regular expression 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: =,.@:/-

Returns:

  • (String)


1617
1618
1619
1620
1621
1622
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1617

class DescribeAccessRequest < Struct.new(
  :server_id,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#server_idString

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

Returns:

  • (String)


1617
1618
1619
1620
1621
1622
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1617

class DescribeAccessRequest < Struct.new(
  :server_id,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end