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.DeleteAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Allows you to delete the access specified in the ServerID and ExternalID parameters.

Synopsis

data DeleteAccess = DeleteAccess' {
- serverId :: Text
- externalId :: Text
}
newDeleteAccess :: Text -> Text -> DeleteAccess
deleteAccess_serverId :: Lens' DeleteAccess Text
deleteAccess_externalId :: Lens' DeleteAccess Text
data DeleteAccessResponse = DeleteAccessResponse' {
}
newDeleteAccessResponse :: DeleteAccessResponse

Creating a Request

data DeleteAccess Source #

See: newDeleteAccess smart constructor.

Constructors

DeleteAccess'

Fields

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

newDeleteAccess Source #

Arguments

:: Text	`$sel:serverId:DeleteAccess'`
-> Text	`$sel:externalId:DeleteAccess'`
-> DeleteAccess

Create a value of DeleteAccess 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:DeleteAccess', deleteAccess_serverId - A system-assigned unique identifier for a server that has this user assigned.

$sel:externalId:DeleteAccess', deleteAccess_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

deleteAccess_serverId :: Lens' DeleteAccess Text Source #

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

deleteAccess_externalId :: Lens' DeleteAccess 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 DeleteAccessResponse Source #

See: newDeleteAccessResponse smart constructor.

Constructors

DeleteAccessResponse'

Instances

Instances details

Eq DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods (==) :: DeleteAccessResponse -> DeleteAccessResponse -> Bool # (/=) :: DeleteAccessResponse -> DeleteAccessResponse -> Bool #
Read DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods readsPrec :: Int -> ReadS DeleteAccessResponse # readList :: ReadS [DeleteAccessResponse] # readPrec :: ReadPrec DeleteAccessResponse # readListPrec :: ReadPrec [DeleteAccessResponse] #
Show DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods showsPrec :: Int -> DeleteAccessResponse -> ShowS # show :: DeleteAccessResponse -> String # showList :: [DeleteAccessResponse] -> ShowS #
Generic DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Associated Types type Rep DeleteAccessResponse :: Type -> Type # Methods from :: DeleteAccessResponse -> Rep DeleteAccessResponse x # to :: Rep DeleteAccessResponse x -> DeleteAccessResponse #
NFData DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods rnf :: DeleteAccessResponse -> () #
type Rep DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess type Rep DeleteAccessResponse = D1 ('MetaData "DeleteAccessResponse" "Amazonka.Transfer.DeleteAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteAccessResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAccessResponse :: DeleteAccessResponse Source #

Create a value of DeleteAccessResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.