Amazonka.Transfer.DescribeAccess

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

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

Instances

ToJSON DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

toJSON :: DescribeAccess -> Value

toEncoding :: DescribeAccess -> Encoding

toJSONList :: [DescribeAccess] -> Value

toEncodingList :: [DescribeAccess] -> Encoding

ToHeaders DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

toHeaders :: DescribeAccess -> [Header]

ToPath DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

toPath :: DescribeAccess -> ByteString

ToQuery DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

toQuery :: DescribeAccess -> QueryString

AWSRequest DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type AWSResponse DescribeAccess

Methods

request :: (Service -> Service) -> DescribeAccess -> Request DescribeAccess

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAccess)))

Generic DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type Rep DescribeAccess :: Type -> Type

Methods

from :: DescribeAccess -> Rep DescribeAccess x

to :: Rep DescribeAccess x -> DescribeAccess

Read DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

readsPrec :: Int -> ReadS DescribeAccess

readList :: ReadS [DescribeAccess]

readPrec :: ReadPrec DescribeAccess

readListPrec :: ReadPrec [DescribeAccess]

Show DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

showsPrec :: Int -> DescribeAccess -> ShowS

show :: DescribeAccess -> String

showList :: [DescribeAccess] -> ShowS

NFData DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

rnf :: DescribeAccess -> ()

Eq DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

(==) :: DescribeAccess -> DescribeAccess -> Bool

(/=) :: DescribeAccess -> DescribeAccess -> Bool

Hashable DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

Methods

hashWithSalt :: Int -> DescribeAccess -> Int

hash :: DescribeAccess -> Int

type AWSResponse DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

type AWSResponse DescribeAccess = DescribeAccessResponse

type Rep DescribeAccess

Defined in Amazonka.Transfer.DescribeAccess

type Rep DescribeAccess = D1 ('MetaData "DescribeAccess" "Amazonka.Transfer.DescribeAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAccess

Arguments

:: Text

DescribeAccess

-> Text

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:

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

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

describeAccess_externalId :: Lens' DescribeAccess 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 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

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 identifier of the server that the access is attached to.

Instances

Generic DescribeAccessResponse

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type Rep DescribeAccessResponse :: Type -> Type

Methods

from :: DescribeAccessResponse -> Rep DescribeAccessResponse x

to :: Rep DescribeAccessResponse x -> DescribeAccessResponse

Read DescribeAccessResponse

Defined in Amazonka.Transfer.DescribeAccess

Methods

readsPrec :: Int -> ReadS DescribeAccessResponse

readList :: ReadS [DescribeAccessResponse]

readPrec :: ReadPrec DescribeAccessResponse

readListPrec :: ReadPrec [DescribeAccessResponse]

Show DescribeAccessResponse

Defined in Amazonka.Transfer.DescribeAccess

Methods

showsPrec :: Int -> DescribeAccessResponse -> ShowS

show :: DescribeAccessResponse -> String

showList :: [DescribeAccessResponse] -> ShowS

NFData DescribeAccessResponse

Defined in Amazonka.Transfer.DescribeAccess

Methods

rnf :: DescribeAccessResponse -> ()

Eq DescribeAccessResponse

Defined in Amazonka.Transfer.DescribeAccess

Methods

(==) :: DescribeAccessResponse -> DescribeAccessResponse -> Bool

(/=) :: DescribeAccessResponse -> DescribeAccessResponse -> Bool

type Rep DescribeAccessResponse

Defined in Amazonka.Transfer.DescribeAccess

type Rep DescribeAccessResponse = D1 ('MetaData "DescribeAccessResponse" "Amazonka.Transfer.DescribeAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" '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

Arguments

:: Int

$sel:httpStatus:DescribeAccessResponse'

-> Text

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.

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

The response's http status code.

describeAccessResponse_serverId :: Lens' DescribeAccessResponse Text

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

describeAccessResponse_access :: Lens' DescribeAccessResponse DescribedAccess

The external identifier of the server that the access is attached to.