Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer.DescribeAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data DescribeAccess Source #

See: newDescribeAccess smart constructor.

Constructors

DescribeAccess'

Fields

serverId :: Text
A system-assigned unique identifier for a server that has this access assigned.
externalId :: Text
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: =,.@:/-

Instances

Instances details

Eq DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods (==) :: DescribeAccess -> DescribeAccess -> Bool # (/=) :: DescribeAccess -> DescribeAccess -> Bool #
Read DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods readsPrec :: Int -> ReadS DescribeAccess # readList :: ReadS [DescribeAccess] # readPrec :: ReadPrec DescribeAccess # readListPrec :: ReadPrec [DescribeAccess] #
Show DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods showsPrec :: Int -> DescribeAccess -> ShowS # show :: DescribeAccess -> String # showList :: [DescribeAccess] -> ShowS #
Generic DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Associated Types type Rep DescribeAccess :: Type -> Type # Methods from :: DescribeAccess -> Rep DescribeAccess x # to :: Rep DescribeAccess x -> DescribeAccess #
NFData DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods rnf :: DescribeAccess -> () #
Hashable DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods hashWithSalt :: Int -> DescribeAccess -> Int # hash :: DescribeAccess -> Int #
ToJSON DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toJSON :: DescribeAccess -> Value # toEncoding :: DescribeAccess -> Encoding # toJSONList :: [DescribeAccess] -> Value # toEncodingList :: [DescribeAccess] -> Encoding #
AWSRequest DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Associated Types type AWSResponse DescribeAccess # Methods request :: DescribeAccess -> Request DescribeAccess # response :: MonadResource m => Logger -> Service -> Proxy DescribeAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAccess))) #
ToHeaders DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toHeaders :: DescribeAccess -> [Header] #
ToPath DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toPath :: DescribeAccess -> ByteString #
ToQuery DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toQuery :: DescribeAccess -> QueryString #
type Rep DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess type Rep DescribeAccess = D1 ('MetaData "DescribeAccess" "Amazonka.Transfer.DescribeAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess type AWSResponse DescribeAccess = DescribeAccessResponse

newDescribeAccess Source #

Arguments

:: Text	`$sel:serverId:DescribeAccess'`
-> Text	`$sel:externalId:DescribeAccess'`
-> 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:

$sel:serverId:DescribeAccess', describeAccess_serverId - A system-assigned unique identifier for a server that has this access assigned.

$sel:externalId: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 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: =,.@:/-

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

Destructuring the Response

data DescribeAccessResponse Source #

See: newDescribeAccessResponse smart constructor.

Constructors

DescribeAccessResponse'
Fields httpStatus :: Int The response's http status code. serverId :: Text A system-assigned unique identifier for a server that has this access assigned. access :: DescribedAccess The external ID of the server that the access is attached to.

Instances

Instances details

Eq DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods (==) :: DescribeAccessResponse -> DescribeAccessResponse -> Bool # (/=) :: DescribeAccessResponse -> DescribeAccessResponse -> Bool #
Read DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods readsPrec :: Int -> ReadS DescribeAccessResponse # readList :: ReadS [DescribeAccessResponse] # readPrec :: ReadPrec DescribeAccessResponse # readListPrec :: ReadPrec [DescribeAccessResponse] #
Show DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods showsPrec :: Int -> DescribeAccessResponse -> ShowS # show :: DescribeAccessResponse -> String # showList :: [DescribeAccessResponse] -> ShowS #
Generic DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Associated Types type Rep DescribeAccessResponse :: Type -> Type # Methods from :: DescribeAccessResponse -> Rep DescribeAccessResponse x # to :: Rep DescribeAccessResponse x -> DescribeAccessResponse #
NFData DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods rnf :: DescribeAccessResponse -> () #
type Rep DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess type Rep DescribeAccessResponse = D1 ('MetaData "DescribeAccessResponse" "Amazonka.Transfer.DescribeAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "access") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedAccess))))

newDescribeAccessResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAccessResponse'`
-> Text	`$sel:serverId:DescribeAccess'`
-> DescribedAccess	`$sel:access:DescribeAccessResponse'`
-> 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.

$sel:serverId:DescribeAccess', describeAccessResponse_serverId - A system-assigned unique identifier for a server that has this access assigned.

$sel:access:DescribeAccessResponse', describeAccessResponse_access - The external ID 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 ID of the server that the access is attached to.