libZSservicesZSamazonka-transferZSamazonka-transfer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

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

Read DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Show DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Generic DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type Rep DescribeAccess :: Type -> Type #

NFData DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Methods

rnf :: DescribeAccess -> () #

Hashable DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

ToJSON DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

AWSRequest DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type AWSResponse DescribeAccess #

ToHeaders DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

ToPath DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

ToQuery DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

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

newDescribeAccess Source #

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

Read DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Show DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Generic DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type Rep DescribeAccessResponse :: Type -> Type #

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 #

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