| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Transfer.DescribeAccess
Description
Describes the access that is assigned to the specific file transfer
protocol-enabled server, as identified by its ServerId property and
its ExternalId.
The response from this call returns the properties of the access that is
associated with the ServerId value that was specified.
Synopsis
- data DescribeAccess = DescribeAccess' {
- serverId :: Text
- externalId :: Text
- newDescribeAccess :: Text -> Text -> DescribeAccess
- describeAccess_serverId :: Lens' DescribeAccess Text
- describeAccess_externalId :: Lens' DescribeAccess Text
- data DescribeAccessResponse = DescribeAccessResponse' {
- httpStatus :: Int
- serverId :: Text
- access :: DescribedAccess
- newDescribeAccessResponse :: Int -> Text -> DescribedAccess -> DescribeAccessResponse
- describeAccessResponse_httpStatus :: Lens' DescribeAccessResponse Int
- describeAccessResponse_serverId :: Lens' DescribeAccessResponse Text
- describeAccessResponse_access :: Lens' DescribeAccessResponse DescribedAccess
Creating a Request
data DescribeAccess Source #
See: newDescribeAccess smart constructor.
Constructors
| DescribeAccess' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeAccess |
Create a value of DescribeAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAccess, describeAccess_serverId - A system-assigned unique identifier for a server that has this access
assigned.
DescribeAccess, describeAccess_externalId - 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: =,.@:/-
Request Lenses
describeAccess_serverId :: Lens' DescribeAccess Text Source #
A system-assigned unique identifier for a server that has this access assigned.
describeAccess_externalId :: Lens' DescribeAccess Text Source #
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: =,.@:/-
Destructuring the Response
data DescribeAccessResponse Source #
See: newDescribeAccessResponse smart constructor.
Constructors
| DescribeAccessResponse' | |
Fields
| |
Instances
newDescribeAccessResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribedAccess | |
| -> DescribeAccessResponse |
Create a value of DescribeAccessResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeAccessResponse', describeAccessResponse_httpStatus - The response's http status code.
DescribeAccess, describeAccessResponse_serverId - A system-assigned unique identifier for a server that has this access
assigned.
$sel:access:DescribeAccessResponse', describeAccessResponse_access - The external identifier of the server that the access is attached to.
Response Lenses
describeAccessResponse_httpStatus :: Lens' DescribeAccessResponse Int Source #
The response's http status code.
describeAccessResponse_serverId :: Lens' DescribeAccessResponse Text Source #
A system-assigned unique identifier for a server that has this access assigned.
describeAccessResponse_access :: Lens' DescribeAccessResponse DescribedAccess Source #
The external identifier of the server that the access is attached to.